Updating tabs

This commit is contained in:
Jennifer Travinski
2022-07-14 14:40:53 -04:00
parent e0b784ad21
commit d7eb4f8378
122 changed files with 876 additions and 876 deletions
@@ -69,8 +69,8 @@ To install `gcloud` and `kubectl`, perform the following steps:
- Using gcloud init, if you want to be walked through setting defaults.
- Using gcloud config, to individually set your project ID, zone, and region.
{{% tabs %}}
{{% tab "Using gloud init" %}}
<Tabs>
<TabItem label="Using gloud init">
1. Run gcloud init and follow the directions:
@@ -84,10 +84,10 @@ To install `gcloud` and `kubectl`, perform the following steps:
```
2. Follow the instructions to authorize gcloud to use your Google Cloud account and select the new project that you created.
{{% /tab %}}
{{% tab "Using gcloud config" %}}
{{% /tab %}}
{{% /tabs %}}
</TabItem>
<TabItem label="Using gcloud config">
</TabItem>
</Tabs>
# 4. Confirm that gcloud is configured correctly
@@ -159,8 +159,8 @@ The exact command to install Rancher differs depending on the certificate config
However, irrespective of the certificate configuration, the name of the Rancher installation in the `cattle-system` namespace should always be `rancher`.
{{% tabs %}}
{{% tab "Rancher-generated Certificates" %}}
<Tabs>
<TabItem label="Rancher-generated Certificates">
The default is for Rancher to generate a self-signed CA, and uses `cert-manager` to issue the certificate for access to the Rancher server interface.
@@ -187,8 +187,8 @@ Waiting for deployment "rancher" rollout to finish: 0 of 3 updated replicas are
deployment "rancher" successfully rolled out
```
{{% /tab %}}
{{% tab "Let's Encrypt" %}}
</TabItem>
<TabItem label="Let's Encrypt">
This option uses `cert-manager` to automatically request and renew [Let's Encrypt](https://letsencrypt.org/) certificates. This is a free service that provides you with a valid certificate as Let's Encrypt is a trusted CA.
@@ -222,8 +222,8 @@ Waiting for deployment "rancher" rollout to finish: 0 of 3 updated replicas are
deployment "rancher" successfully rolled out
```
{{% /tab %}}
{{% tab "Certificates from Files" %}}
</TabItem>
<TabItem label="Certificates from Files">
In this option, Kubernetes secrets are created from your own certificates for Rancher to use.
When you run this command, the `hostname` option must match the `Common Name` or a `Subject Alternative Names` entry in the server certificate, or the Ingress controller will fail to configure correctly.
@@ -257,8 +257,8 @@ helm install rancher rancher-<CHART_REPO>/rancher \
```
Now that Rancher is deployed, see [Adding TLS Secrets]({{<baseurl>}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) to publish the certificate files so Rancher and the Ingress controller can use them.
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
The Rancher chart configuration has many options for customizing the installation to suit your specific environment. Here are some common advanced scenarios.
@@ -22,8 +22,8 @@ Placeholder | Description
### Option A: Default Self-signed Certificate
{{% tabs %}}
{{% tab "Rancher v2.5.8+" %}}
<Tabs>
<TabItem label="Rancher v2.5.8+">
```
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
@@ -36,8 +36,8 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--set useBundledSystemChart=true # Use the packaged Rancher system charts
```
{{% /tab %}}
{{% tab "Rancher before v2.5.8" %}}
</TabItem>
<TabItem label="Rancher before v2.5.8">
```plain
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
@@ -49,16 +49,16 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--set useBundledSystemChart=true # Use the packaged Rancher system charts
```
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
### Option B: Certificates from Files using Kubernetes Secrets
{{% tabs %}}
{{% tab "Rancher v2.5.8+" %}}
<Tabs>
<TabItem label="Rancher v2.5.8+">
```plain
@@ -86,8 +86,8 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--set useBundledSystemChart=true # Use the packaged Rancher system charts
```
{{% /tab %}}
{{% tab "Rancher before v2.5.8" %}}
</TabItem>
<TabItem label="Rancher before v2.5.8">
```plain
@@ -112,8 +112,8 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Set a default private registry to be used in Rancher
--set useBundledSystemChart=true # Use the packaged Rancher system charts
```
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
### Apply the Rendered Templates
@@ -138,8 +138,8 @@ Placeholder | Description
`<REGISTRY.YOURDOMAIN.COM:PORT>` | The DNS name for your private registry.
`<CERTMANAGER_VERSION>` | Cert-manager version running on k8s cluster.
{{% tabs %}}
{{% tab "Rancher v2.5.8+" %}}
<Tabs>
<TabItem label="Rancher v2.5.8+">
```plain
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--no-hooks \ # prevent files for Helm hooks from being generated
@@ -152,8 +152,8 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
```
**Optional**: To install a specific Rancher version, set the `rancherImageTag` value, example: `--set rancherImageTag=v2.5.8`
{{% /tab %}}
{{% tab "Rancher before v2.5.8" %}}
</TabItem>
<TabItem label="Rancher before v2.5.8">
```plain
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
@@ -166,8 +166,8 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
```
**Optional**: To install a specific Rancher version, set the `rancherImageTag` value, example: `--set rancherImageTag=v2.5.6`
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
@@ -188,8 +188,8 @@ Render the Rancher template, declaring your chosen options. Use the reference ta
| `<RANCHER.YOURDOMAIN.COM>` | The DNS name you pointed at your load balancer. |
| `<REGISTRY.YOURDOMAIN.COM:PORT>` | The DNS name for your private registry. |
{{% tabs %}}
{{% tab "Rancher v2.5.8+" %}}
<Tabs>
<TabItem label="Rancher v2.5.8+">
```plain
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
@@ -219,8 +219,8 @@ If you are using a Private CA signed cert, add `--set privateCA=true` following
**Optional**: To install a specific Rancher version, set the `rancherImageTag` value, example: `--set rancherImageTag=v2.3.6`
Then refer to [Adding TLS Secrets]({{<baseurl>}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them.
{{% /tab %}}
{{% tab "Rancher before v2.5.8" %}}
</TabItem>
<TabItem label="Rancher before v2.5.8">
```plain
@@ -249,8 +249,8 @@ If you are using a Private CA signed cert, add `--set privateCA=true` following
**Optional**: To install a specific Rancher version, set the `rancherImageTag` value, example: `--set rancherImageTag=v2.3.6`
Then refer to [Adding TLS Secrets]({{<baseurl>}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them.
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
@@ -14,8 +14,8 @@ As of Rancher v2.5, Rancher can be installed on any Kubernetes cluster, includin
The steps to set up an air-gapped Kubernetes cluster on RKE or K3s are shown below.
{{% tabs %}}
{{% tab "K3s" %}}
<Tabs>
<TabItem label="K3s">
In this guide, we are assuming you have created your nodes in your air gapped environment and have a secure Docker private registry on your bastion server.
@@ -138,8 +138,8 @@ Upgrading an air-gap environment can be accomplished in the following manner:
1. Download the new air-gap images (tar file) from the [releases](https://github.com/rancher/k3s/releases) page for the version of K3s you will be upgrading to. Place the tar in the `/var/lib/rancher/k3s/agent/images/` directory on each node. Delete the old tar file.
2. Copy and replace the old K3s binary in `/usr/local/bin` on each node. Copy over the install script at https://get.k3s.io (as it is possible it has changed since the last release). Run the script again just as you had done in the past with the same environment variables.
3. Restart the K3s service (if not restarted automatically by installer).
{{% /tab %}}
{{% tab "RKE" %}}
</TabItem>
<TabItem label="RKE">
We will create a Kubernetes cluster using Rancher Kubernetes Engine (RKE). Before being able to start your Kubernetes cluster, you’ll need to install RKE and create a RKE config file.
### 1. Install RKE
@@ -211,8 +211,8 @@ Save a copy of the following files in a secure location:
- `rancher-cluster.yml`: The RKE cluster configuration file.
- `kube_config_cluster.yml`: The [Kubeconfig file]({{<baseurl>}}/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster.
- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file]({{<baseurl>}}/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates.<br/><br/>_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
> **Note:** The "rancher-cluster" parts of the two latter file names are dependent on how you name the RKE cluster configuration file.
@@ -24,8 +24,8 @@ The steps in this section differ depending on whether or not you are planning to
>
> If the registry has certs, follow [this K3s documentation](https://rancher.com/docs/k3s/latest/en/installation/private-registry/) about adding a private registry. The certs and registry configuration files need to be mounted into the Rancher container.
{{% tabs %}}
{{% tab "Linux Only Clusters" %}}
<Tabs>
<TabItem label="Linux Only Clusters">
For Rancher servers that will only provision Linux clusters, these are the steps to populate your private registry.
@@ -109,8 +109,8 @@ The `rancher-images.txt` is expected to be on the workstation in the same direct
```plain
./rancher-load-images.sh --image-list ./rancher-images.txt --registry <REGISTRY.YOURDOMAIN.COM:PORT>
```
{{% /tab %}}
{{% tab "Linux and Windows Clusters" %}}
</TabItem>
<TabItem label="Linux and Windows Clusters">
For Rancher servers that will provision Linux and Windows clusters, there are distinctive steps to populate your private registry for the Windows images and the Linux images. Since a Windows cluster is a mix of Linux and Windows nodes, the Linux images pushed into the private registry are manifests.
@@ -288,8 +288,8 @@ The image list, `rancher-images.txt` or `rancher-windows-images.txt`, is expecte
```
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
### [Next step for Kubernetes Installs - Launch a Kubernetes Cluster]({{<baseurl>}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/launch-kubernetes/)
@@ -14,8 +14,8 @@ The infrastructure depends on whether you are installing Rancher on a K3s Kubern
As of Rancher v2.5, Rancher can be installed on any Kubernetes cluster. The RKE and K3s Kubernetes infrastructure tutorials below are still included for convenience.
{{% tabs %}}
{{% tab "K3s" %}}
<Tabs>
<TabItem label="K3s">
We recommend setting up the following infrastructure for a high-availability installation:
- **Two Linux nodes,** typically virtual machines, in the infrastructure provider of your choice.
@@ -85,8 +85,8 @@ Rancher supports air gap installs using a private registry. You must have your o
In a later step, when you set up your K3s Kubernetes cluster, you will create a [private registries configuration file]({{<baseurl>}}/k3s/latest/en/installation/private-registry/) with details from this registry.
If you need help with creating a private registry, please refer to the [official Docker documentation.](https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry)
{{% /tab %}}
{{% tab "RKE" %}}
</TabItem>
<TabItem label="RKE">
To install the Rancher management server on a high-availability RKE cluster, we recommend setting up the following infrastructure:
@@ -149,8 +149,8 @@ In a later step, when you set up your RKE Kubernetes cluster, you will create a
If you need help with creating a private registry, please refer to the [official Docker documentation.](https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry)
{{% /tab %}}
{{% tab "Docker" %}}
</TabItem>
<TabItem label="Docker">
> The Docker installation is for Rancher users that are wanting to test out Rancher. Since there is only one node and a single Docker container, if the node goes down, you will lose all the data of your Rancher server.
>
> As of Rancher v2.5, the Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{<baseurl>}}/rancher/v2.5/en/backups/migrating-rancher)
@@ -169,7 +169,7 @@ Rancher supports air gap installs using a Docker private registry on your bastio
If you need help with creating a private registry, please refer to the [official Docker documentation.](https://docs.docker.com/registry/)
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
### [Next: Collect and Publish Images to your Private Registry]({{<baseurl>}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/)
@@ -130,8 +130,8 @@ To see the command to use when starting the new Rancher server container, choose
- Docker Upgrade
- Docker Upgrade for Air Gap Installs
{{% tabs %}}
{{% tab "Docker Upgrade" %}}
<Tabs>
<TabItem label="Docker Upgrade">
Select which option you had installed Rancher server
@@ -248,8 +248,8 @@ As of Rancher v2.5, privileged access is [required.]({{<baseurl>}}/rancher/v2.5/
{{% /accordion %}}
{{% /tab %}}
{{% tab "Docker Air Gap Upgrade" %}}
</TabItem>
<TabItem label="Docker Air Gap Upgrade">
For security purposes, SSL (Secure Sockets Layer) is required when using Rancher. SSL secures all Rancher network communication, like when you login or interact with a cluster.
@@ -342,8 +342,8 @@ docker run -d --volumes-from rancher-data \
```
As of Rancher v2.5, privileged access is [required.]({{<baseurl>}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5)
{{% /accordion %}}
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
**Result:** You have upgraded Rancher. Data from your upgraded server is now saved to the `rancher-data` container for use in future upgrades.
@@ -280,8 +280,8 @@ When using the [AWS EC2 node driver]({{<baseurl>}}/rancher/v2.5/en/cluster-provi
SUSE Linux may have a firewall that blocks all ports by default. To open the ports needed for adding the host to a custom cluster,
{{% tabs %}}
{{% tab "SLES 15 / openSUSE Leap 15" %}}
<Tabs>
<TabItem label="SLES 15 / openSUSE Leap 15">
1. SSH into the instance.
1. Start YaST in text mode:
```
@@ -299,8 +299,8 @@ UDP Ports
1. When all required ports are enter, select **Accept**.
{{% /tab %}}
{{% tab "SLES 12 / openSUSE Leap 42" %}}
</TabItem>
<TabItem label="SLES 12 / openSUSE Leap 42">
1. SSH into the instance.
1. Edit /`etc/sysconfig/SuSEfirewall2` and open the required ports. In this example, ports 9796 and 10250 are also opened for monitoring:
```
@@ -312,7 +312,7 @@ UDP Ports
```
SuSEfirewall2
```
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
**Result:** The node has the open ports required to be added to a custom cluster.
@@ -16,8 +16,8 @@ The Helm chart version also applies to RancherD installs because RancherD instal
> **Note:** RancherD was an experimental feature available as part of Rancher v2.5.4 through v2.5.10 but is now deprecated and not available for recent releases.
{{% tabs %}}
{{% tab "Helm Charts" %}}
<Tabs>
<TabItem label="Helm Charts">
When installing, upgrading, or rolling back Rancher Server when it is [installed on a Kubernetes cluster]({{<baseurl>}}/rancher/v2.5/en/installation/install-rancher-on-k8s/), Rancher server is installed using a Helm chart on a Kubernetes cluster. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must add a Helm chart repository that contains the charts for installing Rancher.
@@ -80,8 +80,8 @@ After installing Rancher, if you want to change which Helm chart repository to i
```
4. Continue to follow the steps to [upgrade Rancher]({{<baseurl>}}/rancher/v2.5/en/installation/upgrades-rollbacks/upgrades/ha) from the new Helm chart repository.
{{% /tab %}}
{{% tab "Docker Images" %}}
</TabItem>
<TabItem label="Docker Images">
When performing [Docker installs]({{<baseurl>}}/rancher/v2.5/en/installation/single-node), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher.
### Server Tags
@@ -99,5 +99,5 @@ Rancher Server is distributed as a Docker image, which have tags attached to the
> - The `master` tag or any tag with `-rc` or another suffix is meant for the Rancher testing team to validate. You should not use these tags, as these builds are not officially supported.
> - Want to install an alpha review for preview? Install using one of the alpha tags listed on our [announcements page](https://forums.rancher.com/c/announcements) (e.g., `v2.2.0-alpha1`). Caveat: Alpha releases cannot be upgraded to or from any other release.
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
@@ -77,8 +77,8 @@ Here is an example of a command for passing in the feature flag names when rende
The Helm 3 command is as follows:
{{% tabs %}}
{{% tab "Rancher v2.5.8+" %}}
<Tabs>
<TabItem label="Rancher v2.5.8+">
```
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
@@ -92,8 +92,8 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--set 'extraEnv[0].name=CATTLE_FEATURES'
--set 'extraEnv[0].value=<FEATURE-FLAG-NAME-1>=true,<FEATURE-FLAG-NAME-2>=true'
```
{{% /tab %}}
{{% tab "Rancher before v2.5.8" %}}
</TabItem>
<TabItem label="Rancher before v2.5.8">
```
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
@@ -106,8 +106,8 @@ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--set 'extraEnv[0].name=CATTLE_FEATURES'
--set 'extraEnv[0].value=<FEATURE-FLAG-NAME-1>=true,<FEATURE-FLAG-NAME-2>=true'
```
{{% /tab %}}
{{% /tabs %}}
</TabItem>
</Tabs>
The Helm 2 command is as follows: