From 48d9fe2500f94aa50ef95c45cbf4125b7374b6a5 Mon Sep 17 00:00:00 2001 From: Andrej Semen <61939253+asemen2608@users.noreply.github.com> Date: Fri, 26 Feb 2021 14:31:20 +0100 Subject: [PATCH 01/33] Update _index.md --- .../v2.x/en/security/rancher-2.5/1.6-hardening-2.5/_index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/rancher/v2.x/en/security/rancher-2.5/1.6-hardening-2.5/_index.md b/content/rancher/v2.x/en/security/rancher-2.5/1.6-hardening-2.5/_index.md index 9ffbd480966..47a9efadf26 100644 --- a/content/rancher/v2.x/en/security/rancher-2.5/1.6-hardening-2.5/_index.md +++ b/content/rancher/v2.x/en/security/rancher-2.5/1.6-hardening-2.5/_index.md @@ -26,6 +26,9 @@ For more detail about evaluating a hardened cluster against the official CIS ben - Rancher **exec shell** and **view logs** for pods are **not** functional in a CIS 1.6 hardened setup when only public IP is provided when registering custom nodes. This functionality requires a private IP to be provided when registering the custom nodes. - When setting the `default_pod_security_policy_template_id:` to `restricted` Rancher creates **RoleBindings** and **ClusterRoleBindings** on the default service accounts. The CIS 1.6 5.1.5 check requires the default service accounts have no roles or cluster roles bound to it apart from the defaults. In addition the default service accounts should be configured such that it does not provide a service account token and does not have any explicit rights assignments. +- Migration Rancher from 2.4 to 2.5. Addons were removed in HG 2.5, and therefore namespaces on migration may be not created on the downstream clusters. Pod may fail to run because of missing namesapce like ingress-nginx, cattlae-system. + + ### Configure Kernel Runtime Parameters The following `sysctl` configuration is recommended for all nodes type in the cluster. Set the following parameters in `/etc/sysctl.d/90-kubelet.conf`: From a90365cafedda1efc2cc73a4c0845a62f432f090 Mon Sep 17 00:00:00 2001 From: Arsalan Naeem Date: Fri, 26 Feb 2021 11:47:35 -0500 Subject: [PATCH 02/33] Update _index.md Updated Requirements, K3s does not require Docker. --- content/rancher/v2.x/en/installation/requirements/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.x/en/installation/requirements/_index.md b/content/rancher/v2.x/en/installation/requirements/_index.md index 8dba6f9a87d..d4c20002eb1 100644 --- a/content/rancher/v2.x/en/installation/requirements/_index.md +++ b/content/rancher/v2.x/en/installation/requirements/_index.md @@ -30,7 +30,7 @@ The Rancher UI works best in Firefox or Chrome. Rancher should work with any modern Linux distribution. -Docker is required for nodes that will run K3s or RKE Kubernetes clusters. It is not required for RancherD installs. +Docker is required for nodes that will run RKE Kubernetes clusters. It is not required for RancherD installs. Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/) @@ -170,4 +170,4 @@ Before installing Rancher on SELinux Enforcing CentOS 8 nodes or RHEL 8 nodes, y ``` sudo yum install iptables sudo yum install container-selinux -``` \ No newline at end of file +``` From 7feedfabfcd4de48f6ea1a87f9f5b88d292e4aa3 Mon Sep 17 00:00:00 2001 From: calypso Date: Mon, 1 Mar 2021 11:29:56 -0500 Subject: [PATCH 03/33] Update _index.md The old URL 404's at github, this is what I found in the same project link and I believe this is what was supposed to be linked. --- .../rke-clusters/cloud-providers/amazon/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md index 9dbc050f747..16c53b10f8d 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md @@ -8,7 +8,7 @@ When using the `Amazon` cloud provider, you can leverage the following capabilit - **Load Balancers:** Launches an AWS Elastic Load Balancer (ELB) when choosing `Layer-4 Load Balancer` in **Port Mapping** or when launching a `Service` with `type: LoadBalancer`. - **Persistent Volumes**: Allows you to use AWS Elastic Block Stores (EBS) for persistent volumes. -See [cloud-provider-aws README](https://github.com/kubernetes/cloud-provider-aws/blob/master/README.md) for all information regarding the Amazon cloud provider. +See [cloud-provider-aws README](https://kubernetes.github.io/cloud-provider-aws/) for all information regarding the Amazon cloud provider. To set up the Amazon cloud provider, @@ -147,4 +147,4 @@ Setting the value of the tag to `owned` tells the cluster that all resources wit ### Using Amazon Elastic Container Registry (ECR) -The kubelet component has the ability to automatically obtain ECR credentials, when the IAM profile mentioned in [Create an IAM Role and attach to the instances](#1-create-an-iam-role-and-attach-to-the-instances) is attached to the instance(s). When using a Kubernetes version older than v1.15.0, the Amazon cloud provider needs be configured in the cluster. Starting with Kubernetes version v1.15.0, the kubelet can obtain ECR credentials without having the Amazon cloud provider configured in the cluster. \ No newline at end of file +The kubelet component has the ability to automatically obtain ECR credentials, when the IAM profile mentioned in [Create an IAM Role and attach to the instances](#1-create-an-iam-role-and-attach-to-the-instances) is attached to the instance(s). When using a Kubernetes version older than v1.15.0, the Amazon cloud provider needs be configured in the cluster. Starting with Kubernetes version v1.15.0, the kubelet can obtain ECR credentials without having the Amazon cloud provider configured in the cluster. From e44d694746aa4971d5d2b7e12046f7ae802362a4 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 2 Mar 2021 09:57:23 -0800 Subject: [PATCH 04/33] Add tabs for versions to node option table --- .../v2.x/en/cluster-admin/nodes/_index.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/content/rancher/v2.x/en/cluster-admin/nodes/_index.md b/content/rancher/v2.x/en/cluster-admin/nodes/_index.md index 715cf6f9951..58e4c21a870 100644 --- a/content/rancher/v2.x/en/cluster-admin/nodes/_index.md +++ b/content/rancher/v2.x/en/cluster-admin/nodes/_index.md @@ -30,6 +30,26 @@ This section covers the following topics: The following table lists which node options are available for each type of cluster in Rancher. Click the links in the **Option** column for more detailed information about each feature. +{{% tabs %}} +{{% tab "Rancher v2.5" %}} +| Option | [Nodes Hosted by an Infrastructure Provider][1] | [Custom Node][2] | [Hosted Cluster][3] | [Registered EKS Nodes][4] | [All Other Registered Nodes][5] | Description | +| ------------------------------------------------ | ------------------------------------------------ | ---------------- | ------------------- | ------------------- | -------------------| ------------------------------------------------------------------ | +| [Cordon](#cordoning-a-node) | ✓ | ✓ | ✓ | ✓ | ✓ | Marks the node as unschedulable. | +| [Drain](#draining-a-node) | ✓ | ✓ | ✓ | ✓ | ✓ | Marks the node as unschedulable _and_ evicts all pods. | +| [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | ✓ | ✓ | Enter a custom name, description, label, or taints for a node. | +| [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | ✓ | ✓ | View API data. | +| [Delete](#deleting-a-node) | ✓ | ✓ | | | | Deletes defective nodes from the cluster. | +| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | | Download SSH key for in order to SSH into the node. | +| [Node Scaling](#scaling-nodes) | ✓ | | | | | Scale the number of nodes in the node pool up or down. | + +[1]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ +[2]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/ +[3]: {{}}/rancher/v2.x/en/cluster-provisioning/hosted-kubernetes-clusters/ +[4]: {{}}/rancher/v2.x/en/cluster-provisioning/registered-clusters/ +[5]: {{}}/rancher/v2.x/en/cluster-provisioning/registered-clusters/ + +{{% /tab %}} +{{% tab "Rancher v2.0-v2.4" %}} | Option | [Nodes Hosted by an Infrastructure Provider][1] | [Custom Node][2] | [Hosted Cluster][3] | [Imported Nodes][4] | Description | | ------------------------------------------------ | ------------------------------------------------ | ---------------- | ------------------- | ------------------- | ------------------------------------------------------------------ | | [Cordon](#cordoning-a-node) | ✓ | ✓ | ✓ | | Marks the node as unschedulable. | From b19c79fb604cb1a5f2e35fecb8cf0bbae3411cb1 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 2 Mar 2021 10:00:48 -0800 Subject: [PATCH 05/33] Remove typo --- content/rancher/v2.x/en/cluster-admin/nodes/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-admin/nodes/_index.md b/content/rancher/v2.x/en/cluster-admin/nodes/_index.md index 58e4c21a870..6c58354f550 100644 --- a/content/rancher/v2.x/en/cluster-admin/nodes/_index.md +++ b/content/rancher/v2.x/en/cluster-admin/nodes/_index.md @@ -39,7 +39,7 @@ The following table lists which node options are available for each type of clus | [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | ✓ | ✓ | Enter a custom name, description, label, or taints for a node. | | [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | ✓ | ✓ | View API data. | | [Delete](#deleting-a-node) | ✓ | ✓ | | | | Deletes defective nodes from the cluster. | -| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | | Download SSH key for in order to SSH into the node. | +| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | | Download SSH key in order to SSH into the node. | | [Node Scaling](#scaling-nodes) | ✓ | | | | | Scale the number of nodes in the node pool up or down. | [1]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ @@ -57,7 +57,7 @@ The following table lists which node options are available for each type of clus | [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | | Enter a custom name, description, label, or taints for a node. | | [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | | View API data. | | [Delete](#deleting-a-node) | ✓ | ✓ | | | Deletes defective nodes from the cluster. | -| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | Download SSH key for in order to SSH into the node. | +| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | Download SSH key in order to SSH into the node. | | [Node Scaling](#scaling-nodes) | ✓ | | | | Scale the number of nodes in the node pool up or down. | [1]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ From da30ca3750200c50074c1a93c6c0148fe4d45b7a Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 2 Mar 2021 16:35:05 -0800 Subject: [PATCH 06/33] Reg/Imported nodes can be managed --- .../v2.x/en/cluster-admin/nodes/_index.md | 30 +++++++++++++------ 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-admin/nodes/_index.md b/content/rancher/v2.x/en/cluster-admin/nodes/_index.md index 6c58354f550..35c4ac21e34 100644 --- a/content/rancher/v2.x/en/cluster-admin/nodes/_index.md +++ b/content/rancher/v2.x/en/cluster-admin/nodes/_index.md @@ -12,7 +12,7 @@ This section covers the following topics: - [Node options available for each cluster creation option](#node-options-available-for-each-cluster-creation-option) - [Nodes hosted by an infrastructure provider](#nodes-hosted-by-an-infrastructure-provider) - [Nodes provisioned by hosted Kubernetes providers](#nodes-provisioned-by-hosted-kubernetes-providers) - - [Imported nodes](#imported-nodes) + - [Registered/Imported nodes](#registered-imported-nodes) - [Managing and editing individual nodes](#managing-and-editing-individual-nodes) - [Viewing a node in the Rancher API](#viewing-a-node-in-the-rancher-api) - [Deleting a node](#deleting-a-node) @@ -38,9 +38,9 @@ The following table lists which node options are available for each type of clus | [Drain](#draining-a-node) | ✓ | ✓ | ✓ | ✓ | ✓ | Marks the node as unschedulable _and_ evicts all pods. | | [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | ✓ | ✓ | Enter a custom name, description, label, or taints for a node. | | [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | ✓ | ✓ | View API data. | -| [Delete](#deleting-a-node) | ✓ | ✓ | | | | Deletes defective nodes from the cluster. | +| [Delete](#deleting-a-node) | ✓ | ✓ | | * | * | Deletes defective nodes from the cluster. | | [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | | Download SSH key in order to SSH into the node. | -| [Node Scaling](#scaling-nodes) | ✓ | | | | | Scale the number of nodes in the node pool up or down. | +| [Node Scaling](#scaling-nodes) | ✓ | | | ✓ | | Scale the number of nodes in the node pool up or down. | [1]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ [2]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/ @@ -48,14 +48,16 @@ The following table lists which node options are available for each type of clus [4]: {{}}/rancher/v2.x/en/cluster-provisioning/registered-clusters/ [5]: {{}}/rancher/v2.x/en/cluster-provisioning/registered-clusters/ +\* Delete option accessible via View API + {{% /tab %}} {{% tab "Rancher v2.0-v2.4" %}} | Option | [Nodes Hosted by an Infrastructure Provider][1] | [Custom Node][2] | [Hosted Cluster][3] | [Imported Nodes][4] | Description | | ------------------------------------------------ | ------------------------------------------------ | ---------------- | ------------------- | ------------------- | ------------------------------------------------------------------ | -| [Cordon](#cordoning-a-node) | ✓ | ✓ | ✓ | | Marks the node as unschedulable. | -| [Drain](#draining-a-node) | ✓ | ✓ | ✓ | | Marks the node as unschedulable _and_ evicts all pods. | -| [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | | Enter a custom name, description, label, or taints for a node. | -| [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | | View API data. | +| [Cordon](#cordoning-a-node) | ✓ | ✓ | ✓ | ✓ | Marks the node as unschedulable. | +| [Drain](#draining-a-node) | ✓ | ✓ | ✓ | ✓ | Marks the node as unschedulable _and_ evicts all pods. | +| [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | ✓ | Enter a custom name, description, label, or taints for a node. | +| [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | ✓ | View API data. | | [Delete](#deleting-a-node) | ✓ | ✓ | | | Deletes defective nodes from the cluster. | | [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | Download SSH key in order to SSH into the node. | | [Node Scaling](#scaling-nodes) | ✓ | | | | Scale the number of nodes in the node pool up or down. | @@ -64,6 +66,8 @@ The following table lists which node options are available for each type of clus [2]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/ [3]: {{}}/rancher/v2.x/en/cluster-provisioning/hosted-kubernetes-clusters/ [4]: {{}}/rancher/v2.x/en/cluster-provisioning/imported-clusters/ +{{% /tab %}} +{{% /tabs %}} ### Nodes Hosted by an Infrastructure Provider @@ -79,9 +83,17 @@ Rancher uses [node templates]({{}}/rancher/v2.x/en/cluster-provisioning Options for managing nodes [hosted by a Kubernetes provider]({{}}/rancher/v2.x/en/cluster-provisioning/hosted-kubernetes-clusters/) are somewhat limited in Rancher. Rather than using the Rancher UI to make edits such as scaling the number of nodes up or down, edit the cluster directly. -### Imported Nodes +### Registered/Imported Nodes -Although you can deploy workloads to an [imported cluster]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/imported-clusters/) using Rancher, you cannot manage individual cluster nodes. All management of imported cluster nodes must take place outside of Rancher. +{{% tabs %}} +{{% tab "Rancher v2.5" %}} +Although you can deploy workloads to a [registered cluster]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/registered-clusters/) using Rancher, management of individual cluster nodes is limited to the supported options indicated in the [node options table]({{< baseurl >}}/rancher/v2.x/en/cluster-admin/nodes/#cordoning-a-node). All other options to manage registered cluster nodes must take place outside of Rancher. +{{% /tab %}} +{{% tab "Rancher v2.0-v2.4" %}} +Although you can deploy workloads to an [imported cluster]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/imported-clusters/) using Rancher, management of individual cluster nodes is limited to the supported options indicated in the [node options table]({{< baseurl >}}/rancher/v2.x/en/cluster-admin/nodes/#cordoning-a-node). All other options + to manage imported cluster nodes must take place outside of Rancher. +{{% /tab %}} +{{% /tabs %}} # Managing and Editing Individual Nodes From 34dc0c3a1f95bddccae0759244de0680bdc2a875 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 2 Mar 2021 17:10:32 -0800 Subject: [PATCH 07/33] Fix broker links --- .../installation/install-rancher-on-k8s/rollbacks/_index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md index 9758dd07086..e59a75616ac 100644 --- a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md +++ b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md @@ -31,7 +31,7 @@ A restore is performed by creating a Restore custom resource. 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.** -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference](../../../backups/v2.5/configuration/restore-config/) and to the [examples.](../../../backups/v2.5/examples) 1. For using the YAML editor, we can click **Create > Create from YAML.** Enter the Restore YAML. ```yaml @@ -52,7 +52,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) + For help configuring the Restore, refer to the [configuration reference](../../../backups/v2.5/configuration/restore-config/) and to the [examples.](../../../backups/v2.5/examples) 1. Click **Create.** @@ -88,4 +88,4 @@ For information on how to roll back Rancher installed with Docker, refer to [thi # Rolling Back to Rancher v2.0-v2.1 -Rolling back to Rancher v2.0-v2.1 is no longer supported. The instructions for rolling back to these versions are preserved [here]({{}}/rancher/v2.x/en/backups/v2.0.x-v2.4.x/restore/rke-restore/v2.0-v2.1) and are intended to be used only in cases where upgrading to Rancher v2.2+ is not feasible. \ No newline at end of file +Rolling back to Rancher v2.0-v2.1 is no longer supported. The instructions for rolling back to these versions are preserved [here]({{}}/rancher/v2.x/en/backups/v2.0.x-v2.4.x/restore/rke-restore/v2.0-v2.1) and are intended to be used only in cases where upgrading to Rancher v2.2+ is not feasible. From d6aba9ffb0dde23c36d4fe1a0019fd64cf51684a Mon Sep 17 00:00:00 2001 From: Dan Bason Date: Wed, 3 Mar 2021 14:22:17 +1300 Subject: [PATCH 08/33] Add complete list of required ports --- .../v2.0.x-v2.4.x/cluster-monitoring/_index.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md index c8e6087c6ec..35cb2e6dacd 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md @@ -54,7 +54,15 @@ Using Prometheus, you can monitor Rancher at both the cluster level and [project As an [administrator]({{}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/) or [cluster owner]({{}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster. -> **Prerequisite:** Make sure that you are allowing traffic on port 9796 for each of your nodes because Prometheus will scrape metrics from here. +> **Prerequisite:** The following TCP ports need to be opened for metrics scraping +> | Port | Node type | Component | +> | --- | --- | --- | +> | 9796 | Worker | Node exporter | +> | 10254 | Worker | Nginx Ingress Controller | +> | 10250 | Worker/Controlplane | Kubelet | +> | 10251 | Controlplane | Kube scheduler | +> | 10252 | Controlplane | Kube controller manager | +> | 2379 | Etcd | Etcd server | 1. From the **Global** view, navigate to the cluster that you want to configure cluster monitoring. From 711594203315248e047ba073c35525e60f293972 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Steenis Date: Wed, 3 Mar 2021 17:23:13 +0100 Subject: [PATCH 09/33] Explain how to find latest RKE release --- content/rke/latest/en/installation/_index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/content/rke/latest/en/installation/_index.md b/content/rke/latest/en/installation/_index.md index b96e58af4b7..215ea8e025e 100644 --- a/content/rke/latest/en/installation/_index.md +++ b/content/rke/latest/en/installation/_index.md @@ -17,7 +17,10 @@ RKE is a fast, versatile Kubernetes installer that you can use to install Kubern ## Download the RKE binary -1. From your workstation, open a web browser and navigate to our [RKE Releases](https://github.com/rancher/rke/releases) page. Download the latest RKE v1.x installer applicable to your operating system and architecture: +1. From your workstation, open a web browser and look up the [latest available RKE release](https://github.com/rancher/rke/#latest-release). You can click on the release notes link to go straight to that release or manually navigate to our [RKE Releases](https://github.com/rancher/rke/releases) page and download the latest available RKE installer applicable to your operating system and architecture: + + >**Note:** + > Be aware that the release that is marked as `Latest release` on GitHub release page might not be the actual latest available release of RKE. - **macOS**: `rke_darwin-amd64` - **Linux (Intel/AMD)**: `rke_linux-amd64` From f25da64e0809bf38e0452b98f573c1405de2fe78 Mon Sep 17 00:00:00 2001 From: Brian Downs Date: Wed, 3 Mar 2021 17:48:58 -0700 Subject: [PATCH 10/33] K3s Etcd S3 Integration (#3043) * add base s3 documentation Signed-off-by: Brian Downs --- .../k3s/latest/en/backup-restore/_index.md | 43 ++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/content/k3s/latest/en/backup-restore/_index.md b/content/k3s/latest/en/backup-restore/_index.md index a913b68eb2a..ca6aa53ab1a 100644 --- a/content/k3s/latest/en/backup-restore/_index.md +++ b/content/k3s/latest/en/backup-restore/_index.md @@ -59,4 +59,45 @@ These options can be passed in with the command line, or in the [configuration f | `--etcd-snapshot-retention` value | Number of snapshots to retain (default: 5) | | `--etcd-snapshot-dir` value | Directory to save db snapshots. (Default location: `${data-dir}/db/snapshots`) | | `--cluster-reset` | Forget all peers and become sole member of a new cluster. This can also be set with the environment variable `[$K3S_CLUSTER_RESET]`. -| `--cluster-reset-restore-path` value | Path to snapshot file to be restored \ No newline at end of file +| `--cluster-reset-restore-path` value | Path to snapshot file to be restored + +### S3 Compatible API Support + +K3s supports writing etcd snapshots to and restoring etcd snapshots from systems with S3-compatible APIs. S3 support is available for both on-demand and scheduled snapshots. + +The arguments below have been added to the `server` subcommand. These flags exist for the `etcd-snapshot` subcommand as well however the `--etcd-s3` portion is removed to avoid redundancy. + +| Options | Description | +| ----------- | --------------- | +| `--etcd-s3` | Enable backup to S3 | +| `--etcd-s3-endpoint` | S3 endpoint url | +| `--etcd-s3-endpoint-ca` | S3 custom CA cert to connect to S3 endpoint | +| `--etcd-s3-skip-ssl-verify` | Disables S3 SSL certificate validation | +| `--etcd-s3-access-key` | S3 access key | +| `--etcd-s3-secret-key` | S3 secret key" | +| `--etcd-s3-bucket` | S3 bucket name | +| `--etcd-s3-region` | S3 region / bucket location (optional). defaults to us-east-1 | +| `--etcd-s3-folder` | S3 folder | + +To perform an on-demand etcd snapshot and save it to S3: + +``` +k3s etcd-snapshot \ + --s3 \ + --s3-bucket= \ + --s3-access-key= \ + --s3-secret-key= +``` + +To perform an on-demand etcd snapshot restore from S3, first make sure that K3s isn't running. Then run the following commands: + +``` +k3s server \ + --cluster-init \ + --cluster-reset \ + --etcd-s3 \ + --cluster-reset-restore-path= \ + --etcd-s3-bucket= \ + --etcd-s3-access-key= \ + --etcd-s3-secret-key= +``` From 95ff5511495ad90b96b126bcf56b16c4a5c098b5 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 3 Mar 2021 20:18:39 -0700 Subject: [PATCH 11/33] Revise vSphere cloud provider docs in v2.x section #3090 --- .../volumes-and-storage/_index.md | 7 ++ .../cloud-providers/vsphere/_index.md | 22 ++---- .../cloud-providers/vsphere/in-tree/_index.md | 24 ++++++ .../vsphere/out-of-tree/_index.md | 51 +++++++++++++ .../vsphere-volume-migration/_index.md | 74 +++++++++++++++++++ .../node-pools/vsphere/migration/_index.md | 9 --- .../vsphere/out-of-tree-vsphere/_index.md | 9 --- 7 files changed, 162 insertions(+), 34 deletions(-) create mode 100644 content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md create mode 100644 content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/_index.md create mode 100644 content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md delete mode 100644 content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md delete mode 100644 content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md diff --git a/content/rancher/v2.x/en/cluster-admin/volumes-and-storage/_index.md b/content/rancher/v2.x/en/cluster-admin/volumes-and-storage/_index.md index cdc9bfaef3b..dccab770900 100644 --- a/content/rancher/v2.x/en/cluster-admin/volumes-and-storage/_index.md +++ b/content/rancher/v2.x/en/cluster-admin/volumes-and-storage/_index.md @@ -66,6 +66,13 @@ In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.x/en/cluster- ### hostPath Volumes Before you create a hostPath volume, you need to set up an [extra_bind]({{}}/rke/latest/en/config-options/services/services-extras/#extra-binds/) in your cluster configuration. This will mount the path as a volume in your kubelets, which can then be used for hostPath volumes in your workloads. +### Migrating vSphere Cloud Provider from In-tree to Out-of-tree + +Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. + +For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree) + + ### Related Links - [Kubernetes Documentation: Storage](https://kubernetes.io/docs/concepts/storage/) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md index 2ecc8a4e6a4..9e999ad086e 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md @@ -2,24 +2,14 @@ title: Setting up the vSphere Cloud Provider weight: 4 --- +In this section, you'll learn how to set up a vSphere cloud provider for a Rancher managed RKE Kubernetes cluster in vSphere. -In this section, you'll learn how to set up the vSphere cloud provider for a Rancher managed RKE Kubernetes cluster in vSphere. +# In-tree Cloud Provider -Follow these steps while creating the vSphere cluster in Rancher: +To use the in-tree vSphere cloud provider, you will need to use an RKE configuration option. For details, refer to [this page.](./in-tree) -1. Set **Cloud Provider** option to `Custom`. +# Out-of-tree Cloud Provider - {{< img "/img/rancher/vsphere-node-driver-cloudprovider.png" "vsphere-node-driver-cloudprovider">}} +_Available as of v2.5+_ -1. Click on **Edit as YAML** -1. Insert the following structure to the pre-populated cluster YAML. As of Rancher v2.3+, this structure must be placed under `rancher_kubernetes_engine_config`. In versions before v2.3, it has to be defined as a top-level field. Note that the `name` *must* be set to `vsphere`. - - ```yaml - rancher_kubernetes_engine_config: # Required as of Rancher v2.3+ - cloud_provider: - name: vsphere - vsphereCloudProvider: - [Insert provider configuration] - ``` - -Rancher uses RKE (the Rancher Kubernetes Engine) to provision Kubernetes clusters. Refer to the [vSphere configuration reference in the RKE documentation]({{}}/rke/latest/en/config-options/cloud-providers/vsphere/config-reference/) for details about the properties of the `vsphereCloudProvider` directive. \ No newline at end of file +To set up the out-of-tree vSphere cloud provider, you will need to install Helm charts from the Rancher marketplace. For details, refer to [this page.](./out-of-tree) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md new file mode 100644 index 00000000000..d4a19ef8b58 --- /dev/null +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md @@ -0,0 +1,24 @@ +--- +title: How to Configure In-tree vSphere Cloud Provider +shortTitle: In-tree Cloud Provider +weight: 10 +--- + +To set up the in-tree vSphere cloud provider, follow these steps while creating the vSphere cluster in Rancher: + +1. Set **Cloud Provider** option to `Custom` or `Custom (In-Tree)`. + + {{< img "/img/rancher/vsphere-node-driver-cloudprovider.png" "vsphere-node-driver-cloudprovider">}} + +1. Click on **Edit as YAML** +1. Insert the following structure to the pre-populated cluster YAML. This structure must be placed under `rancher_kubernetes_engine_config`. Note that the `name` *must* be set to `vsphere`. + + ```yaml + rancher_kubernetes_engine_config: + cloud_provider: + name: vsphere + vsphereCloudProvider: + [Insert provider configuration] + ``` + +Rancher uses RKE (the Rancher Kubernetes Engine) to provision Kubernetes clusters. Refer to the [vSphere configuration reference in the RKE documentation]({{}}/rke/latest/en/config-options/cloud-providers/vsphere/config-reference/) for details about the properties of the `vsphereCloudProvider` directive. diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/_index.md new file mode 100644 index 00000000000..7ba765989f7 --- /dev/null +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/_index.md @@ -0,0 +1,51 @@ +--- +title: How to Configure Out-of-tree vSphere Cloud Provider +shortTitle: Out-of-tree Cloud Provider +weight: 10 +--- +_Available as of v2.5+_ + +Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. + +This page covers how to install the Cloud Provider Interface (CPI) and Cloud Storage Interface (CSI) plugins after bringing up a cluster. + +# Prerequisites + +The vSphere version must be 7.0u1 or higher. + +The Kubernetes version must be 1.19 or higher. + +Using the vSphere out-of-tree cloud provider requires Linux nodes and is not supported on Windows. + +# Installation + +The Cloud Provider Interface (CPI) should be installed first before installing the Cloud Storage Interface (CSI). + +### 1. Create a vSphere cluster + +1. On the Clusters page, click on **Add Cluster** and select the **vSphere** option or **Existing Nodes** option. +1. Under **Cluster Options > Cloud Provider** select **External (Out-of-tree)**. This sets the cloud provider option on the Kubernetes cluster to `external` which sets your Kubernetes cluster up to be configured with an out-of-tree cloud provider. +1. Finish creating your cluster. + +### 2. Install the CPI plugin + +1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** +1. Select the **vSphere CPI** chart. Fill out the required vCenter details. +1. vSphere CPI initializes all nodes with ProviderID which is needed by the vSphere CSI driver. Check if all nodes are initialized with the ProviderID before installing CSI driver with the following command: + + ``` + kubectl describe nodes | grep "ProviderID" + ``` +### 3. Installing the CSI plugin + + 1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** +1. Select the **vSphere CSI** chart. Fill out the required vCenter details. +2. Set **Enable CSI Migration** to **false**. +3. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner. Fill out the details for the StorageClass and launch the chart. + +# Using the CSI driver for provisioning volumes +The CSI chart by default creates a storageClass. + +If that option was not selected while launching the chart, create a storageClass with the `csi.vsphere.vmware.com` as the provisioner. + +All volumes provisioned using this StorageClass will get provisioned by the CSI driver. diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md new file mode 100644 index 00000000000..8694af37226 --- /dev/null +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md @@ -0,0 +1,74 @@ +--- +title: Migrating vSphere In-tree Volumes to CSI +weight: 5 +--- +_Available as of v2.5+_ + +Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. + +This page covers how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration. +It follows the steps provided in the official [vSphere migration documentation](https://vsphere-csi-driver.sigs.k8s.io/features/vsphere_csi_migration.html) and provides the steps to be performed in Rancher. +### Cloud-config Format Limitation +Existing volumes that were provisioned using the following cloud-config format will NOT get migrated due to an existing bug in vsphere CSI. +If the cloud-config has this format for datastore and resource pool path, vsphere CSI driver cannot recognize it: +```yaml +default-datastore: /datastore/ +resourcepool-path: "/host//Resources/" +``` +Volumes provisioned with the in-tree provider using the following format will get migrated correctly: +```yaml +default-datastore: +resourcepool-path: "/Resources/" +``` +Upstream bug: https://github.com/kubernetes-sigs/vsphere-csi-driver/issues/628 +Rancher issue tracking this bug: https://github.com/rancher/rancher/issues/31105 +# Prerequisites +- vSphere CSI Migration requires vSphere 7.0u1. In order to be able to manage existing in-tree vSphere volumes, upgrade vSphere to 7.0u1. +- The Kubernetes version must be 1.19 or higher. +# Migration +### 1. Install the CPI plugin +Before installing CPI, we need to taint all nodes with `node.cloudprovider.kubernetes.io/uninitialized=true:NoSchedule`. +This can be done by running the following commands: +``` +curl -O https://raw.githubusercontent.com/rancher/helm3-charts/56b622f519728378abeddfe95074f1b87ab73b1e/charts/vsphere-cpi/taints.sh +``` +Or: +``` +wget https://raw.githubusercontent.com/rancher/helm3-charts/56b622f519728378abeddfe95074f1b87ab73b1e/charts/vsphere-cpi/taints.sh +chmod +x taints.sh +./taints.sh +``` + +Once all nodes are tainted by the running the script, launch the Helm vSphere CPI chart. + +1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** +2. Select the **vSphere CPI** chart. +3. Fill out the required vCenter details and click **Launch**. + +vSphere CPI initializes all nodes with ProviderID, which is needed by the vSphere CSI driver. +Check if all nodes are initialized with the ProviderID with the following command: +``` +kubectl describe nodes | grep "ProviderID" +``` + +### 2. Install the CSI driver + +1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** +1. Select the **vSphere CSI** chart. +1. Fill out the required vCenter details and click **Launch**. +1. Set **Enable CSI Migration** to **true**. +1. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner. You can provide the URL of the datastore to be used for CSI volume provisioning while creating this StorageClass. The datastore URL can be found in the vSphere client by selecting the datastore and going to the Summary tab. Fill out the details for the StorageClass and click **Launch**. +### 3. Edit the cluster to enable CSI migration feature flags +1. While editing the cluster, if the Kubernetes version is less than 1.19, select Kubernetes version 1.19 or higher from the **Kubernetes Version** dropdown. +2. For enabling feature flags, click on "Edit as YAML", and add the following under kube-controller and kubelet: + ```yaml + extra_args: + feature-gates: "CSIMigration=true,CSIMigrationvSphere=true" + ``` +### 4. Drain worker nodes +Worker nodes must be drained during the upgrade before changing the kubelet and kube-controller-manager args. +1. Click **Edit as Form** and then click on "Advanced Options." +1. Set the field **Maximum Worker Nodes Unavailable** to count of 1. +1. To drain the nodes during upgrade, select **Drain Nodes > Yes**. +1. Set **Force** and **Delete Local Data** to **true**. +1. Click **Save** to upgrade the cluster. diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md deleted file mode 100644 index 0b50820e403..00000000000 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Migrating vSphere In-tree Volumes to CSI -weight: 5 ---- -_Available as of v2.5.6_ - -Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. - -For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to [this page.]({{}}/rancher/v2.x/en/cluster-admin/volumes-and-storage/vsphere-volume-migration) \ No newline at end of file diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md deleted file mode 100644 index d3a1f3a12f0..00000000000 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: vSphere Out-of-tree Cloud Provider -weight: 4 ---- -_Available as of v2.5.6_ - -Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. - -For instructions on how to install the CPI and CSI plugins after bringing up a cluster, refer to [this page.]({{}}/rancher/v2.x/en/cluster-admin/volumes-and-storage/out-of-tree-vsphere) \ No newline at end of file From 2914a9a00e33356053c8df9aa9fde015164c10db Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 3 Mar 2021 22:40:30 -0700 Subject: [PATCH 12/33] Fix broken links --- .../en/cluster-provisioning/node-requirements/_index.md | 2 +- content/rancher/v2.5/en/backups/restoring-rancher/_index.md | 4 ++-- .../v2.5/en/cluster-provisioning/node-requirements/_index.md | 2 +- .../installation/install-rancher-on-k8s/rollbacks/_index.md | 2 +- .../rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md | 2 +- .../v2.x/en/cluster-provisioning/node-requirements/_index.md | 2 +- .../installation/install-rancher-on-k8s/rollbacks/_index.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/rancher/v2.0-v2.4/en/cluster-provisioning/node-requirements/_index.md b/content/rancher/v2.0-v2.4/en/cluster-provisioning/node-requirements/_index.md index f9fdbd5dcfd..a3ea0e34f85 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-provisioning/node-requirements/_index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-provisioning/node-requirements/_index.md @@ -108,7 +108,7 @@ The ports required to be open are different depending on how the user cluster is For a breakdown of the port requirements for etcd nodes, controlplane nodes, and worker nodes in a Kubernetes cluster, refer to the [port requirements for the Rancher Kubernetes Engine.]({{}}/rke/latest/en/os/#ports) -Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements](({{}}/rancher/v2.0-v2.4/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes)). +Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements]({{}}/rancher/v2.0-v2.4/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes). # Optional: Security Considerations diff --git a/content/rancher/v2.5/en/backups/restoring-rancher/_index.md b/content/rancher/v2.5/en/backups/restoring-rancher/_index.md index ce965a74636..216526cab48 100644 --- a/content/rancher/v2.5/en/backups/restoring-rancher/_index.md +++ b/content/rancher/v2.5/en/backups/restoring-rancher/_index.md @@ -17,7 +17,7 @@ A restore is performed by creating a Restore custom resource. 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.** -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.5/en/backups/examples) 1. For using the YAML editor, we can click **Create > Create from YAML.** Enter the Restore YAML. ```yaml @@ -38,7 +38,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) + For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.5/en/backups/examples) 1. Click **Create.** diff --git a/content/rancher/v2.5/en/cluster-provisioning/node-requirements/_index.md b/content/rancher/v2.5/en/cluster-provisioning/node-requirements/_index.md index 5a0e7e40601..1ab8a565fcf 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/node-requirements/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/node-requirements/_index.md @@ -106,7 +106,7 @@ The ports required to be open are different depending on how the user cluster is For a breakdown of the port requirements for etcd nodes, controlplane nodes, and worker nodes in a Kubernetes cluster, refer to the [port requirements for the Rancher Kubernetes Engine.]({{}}/rke/latest/en/os/#ports) -Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements](({{}}/rancher/v2.5/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes)). +Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements]({{}}/rancher/v2.5/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes). # Optional: Security Considerations diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md index ff93d41792b..7670f40a09e 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md @@ -31,7 +31,7 @@ A restore is performed by creating a Restore custom resource. 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.** -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.5/en/backups/examples) 1. For using the YAML editor, we can click **Create > Create from YAML.** Enter the Restore YAML. ```yaml diff --git a/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md b/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md index baf91b4ec95..d27d140570a 100644 --- a/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md +++ b/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md @@ -17,7 +17,7 @@ A restore is performed by creating a Restore custom resource. 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.** -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [ [configuration reference]({{}}/rancher/v2.5/en/backups/v2.5/configuration/restore-config/) and to the [examples.]({{}}/rancher/v2.5/en/backups/v2.5/examples/) 1. For using the YAML editor, we can click **Create > Create from YAML.** Enter the Restore YAML. ```yaml diff --git a/content/rancher/v2.x/en/cluster-provisioning/node-requirements/_index.md b/content/rancher/v2.x/en/cluster-provisioning/node-requirements/_index.md index 2f309c7ed0c..62b501daeb6 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/node-requirements/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/node-requirements/_index.md @@ -108,7 +108,7 @@ The ports required to be open are different depending on how the user cluster is For a breakdown of the port requirements for etcd nodes, controlplane nodes, and worker nodes in a Kubernetes cluster, refer to the [port requirements for the Rancher Kubernetes Engine.]({{}}/rke/latest/en/os/#ports) -Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements](({{}}/rancher/v2.x/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes)). +Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements]({{}}/rancher/v2.x/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes). # Optional: Security Considerations diff --git a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md index fbe6fdb2966..32324f6b0a2 100644 --- a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md +++ b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md @@ -31,7 +31,7 @@ A restore is performed by creating a Restore custom resource. 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.** -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/v2.5/configuration/restore-config/) and to the [examples.]({{}}/rancher/v2.5/en/backups/v2.5/examples/) 1. For using the YAML editor, we can click **Create > Create from YAML.** Enter the Restore YAML. ```yaml From 2ffbffba621ecc44180c8ffa0c1436dbdd26b745 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 3 Mar 2021 23:27:05 -0700 Subject: [PATCH 13/33] Fix links --- content/k3s/latest/en/security/self_assessment/_index.md | 2 +- content/rancher/v2.0-v2.4/en/deploy-across-clusters/_index.md | 2 +- content/rancher/v2.0-v2.4/en/helm-charts/_index.md | 2 +- .../rancher/v2.0-v2.4/en/helm-charts/launching-apps/_index.md | 2 +- .../en/installation/resources/update-ca-cert/_index.md | 2 +- content/rancher/v2.0-v2.4/en/k8s-in-rancher/_index.md | 2 +- .../en/k8s-in-rancher/load-balancers-and-ingress/_index.md | 2 +- .../v2.5/en/cluster-provisioning/registered-clusters/_index.md | 2 +- .../v2.5/en/cluster-provisioning/rke-clusters/options/_index.md | 2 +- .../v2.5/en/installation/resources/update-ca-cert/_index.md | 2 +- content/rancher/v2.5/en/k8s-in-rancher/_index.md | 2 -- .../v2.5/en/k8s-in-rancher/load-balancers-and-ingress/_index.md | 2 +- .../k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md | 2 +- .../v2.x/en/cluster-provisioning/registered-clusters/_index.md | 2 +- .../v2.x/en/cluster-provisioning/rke-clusters/options/_index.md | 2 +- .../v2.x/en/deploy-across-clusters/multi-cluster-apps/_index.md | 2 +- content/rancher/v2.x/en/helm-charts/legacy-catalogs/_index.md | 2 +- .../en/helm-charts/legacy-catalogs/launching-apps/_index.md | 2 +- .../v2.x/en/installation/resources/update-ca-cert/_index.md | 2 +- content/rancher/v2.x/en/k8s-in-rancher/_index.md | 2 +- .../v2.x/en/k8s-in-rancher/load-balancers-and-ingress/_index.md | 2 +- .../k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md | 2 +- .../cloud-providers/vsphere/enabling-uuid/_index.md | 2 +- 23 files changed, 22 insertions(+), 24 deletions(-) diff --git a/content/k3s/latest/en/security/self_assessment/_index.md b/content/k3s/latest/en/security/self_assessment/_index.md index 013da6db076..6dc8799df5e 100644 --- a/content/k3s/latest/en/security/self_assessment/_index.md +++ b/content/k3s/latest/en/security/self_assessment/_index.md @@ -2040,7 +2040,7 @@ Where access to the Kubernetes API from a pod is required, a specific service ac The default service account should be configured such that it does not provide a service account token and does not have any explicit rights assignments. -**Result:** Fail. Currently requires operator intervention See the [Harending Guide](../hardening_guide/_) for details. +**Result:** Fail. Currently requires operator intervention See the [Hardening Guide]({{}}/rancher/k3s/latest/en/security/hardening_guide) for details. **Audit:** For each namespace in the cluster, review the rights assigned to the default service account and ensure that it has no roles or cluster roles bound to it apart from the defaults. Additionally ensure that the automountServiceAccountToken: false setting is in place for each default service account. diff --git a/content/rancher/v2.0-v2.4/en/deploy-across-clusters/_index.md b/content/rancher/v2.0-v2.4/en/deploy-across-clusters/_index.md index 571f38bf09f..f02706abbda 100644 --- a/content/rancher/v2.0-v2.4/en/deploy-across-clusters/_index.md +++ b/content/rancher/v2.0-v2.4/en/deploy-across-clusters/_index.md @@ -11,7 +11,7 @@ Typically, most applications are deployed on a single Kubernetes cluster, but th Any Helm charts from a global catalog can be used to deploy and manage multi-cluster applications. -After creating a multi-cluster application, you can program a [Global DNS entry]({{}}/rancher/v2.0-v2.4/en/catalog/globaldns/) to make it easier to access the application. +After creating a multi-cluster application, you can program a [Global DNS entry]({{}}/rancher/v2.0-v2.4/en/helm-charts/globaldns/) to make it easier to access the application. - [Prerequisites](#prerequisites) - [Launching a multi-cluster app](#launching-a-multi-cluster-app) diff --git a/content/rancher/v2.0-v2.4/en/helm-charts/_index.md b/content/rancher/v2.0-v2.4/en/helm-charts/_index.md index 706eb1105d0..989a22e38ca 100644 --- a/content/rancher/v2.0-v2.4/en/helm-charts/_index.md +++ b/content/rancher/v2.0-v2.4/en/helm-charts/_index.md @@ -102,4 +102,4 @@ _Available as v2.2.0_ When creating applications that span multiple Kubernetes clusters, a Global DNS entry can be created to route traffic to the endpoints in all of the different clusters. An external DNS server will need be programmed to assign a fully qualified domain name (a.k.a FQDN) to your application. Rancher will use the FQDN you provide and the IP addresses where your application is running to program the DNS. Rancher will gather endpoints from all the Kubernetes clusters running your application and program the DNS. -For more information on how to use this feature, see [Global DNS]({{}}/rancher/v2.0-v2.4/en/catalog/globaldns/). +For more information on how to use this feature, see [Global DNS]({{}}/rancher/v2.0-v2.4/en/helm-charts/globaldns/). diff --git a/content/rancher/v2.0-v2.4/en/helm-charts/launching-apps/_index.md b/content/rancher/v2.0-v2.4/en/helm-charts/launching-apps/_index.md index 4a6dbc6f557..e3af01f5d48 100644 --- a/content/rancher/v2.0-v2.4/en/helm-charts/launching-apps/_index.md +++ b/content/rancher/v2.0-v2.4/en/helm-charts/launching-apps/_index.md @@ -8,7 +8,7 @@ aliases: Within a project, when you want to deploy applications from catalogs, the applications available in your project will be based on the [scope of the catalogs]({{}}/rancher/v2.0-v2.4/en/helm-charts/legacy-catalogs/#catalog-scopes). -If your application is using ingresses, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.0-v2.4/en/catalog/globaldns/). +If your application is using ingresses, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.0-v2.4/en/helm-charts/globaldns/). - [Prerequisites](#prerequisites) - [Launching a catalog app](#launching-a-catalog-app) diff --git a/content/rancher/v2.0-v2.4/en/installation/resources/update-ca-cert/_index.md b/content/rancher/v2.0-v2.4/en/installation/resources/update-ca-cert/_index.md index b7a3a8472eb..9ad73812a47 100644 --- a/content/rancher/v2.0-v2.4/en/installation/resources/update-ca-cert/_index.md +++ b/content/rancher/v2.0-v2.4/en/installation/resources/update-ca-cert/_index.md @@ -76,7 +76,7 @@ $ helm ls -A Upgrade the Helm application instance using the original configuration values and making sure to specify `ingress.tls.source=secret` as well as the current chart version to prevent an application upgrade. -If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using [custom certificates]({{}}/rancher/v2.0-v2.4/en/installation/install-rancher-on-Kubernetes/#6-install-rancher-with-helm-and-your-chosen-certificate-option). +If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using custom certificates. ``` helm upgrade rancher rancher-stable/rancher \ diff --git a/content/rancher/v2.0-v2.4/en/k8s-in-rancher/_index.md b/content/rancher/v2.0-v2.4/en/k8s-in-rancher/_index.md index 661c98089d2..eeaab9d0ca3 100644 --- a/content/rancher/v2.0-v2.4/en/k8s-in-rancher/_index.md +++ b/content/rancher/v2.0-v2.4/en/k8s-in-rancher/_index.md @@ -44,7 +44,7 @@ For more information, see [Ingress]({{}}/rancher/v2.0-v2.4/en/k8s-in-ra When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. -For more information, see [Global DNS]({{}}/rancher/v2.0-v2.4/en/catalog/globaldns/). +For more information, see [Global DNS]({{}}/rancher/v2.0-v2.4/en/helm-charts/globaldns/). ## Service Discovery diff --git a/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/_index.md b/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/_index.md index 2a59ec16882..5c18feeec1c 100644 --- a/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/_index.md +++ b/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/_index.md @@ -60,4 +60,4 @@ Ingress can provide other functionality as well, such as SSL termination, name-b - For more information on how to set up ingress in Rancher, see [Ingress]({{}}/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress). - For complete information about ingress and ingress controllers, see the [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/) -- When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry, see [Global DNS]({{}}/rancher/v2.0-v2.4/en/catalog/globaldns/). +- When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry, see [Global DNS]({{}}/rancher/v2.0-v2.4/en/helm-charts/globaldns/). diff --git a/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md b/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md index 3e9135ae344..92504883257 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md @@ -45,7 +45,7 @@ If you are registering a K3s cluster, make sure the `cluster.yml` is readable. I 2. Choose **Register**. 3. Enter a **Cluster Name**. 4. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. -5. For Rancher v2.5.6+, use **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent]({{}}rancher/v2.5/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. +5. For Rancher v2.5.6+, use **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. 6. Click **Create**. 7. The prerequisite for `cluster-admin` privileges is shown (see **Prerequisites** above), including an example command to fulfil the prerequisite. 8. Copy the `kubectl` command to your clipboard and run it on a node where kubeconfig is configured to point to the cluster you want to import. If you are unsure it is configured correctly, run `kubectl get nodes` to verify before running the command shown in Rancher. diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/_index.md index c9cc5b71ed0..0e394858eb4 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/_index.md @@ -142,7 +142,7 @@ Option to enable or disable [recurring etcd snapshots]({{}}/rke/latest/ _Available as of v2.5.6_ -Option to set environment variables for [rancher agents]({{}}rancher/v2.x/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. +Option to set environment variables for [rancher agents]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. # Cluster Config File diff --git a/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md b/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md index 6158f88cf94..93e428a3a54 100644 --- a/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md +++ b/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md @@ -76,7 +76,7 @@ $ helm ls -A Upgrade the Helm application instance using the original configuration values and making sure to specify `ingress.tls.source=secret` as well as the current chart version to prevent an application upgrade. -If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using [custom certificates]({{}}/rancher/v2.5/en/installation/install-rancher-on-Kubernetes/#6-install-rancher-with-helm-and-your-chosen-certificate-option). +If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using custom certificates. ``` helm upgrade rancher rancher-stable/rancher \ diff --git a/content/rancher/v2.5/en/k8s-in-rancher/_index.md b/content/rancher/v2.5/en/k8s-in-rancher/_index.md index 8985a1e016c..f048d0f174f 100644 --- a/content/rancher/v2.5/en/k8s-in-rancher/_index.md +++ b/content/rancher/v2.5/en/k8s-in-rancher/_index.md @@ -46,8 +46,6 @@ For more information, see [Ingress]({{}}/rancher/v2.5/en/k8s-in-rancher When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. -For more information, see [Global DNS]({{}}/rancher/v2.5/en/catalog/globaldns/). - ## Service Discovery After you expose your cluster to external requests using a load balancer and/or ingress, it's only available by IP address. To create a resolveable hostname, you must create a service record, which is a record that maps an IP address, external hostname, DNS record alias, workload(s), or labelled pods to a specific hostname. diff --git a/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/_index.md b/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/_index.md index 9be717e61af..ae0b9946a2b 100644 --- a/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/_index.md +++ b/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/_index.md @@ -60,4 +60,4 @@ Ingress can provide other functionality as well, such as SSL termination, name-b - For more information on how to set up ingress in Rancher, see [Ingress]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress). - For complete information about ingress and ingress controllers, see the [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/) -- When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry, see [Global DNS]({{}}/rancher/v2.5/en/catalog/globaldns/). +- When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. diff --git a/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md b/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md index 8fe230ae782..3e5952c588c 100644 --- a/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md +++ b/content/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md @@ -7,7 +7,7 @@ aliases: - /rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress --- -Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.5/en/catalog/globaldns/). +Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. 1. From the **Global** view, open the project that you want to add ingress to. 1. Click **Resources** in the main navigation bar. Click the **Load Balancing** tab. Then click **Add Ingress**. diff --git a/content/rancher/v2.x/en/cluster-provisioning/registered-clusters/_index.md b/content/rancher/v2.x/en/cluster-provisioning/registered-clusters/_index.md index fcf2605019b..539f5d4555f 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/registered-clusters/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/registered-clusters/_index.md @@ -45,7 +45,7 @@ If you are registering a K3s cluster, make sure the `cluster.yml` is readable. I 2. Choose **Register**. 3. Enter a **Cluster Name**. 4. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. -5. Use **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent]({{}}rancher/v2.x/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. +5. Use **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. 6. Click **Create**. 7. The prerequisite for `cluster-admin` privileges is shown (see **Prerequisites** above), including an example command to fulfil the prerequisite. 8. Copy the `kubectl` command to your clipboard and run it on a node where kubeconfig is configured to point to the cluster you want to import. If you are unsure it is configured correctly, run `kubectl get nodes` to verify before running the command shown in Rancher. diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index 267a8ba8faa..a7f4c4580d3 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -157,7 +157,7 @@ Option to enable or disable [recurring etcd snapshots]({{}}/rke/latest/ _Available as of v2.5.6_ -Option to set environment variables for [rancher agents]({{}}rancher/v2.x/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. +Option to set environment variables for [rancher agents]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. # Cluster Config File diff --git a/content/rancher/v2.x/en/deploy-across-clusters/multi-cluster-apps/_index.md b/content/rancher/v2.x/en/deploy-across-clusters/multi-cluster-apps/_index.md index b0eaddf0d1b..592798311f6 100644 --- a/content/rancher/v2.x/en/deploy-across-clusters/multi-cluster-apps/_index.md +++ b/content/rancher/v2.x/en/deploy-across-clusters/multi-cluster-apps/_index.md @@ -12,7 +12,7 @@ Typically, most applications are deployed on a single Kubernetes cluster, but th Any Helm charts from a global catalog can be used to deploy and manage multi-cluster applications. -After creating a multi-cluster application, you can program a [Global DNS entry]({{}}/rancher/v2.x/en/catalog/globaldns/) to make it easier to access the application. +After creating a multi-cluster application, you can program a [Global DNS entry]({{}}/rancher/v2.x/en/helm-charts/legacy-catalogs/globaldns/) to make it easier to access the application. - [Prerequisites](#prerequisites) - [Launching a multi-cluster app](#launching-a-multi-cluster-app) diff --git a/content/rancher/v2.x/en/helm-charts/legacy-catalogs/_index.md b/content/rancher/v2.x/en/helm-charts/legacy-catalogs/_index.md index 65f83844f4f..c8606dfc44e 100644 --- a/content/rancher/v2.x/en/helm-charts/legacy-catalogs/_index.md +++ b/content/rancher/v2.x/en/helm-charts/legacy-catalogs/_index.md @@ -105,4 +105,4 @@ _Available as v2.2.0_ When creating applications that span multiple Kubernetes clusters, a Global DNS entry can be created to route traffic to the endpoints in all of the different clusters. An external DNS server will need be programmed to assign a fully qualified domain name (a.k.a FQDN) to your application. Rancher will use the FQDN you provide and the IP addresses where your application is running to program the DNS. Rancher will gather endpoints from all the Kubernetes clusters running your application and program the DNS. -For more information on how to use this feature, see [Global DNS]({{}}/rancher/v2.x/en/catalog/globaldns/). +For more information on how to use this feature, see [Global DNS]({{}}/rancher/v2.x/en/helm-charts/legacy-catalogs/globaldns/). diff --git a/content/rancher/v2.x/en/helm-charts/legacy-catalogs/launching-apps/_index.md b/content/rancher/v2.x/en/helm-charts/legacy-catalogs/launching-apps/_index.md index 932c04cd648..ce8e22b1bf6 100644 --- a/content/rancher/v2.x/en/helm-charts/legacy-catalogs/launching-apps/_index.md +++ b/content/rancher/v2.x/en/helm-charts/legacy-catalogs/launching-apps/_index.md @@ -7,7 +7,7 @@ aliases: Within a project, when you want to deploy applications from catalogs, the applications available in your project will be based on the [scope of the catalogs]({{}}/rancher/v2.x/en/helm-charts/legacy-catalogs/#catalog-scopes). -If your application is using ingresses, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.x/en/catalog/globaldns/). +If your application is using ingresses, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.x/en/helm-charts/legacy-catalogs/globaldns/). - [Prerequisites](#prerequisites) - [Launching a catalog app](#launching-a-catalog-app) diff --git a/content/rancher/v2.x/en/installation/resources/update-ca-cert/_index.md b/content/rancher/v2.x/en/installation/resources/update-ca-cert/_index.md index a46b54f8552..1b9368fe85a 100644 --- a/content/rancher/v2.x/en/installation/resources/update-ca-cert/_index.md +++ b/content/rancher/v2.x/en/installation/resources/update-ca-cert/_index.md @@ -76,7 +76,7 @@ $ helm ls -A Upgrade the Helm application instance using the original configuration values and making sure to specify `ingress.tls.source=secret` as well as the current chart version to prevent an application upgrade. -If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using [custom certificates]({{}}/rancher/v2.x/en/installation/install-rancher-on-Kubernetes/#6-install-rancher-with-helm-and-your-chosen-certificate-option). +If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using custom certificates. ``` helm upgrade rancher rancher-stable/rancher \ diff --git a/content/rancher/v2.x/en/k8s-in-rancher/_index.md b/content/rancher/v2.x/en/k8s-in-rancher/_index.md index fe60b1f2a83..51100243b59 100644 --- a/content/rancher/v2.x/en/k8s-in-rancher/_index.md +++ b/content/rancher/v2.x/en/k8s-in-rancher/_index.md @@ -46,7 +46,7 @@ For more information, see [Ingress]({{}}/rancher/v2.x/en/k8s-in-rancher When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. -For more information, see [Global DNS]({{}}/rancher/v2.x/en/catalog/globaldns/). +For more information, see [Global DNS]({{}}/rancher/v2.x/en/helm-charts/legacy-catalogs/globaldns/). ## Service Discovery diff --git a/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/_index.md b/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/_index.md index 559a9be1810..c4bf313832d 100644 --- a/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/_index.md +++ b/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/_index.md @@ -60,4 +60,4 @@ Ingress can provide other functionality as well, such as SSL termination, name-b - For more information on how to set up ingress in Rancher, see [Ingress]({{}}/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/ingress). - For complete information about ingress and ingress controllers, see the [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/) -- When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry, see [Global DNS]({{}}/rancher/v2.x/en/catalog/globaldns/). +- When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry, see [Global DNS]({{}}/rancher/v2.x/en/helm-charts/legacy-catalogs/globaldns/). diff --git a/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md b/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md index d13fba7b7ca..86928adaafd 100644 --- a/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md +++ b/content/rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md @@ -7,7 +7,7 @@ aliases: - /rancher/v2.x/en/k8s-in-rancher/load-balancers-and-ingress/ingress --- -Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.x/en/catalog/globaldns/). +Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.x/en/helm-charts/legacy-catalogs/globaldns/). 1. From the **Global** view, open the project that you want to add ingress to. 1. Click **Resources** in the main navigation bar. Click the **Load Balancing** tab. (In versions before v2.3.0, just click the **Load Balancing** tab.) Then click **Add Ingress**. diff --git a/content/rke/latest/en/config-options/cloud-providers/vsphere/enabling-uuid/_index.md b/content/rke/latest/en/config-options/cloud-providers/vsphere/enabling-uuid/_index.md index df0278d5088..6afccab7d70 100644 --- a/content/rke/latest/en/config-options/cloud-providers/vsphere/enabling-uuid/_index.md +++ b/content/rke/latest/en/config-options/cloud-providers/vsphere/enabling-uuid/_index.md @@ -32,4 +32,4 @@ $ govc vm.change -vm -e disk.enableUUID=TRUE In Rancher v2.0.4+, disk UUIDs are enabled in vSphere node templates by default. -If you are using Rancher before v2.0.4, refer to the [vSphere node template documentation.]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/before-2.0.4/#disk-uuids) for details on how to enable a UUID with a Rancher node template. +If you are using Rancher before v2.0.4, refer to the [vSphere node template documentation.]({{}}/rancher/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/prior-to-2.0.4//) for details on how to enable a UUID with a Rancher node template. From da9179a84a5d2328a5bd742bc1b0c4e878a1f91a Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 3 Mar 2021 23:46:14 -0700 Subject: [PATCH 14/33] Fix more links --- content/rancher/v2.0-v2.4/en/cluster-admin/nodes/_index.md | 2 +- .../advanced/air-gap-helm2/install-rancher/_index.md | 4 ++-- content/rancher/v2.0-v2.4/en/troubleshooting/dns/_index.md | 2 +- .../installation/install-rancher-on-k8s/rollbacks/_index.md | 2 +- content/rancher/v2.5/en/troubleshooting/dns/_index.md | 2 +- .../rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md | 2 +- .../installation/install-rancher-on-k8s/rollbacks/_index.md | 2 +- .../advanced/air-gap-helm2/install-rancher/_index.md | 4 ++-- content/rancher/v2.x/en/troubleshooting/dns/_index.md | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/content/rancher/v2.0-v2.4/en/cluster-admin/nodes/_index.md b/content/rancher/v2.0-v2.4/en/cluster-admin/nodes/_index.md index bf964ec119a..7311650ae0d 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-admin/nodes/_index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-admin/nodes/_index.md @@ -5,7 +5,7 @@ weight: 2030 After you launch a Kubernetes cluster in Rancher, you can manage individual nodes from the cluster's **Node** tab. Depending on the [option used]({{}}/rancher/v2.0-v2.4/en/cluster-provisioning/) to provision the cluster, there are different node options available. -> If you want to manage the _cluster_ and not individual nodes, see [Editing Clusters]({{< baseurl >}}/rancher/v2.0-v2.4/en/k8s-in-rancher/editing-clusters). +> If you want to manage the _cluster_ and not individual nodes, see [Editing Clusters]({{< baseurl >}}/rancher/v2.0-v2.4/en/cluster-admin/editing-clusters/#editing-clusters-with-yaml). This section covers the following topics: diff --git a/content/rancher/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md b/content/rancher/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md index e3373059d71..0612502462a 100644 --- a/content/rancher/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md +++ b/content/rancher/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md @@ -164,7 +164,7 @@ If you are using a Private CA signed cert, add `--set privateCA=true` following --set useBundledSystemChart=true # Available as of v2.3.0, use the packaged Rancher system charts ``` -Then refer to [Adding TLS Secrets]({{}}/rancher/v2.0-v2.4/en/installation/options/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them. +Then refer to [Adding TLS Secrets]({{}}/rancher/v2.0-v2.4/en/installation/resources/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them. {{% /accordion %}} @@ -218,7 +218,7 @@ If you are installing Rancher versions before v2.3.0, you will not be able to us These resources could be helpful when installing Rancher: - [Rancher Helm chart options]({{}}/rancher/v2.0-v2.4/en/installation/options/chart-options/) -- [Adding TLS secrets]({{}}/rancher/v2.0-v2.4/en/installation/options/tls-secrets/) +- [Adding TLS secrets]({{}}/rancher/v2.0-v2.4/en/installation/resources/tls-secrets/) - [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.0-v2.4/en/installation/options/troubleshooting/) {{% /tab %}} diff --git a/content/rancher/v2.0-v2.4/en/troubleshooting/dns/_index.md b/content/rancher/v2.0-v2.4/en/troubleshooting/dns/_index.md index ac7f2ee87d4..48a98a37919 100644 --- a/content/rancher/v2.0-v2.4/en/troubleshooting/dns/_index.md +++ b/content/rancher/v2.0-v2.4/en/troubleshooting/dns/_index.md @@ -196,7 +196,7 @@ services: > **Note:** As the `kubelet` is running inside a container, the path for files located in `/etc` and `/usr` are in `/host/etc` and `/host/usr` inside the `kubelet` container. -See [Editing Cluster as YAML]({{}}/rancher/v2.0-v2.4/en/k8s-in-rancher/editing-clusters/#editing-cluster-as-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: +See [Editing Cluster as YAML]({{}}/rancher/v2.0-v2.4/en/cluster-admin/editing-clusters/#editing-clusters-with-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: ``` kubectl delete pods -n kube-system -l k8s-app=kube-dns diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md index 7670f40a09e..e777477c8a8 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md @@ -52,7 +52,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) + For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/v2.5/configuration/restore-config/) and to the [examples.]({{}}/rancher/v2.5/en/backups/v2.5/examples/) 1. Click **Create.** diff --git a/content/rancher/v2.5/en/troubleshooting/dns/_index.md b/content/rancher/v2.5/en/troubleshooting/dns/_index.md index 6e048e7edf1..c7834da7c9f 100644 --- a/content/rancher/v2.5/en/troubleshooting/dns/_index.md +++ b/content/rancher/v2.5/en/troubleshooting/dns/_index.md @@ -196,7 +196,7 @@ services: > **Note:** As the `kubelet` is running inside a container, the path for files located in `/etc` and `/usr` are in `/host/etc` and `/host/usr` inside the `kubelet` container. -See [Editing Cluster as YAML]({{}}/rancher/v2.5/en/k8s-in-rancher/editing-clusters/#editing-cluster-as-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: +See [Editing Cluster as YAML]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/#editing-clusters-with-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: ``` kubectl delete pods -n kube-system -l k8s-app=kube-dns diff --git a/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md b/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md index d27d140570a..65721283c33 100644 --- a/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md +++ b/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md @@ -38,7 +38,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) + For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/v2.5/configuration/restore-config/) and to the [examples.]({{}}/rancher/v2.5/en/backups/v2.5/examples/) 1. Click **Create.** diff --git a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md index 32324f6b0a2..e4e49698bc6 100644 --- a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md +++ b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/rollbacks/_index.md @@ -52,7 +52,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference](../configuration/restore-config) and to the [examples.](../examples/#restore) + For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/v2.5/configuration/restore-config/) and to the [examples.]({{}}/rancher/v2.5/en/backups/v2.5/examples/) 1. Click **Create.** diff --git a/content/rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md b/content/rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md index 0d1713c03f9..b0d43bfeb4c 100644 --- a/content/rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/install-rancher/_index.md @@ -164,7 +164,7 @@ If you are using a Private CA signed cert, add `--set privateCA=true` following --set useBundledSystemChart=true # Available as of v2.3.0, use the packaged Rancher system charts ``` -Then refer to [Adding TLS Secrets]({{}}/rancher/v2.x/en/installation/options/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them. +Then refer to [Adding TLS Secrets]({{}}/rancher/v2.0-v2.4/en/installation/resources/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them. {{% /accordion %}} @@ -218,7 +218,7 @@ If you are installing Rancher versions before v2.3.0, you will not be able to us These resources could be helpful when installing Rancher: - [Rancher Helm chart options]({{}}/rancher/v2.x/en/installation/options/chart-options/) -- [Adding TLS secrets]({{}}/rancher/v2.x/en/installation/options/tls-secrets/) +- [Adding TLS secrets]({{}}/rancher/v2.0-v2.4/en/installation/resources/tls-secrets/) - [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.x/en/installation/options/troubleshooting/) {{% /tab %}} diff --git a/content/rancher/v2.x/en/troubleshooting/dns/_index.md b/content/rancher/v2.x/en/troubleshooting/dns/_index.md index ecbe88a7588..4acec0b3c95 100644 --- a/content/rancher/v2.x/en/troubleshooting/dns/_index.md +++ b/content/rancher/v2.x/en/troubleshooting/dns/_index.md @@ -196,7 +196,7 @@ services: > **Note:** As the `kubelet` is running inside a container, the path for files located in `/etc` and `/usr` are in `/host/etc` and `/host/usr` inside the `kubelet` container. -See [Editing Cluster as YAML]({{}}/rancher/v2.x/en/k8s-in-rancher/editing-clusters/#editing-cluster-as-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: +See [Editing Cluster as YAML]({{}}/rancher/v2.x/en/cluster-admin/editing-clusters/#editing-clusters-with-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: ``` kubectl delete pods -n kube-system -l k8s-app=kube-dns From a02b6648ea19379cf670ff4a10a570e40eec9519 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 4 Mar 2021 00:46:18 -0700 Subject: [PATCH 15/33] Add redirects, fix links --- .../v2.0-v2.4/en/backups/backup/docker-backups/_index.md | 1 + content/rancher/v2.0-v2.4/en/cli/_index.md | 2 +- .../en/cluster-admin/upgrading-kubernetes/_index.md | 2 +- .../v2.0-v2.4/en/cluster-admin/volumes-and-storage/_index.md | 1 + .../volumes-and-storage/attaching-existing-storage/_index.md | 2 +- .../volumes-and-storage/provisioning-new-storage/_index.md | 2 +- .../cluster-provisioning/cluster-capabilities-table/index.md | 2 +- .../air-gap/install-rancher/_index.md | 1 + .../rke-add-on/troubleshooting/404-default-backend/_index.md | 1 + .../advanced/helm2/rke-add-on/troubleshooting/_index.md | 1 + .../load-balancers-and-ingress/ingress/_index.md | 2 +- content/rancher/v2.0-v2.4/en/project-admin/_index.md | 1 + .../v2.0-v2.4/en/project-admin/resource-quotas/_index.md | 2 ++ content/rancher/v2.5/en/cli/_index.md | 2 +- .../cluster-admin/cluster-access/cluster-members/_index.md | 1 + .../volumes-and-storage/attaching-existing-storage/_index.md | 2 ++ .../cluster-provisioning/cluster-capabilities-table/index.md | 2 +- .../en/cluster-provisioning/registered-clusters/_index.md | 2 ++ .../vsphere/out-of-tree/vsphere-volume-migration/_index.md | 2 ++ .../en/deploy-across-clusters/multi-cluster-apps/_index.md | 4 ++-- content/rancher/v2.5/en/helm-charts/_index.md | 5 ++++- .../installation/resources/k8s-tutorials/ha-rke2/_index.md | 2 ++ .../configuration-reference/selectors-and-scrape/_index.md | 1 + content/rancher/v2.5/en/logging/_index.md | 1 + .../monitoring-alerting/configuration/alertmanager/_index.md | 3 +++ content/rancher/v2.5/en/pipelines/config/_index.md | 2 +- .../rancher/v2.5/en/project-admin/resource-quotas/_index.md | 2 ++ content/rancher/v2.5/en/troubleshooting/_index.md | 4 ---- content/rancher/v2.x/en/cli/_index.md | 2 +- .../v2.x/en/cluster-admin/upgrading-kubernetes/_index.md | 2 +- .../cluster-provisioning/cluster-capabilities-table/index.md | 2 +- .../v2.x/en/installation/requirements/ports/_index.md | 2 ++ .../rke-add-on/troubleshooting/404-default-backend/_index.md | 1 + 33 files changed, 45 insertions(+), 19 deletions(-) diff --git a/content/rancher/v2.0-v2.4/en/backups/backup/docker-backups/_index.md b/content/rancher/v2.0-v2.4/en/backups/backup/docker-backups/_index.md index 402fbac1eb1..6f4d55c4b4f 100644 --- a/content/rancher/v2.0-v2.4/en/backups/backup/docker-backups/_index.md +++ b/content/rancher/v2.0-v2.4/en/backups/backup/docker-backups/_index.md @@ -8,6 +8,7 @@ aliases: - /rancher/v2.0-v2.4/en/backups/backups/single-node-backups/ - /rancher/v2.0-v2.4/en/backups/legacy/backup/single-node-backups/ - /rancher/v2.0-v2.4/en/backups/v2.0.x-v2.4.x/backup/docker-backups + - /rancher/v2.0-v2.4/en/installation/backups-and-restoration/single-node-backup-and-restoration/ --- diff --git a/content/rancher/v2.0-v2.4/en/cli/_index.md b/content/rancher/v2.0-v2.4/en/cli/_index.md index a4e0801824a..b78a30db643 100644 --- a/content/rancher/v2.0-v2.4/en/cli/_index.md +++ b/content/rancher/v2.0-v2.4/en/cli/_index.md @@ -18,7 +18,7 @@ The binary can be downloaded directly from the UI. The link can be found in the After you download the Rancher CLI, you need to make a few configurations. Rancher CLI requires: -- Your [Rancher Server URL]({{}}/rancher/v2.0-v2.4/en/admin-settings/server-url), which is used to connect to Rancher Server. +- Your Rancher Server URL, which is used to connect to Rancher Server. - An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{}}/rancher/v2.0-v2.4/en/user-settings/api-keys/). ### CLI Authentication diff --git a/content/rancher/v2.0-v2.4/en/cluster-admin/upgrading-kubernetes/_index.md b/content/rancher/v2.0-v2.4/en/cluster-admin/upgrading-kubernetes/_index.md index 57447b86131..ff2c692af34 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-admin/upgrading-kubernetes/_index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-admin/upgrading-kubernetes/_index.md @@ -69,7 +69,7 @@ The cluster cannot be downgraded to a previous Kubernetes version. > **Prerequisites:** > -> - The options below are available only for [Rancher-launched RKE Kubernetes clusters]({{}}/rancher/v2.0-v2.4/en/cluster-provisioning/rke-clusters/) and [imported K3s Kubernetes clusters.]({{}}/rancher/v2.0-v2.4/en/cluster-provisioning/imported-clusters/#additional-features-for-imported-k3s-clusters) +> - The options below are available only for [Rancher-launched RKE Kubernetes clusters]({{}}/rancher/v2.0-v2.4/en/cluster-provisioning/rke-clusters/) and imported/registered K3s Kubernetes clusters. > - Before upgrading Kubernetes, [back up your cluster.]({{}}/rancher/v2.0-v2.4/en/backups) 1. From the **Global** view, find the cluster for which you want to upgrade Kubernetes. Select **⋮ > Edit**. diff --git a/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/_index.md b/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/_index.md index ae0abbbcacf..2be0a8a58d4 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/_index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/_index.md @@ -5,6 +5,7 @@ weight: 2031 aliases: - /rancher/v2.0-v2.4/en/tasks/clusters/adding-storage/ - /rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/persistent-volume-claims/ + - /rancher/v2.0-v2.4/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/ --- When deploying an application that needs to retain data, you'll need to create persistent storage. Persistent storage allows you to store application data external from the pod running your application. This storage practice allows you to maintain application data, even if the application's pod fails. diff --git a/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md b/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md index d61129a6c03..407782a7fd5 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md @@ -25,7 +25,7 @@ Creating a persistent volume in Rancher will not create a storage volume. It onl The steps to set up a persistent storage device will differ based on your infrastructure. We provide examples of how to set up storage using [vSphere,](../examples/vsphere) [NFS,](../examples/nfs) or Amazon's [EBS.](../examples/ebs) -If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.0-v2.4/en/longhorn) +If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. ### 2. Add a persistent volume that refers to the persistent storage diff --git a/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md b/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md index 884136c1bb8..d819c28d2f9 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md @@ -9,7 +9,7 @@ This section assumes that you understand the Kubernetes concepts of storage clas New storage is often provisioned by a cloud provider such as Amazon EBS. However, new storage doesn't have to be in the cloud. -If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.0-v2.4/en/longhorn) +If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. To provision new storage for your workloads, follow these steps: diff --git a/content/rancher/v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/index.md b/content/rancher/v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/index.md index d82ca959207..2af054da595 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/index.md @@ -19,4 +19,4 @@ headless: true | [Configuring Pod Security Policies]({{}}/rancher/v2.0-v2.4/en/cluster-admin/pod-security-policy/) | ✓ | | | | [Running Security Scans]({{}}/rancher/v2.0-v2.4/en/security/security-scan/) | ✓ | | | -\* Cluster configuration options can't be edited for imported clusters, except for [K3s clusters.]({{}}/rancher/v2.0-v2.4/en/cluster-provisioning/imported-clusters/#additional-features-for-imported-k3s-clusters) +\* Cluster configuration options can't be edited for imported clusters, except for K3s clusters. diff --git a/content/rancher/v2.0-v2.4/en/installation/other-installation-methods/air-gap/install-rancher/_index.md b/content/rancher/v2.0-v2.4/en/installation/other-installation-methods/air-gap/install-rancher/_index.md index d2df97db105..f94562e9002 100644 --- a/content/rancher/v2.0-v2.4/en/installation/other-installation-methods/air-gap/install-rancher/_index.md +++ b/content/rancher/v2.0-v2.4/en/installation/other-installation-methods/air-gap/install-rancher/_index.md @@ -6,6 +6,7 @@ aliases: - /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-for-private-reg/ - /rancher/v2.0-v2.4/en/installation/air-gap-single-node/install-rancher - /rancher/v2.0-v2.4/en/installation/air-gap/install-rancher + - /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/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. diff --git a/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md b/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md index d061b53e88a..2387e81fd55 100644 --- a/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md +++ b/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md @@ -4,6 +4,7 @@ weight: 30 aliases: - /rancher/v2.0-v2.4/en/installation/troubleshooting-ha/404-default-backend/ - /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/troubleshooting/404-default-backend +- /404-default-backend/ --- > #### **Important: RKE add-on install is only supported up to Rancher v2.0.8** diff --git a/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/_index.md b/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/_index.md index cc461cbe0d4..35978bf4a31 100644 --- a/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/_index.md +++ b/content/rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/_index.md @@ -4,6 +4,7 @@ weight: 370 aliases: - /rancher/v2.0-v2.4/en/installation/troubleshooting-ha/ - /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/troubleshooting +- /rancher/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/ --- > #### **Important: RKE add-on install is only supported up to Rancher v2.0.8** diff --git a/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md b/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md index 40bf14d6aa8..e2eba57e3ff 100644 --- a/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md +++ b/content/rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md @@ -7,7 +7,7 @@ aliases: - /rancher/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress --- -Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.0-v2.4/en/catalog/globaldns/). +Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a [Global DNS entry]({{}}/rancher/v2.0-v2.4/en/helm-charts/globaldns/). 1. From the **Global** view, open the project that you want to add ingress to. 1. Click **Resources** in the main navigation bar. Click the **Load Balancing** tab. (In versions before v2.3.0, just click the **Load Balancing** tab.) Then click **Add Ingress**. diff --git a/content/rancher/v2.0-v2.4/en/project-admin/_index.md b/content/rancher/v2.0-v2.4/en/project-admin/_index.md index e1af57cf974..a0a86c22d04 100644 --- a/content/rancher/v2.0-v2.4/en/project-admin/_index.md +++ b/content/rancher/v2.0-v2.4/en/project-admin/_index.md @@ -3,6 +3,7 @@ title: Project Administration weight: 9 aliases: - /rancher/v2.0-v2.4/en/project-admin/editing-projects/ + - /rancher/v2.0-v2.4/en/k8s-in-rancher/projects-and-namespaces/editing-projects/ --- _Projects_ are objects introduced in Rancher that help organize namespaces in your Kubernetes cluster. You can use projects to create multi-tenant clusters, which allows a group of users to share the same underlying resources without interacting with each other's applications. diff --git a/content/rancher/v2.0-v2.4/en/project-admin/resource-quotas/_index.md b/content/rancher/v2.0-v2.4/en/project-admin/resource-quotas/_index.md index af7dbffe90a..6cac538d8f9 100644 --- a/content/rancher/v2.0-v2.4/en/project-admin/resource-quotas/_index.md +++ b/content/rancher/v2.0-v2.4/en/project-admin/resource-quotas/_index.md @@ -1,6 +1,8 @@ --- title: Project Resource Quotas weight: 2515 +aliases: + - /rancher/v2.0-v2.4/en/k8s-in-rancher/projects-and-namespaces/resource-quotas --- _Available as of v2.1.0_ diff --git a/content/rancher/v2.5/en/cli/_index.md b/content/rancher/v2.5/en/cli/_index.md index c719667a7b3..7c1f5b96006 100644 --- a/content/rancher/v2.5/en/cli/_index.md +++ b/content/rancher/v2.5/en/cli/_index.md @@ -18,7 +18,7 @@ The binary can be downloaded directly from the UI. The link can be found in the After you download the Rancher CLI, you need to make a few configurations. Rancher CLI requires: -- Your [Rancher Server URL]({{}}/rancher/v2.5/en/admin-settings/server-url), which is used to connect to Rancher Server. +- Your Rancher Server URL, which is used to connect to Rancher Server. - An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{}}/rancher/v2.5/en/user-settings/api-keys/). ### CLI Authentication diff --git a/content/rancher/v2.5/en/cluster-admin/cluster-access/cluster-members/_index.md b/content/rancher/v2.5/en/cluster-admin/cluster-access/cluster-members/_index.md index 01d3e41cf7a..9c4bf05aea6 100644 --- a/content/rancher/v2.5/en/cluster-admin/cluster-access/cluster-members/_index.md +++ b/content/rancher/v2.5/en/cluster-admin/cluster-access/cluster-members/_index.md @@ -5,6 +5,7 @@ aliases: - /rancher/v2.5/en/tasks/clusters/adding-managing-cluster-members/ - /rancher/v2.5/en/k8s-in-rancher/cluster-members/ - /rancher/v2.5/en/cluster-admin/cluster-members + - /rancher/v2.5/en/cluster-provisioning/cluster-members/ --- If you want to provide a user with access and permissions to _all_ projects, nodes, and resources within a cluster, assign the user a cluster membership. diff --git a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md b/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md index 4d37a56dfd8..4d1ebf61624 100644 --- a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md +++ b/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md @@ -1,6 +1,8 @@ --- title: Setting up Existing Storage weight: 1 +aliases: + - /rancher/v2.5/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/ --- This section describes how to set up existing persistent storage for workloads in Rancher. diff --git a/content/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table/index.md b/content/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table/index.md index a93442202c7..404c8a0e057 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table/index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table/index.md @@ -19,4 +19,4 @@ headless: true | [Configuring Pod Security Policies]({{}}/rancher/v2.5/en/cluster-admin/pod-security-policy/) | ✓ | | | | [Running Security Scans]({{}}/rancher/v2.5/en/security/security-scan/) | ✓ | | | -\* Cluster configuration options can't be edited for imported clusters, except for [K3s clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/imported-clusters/#additional-features-for-imported-k3s-clusters) +\* Cluster configuration options can't be edited for imported clusters, except for [K3s clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/imported-clusters/) diff --git a/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md b/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md index 92504883257..5d8553db48e 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/registered-clusters/_index.md @@ -1,6 +1,8 @@ --- title: Registering Existing Clusters weight: 6 +aliases: + - /rancher/v2.5/en/cluster-provisioning/imported-clusters --- _Available as of v2.5_ diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md index 0582fb22bc9..7db29d7ee14 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md @@ -1,6 +1,8 @@ --- title: Migrating vSphere In-tree Volumes to CSI weight: 5 +aliases: + - /rancher/v2.x/en/installation/install-rancher-on-k8s/migrating-rancher --- _Available as of v2.5+_ diff --git a/content/rancher/v2.5/en/deploy-across-clusters/multi-cluster-apps/_index.md b/content/rancher/v2.5/en/deploy-across-clusters/multi-cluster-apps/_index.md index a3602c3db73..d1acf032400 100644 --- a/content/rancher/v2.5/en/deploy-across-clusters/multi-cluster-apps/_index.md +++ b/content/rancher/v2.5/en/deploy-across-clusters/multi-cluster-apps/_index.md @@ -9,7 +9,7 @@ Typically, most applications are deployed on a single Kubernetes cluster, but th Any Helm charts from a global catalog can be used to deploy and manage multi-cluster applications. -After creating a multi-cluster application, you can program a [Global DNS entry]({{}}/rancher/v2.5/en/catalog/globaldns/) to make it easier to access the application. +After creating a multi-cluster application, you can program a global DNS entry to make it easier to access the application. - [Prerequisites](#prerequisites) - [Launching a multi-cluster app](#launching-a-multi-cluster-app) @@ -99,7 +99,7 @@ If the Helm chart that you are deploying contains a `questions.yml` file, Ranche ### Key Value Pairs for Native Helm Charts -For native Helm charts (i.e., charts from the **Helm Stable** or **Helm Incubator** catalogs or a [custom Helm chart repository]({{}}/rancher/v2.5/en/catalog/custom/), answers are provided as key value pairs in the **Answers** section. These answers are used to override the default values. +For native Helm charts (i.e., charts from the **Helm Stable** or **Helm Incubator** catalogs or a custom Helm chart repository, answers are provided as key value pairs in the **Answers** section. These answers are used to override the default values. ### Members diff --git a/content/rancher/v2.5/en/helm-charts/_index.md b/content/rancher/v2.5/en/helm-charts/_index.md index 4b834e05d3a..f310c46c58e 100644 --- a/content/rancher/v2.5/en/helm-charts/_index.md +++ b/content/rancher/v2.5/en/helm-charts/_index.md @@ -2,7 +2,10 @@ title: Helm Charts in Rancher weight: 11 aliases: - - rancher/v2.x/en/helm-charts/apps-marketplace + - /rancher/v2.x/en/helm-charts/apps-marketplace + - /rancher/v2.5/en/catalog/ + - /rancher/v2.5/en/catalog/apps + - /rancher/v2.5/en/catalog/launching-apps --- In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. diff --git a/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md b/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md index ce6dc4632ad..e112e1dfed7 100644 --- a/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md +++ b/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md @@ -2,6 +2,8 @@ title: Setting up a High-availability RKE2 Kubernetes Cluster for Rancher shortTitle: Set up RKE2 for Rancher weight: 2 +aliases; + - /rancher/v2.x/en/installation/resources/k8s-tutorials/ha-RKE2 --- _Tested on v2.5.6_ diff --git a/content/rancher/v2.5/en/istio/configuration-reference/selectors-and-scrape/_index.md b/content/rancher/v2.5/en/istio/configuration-reference/selectors-and-scrape/_index.md index fa2dfdf7cc0..f9f3cd833e4 100644 --- a/content/rancher/v2.5/en/istio/configuration-reference/selectors-and-scrape/_index.md +++ b/content/rancher/v2.5/en/istio/configuration-reference/selectors-and-scrape/_index.md @@ -3,6 +3,7 @@ title: Selectors and Scrape Configs weight: 2 aliases: - /rancher/v2.5/en/istio/v2.5/configuration-reference/selectors-and-scrape + - /rancher/v2.5/en/cluster-admin/tools/istio/setup/node-selectors --- The Monitoring app sets `prometheus.prometheusSpec.ignoreNamespaceSelectors=false`, which enables monitoring across all namespaces by default. diff --git a/content/rancher/v2.5/en/logging/_index.md b/content/rancher/v2.5/en/logging/_index.md index cf43e02b261..b39293e58f7 100644 --- a/content/rancher/v2.5/en/logging/_index.md +++ b/content/rancher/v2.5/en/logging/_index.md @@ -7,6 +7,7 @@ weight: 15 aliases: - /rancher/v2.5/en/dashboard/logging - /rancher/v2.5/en/logging/v2.5 + - /rancher/v2.5/en/cluster-admin/tools/logging --- - [Changes in Rancher v2.5](#changes-in-rancher-v2-5) diff --git a/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md b/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md index 5d8af8dda23..0fcac6d9aac 100644 --- a/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md +++ b/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md @@ -3,6 +3,9 @@ title: Alertmanager weight: 1 aliases: - /rancher/v2.5/en/monitoring-alerting/v2.5/configuration/alertmanager + - rancher/v2.5/en/monitoring-alerting/legacy/notifiers/ + - /rancher/v2.5/en/cluster-admin/tools/notifiers + - /rancher/v2.5/en/cluster-admin/tools/alerts --- The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configuration/#configuration-file) Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus. diff --git a/content/rancher/v2.5/en/pipelines/config/_index.md b/content/rancher/v2.5/en/pipelines/config/_index.md index d7d3fa52540..a2ae7bc3c3d 100644 --- a/content/rancher/v2.5/en/pipelines/config/_index.md +++ b/content/rancher/v2.5/en/pipelines/config/_index.md @@ -154,7 +154,7 @@ stages: # Step Type: Publish Catalog Template -The **Publish Catalog Template** step publishes a version of a catalog app template (i.e. Helm chart) to a [git hosted chart repository]({{}}/rancher/v2.5/en/catalog/custom/). It generates a git commit and pushes it to your chart repository. This process requires a chart folder in your source code's repository and a pre-configured secret in the dedicated pipeline namespace to complete successfully. Any variables in the [pipeline variable substitution reference](#pipeline-variable-substitution-reference) is supported for any file in the chart folder. +The **Publish Catalog Template** step publishes a version of a catalog app template (i.e. Helm chart) to a git hosted chart repository. It generates a git commit and pushes it to your chart repository. This process requires a chart folder in your source code's repository and a pre-configured secret in the dedicated pipeline namespace to complete successfully. Any variables in the [pipeline variable substitution reference](#pipeline-variable-substitution-reference) is supported for any file in the chart folder. ### Configuring Publishing a Catalog Template by UI diff --git a/content/rancher/v2.5/en/project-admin/resource-quotas/_index.md b/content/rancher/v2.5/en/project-admin/resource-quotas/_index.md index 39e12eaca67..d63f81dfadd 100644 --- a/content/rancher/v2.5/en/project-admin/resource-quotas/_index.md +++ b/content/rancher/v2.5/en/project-admin/resource-quotas/_index.md @@ -1,6 +1,8 @@ --- title: Project Resource Quotas weight: 2515 +aliases: + - /rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas --- In situations where several teams share a cluster, one team may overconsume the resources available: CPU, memory, storage, services, Kubernetes objects like pods or secrets, and so on. To prevent this overconsumption, you can apply a _resource quota_, which is a Rancher feature that limits the resources available to a project or namespace. diff --git a/content/rancher/v2.5/en/troubleshooting/_index.md b/content/rancher/v2.5/en/troubleshooting/_index.md index 0cbd5336e02..bb761060cca 100644 --- a/content/rancher/v2.5/en/troubleshooting/_index.md +++ b/content/rancher/v2.5/en/troubleshooting/_index.md @@ -32,10 +32,6 @@ This section contains information to help you troubleshoot issues when using Ran If you experience issues with your [Rancher server installed on Kubernetes]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) -- [Registered clusters]({{}}/rancher/v2.5/en/troubleshooting/registered-clusters/) - - If you experience issues when [Registering Kubernetes Clusters]({{}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/) - - [Logging]({{}}/rancher/v2.5/en/troubleshooting/logging/) Read more about what log levels can be configured and how to configure a log level. diff --git a/content/rancher/v2.x/en/cli/_index.md b/content/rancher/v2.x/en/cli/_index.md index 0d2d39e3a8c..60efccf166a 100644 --- a/content/rancher/v2.x/en/cli/_index.md +++ b/content/rancher/v2.x/en/cli/_index.md @@ -18,7 +18,7 @@ The binary can be downloaded directly from the UI. The link can be found in the After you download the Rancher CLI, you need to make a few configurations. Rancher CLI requires: -- Your [Rancher Server URL]({{}}/rancher/v2.x/en/admin-settings/server-url), which is used to connect to Rancher Server. +- Your Your Rancher Server URL, which is used to connect to Rancher Server. - An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{}}/rancher/v2.x/en/user-settings/api-keys/). ### CLI Authentication diff --git a/content/rancher/v2.x/en/cluster-admin/upgrading-kubernetes/_index.md b/content/rancher/v2.x/en/cluster-admin/upgrading-kubernetes/_index.md index c49e3df53ff..15be6c9a0b7 100644 --- a/content/rancher/v2.x/en/cluster-admin/upgrading-kubernetes/_index.md +++ b/content/rancher/v2.x/en/cluster-admin/upgrading-kubernetes/_index.md @@ -69,7 +69,7 @@ The cluster cannot be downgraded to a previous Kubernetes version. > **Prerequisites:** > -> - The options below are available only for [Rancher-launched RKE Kubernetes clusters]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/) and [imported K3s Kubernetes clusters.]({{}}/rancher/v2.x/en/cluster-provisioning/imported-clusters/#additional-features-for-imported-k3s-clusters) +> - The options below are available only for [Rancher-launched RKE Kubernetes clusters]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/) and imported K3s Kubernetes clusters. > - Before upgrading Kubernetes, [back up your cluster.]({{}}/rancher/v2.x/en/backups) 1. From the **Global** view, find the cluster for which you want to upgrade Kubernetes. Select **⋮ > Edit**. diff --git a/content/rancher/v2.x/en/cluster-provisioning/cluster-capabilities-table/index.md b/content/rancher/v2.x/en/cluster-provisioning/cluster-capabilities-table/index.md index 875779e9ab0..80271f0aed0 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/cluster-capabilities-table/index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/cluster-capabilities-table/index.md @@ -19,4 +19,4 @@ headless: true | [Configuring Pod Security Policies]({{}}/rancher/v2.x/en/cluster-admin/pod-security-policy/) | ✓ | | | | [Running Security Scans]({{}}/rancher/v2.x/en/security/security-scan/) | ✓ | | | -\* Cluster configuration options can't be edited for imported clusters, except for [K3s clusters.]({{}}/rancher/v2.x/en/cluster-provisioning/imported-clusters/#additional-features-for-imported-k3s-clusters) +\* Cluster configuration options can't be edited for imported clusters, except for K3s clusters. \ No newline at end of file diff --git a/content/rancher/v2.x/en/installation/requirements/ports/_index.md b/content/rancher/v2.x/en/installation/requirements/ports/_index.md index aaa0c2d6cbb..2cb204d6ea8 100644 --- a/content/rancher/v2.x/en/installation/requirements/ports/_index.md +++ b/content/rancher/v2.x/en/installation/requirements/ports/_index.md @@ -2,6 +2,8 @@ title: Port Requirements description: Read about port requirements needed in order for Rancher to operate properly, both for Rancher nodes and downstream Kubernetes cluster nodes weight: 300 +aliases: + - /rancher/v2.5/en/installation/references --- To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes. diff --git a/content/rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md b/content/rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md index 788ec1c5565..6727ea641da 100644 --- a/content/rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md +++ b/content/rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/_index.md @@ -4,6 +4,7 @@ weight: 30 aliases: - /rancher/v2.x/en/installation/troubleshooting-ha/404-default-backend/ - /rancher/v2.x/en/installation/options/helm2/rke-add-on/troubleshooting/404-default-backend +- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/ --- > #### **Important: RKE add-on install is only supported up to Rancher v2.0.8** From 17c52e63d2c4f1149f42f3ffeb8e30925388836a Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 3 Mar 2021 20:28:39 -0700 Subject: [PATCH 16/33] Update CVE table --- content/rancher/v2.5/en/security/cve/_index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/rancher/v2.5/en/security/cve/_index.md b/content/rancher/v2.5/en/security/cve/_index.md index e02fa2bf17d..b3ca1c42539 100644 --- a/content/rancher/v2.5/en/security/cve/_index.md +++ b/content/rancher/v2.5/en/security/cve/_index.md @@ -15,3 +15,4 @@ Rancher is committed to informing the community of security issues in our produc | [CVE-2019-13209](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-13209) | The vulnerability is known as a [Cross-Site Websocket Hijacking attack](https://www.christian-schneider.net/CrossSiteWebSocketHijacking.html). This attack allows an exploiter to gain access to clusters managed by Rancher with the roles/permissions of a victim. It requires that a victim to be logged into a Rancher server and then access a third-party site hosted by the exploiter. Once that is accomplished, the exploiter is able to execute commands against the Kubernetes API with the permissions and identity of the victim. Reported by Matt Belisle and Alex Stevenson from Workiva. | 15 Jul 2019 | [Rancher v2.2.5](https://github.com/rancher/rancher/releases/tag/v2.2.5), [Rancher v2.1.11](https://github.com/rancher/rancher/releases/tag/v2.1.11) and [Rancher v2.0.16](https://github.com/rancher/rancher/releases/tag/v2.0.16) | | [CVE-2019-14436](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-14436) | The vulnerability allows a member of a project that has access to edit role bindings to be able to assign themselves or others a cluster level role granting them administrator access to that cluster. The issue was found and reported by Michal Lipinski at Nokia. | 5 Aug 2019 | [Rancher v2.2.7](https://github.com/rancher/rancher/releases/tag/v2.2.7) and [Rancher v2.1.12](https://github.com/rancher/rancher/releases/tag/v2.1.12) | | [CVE-2019-14435](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-14435) | This vulnerability allows authenticated users to potentially extract otherwise private data out of IPs reachable from system service containers used by Rancher. This can include but not only limited to services such as cloud provider metadata services. Although Rancher allow users to configure whitelisted domains for system service access, this flaw can still be exploited by a carefully crafted HTTP request. The issue was found and reported by Matt Belisle and Alex Stevenson at Workiva. | 5 Aug 2019 | [Rancher v2.2.7](https://github.com/rancher/rancher/releases/tag/v2.2.7) and [Rancher v2.1.12](https://github.com/rancher/rancher/releases/tag/v2.1.12) | +| [CVE-2021-25313](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-25313) | A security vulnerability was discovered on all Rancher 2 versions. When accessing the Rancher API with a browser, the URL was not properly escaped, making it vulnerable to an XSS attack. Specially crafted URLs to these API endpoints could include JavaScript which would be embedded in the page and execute in a browser. There is no direct mitigation. Avoid clicking on untrusted links to your Rancher server. | 2 Mar 2021 | [Rancher v2.5.6](rancher/rancher:stable server-charts/stable), [Rancher v2.4.14](rancher/rancher:v2.4.14 server-charts/stable), and [Rancher v2.3.11](rancher/rancher:v2.3.11 server-charts/stable) | \ No newline at end of file From a5b71ed0b9c1d737e120328663a80eff61dc5a2a Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 4 Mar 2021 09:31:04 -0700 Subject: [PATCH 17/33] Update CVE table again --- content/rancher/v2.5/en/security/cve/_index.md | 2 +- content/rancher/v2.x/en/security/cve/_index.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/content/rancher/v2.5/en/security/cve/_index.md b/content/rancher/v2.5/en/security/cve/_index.md index b3ca1c42539..3c845125277 100644 --- a/content/rancher/v2.5/en/security/cve/_index.md +++ b/content/rancher/v2.5/en/security/cve/_index.md @@ -15,4 +15,4 @@ Rancher is committed to informing the community of security issues in our produc | [CVE-2019-13209](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-13209) | The vulnerability is known as a [Cross-Site Websocket Hijacking attack](https://www.christian-schneider.net/CrossSiteWebSocketHijacking.html). This attack allows an exploiter to gain access to clusters managed by Rancher with the roles/permissions of a victim. It requires that a victim to be logged into a Rancher server and then access a third-party site hosted by the exploiter. Once that is accomplished, the exploiter is able to execute commands against the Kubernetes API with the permissions and identity of the victim. Reported by Matt Belisle and Alex Stevenson from Workiva. | 15 Jul 2019 | [Rancher v2.2.5](https://github.com/rancher/rancher/releases/tag/v2.2.5), [Rancher v2.1.11](https://github.com/rancher/rancher/releases/tag/v2.1.11) and [Rancher v2.0.16](https://github.com/rancher/rancher/releases/tag/v2.0.16) | | [CVE-2019-14436](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-14436) | The vulnerability allows a member of a project that has access to edit role bindings to be able to assign themselves or others a cluster level role granting them administrator access to that cluster. The issue was found and reported by Michal Lipinski at Nokia. | 5 Aug 2019 | [Rancher v2.2.7](https://github.com/rancher/rancher/releases/tag/v2.2.7) and [Rancher v2.1.12](https://github.com/rancher/rancher/releases/tag/v2.1.12) | | [CVE-2019-14435](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-14435) | This vulnerability allows authenticated users to potentially extract otherwise private data out of IPs reachable from system service containers used by Rancher. This can include but not only limited to services such as cloud provider metadata services. Although Rancher allow users to configure whitelisted domains for system service access, this flaw can still be exploited by a carefully crafted HTTP request. The issue was found and reported by Matt Belisle and Alex Stevenson at Workiva. | 5 Aug 2019 | [Rancher v2.2.7](https://github.com/rancher/rancher/releases/tag/v2.2.7) and [Rancher v2.1.12](https://github.com/rancher/rancher/releases/tag/v2.1.12) | -| [CVE-2021-25313](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-25313) | A security vulnerability was discovered on all Rancher 2 versions. When accessing the Rancher API with a browser, the URL was not properly escaped, making it vulnerable to an XSS attack. Specially crafted URLs to these API endpoints could include JavaScript which would be embedded in the page and execute in a browser. There is no direct mitigation. Avoid clicking on untrusted links to your Rancher server. | 2 Mar 2021 | [Rancher v2.5.6](rancher/rancher:stable server-charts/stable), [Rancher v2.4.14](rancher/rancher:v2.4.14 server-charts/stable), and [Rancher v2.3.11](rancher/rancher:v2.3.11 server-charts/stable) | \ No newline at end of file +| [CVE-2021-25313](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-25313) | A security vulnerability was discovered on all Rancher 2 versions. When accessing the Rancher API with a browser, the URL was not properly escaped, making it vulnerable to an XSS attack. Specially crafted URLs to these API endpoints could include JavaScript which would be embedded in the page and execute in a browser. There is no direct mitigation. Avoid clicking on untrusted links to your Rancher server. | 2 Mar 2021 | [Rancher v2.5.6](https://github.com/rancher/rancher/releases/tag/v2.5.6), [Rancher v2.4.14](https://github.com/rancher/rancher/releases/tag/v2.4.14), and [Rancher v2.3.11](https://github.com/rancher/rancher/releases/tag/v2.3.11) | \ No newline at end of file diff --git a/content/rancher/v2.x/en/security/cve/_index.md b/content/rancher/v2.x/en/security/cve/_index.md index 02c00946dc9..558da2418d5 100644 --- a/content/rancher/v2.x/en/security/cve/_index.md +++ b/content/rancher/v2.x/en/security/cve/_index.md @@ -15,3 +15,4 @@ Rancher is committed to informing the community of security issues in our produc | [CVE-2019-13209](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-13209) | The vulnerability is known as a [Cross-Site Websocket Hijacking attack](https://www.christian-schneider.net/CrossSiteWebSocketHijacking.html). This attack allows an exploiter to gain access to clusters managed by Rancher with the roles/permissions of a victim. It requires that a victim to be logged into a Rancher server and then access a third-party site hosted by the exploiter. Once that is accomplished, the exploiter is able to execute commands against the Kubernetes API with the permissions and identity of the victim. Reported by Matt Belisle and Alex Stevenson from Workiva. | 15 Jul 2019 | [Rancher v2.2.5](https://github.com/rancher/rancher/releases/tag/v2.2.5), [Rancher v2.1.11](https://github.com/rancher/rancher/releases/tag/v2.1.11) and [Rancher v2.0.16](https://github.com/rancher/rancher/releases/tag/v2.0.16) | | [CVE-2019-14436](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-14436) | The vulnerability allows a member of a project that has access to edit role bindings to be able to assign themselves or others a cluster level role granting them administrator access to that cluster. The issue was found and reported by Michal Lipinski at Nokia. | 5 Aug 2019 | [Rancher v2.2.7](https://github.com/rancher/rancher/releases/tag/v2.2.7) and [Rancher v2.1.12](https://github.com/rancher/rancher/releases/tag/v2.1.12) | | [CVE-2019-14435](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-14435) | This vulnerability allows authenticated users to potentially extract otherwise private data out of IPs reachable from system service containers used by Rancher. This can include but not only limited to services such as cloud provider metadata services. Although Rancher allow users to configure whitelisted domains for system service access, this flaw can still be exploited by a carefully crafted HTTP request. The issue was found and reported by Matt Belisle and Alex Stevenson at Workiva. | 5 Aug 2019 | [Rancher v2.2.7](https://github.com/rancher/rancher/releases/tag/v2.2.7) and [Rancher v2.1.12](https://github.com/rancher/rancher/releases/tag/v2.1.12) | +| [CVE-2021-25313](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-25313) | A security vulnerability was discovered on all Rancher 2 versions. When accessing the Rancher API with a browser, the URL was not properly escaped, making it vulnerable to an XSS attack. Specially crafted URLs to these API endpoints could include JavaScript which would be embedded in the page and execute in a browser. There is no direct mitigation. Avoid clicking on untrusted links to your Rancher server. | 2 Mar 2021 | [Rancher v2.5.6](https://github.com/rancher/rancher/releases/tag/v2.5.6), [Rancher v2.4.14](https://github.com/rancher/rancher/releases/tag/v2.4.14), and [Rancher v2.3.11](https://github.com/rancher/rancher/releases/tag/v2.3.11) | \ No newline at end of file From 6fe3333139aad5ed869600594f4b7a2331cbd71a Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 4 Mar 2021 23:12:35 -0700 Subject: [PATCH 18/33] Update link to doc about AWS cloud provider --- .../rke-clusters/cloud-providers/amazon/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md index ef9b6587d1c..101110b7992 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md @@ -8,7 +8,7 @@ When using the `Amazon` cloud provider, you can leverage the following capabilit - **Load Balancers:** Launches an AWS Elastic Load Balancer (ELB) when choosing `Layer-4 Load Balancer` in **Port Mapping** or when launching a `Service` with `type: LoadBalancer`. - **Persistent Volumes**: Allows you to use AWS Elastic Block Stores (EBS) for persistent volumes. -See [cloud-provider-aws README](https://github.com/kubernetes/cloud-provider-aws/blob/master/README.md) for all information regarding the Amazon cloud provider. +See [cloud-provider-aws README](https://kubernetes.github.io/cloud-provider-aws/) for all information regarding the Amazon cloud provider. To set up the Amazon cloud provider, From db01df46931dddac73492b0395e5c0ff26d07b0e Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 4 Mar 2021 23:39:26 -0700 Subject: [PATCH 19/33] Document known issue for migration to Rancher v2.5 #3068 --- .../v2.5/en/security/rancher-2.5/1.6-hardening-2.5/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/rancher/v2.5/en/security/rancher-2.5/1.6-hardening-2.5/_index.md b/content/rancher/v2.5/en/security/rancher-2.5/1.6-hardening-2.5/_index.md index a6352e98d75..6d20521a94d 100644 --- a/content/rancher/v2.5/en/security/rancher-2.5/1.6-hardening-2.5/_index.md +++ b/content/rancher/v2.5/en/security/rancher-2.5/1.6-hardening-2.5/_index.md @@ -26,6 +26,8 @@ For more detail about evaluating a hardened cluster against the official CIS ben - Rancher **exec shell** and **view logs** for pods are **not** functional in a CIS 1.6 hardened setup when only public IP is provided when registering custom nodes. This functionality requires a private IP to be provided when registering the custom nodes. - When setting the `default_pod_security_policy_template_id:` to `restricted` Rancher creates **RoleBindings** and **ClusterRoleBindings** on the default service accounts. The CIS 1.6 5.1.5 check requires the default service accounts have no roles or cluster roles bound to it apart from the defaults. In addition the default service accounts should be configured such that it does not provide a service account token and does not have any explicit rights assignments. +Migration Rancher from 2.4 to 2.5. Addons were removed in HG 2.5, and therefore namespaces on migration may be not created on the downstream clusters. Pod may fail to run because of missing namesapce like ingress-nginx, cattlae-system. + ### Configure Kernel Runtime Parameters The following `sysctl` configuration is recommended for all nodes type in the cluster. Set the following parameters in `/etc/sysctl.d/90-kubelet.conf`: From ca4bd21f5664f9afb2083e950c5b3de9d13321e6 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 4 Mar 2021 23:43:37 -0700 Subject: [PATCH 20/33] Clarify that Docker is only required for RKE #3069 --- content/rancher/v2.5/en/installation/requirements/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/rancher/v2.5/en/installation/requirements/_index.md b/content/rancher/v2.5/en/installation/requirements/_index.md index 38423751cd5..2a418430059 100644 --- a/content/rancher/v2.5/en/installation/requirements/_index.md +++ b/content/rancher/v2.5/en/installation/requirements/_index.md @@ -30,7 +30,7 @@ The Rancher UI works best in Firefox or Chrome. Rancher should work with any modern Linux distribution. -Docker is required for nodes that will run K3s or RKE Kubernetes clusters. It is not required for RancherD installs. +Docker is required for nodes that will run RKE Kubernetes clusters. It is not required for RancherD installs. Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/) From ed069368ac4fb9f636ce63653e01b2dc3ab5e2f9 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Fri, 5 Mar 2021 00:06:54 -0700 Subject: [PATCH 21/33] Update node options for registered/imported cluster in v2.5 docs #3080 --- .../v2.5/en/cluster-admin/nodes/_index.md | 35 ++++++++++--------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/content/rancher/v2.5/en/cluster-admin/nodes/_index.md b/content/rancher/v2.5/en/cluster-admin/nodes/_index.md index 2d91252f344..2fcd5b620d9 100644 --- a/content/rancher/v2.5/en/cluster-admin/nodes/_index.md +++ b/content/rancher/v2.5/en/cluster-admin/nodes/_index.md @@ -12,7 +12,7 @@ This section covers the following topics: - [Node options available for each cluster creation option](#node-options-available-for-each-cluster-creation-option) - [Nodes hosted by an infrastructure provider](#nodes-hosted-by-an-infrastructure-provider) - [Nodes provisioned by hosted Kubernetes providers](#nodes-provisioned-by-hosted-kubernetes-providers) - - [Imported nodes](#imported-nodes) + - [Registered nodes](#registered-nodes) - [Managing and editing individual nodes](#managing-and-editing-individual-nodes) - [Viewing a node in the Rancher API](#viewing-a-node-in-the-rancher-api) - [Deleting a node](#deleting-a-node) @@ -29,21 +29,24 @@ This section covers the following topics: # Node Options Available for Each Cluster Creation Option The following table lists which node options are available for each type of cluster in Rancher. Click the links in the **Option** column for more detailed information about each feature. +| Option | [Nodes Hosted by an Infrastructure Provider][1] | [Custom Node][2] | [Hosted Cluster][3] | [Registered EKS Nodes][4] | [All Other Registered Nodes][5] | Description | +| ------------------------------------------------ | ------------------------------------------------ | ---------------- | ------------------- | ------------------- | -------------------| ------------------------------------------------------------------ | +| [Cordon](#cordoning-a-node) | ✓ | ✓ | ✓ | ✓ | ✓ | Marks the node as unschedulable. | +| [Drain](#draining-a-node) | ✓ | ✓ | ✓ | ✓ | ✓ | Marks the node as unschedulable _and_ evicts all pods. | +| [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | ✓ | ✓ | Enter a custom name, description, label, or taints for a node. | +| [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | ✓ | ✓ | View API data. | +| [Delete](#deleting-a-node) | ✓ | ✓ | | * | * | Deletes defective nodes from the cluster. | +| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | | Download SSH key in order to SSH into the node. | +| [Node Scaling](#scaling-nodes) | ✓ | | | ✓ | | Scale the number of nodes in the node pool up or down. | -| Option | [Nodes Hosted by an Infrastructure Provider][1] | [Custom Node][2] | [Hosted Cluster][3] | [Registered Nodes][4] | Description | -| ------------------------------------------------ | ------------------------------------------------ | ---------------- | ------------------- | ------------------- | ------------------------------------------------------------------ | -| [Cordon](#cordoning-a-node) | ✓ | ✓ | ✓ | | Marks the node as unschedulable. | -| [Drain](#draining-a-node) | ✓ | ✓ | ✓ | | Marks the node as unschedulable _and_ evicts all pods. | -| [Edit](#managing-and-editing-individual-nodes) | ✓ | ✓ | ✓ | | Enter a custom name, description, label, or taints for a node. | -| [View API](#viewing-a-node-in-the-rancher-api) | ✓ | ✓ | ✓ | | View API data. | -| [Delete](#deleting-a-node) | ✓ | ✓ | | | Deletes defective nodes from the cluster. | -| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | Download SSH key for in order to SSH into the node. | -| [Node Scaling](#scaling-nodes) | ✓ | | | | Scale the number of nodes in the node pool up or down. | +[1]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ +[2]: {{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/ +[3]: {{}}/rancher/v2.x/en/cluster-provisioning/hosted-kubernetes-clusters/ +[4]: {{}}/rancher/v2.x/en/cluster-provisioning/registered-clusters/ +[5]: {{}}/rancher/v2.x/en/cluster-provisioning/registered-clusters/ + +\* Delete option accessible via View API -[1]: {{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ -[2]: {{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes/ -[3]: {{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/ -[4]: {{}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/ ### Nodes Hosted by an Infrastructure Provider @@ -59,9 +62,9 @@ Rancher uses [node templates]({{}}/rancher/v2.5/en/cluster-provisioning Options for managing nodes [hosted by a Kubernetes provider]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/) are somewhat limited in Rancher. Rather than using the Rancher UI to make edits such as scaling the number of nodes up or down, edit the cluster directly. -### Imported Nodes +### Registered Nodes -Although you can deploy workloads to an [imported cluster]({{< baseurl >}}/rancher/v2.5/en/cluster-provisioning/imported-clusters/) using Rancher, you cannot manage individual cluster nodes. All management of imported cluster nodes must take place outside of Rancher. +Although you can deploy workloads to a [registered cluster]({{< baseurl >}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/) using Rancher, you cannot manage individual cluster nodes. All management of imported cluster nodes must take place outside of Rancher. # Managing and Editing Individual Nodes From d6e1acf84489c65b398789130063afe2b5b09490 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Fri, 5 Mar 2021 00:14:48 -0700 Subject: [PATCH 22/33] Update monitoring v1 port requirements in v2.0-v2.4 docs #3082 --- .../cluster-admin/tools/cluster-monitoring/_index.md | 11 ++++++++++- .../v2.0.x-v2.4.x/cluster-monitoring/_index.md | 3 ++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/_index.md b/content/rancher/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/_index.md index a85de802964..6e376e0c10d 100644 --- a/content/rancher/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/_index.md +++ b/content/rancher/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/_index.md @@ -53,7 +53,16 @@ Using Prometheus, you can monitor Rancher at both the cluster level and [project As an [administrator]({{}}/rancher/v2.0-v2.4/en/admin-settings/rbac/global-permissions/) or [cluster owner]({{}}/rancher/v2.0-v2.4/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster. -> **Prerequisite:** Make sure that you are allowing traffic on port 9796 for each of your nodes because Prometheus will scrape metrics from here. +> **Prerequisite:** The following TCP ports need to be opened for metrics scraping: +> +> | Port | Node type | Component | +> | --- | --- | --- | +> | 9796 | Worker | Node exporter | +> | 10254 | Worker | Nginx Ingress Controller | +> | 10250 | Worker/Controlplane | Kubelet | +> | 10251 | Controlplane | Kube scheduler | +> | 10252 | Controlplane | Kube controller manager | +> | 2379 | Etcd | Etcd server | 1. From the **Global** view, navigate to the cluster that you want to configure cluster monitoring. diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md index 88be5ee1c7c..0ef3328ff6d 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/_index.md @@ -54,7 +54,8 @@ Using Prometheus, you can monitor Rancher at both the cluster level and [project As an [administrator]({{}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/) or [cluster owner]({{}}/rancher/v2.x/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster. -> **Prerequisite:** The following TCP ports need to be opened for metrics scraping +> **Prerequisite:** The following TCP ports need to be opened for metrics scraping: +> > | Port | Node type | Component | > | --- | --- | --- | > | 9796 | Worker | Node exporter | From a173b9d921fec42c45709cede43056301a563b53 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Fri, 5 Mar 2021 01:39:53 -0700 Subject: [PATCH 23/33] Fix links --- content/rancher/v2.5/en/backups/_index.md | 2 +- content/rancher/v2.5/en/backups/migrating-rancher/_index.md | 2 -- content/rancher/v2.5/en/backups/restoring-rancher/_index.md | 2 +- .../v2.5/en/cluster-admin/cleaning-cluster-nodes/_index.md | 2 ++ .../v2.5/en/cluster-admin/editing-clusters/_index.md | 4 +++- .../vsphere/out-of-tree/vsphere-volume-migration/_index.md | 2 -- content/rancher/v2.5/en/installation/_index.md | 2 +- .../v2.5/en/installation/install-rancher-on-k8s/_index.md | 2 +- .../install-rancher-on-k8s/chart-options/_index.md | 4 ++-- .../installation/install-rancher-on-k8s/rollbacks/_index.md | 2 +- .../installation/install-rancher-on-k8s/upgrades/_index.md | 6 ++---- .../install-rancher-on-linux/upgrades/_index.md | 2 +- .../en/installation/other-installation-methods/_index.md | 2 +- .../air-gap/install-rancher/_index.md | 4 +++- .../air-gap/launch-kubernetes/_index.md | 2 +- .../air-gap/populate-private-registry/_index.md | 1 + .../air-gap/prepare-nodes/_index.md | 2 +- .../other-installation-methods/single-node-docker/_index.md | 2 +- .../single-node-docker/single-node-upgrades/_index.md | 2 +- content/rancher/v2.5/en/overview/architecture/_index.md | 2 +- .../v2.x/en/installation/install-rancher-on-k8s/_index.md | 2 +- 21 files changed, 26 insertions(+), 25 deletions(-) diff --git a/content/rancher/v2.5/en/backups/_index.md b/content/rancher/v2.5/en/backups/_index.md index b641ed7a26d..4b64fec0272 100644 --- a/content/rancher/v2.5/en/backups/_index.md +++ b/content/rancher/v2.5/en/backups/_index.md @@ -104,7 +104,7 @@ A restore is performed by creating a Restore custom resource. For a tutorial, re # Migrating Rancher to a New Cluster -A migration is performed by following [these steps.](./migrating-rancher) +A migration is performed by following [these steps.]({{}}/rancher/v2.5/en/backups/migrating-rancher) # Default Storage Location Configuration diff --git a/content/rancher/v2.5/en/backups/migrating-rancher/_index.md b/content/rancher/v2.5/en/backups/migrating-rancher/_index.md index dce088d68da..1295c7c0940 100644 --- a/content/rancher/v2.5/en/backups/migrating-rancher/_index.md +++ b/content/rancher/v2.5/en/backups/migrating-rancher/_index.md @@ -1,8 +1,6 @@ --- title: Migrating Rancher to a New Cluster weight: 3 -aliases: - - /rancher/v2.5/en/backups/v2.5/migrating-rancher --- If you are migrating Rancher to a new Kubernetes cluster, you don't need to install Rancher on the new cluster first. If Rancher is restored to a new cluster with Rancher already installed, it can cause problems. diff --git a/content/rancher/v2.5/en/backups/restoring-rancher/_index.md b/content/rancher/v2.5/en/backups/restoring-rancher/_index.md index 216526cab48..25dec398402 100644 --- a/content/rancher/v2.5/en/backups/restoring-rancher/_index.md +++ b/content/rancher/v2.5/en/backups/restoring-rancher/_index.md @@ -10,7 +10,7 @@ A restore is performed by creating a Restore custom resource. > **Important** > -> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.](../migrating-rancher) +> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.]({{}}/rancher/v2.5/en/backups/migrating-rancher) > * While restoring rancher on the same setup, the operator will scale down the rancher deployment when restore starts, and it will scale back up the deployment once restore completes. So Rancher will be unavailable during the restore. ### Create the Restore Custom Resource diff --git a/content/rancher/v2.5/en/cluster-admin/cleaning-cluster-nodes/_index.md b/content/rancher/v2.5/en/cluster-admin/cleaning-cluster-nodes/_index.md index c365b057e1e..59f8087da31 100644 --- a/content/rancher/v2.5/en/cluster-admin/cleaning-cluster-nodes/_index.md +++ b/content/rancher/v2.5/en/cluster-admin/cleaning-cluster-nodes/_index.md @@ -2,6 +2,8 @@ title: Removing Kubernetes Components from Nodes description: Learn about cluster cleanup when removing nodes from your Rancher-launched Kubernetes cluster. What is removed, how to do it manually weight: 2055 +aliases: + - /rancher/v2.5/en/faq/cleaning-cluster-nodes/ --- This section describes how to disconnect a node from a Rancher-launched Kubernetes cluster and remove all of the Kubernetes components from the node. This process allows you to use the node for other purposes. diff --git a/content/rancher/v2.5/en/cluster-admin/editing-clusters/_index.md b/content/rancher/v2.5/en/cluster-admin/editing-clusters/_index.md index 6886a19909f..011d4e92b1f 100644 --- a/content/rancher/v2.5/en/cluster-admin/editing-clusters/_index.md +++ b/content/rancher/v2.5/en/cluster-admin/editing-clusters/_index.md @@ -1,6 +1,8 @@ --- title: Cluster Configuration weight: 2025 +aliases: + - /rancher/v2.5/en/k8s-in-rancher/editing-clusters --- After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. @@ -36,7 +38,7 @@ Option | Description | Nginx Ingress | If you want to publish your applications in a high-availability configuration, and you're hosting your nodes with a cloud-provider that doesn't have a native load-balancing feature, enable this option to use Nginx ingress within the cluster. | Metrics Server Monitoring | Each cloud provider capable of launching a cluster using RKE can collect metrics and monitor for your cluster nodes. Enable this option to view your node metrics from your cloud provider's portal. | Pod Security Policy Support | Enables [pod security policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/) for the cluster. After enabling this option, choose a policy using the **Default Pod Security Policy** drop-down. | - Docker version on nodes | Configures whether nodes are allowed to run versions of Docker that Rancher doesn't officially support. If you choose to require a [supported Docker version]({{}}/rancher/v2.5/en/installation/options/rke-add-on/layer-7-lb/), Rancher will stop pods from running on nodes that don't have a supported Docker version installed. | + Docker version on nodes | Configures whether nodes are allowed to run versions of Docker that Rancher doesn't officially support. If you choose to require a supported Docker version, Rancher will stop pods from running on nodes that don't have a supported Docker version installed. | Docker Root Directory | The directory on your cluster nodes where you've installed Docker. If you install Docker on your nodes to a non-default directory, update this path. | Default Pod Security Policy | If you enable **Pod Security Policy Support**, use this drop-down to choose the pod security policy that's applied to the cluster. | Cloud Provider | If you're using a cloud provider to host cluster nodes launched by RKE, enable [this option]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) so that you can use the cloud provider's native features. If you want to store persistent data for your cloud-hosted cluster, this option is required. | diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md index 7db29d7ee14..0582fb22bc9 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md @@ -1,8 +1,6 @@ --- title: Migrating vSphere In-tree Volumes to CSI weight: 5 -aliases: - - /rancher/v2.x/en/installation/install-rancher-on-k8s/migrating-rancher --- _Available as of v2.5+_ diff --git a/content/rancher/v2.5/en/installation/_index.md b/content/rancher/v2.5/en/installation/_index.md index f06e3c805cb..30bb37a6564 100644 --- a/content/rancher/v2.5/en/installation/_index.md +++ b/content/rancher/v2.5/en/installation/_index.md @@ -56,7 +56,7 @@ However, this option is useful if you want to save resources by using a single n For test and demonstration purposes, Rancher can be installed with Docker on a single node. -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.]({{}}/rancher/v2.5/en/backups/v2.5/migrating-rancher/) +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.]({{}}/rancher/v2.5/en/backups/migrating-rancher) ### Other Options diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md index e1585cae32a..075b6a8c492 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md @@ -22,7 +22,7 @@ For the tutorial to install an RKE Kubernetes cluster, refer to [this page.]({{< For the tutorial to install a K3s Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-with-external-db) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db) -For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-RKE2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) +For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) # Install the Rancher Helm Chart diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/_index.md index 64b3b5b6804..c9b49d57ac3 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/_index.md @@ -77,13 +77,13 @@ For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.5/en/installation/api-auditing/). -You can collect this log as you would any container log. Enable the [Logging service under Rancher Tools]({{}}/rancher/v2.5/en/cluster-admin/tools/logging/) for the `System` Project on the Rancher server cluster. +You can collect this log as you would any container log. Enable [logging]({{}}/rancher/v2.5/en/logging) for the `System` Project on the Rancher server cluster. ```plain --set auditLog.level=1 ``` -By default enabling Audit Logging will create a sidecar container in the Rancher pod. This container (`rancher-audit-log`) will stream the log to `stdout`. You can collect this log as you would any container log. When using the sidecar as the audit log destination, the `hostPath`, `maxAge`, `maxBackups`, and `maxSize` options do not apply. It's advised to use your OS or Docker daemon's log rotation features to control disk space use. Enable the [Logging service under Rancher Tools]({{}}/rancher/v2.5/en/cluster-admin/tools/logging/) for the Rancher server cluster or System Project. +By default enabling Audit Logging will create a sidecar container in the Rancher pod. This container (`rancher-audit-log`) will stream the log to `stdout`. You can collect this log as you would any container log. When using the sidecar as the audit log destination, the `hostPath`, `maxAge`, `maxBackups`, and `maxSize` options do not apply. It's advised to use your OS or Docker daemon's log rotation features to control disk space use. Enable [logging]({{}}/rancher/v2.5/en/logging) for the Rancher server cluster or System Project. Set the `auditLog.destination` to `hostPath` to forward logs to volume shared with the host system instead of streaming to a sidecar container. When setting the destination to `hostPath` you may want to adjust the other auditLog parameters for log rotation. diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md index e777477c8a8..acf3b933318 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/rollbacks/_index.md @@ -24,7 +24,7 @@ A restore is performed by creating a Restore custom resource. > **Important** > -> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.](../migrating-rancher) +> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.]({{}}/rancher/v2.5/en/backups/migrating-rancher) > * While restoring rancher on the same setup, the operator will scale down the rancher deployment when restore starts, and it will scale back up the deployment once restore completes. So Rancher will be unavailable during the restore. ### Create the Restore Custom Resource diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/_index.md index 45abf811aaa..b924a20ee13 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/_index.md @@ -24,8 +24,6 @@ For the instructions to upgrade Rancher installed with Docker, refer to [ths pag To upgrade the components in your Kubernetes cluster, or the definition of the [Kubernetes services]({{}}/rke/latest/en/config-options/services/) or [add-ons]({{}}/rke/latest/en/config-options/add-ons/), refer to the [upgrade documentation for RKE]({{}}/rke/latest/en/upgrades/), the Rancher Kubernetes Engine. -If you installed Rancher using the RKE Add-on yaml, follow the directions to [migrate or upgrade]({{}}/rancher/v2.5/en/upgrades/upgrades/migrating-from-rke-add-on). - - [Prerequisites](#prerequisites) - [Upgrade Outline](#upgrade-outline) - [Known Upgrade Issues](#known-upgrade-issues) @@ -51,7 +49,7 @@ Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository]({{ The upgrade instructions assume you are using Helm 3. -For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here]({{}}/rancher/v2.5/en/installation/upgrades-rollbacks/upgrades/ha/helm2)provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. +For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here]({{}}/rancher/v2.0-v2.4/en/installation/upgrades-rollbacks/upgrades/ha/helm2)provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. ### For air gap installs: Populate private registry @@ -258,7 +256,7 @@ Log into Rancher to confirm that the upgrade succeeded. >**Having network issues following upgrade?** > -> See [Restoring Cluster Networking]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/namespace-migration/#restoring-cluster-networking). +> See [Restoring Cluster Networking]({{}}/rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/namespace-migration). # Known Upgrade Issues diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-linux/upgrades/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-linux/upgrades/_index.md index d8dbc6e54c2..4700c807d82 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-linux/upgrades/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-linux/upgrades/_index.md @@ -37,7 +37,7 @@ To upgrade Rancher without upgrading the underlying Kubernetes cluster, follow t **Result:** Rancher is upgraded to the new version. -If necessary, restore Rancher from backup by following [these steps.]({{}}/rancher/v2.5/en/backups/v2.5/restoring-rancher/) +If necessary, restore Rancher from backup by following [these steps.]({{}}/rancher/v2.5/en/backups/restoring-rancher/) ### Upgrading Both Rancher and the Underlying Cluster diff --git a/content/rancher/v2.5/en/installation/other-installation-methods/_index.md b/content/rancher/v2.5/en/installation/other-installation-methods/_index.md index e9e4a84f9b7..20b34efef95 100644 --- a/content/rancher/v2.5/en/installation/other-installation-methods/_index.md +++ b/content/rancher/v2.5/en/installation/other-installation-methods/_index.md @@ -17,4 +17,4 @@ The Docker installation is for development and testing environments only. Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. -For 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.]({{}}/rancher/v2.5/en/backups/v2.5/migrating-rancher/) \ No newline at end of file +For 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.]({{}}/rancher/v2.5/en/backups/migrating-rancher) \ No newline at end of file diff --git a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/install-rancher/_index.md b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/install-rancher/_index.md index 9f9bda5c791..7bb8227939f 100644 --- a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/install-rancher/_index.md +++ b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/install-rancher/_index.md @@ -6,6 +6,8 @@ aliases: - /rancher/v2.5/en/installation/air-gap-high-availability/config-rancher-for-private-reg/ - /rancher/v2.5/en/installation/air-gap-single-node/install-rancher - /rancher/v2.5/en/installation/air-gap/install-rancher + - /rancher/v2.5/en/installation/air-gap-installation/install-rancher/ + - /rancher/v2.5/en/installation/air-gap-high-availability/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. @@ -234,7 +236,7 @@ The Docker installation is for Rancher users who want to test out Rancher. Instead of running on a Kubernetes cluster, you install the Rancher server component on a single node using a `docker run` command. Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. -For Rancher v2.5+, the backup application can be used to migrate the Rancher server from a Docker install to a Kubernetes install using [these steps.]({{}}/rancher/v2.5/en/backups/v2.5/migrating-rancher/) +For Rancher v2.5+, the backup application can be used to migrate the Rancher server from a Docker install to a Kubernetes install using [these steps.]({{}}/rancher/v2.5/en/backups/migrating-rancher) 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. diff --git a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md index 060ac2c5513..d30cfd006ef 100644 --- a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md +++ b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md @@ -151,7 +151,7 @@ From a system that can access ports 22/TCP and 6443/TCP on the Linux host node(s This file is an RKE configuration file, which is a configuration for the cluster you're deploying Rancher to. -Replace values in the code sample below with help of the _RKE Options_ table. Use the IP address or DNS names of the [3 nodes]({{}}/rancher/v2.5/en/installation/air-gap-high-availability/provision-hosts) you created. +Replace values in the code sample below with help of the _RKE Options_ table. Use the IP address or DNS names of the three nodes you created. > **Tip:** For more details on the options available, see the RKE [Config Options]({{}}/rke/latest/en/config-options/). diff --git a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md index 7e151ea2169..6a42b228665 100644 --- a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md +++ b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md @@ -6,6 +6,7 @@ aliases: - /rancher/v2.5/en/installation/air-gap-single-node/prepare-private-registry/ - /rancher/v2.5/en/installation/air-gap-single-node/config-rancher-for-private-reg/ - /rancher/v2.5/en/installation/air-gap-high-availability/config-rancher-for-private-reg/ + - /rancher/v2.5/en/installation/air-gap-installation/prepare-private-reg/ --- This section describes how to set up your private registry so that when you install Rancher, Rancher will pull all the required images from this registry. diff --git a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md index 12ebec1ae38..0d21d8ca329 100644 --- a/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md +++ b/content/rancher/v2.5/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md @@ -152,7 +152,7 @@ If you need help with creating a private registry, please refer to the [official {{% tab "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.]({{}}/rancher/v2.5/en/backups/v2.5/migrating-rancher/) +> 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.]({{}}/rancher/v2.5/en/backups/migrating-rancher) ### 1. Set up a Linux Node diff --git a/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/_index.md b/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/_index.md index 1f04b96c900..14aaba60458 100644 --- a/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/_index.md +++ b/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/_index.md @@ -17,7 +17,7 @@ In this installation scenario, you'll install Docker on a single Linux host, and A Docker installation of Rancher is recommended only for development and testing purposes. The ability to migrate Rancher to a high-availability cluster depends on the Rancher version: -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.]({{}}/rancher/v2.5/en/backups/v2.5/migrating-rancher/) +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.]({{}}/rancher/v2.5/en/backups/migrating-rancher) ### Privileged Access for Rancher v2.5+ diff --git a/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md b/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md index 18dac27f2ae..a4b9b4b9583 100644 --- a/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md +++ b/content/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md @@ -352,7 +352,7 @@ Log into Rancher. Confirm that the upgrade succeeded by checking the version dis >**Having network issues in your user clusters following upgrade?** > -> See [Restoring Cluster Networking]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/namespace-migration/#restoring-cluster-networking). +> See [Restoring Cluster Networking]({{}}/rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/namespace-migration). # 6. Clean up Your Old Rancher Server Container diff --git a/content/rancher/v2.5/en/overview/architecture/_index.md b/content/rancher/v2.5/en/overview/architecture/_index.md index 301e5399e0e..6ec1dfd588b 100644 --- a/content/rancher/v2.5/en/overview/architecture/_index.md +++ b/content/rancher/v2.5/en/overview/architecture/_index.md @@ -45,7 +45,7 @@ A high-availability Kubernetes installation is recommended for production. A Docker installation of Rancher is recommended only for development and testing purposes. The ability to migrate Rancher to a high-availability cluster depends on the Rancher version: -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.]({{}}/rancher/v2.5/en/backups/v2.5/migrating-rancher/) +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.]({{}}/rancher/v2.5/en/backups/migrating-rancher) The Rancher server, regardless of the installation method, should always run on nodes that are separate from the downstream user clusters that it manages. If Rancher is installed on a high-availability Kubernetes cluster, it should run on a separate cluster from the cluster(s) it manages. diff --git a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md index f572486e857..82c45d4cd7e 100644 --- a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md +++ b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md @@ -24,7 +24,7 @@ For the tutorial to install an RKE Kubernetes cluster, refer to [this page.]({{< For the tutorial to install a K3s Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/ha-with-external-db) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db) -For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/ha-RKE2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) +For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/ha-rke2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) # Install the Rancher Helm Chart From 297a7e379b85bd2cd5e804f29ebbea48e15441eb Mon Sep 17 00:00:00 2001 From: David Noland Date: Mon, 8 Mar 2021 11:57:35 -0800 Subject: [PATCH 24/33] Single command to follow the restore logs --- .../v2.x/en/backups/v2.5/restoring-rancher/_index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md b/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md index 65721283c33..935b27fec38 100644 --- a/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md +++ b/content/rancher/v2.x/en/backups/v2.5/restoring-rancher/_index.md @@ -50,11 +50,10 @@ A restore is performed by creating a Restore custom resource. ### Logs -To check how the restore is progressing, you can check the logs of the operator. Follow these steps to get the logs: +To check how the restore is progressing, you can check the logs of the operator. Run this command to follow the logs: -```yaml -kubectl get pods -n cattle-resources-system -kubectl logs -n cattle-resources-system -f +``` +kubectl logs -n cattle-resources-system -l app.kubernetes.io/name=rancher-backup -f ``` ### Cleanup From 70eeb7a19117f56d4473e4cd9314fb996b69d736 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Mon, 8 Mar 2021 13:44:27 -0700 Subject: [PATCH 25/33] Add command to follow restore logs to versioned docs #3098 --- .../rancher/v2.5/en/backups/restoring-rancher/_index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/rancher/v2.5/en/backups/restoring-rancher/_index.md b/content/rancher/v2.5/en/backups/restoring-rancher/_index.md index 25dec398402..64830e652aa 100644 --- a/content/rancher/v2.5/en/backups/restoring-rancher/_index.md +++ b/content/rancher/v2.5/en/backups/restoring-rancher/_index.md @@ -50,12 +50,11 @@ A restore is performed by creating a Restore custom resource. ### Logs -To check how the restore is progressing, you can check the logs of the operator. Follow these steps to get the logs: +To check how the restore is progressing, you can check the logs of the operator. Run this command to follow the logs: -```yaml -kubectl get pods -n cattle-resources-system -kubectl logs -n cattle-resources-system -f ``` +kubectl logs -n cattle-resources-system -l app.kubernetes.io/name=rancher-backup -f + ### Cleanup From 920ccbd7a165468363bf35ed0e7f64bb8e9ca968 Mon Sep 17 00:00:00 2001 From: Tejeev Date: Tue, 9 Mar 2021 18:22:42 +0000 Subject: [PATCH 26/33] fixed internal link to alertmanager config example --- .../v2.5/configuration/alertmanager/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md index 1862398d06e..f1b27fd89a4 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md @@ -19,7 +19,7 @@ The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configurati - [Receiver](#receiver) - [Grouping](#grouping) - [Matching](#matching) -- [Example Alertmanager YAML](#example-alertmanager-yaml) +- [Example Alertmanager config](#example-alertmanager-config) - [Example Route Config for CIS Scan Alerts](#example-route-config-for-cis-scan-alerts) # Overview @@ -232,4 +232,4 @@ spec: # key: string ``` -For more information on enabling alerting for `rancher-cis-benchmark`, see [this section.]({{}}/rancher/v2.x/en/cis-scans/v2.5/#enabling-alerting-for-rancher-cis-benchmark) \ No newline at end of file +For more information on enabling alerting for `rancher-cis-benchmark`, see [this section.]({{}}/rancher/v2.x/en/cis-scans/v2.5/#enabling-alerting-for-rancher-cis-benchmark) From fe93793315d85d59c0d8bbf5cb8a3c539d86ce2f Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 9 Mar 2021 10:34:32 -0800 Subject: [PATCH 27/33] Fix link formatting and typo --- .../installation/resources/k8s-tutorials/ha-rke2/_index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md b/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md index e112e1dfed7..2e9115d294a 100644 --- a/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md +++ b/content/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/_index.md @@ -2,7 +2,7 @@ title: Setting up a High-availability RKE2 Kubernetes Cluster for Rancher shortTitle: Set up RKE2 for Rancher weight: 2 -aliases; +aliases: - /rancher/v2.x/en/installation/resources/k8s-tutorials/ha-RKE2 --- _Tested on v2.5.6_ @@ -11,7 +11,7 @@ This section describes how to install a Kubernetes cluster according to the [bes # Prerequisites -These instructions assume you have set up three nodes, a load balancer, a DNS record, [this section.](({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) +These instructions assume you have set up three nodes, a load balancer, and a DNS record as described [this section.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) Note that in order for RKE2 to work correctly with the load balancer, you need to set up two listeners: one for the supervisor on port 9345, and one for the Kubernetes API on port 6443. @@ -178,4 +178,4 @@ spec: image: repository: us.gcr.io/k8s-artifacts-prod/ingress-nginx/controller tag: "v0.34.1" -``` \ No newline at end of file +``` From 5a0f122973da120fbea0627d4bdeb969c70ecbde Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 10 Mar 2021 11:23:13 -0700 Subject: [PATCH 28/33] Clarify that Rancher backup app is installed in local cluster --- content/rancher/v2.5/en/backups/back-up-rancher/_index.md | 4 +++- .../rancher/v2.x/en/backups/v2.5/back-up-rancher/_index.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.5/en/backups/back-up-rancher/_index.md b/content/rancher/v2.5/en/backups/back-up-rancher/_index.md index 70d6786b3da..661bbfbb13a 100644 --- a/content/rancher/v2.5/en/backups/back-up-rancher/_index.md +++ b/content/rancher/v2.5/en/backups/back-up-rancher/_index.md @@ -7,6 +7,8 @@ aliases: In this section, you'll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer the instructions for [single node backups]({{}}/rancher/v2.5/en/backups/v2.5/docker-installs/docker-backups) +The backup-restore operator needs to be installed in the local cluster, and only backs up the Rancher app. The backup and restore operations are performed only in the local Kubernetes cluster. + ### Prerequisites Rancher version must be v2.5.0 and up @@ -17,7 +19,7 @@ The backup storage location is an operator-level setting, so it needs to be conf Backups are created as .tar.gz files. These files can be pushed to S3 or Minio, or they can be stored in a persistent volume. -1. In the Rancher UI, go to the **Cluster Explorer.** +1. In the Rancher UI, go to the **Cluster Explorer** view for the local cluster. 1. Click **Apps.** 1. Click **Rancher Backups.** 1. Configure the default storage location. For help, refer to the [storage configuration section.](../configuration/storage-config) diff --git a/content/rancher/v2.x/en/backups/v2.5/back-up-rancher/_index.md b/content/rancher/v2.x/en/backups/v2.5/back-up-rancher/_index.md index 6edbbc9cd15..c3761261a32 100644 --- a/content/rancher/v2.x/en/backups/v2.5/back-up-rancher/_index.md +++ b/content/rancher/v2.x/en/backups/v2.5/back-up-rancher/_index.md @@ -7,6 +7,8 @@ aliases: In this section, you'll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer the instructions for [single node backups]({{}}/rancher/v2.x/en/backups/v2.5/docker-installs/docker-backups) +The backup-restore operator needs to be installed in the local cluster, and only backs up the Rancher app. The backup and restore operations are performed only in the local Kubernetes cluster. + ### Prerequisites Rancher version must be v2.5.0 and up @@ -17,7 +19,7 @@ The backup storage location is an operator-level setting, so it needs to be conf Backups are created as .tar.gz files. These files can be pushed to S3 or Minio, or they can be stored in a persistent volume. -1. In the Rancher UI, go to the **Cluster Explorer.** +1. In the Rancher UI, go to the **Cluster Explorer** view for the local cluster. 1. Click **Apps.** 1. Click **Rancher Backups.** 1. Configure the default storage location. For help, refer to the [storage configuration section.](../configuration/storage-config) From ff1369edac29eb5530b8e7deef5a16ed5ba6bb97 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 10 Mar 2021 14:34:38 -0700 Subject: [PATCH 29/33] Fix internal link --- .../en/monitoring-alerting/configuration/alertmanager/_index.md | 2 +- .../v2.5/configuration/alertmanager/_index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md b/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md index 0fcac6d9aac..febc6aa22d3 100644 --- a/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md +++ b/content/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/_index.md @@ -24,7 +24,7 @@ The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configurati - [Receiver](#receiver) - [Grouping](#grouping) - [Matching](#matching) -- [Example Alertmanager YAML](#example-alertmanager-yaml) +- [Example Alertmanager Config](#example-alertmanager-config) - [Example Route Config for CIS Scan Alerts](#example-route-config-for-cis-scan-alerts) # Overview diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md index f1b27fd89a4..9b8ef4cf9b4 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md @@ -19,7 +19,7 @@ The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configurati - [Receiver](#receiver) - [Grouping](#grouping) - [Matching](#matching) -- [Example Alertmanager config](#example-alertmanager-config) +- [Example Alertmanager Config](#example-alertmanager-config) - [Example Route Config for CIS Scan Alerts](#example-route-config-for-cis-scan-alerts) # Overview From a946af7c56e9db42d22d48008e83ffdff8218184 Mon Sep 17 00:00:00 2001 From: Sascha Marcel Schmidt Date: Sat, 13 Mar 2021 16:24:26 +0100 Subject: [PATCH 30/33] mention maintain-only-as-essential mode --- content/os/v1.x/en/_index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/os/v1.x/en/_index.md b/content/os/v1.x/en/_index.md index d42a627a00c..506f3a9d511 100644 --- a/content/os/v1.x/en/_index.md +++ b/content/os/v1.x/en/_index.md @@ -5,6 +5,9 @@ description: RancherOS is a simplified Linux distribution built from containers, weight: 1 --- +**RancherOS 1.x is currently in a maintain-only-as-essential mode.** +That is to say, it is no longer being actively maintained at a code level other than addressing critical or security fixes. + RancherOS is the smallest, easiest way to run Docker in production. Every process in RancherOS is a container managed by Docker. This includes system services such as `udev` and `syslog`. Because it only includes the services necessary to run Docker, RancherOS is significantly smaller than most traditional operating systems. By removing unnecessary libraries and services, requirements for security patches and other maintenance are also reduced. This is possible because, with Docker, users typically package all necessary libraries into their containers. Another way in which RancherOS is designed specifically for running Docker is that it always runs the latest version of Docker. This allows users to take advantage of the latest Docker capabilities and bug fixes. From ca1e7e5f3498238fb7a086b775983885744450cf Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Mon, 15 Mar 2021 16:18:28 -0700 Subject: [PATCH 31/33] Fix links --- .../v2.5/en/best-practices/rancher-managed/monitoring/_index.md | 2 +- .../v2.5/en/installation/resources/tls-secrets/_index.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/content/rancher/v2.5/en/best-practices/rancher-managed/monitoring/_index.md b/content/rancher/v2.5/en/best-practices/rancher-managed/monitoring/_index.md index 2db151bfe1e..24faff8755c 100644 --- a/content/rancher/v2.5/en/best-practices/rancher-managed/monitoring/_index.md +++ b/content/rancher/v2.5/en/best-practices/rancher-managed/monitoring/_index.md @@ -7,7 +7,7 @@ aliases: Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier. -The [Rancher Documentation]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/) describes in detail, how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this. +The [Rancher monitoring documentation]({{}}/rancher/v2.5/en/monitoring-alerting/) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this. - [What to Monitor](#what-to-monitor) - [Configuring Prometheus Resource Usage](#configuring-prometheus-resource-usage) diff --git a/content/rancher/v2.5/en/installation/resources/tls-secrets/_index.md b/content/rancher/v2.5/en/installation/resources/tls-secrets/_index.md index 8a06eba99c6..351bc9ed879 100644 --- a/content/rancher/v2.5/en/installation/resources/tls-secrets/_index.md +++ b/content/rancher/v2.5/en/installation/resources/tls-secrets/_index.md @@ -1,6 +1,8 @@ --- title: Adding TLS Secrets weight: 2 +aliases: + - /rancher/v2.5/en/installation/resources/encryption/tls-secrets/ --- Kubernetes will create all the objects and services for Rancher, but it will not become available until we populate the `tls-rancher-ingress` secret in the `cattle-system` namespace with the certificate and key. From bfe574d8c588a854fc7704e9f69f8f330855f3ad Mon Sep 17 00:00:00 2001 From: Marcel Sinn Date: Tue, 16 Mar 2021 18:54:21 +0100 Subject: [PATCH 32/33] Typo Cleanup --- content/rancher/v2.x/en/logging/v2.5/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/rancher/v2.x/en/logging/v2.5/_index.md b/content/rancher/v2.x/en/logging/v2.5/_index.md index 242aaa11710..b13e3b427aa 100644 --- a/content/rancher/v2.x/en/logging/v2.5/_index.md +++ b/content/rancher/v2.x/en/logging/v2.5/_index.md @@ -103,7 +103,7 @@ spec: scheme: http ``` -We have created this cluster output, without elasticsearch configuration, in the same namespace as our operator: `cattle-logging-system.`. Any time we create a cluster flow or cluster output, we have to put it in the `cattle-logging-system` namespace. +We have created this cluster output, without elasticsearch configuration, in the same namespace as our operator: `cattle-logging-system`. Any time we create a cluster flow or cluster output, we have to put it in the `cattle-logging-system` namespace. Now that we have configured where we want the logs to go, let's configure all logs to go to that output. From 18b81a5467a2993fc58e888c8d5b0fa79987ea30 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Tue, 16 Mar 2021 11:43:40 -0700 Subject: [PATCH 33/33] Link to support doc in RancherOS overview --- content/os/v1.x/en/_index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/os/v1.x/en/_index.md b/content/os/v1.x/en/_index.md index 506f3a9d511..55f072a94f5 100644 --- a/content/os/v1.x/en/_index.md +++ b/content/os/v1.x/en/_index.md @@ -5,8 +5,7 @@ description: RancherOS is a simplified Linux distribution built from containers, weight: 1 --- -**RancherOS 1.x is currently in a maintain-only-as-essential mode.** -That is to say, it is no longer being actively maintained at a code level other than addressing critical or security fixes. +> RancherOS 1.x is currently in a maintain-only-as-essential mode. It is no longer being actively maintained at a code level other than addressing critical or security fixes. For more information about the support status of RancherOS, see [this page.](https://support.rancher.com/hc/en-us/articles/360041771072#development-status-0-0) RancherOS is the smallest, easiest way to run Docker in production. Every process in RancherOS is a container managed by Docker. This includes system services such as `udev` and `syslog`. Because it only includes the services necessary to run Docker, RancherOS is significantly smaller than most traditional operating systems. By removing unnecessary libraries and services, requirements for security patches and other maintenance are also reduced. This is possible because, with Docker, users typically package all necessary libraries into their containers.