跳到主要内容
版本：v2.0-v2.4

4. Install Rancher

This section is about how to deploy Rancher for your air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. There are tabs for either a high availability (recommended) or a Docker installation.

Rancher recommends installing Rancher on a Kubernetes cluster. A highly available Kubernetes Installation is comprised of three nodes running the Rancher server components on a Kubernetes cluster. The persistence layer (etcd) is also replicated on these three nodes, providing redundancy and data duplication in case one of the nodes fails.

A. Add the Helm Chart Repository​

From a system that has access to the internet, fetch the latest Helm chart and copy the resulting manifests to a system that has access to the Rancher server cluster.

  1. If you haven't already, initialize Helm locally on a workstation that has internet access.
备注

Refer to the Helm version requirements to choose a version of Helm to install Rancher.

```plain
helm init -c
```

  1. Use the helm repo add command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see Choosing a Version of Rancher.

    • Latest: Recommended for trying out the newest features
      helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
    • Stable: Recommended for production environments
      helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
    • Alpha: Experimental preview of upcoming releases.
      helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
      Note: Upgrades are not supported to, from, or between Alphas.

  2. Fetch the latest Rancher chart. This will pull down the chart and save it in the current directory as a .tgz file.

helm fetch rancher-<CHART_REPO>/rancher

Want additional options? See the Rancher Helm chart options.

B. Choose your SSL Configuration​

Rancher Server is designed to be secure by default and requires SSL/TLS configuration.

When Rancher is installed on an air gapped Kubernetes cluster, there are two recommended options for the source of the certificate.

Note: If you want terminate SSL/TLS externally, see TLS termination on an External Load Balancer.

ConfigurationChart optionDescriptionRequires cert-manager
Rancher Generated Self-Signed Certificatesingress.tls.source=rancherUse certificates issued by Rancher's generated CA (self signed)
This is the default and does not need to be added when rendering the Helm template.		yes
Certificates from Filesingress.tls.source=secretUse your own certificate files by creating Kubernetes Secret(s).
This option must be passed when rendering the Rancher Helm template.		no

C. Render the Rancher Helm Template​

When setting up the Rancher Helm template, there are several options in the Helm chart that are designed specifically for air gap installations.

Chart OptionChart ValueDescription
certmanager.version<version>Configure proper Rancher TLS issuer depending of running cert-manager version.
systemDefaultRegistry<REGISTRY.YOURDOMAIN.COM:PORT>Configure Rancher server to always pull from your private registry when provisioning clusters.
useBundledSystemCharttrueConfigure Rancher server to use the packaged copy of Helm system charts. The system charts repository contains all the catalog items required for features such as monitoring, logging, alerting and global DNS. These Helm charts are located in GitHub, but since you are in an air gapped environment, using the charts that are bundled within Rancher is much easier than setting up a Git mirror. Available as of v2.3.0

Based on the choice your made in B. Choose your SSL Configuration, complete one of the procedures below.

Option A-Default Self-Signed Certificate

By default, Rancher generates a CA and uses cert-manager to issue the certificate for access to the Rancher server interface.

Note: Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our upgrade cert-manager documentation.

  1. From a system connected to the internet, add the cert-manager repo to Helm.

    helm repo add jetstack https://charts.jetstack.io
    helm repo update

  2. Fetch the latest cert-manager chart available from the Helm chart repository.

    helm fetch jetstack/cert-manager --version v0.14.2

  3. Render the cert manager template with the options you would like to use to install the chart. Remember to set the image.repository option to pull the image from your private registry. This will create a cert-manager directory with the Kubernetes manifest files.

    helm template ./cert-manager-v0.14.2.tgz --output-dir . \
        --name cert-manager --namespace cert-manager \
        --set image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-controller
        --set webhook.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-webhook
        --set cainjector.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-cainjector

  4. Download the required CRD file for cert-manager

    curl -L -o cert-manager-crd.yaml https://raw.githubusercontent.com/jetstack/cert-manager/release-0.14/deploy/manifests/00-crds.yaml

  5. Render the Rancher template, declaring your chosen options. Use the reference table below to replace each placeholder. Rancher needs to be configured to use the private registry in order to provision any Rancher launched Kubernetes clusters or Rancher tools.

