public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-28 14:08:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleaned up typos

Browse Source
This commit is contained in:
Mark Bishop
2018-09-21 11:56:13 -07:00
parent 7a6725a0f3
commit bcf346bf58
4 changed files with 22 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/installation/air-gap-installation/_index.md
+3 -3
View File
@@ -6,11 +6,11 @@ In environments where security is high priority, you can set up Rancher in an ai
## Prerequisites ## Prerequisites
- Rancher supports air gap installs using a private registry. You must have your own private registry or other means of distributing docker images to your machine. If you need help with creating a private registry, please refer to the [Docker documentation for private registries](https://docs.docker.com/registry/). - Rancher supports air gap installs using a private registry. You must have your own private registry or other means of distributing docker images to your machine. If you need help with creating a private registry, please refer to the [Docker documentation](https://docs.docker.com/registry/).
In every [release](https://github.com/rancher/rancher/releases), we provide you with the needed Docker images and scripts to mirror those images to your own registry. The Docker images are used when nodes are added to a cluster, or when you enable features like pipelines or logging. For each Rancher [release](https://github.com/rancher/rancher/releases), we provide the Docker images and scripts needed to mirror those images to your own registry. The Docker images are used when nodes are added to a cluster, or when you enable features like pipelines or logging.
- **Installation Option:** Before beginning your air gap installation, choose whether your want it to be a [single-node install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node) or a [high availability install]({{< baseurl >}}/rancher/v2.x/en/installation/ha). View your chosen configuration's introduction notes along with Rancher's [node requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements). - **Installation Option:** Before beginning your air gap installation, choose whether you want ~~a~~ [single-node install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node) or a [high availability install]({{< baseurl >}}/rancher/v2.x/en/installation/ha). View your chosen configuration's introduction notes along with Rancher's [node requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements).
## Caveats ## Caveats
content/rancher/v2.x/en/installation/air-gap-installation/config-rancher-for-private-reg/_index.md
+4 -2
View File
@@ -6,15 +6,17 @@ draft: true
Rancher needs to be configured to use the private registry as source for the needed images. Rancher needs to be configured to use the private registry as source for the needed images.
1. Log into Rancher and configure the default admin password.
1. Go into the **Settings** view. 1. Go into the **Settings** view.
![Settings]({{< baseurl >}}/img/rancher/airgap/settings.png) ![Settings]({{< baseurl >}}/img/rancher/airgap/settings.png)
2. Look for the setting called `system-default-registry` and choose **Edit**. 1. Look for the setting called `system-default-registry` and choose **Edit**.
![Edit]({{< baseurl >}}/img/rancher/airgap/edit-system-default-registry.png) ![Edit]({{< baseurl >}}/img/rancher/airgap/edit-system-default-registry.png)
3. Change the value to your registry (e.g. `registry.yourdomain.com:port`). Do not prefix the registry with `http://` or `https://`. 1. Change the value to your registry (e.g. `registry.yourdomain.com:port`). Do not prefix the registry with `http://` or `https://`.
![Save]({{< baseurl >}}/img/rancher/airgap/enter-system-default-registry.png) ![Save]({{< baseurl >}}/img/rancher/airgap/enter-system-default-registry.png)
content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md
+12 -13
View File
@@ -8,19 +8,18 @@ After your private registry is setup for your Rancher installation, complete tha
<!-- TOC --> <!-- TOC -->
- [Single Node Install](#single-node-install) - [Single Node Air Gap Install](#single-node-air-gap-install)
- [High Availability Install](#high-availability-install) - [High Availability Air Gap Install](#high-availability-air-gap-install)
<!-- /TOC --> <!-- /TOC -->
## Single Node Air Gap Install
## Single Node Install To deploy Rancher on a single node in an air gap environment, follow the instructions in the standard [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/). Parts of the install where you must complete a special action for air gap are flagged with a substitute step, which is listed in the subheading below.
To deploy Rancher on a single node in an air gap environment, follow the instructions in [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/). Parts of the install where you must complete a special action for air gap are flagged with a substitute step, which is listed in the subheading below.
### Add Private Registry URL to Run Command ### Add Private Registry URL to Run Command
When you get [Choose an SSL Option and Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/#2-choose-an-ssl-option-and-install-rancher), regardless of which install option you choose, prepend your Rancher image tag with your private registry URL (`<registry.yourdomain.com:port>`), as shown in the example below. When you get to the section [Choose an SSL Option and Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/#2-choose-an-ssl-option-and-install-rancher), regardless of which install option you choose, prepend your Rancher image tag with your private registry URL (`<registry.yourdomain.com:port>`), as shown in the example below.
``` ```
docker run -d --restart=unless-stopped \ docker run -d --restart=unless-stopped \
@@ -31,16 +30,16 @@ docker run -d --restart=unless-stopped \
>**Note:** If you want to skip [3—Configuring Rancher for the Private Registry]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/config-rancher-for-private-reg/) later, you can complete it now by setting the environment variable `CATTLE_SYSTEM_DEFAULT_REGISTRY`. >**Note:** If you want to skip [3—Configuring Rancher for the Private Registry]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/config-rancher-for-private-reg/) later, you can complete it now by setting the environment variable `CATTLE_SYSTEM_DEFAULT_REGISTRY`.
> >
> Example: > Example:
> ``` ```
docker run -d --restart=unless-stopped \ docker run -d --restart=unless-stopped \
-p 80:80 -p 443:443 \ -p 80:80 -p 443:443 \
-e CATTLE_SYSTEM_DEFAULT_REGISTRY=<registry.yourdomain.com:port> \ -e CATTLE_SYSTEM_DEFAULT_REGISTRY=<registry.yourdomain.com:port> \
<registry.yourdomain.com:port>/rancher/rancher:v2.0.0 <registry.yourdomain.com:port>/rancher/rancher:v2.0.0
``` ```
## High Availability Install ## High Availability Air Gap Install
To install Rancher in a high availability configuration within an air gap environment, follow the instructions in [High Availability Install]({{< baseurl >}}/rancher/v2.x/en/installation/ha). Parts of the install where you must complete a special action for air gap are flagged with substitute steps, which are listed in the subheadings below. To install Rancher in a high availability configuration within an air gap environment, follow the instructions in the standard [High Availability Install]({{< baseurl >}}/rancher/v2.x/en/installation/ha). Parts of the install where you must complete a special action for air gap are flagged with substitute steps, which are listed in the subheadings below.
### Add Private Registry to RKE YAML ### Add Private Registry to RKE YAML
@@ -51,7 +50,7 @@ Replace values in the code sample according to the table below.
| Directive Replacement | Description | | Directive Replacement | Description |
| ----------------------- | --------------------------------------------------------------------- | | ----------------------- | --------------------------------------------------------------------- |
| `address` | The IP address for each of your air gap nodes outside of the cluster. | | `address` | The IP address for each of your air gap nodes outside of the cluster. |
| `internal address` | The IP address for each of your air gap nodes within the cluster. | | `internal_address` | The IP address for each of your air gap nodes within the cluster. |
| `url` | The URL for your private registry. | | `url` | The URL for your private registry. |
content/rancher/v2.x/en/installation/air-gap-installation/prepare-private-reg/_index.md
+3 -3
View File
@@ -88,7 +88,7 @@ The architecture for this scenario is:
1. From the host that can access DockerHub, run `rancher-save-images.sh`. This will require at least 20GB of disk space. 1. From the host that can access DockerHub, run `rancher-save-images.sh`. This will require at least 20GB of disk space.
1. Transfer the output file from the previous step (`rancher-images.tar.gz`) to the on-premise host that can access the private registry. 1. Transfer the output file from the previous step (`rancher-images.tar.gz`) to the host that can access the private registry.
1. Transfer and run `rancher-load-images.sh` on the host that can access the private registry. It should be run in the same directory as `rancher-images.tar.gz`. 1. Transfer and run `rancher-load-images.sh` on the host that can access the private registry. It should be run in the same directory as `rancher-images.tar.gz`.
{{% /tab %}} {{% /tab %}}
@@ -96,7 +96,7 @@ The architecture for this scenario is:
<br/> <br/>
The architecture for this scenario is: The architecture for this scenario is:
- A host that can access both DockerHub and your private registry - A host that can access both DockerHub and your private registry.
- An on-premise private registry, which you'll use to deploy Rancher in your air gap environment. - An on-premise private registry, which you'll use to deploy Rancher in your air gap environment.
<br/> <br/>
@@ -104,7 +104,7 @@ The architecture for this scenario is:
![Scenario2]({{< baseurl >}}/img/rancher/airgap/privateregistrypushpull.svg) ![Scenario2]({{< baseurl >}}/img/rancher/airgap/privateregistrypushpull.svg)
2. Pull all the images present in `rancher-images.txt`, re-tag each image with the location of your registry, and push the image to the registry. This will require at least 20GB of disk space. See an example script below: 2. Pull all the images present in `rancher-images.txt`, re-tag each image with the location of your registry, and push the image to the registry. This action requires at least 20GB of disk space. See an example script below:
``` ```
#!/bin/sh #!/bin/sh