Placeholder | Description
------------|-------------
`<VERSION>` | The version number of the output tarball.
`<RANCHER.YOURDOMAIN.COM>` | The DNS name you pointed at your load balancer.
`<REGISTRY.YOURDOMAIN.COM:PORT>` | The DNS name for your private registry.
`<CERTMANAGER_VERSION>` | Cert-manager version running on k8s cluster.

 ```plain
helm template ./rancher-<VERSION>.tgz --output-dir . \
 --name rancher \
 --namespace cattle-system \
 --set hostname=<RANCHER.YOURDOMAIN.COM> \
 --set certmanager.version=<CERTMANAGER_VERSION> \
 --set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
 --set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Available as of v2.2.0, set a default private registry to be used in Rancher
 --set useBundledSystemChart=true # Available as of v2.3.0, use the packaged Rancher system charts

</details>

<details id="secret">
  <summary>Option B: Certificates From Files using Kubernetes Secrets</summary>

Create Kubernetes secrets from your own certificates for Rancher to use. The common name for the cert will need to match the `hostname` option in the command below, or the ingress controller will fail to provision the site for Rancher.

Render the Rancher template, declaring your chosen options. Use the reference table below to replace each placeholder. Rancher needs to be configured to use the private registry in order to provision any Rancher launched Kubernetes clusters or Rancher tools.

| Placeholder                      | Description                                     |
| -------------------------------- | ----------------------------------------------- |
| `<VERSION>`                      | The version number of the output tarball.       |
| `<RANCHER.YOURDOMAIN.COM>`       | The DNS name you pointed at your load balancer. |
| `<REGISTRY.YOURDOMAIN.COM:PORT>` | The DNS name for your private registry.         |

```plain
   helm template ./rancher-<VERSION>.tgz --output-dir . \
    --name rancher \
    --namespace cattle-system \
    --set hostname=<RANCHER.YOURDOMAIN.COM> \
    --set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
    --set ingress.tls.source=secret \
    --set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Available as of v2.2.0, set a default private registry to be used in Rancher
    --set useBundledSystemChart=true # Available as of v2.3.0, use the packaged Rancher system charts

If you are using a Private CA signed cert, add --set privateCA=true following --set ingress.tls.source=secret:

   helm template ./rancher-<VERSION>.tgz --output-dir . \
    --name rancher \
    --namespace cattle-system \
    --set hostname=<RANCHER.YOURDOMAIN.COM> \
    --set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
    --set ingress.tls.source=secret \
    --set privateCA=true \
    --set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Available as of v2.2.0, set a default private registry to be used in Rancher
    --set useBundledSystemChart=true # Available as of v2.3.0, use the packaged Rancher system charts

Then refer to Adding TLS Secrets to publish the certificate files so Rancher and the ingress controller can use them.

D. Install Rancher​

Copy the rendered manifest directories to a system that has access to the Rancher server cluster to complete installation.

Use kubectl to create namespaces and apply the rendered manifests.

If you choose to use self-signed certificates in B. Choose your SSL Configuration, install cert-manager.

Self-Signed Certificate Installs - Install Cert-manager

If you are using self-signed certificates, install cert-manager:

  1. Create the namespace for cert-manager.
kubectl create namespace cert-manager
  1. Create the cert-manager CustomResourceDefinitions (CRDs).
kubectl apply -f cert-manager/cert-manager-crd.yaml

Important: If you are running Kubernetes v1.15 or below, you will need to add the `--validate=false flag to your kubectl apply command above else you will receive a validation error relating to the x-kubernetes-preserve-unknown-fields field in cert-manager’s CustomResourceDefinition resources. This is a benign error and occurs due to the way kubectl performs resource validation.

  1. Launch cert-manager.
kubectl apply -R -f ./cert-manager

Install Rancher:

kubectl create namespace cattle-system
kubectl -n cattle-system apply -R -f ./rancher

Step Result: If you are installing Rancher v2.3.0+, the installation is complete.

E. For Rancher versions before v2.3.0, Configure System Charts​

If you are installing Rancher versions before v2.3.0, you will not be able to use the packaged system charts. Since the Rancher system charts are hosted in Github, an air gapped installation will not be able to access these charts. Therefore, you must configure the Rancher system charts.

Additional Resources​

These resources could be helpful when installing Rancher: