diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index bed50097307..f228eefae5f 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -22,7 +22,7 @@ jobs: run: yarn install --frozen-lockfile - name: Build website env: - NODE_OPTIONS: "--max_old_space_size=6144" + NODE_OPTIONS: "--max_old_space_size=7168" run: yarn build --no-minify # Popular action to deploy to GitHub Pages: diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml index 4c1907c8c19..39e8fa97909 100644 --- a/.github/workflows/test-deploy.yml +++ b/.github/workflows/test-deploy.yml @@ -19,10 +19,10 @@ jobs: - name: Install dependencies run: yarn install --frozen-lockfile - name: Check Markdown links - run: yarn run remark --quiet --use remark-validate-links ./docs + run: yarn run remark --quiet --frail --use remark-validate-links ./docs - name: Check External links run: yarn run remark --quiet --use remark-lint-no-dead-urls ./docs - name: Test build website env: - NODE_OPTIONS: "--max_old_space_size=6144" + NODE_OPTIONS: "--max_old_space_size=7168" run: yarn build --no-minify \ No newline at end of file diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000000..c25f917946c --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @btat @LucasSaintarbor @martyav @sunilarjun \ No newline at end of file diff --git a/README.md b/README.md index 5fea49ee99f..6e9adbc8dac 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ If a file is moved or renamed, you'll also need to edit the `sidebars.js` files ### Navigate the Repo -The file paths in the repo correspond to the URLs for pages on the docs website. The docs for the latest version of Rancher are located in `/docs`. Most index pages are found within the `/pages-for-subheaders` directory in `/docs`. All images are in `/static/img` in the top level of the repo. Older docs are found within `/versioned_docs` and generally follow the same structure as the files in `/docs`. +The file paths in the repo correspond to the URLs for pages on the docs website. The docs for the latest version of Rancher are located in `/docs`. All images are in `/static/img` in the top level of the repo. Older docs are found within `/versioned_docs` and generally follow the same structure as the files in `/docs`. ### Style & Formatting diff --git a/docs/api/api-reference.mdx b/docs/api/api-reference.mdx index 794b4ad9b91..2ae392ecf47 100644 --- a/docs/api/api-reference.mdx +++ b/docs/api/api-reference.mdx @@ -2,6 +2,10 @@ title: API Reference --- + + + + :::note At this time, not all Rancher resources are available through the Rancher Kubernetes API. diff --git a/docs/api/quickstart.md b/docs/api/quickstart.md index a9acd862973..9ec6a5b4611 100644 --- a/docs/api/quickstart.md +++ b/docs/api/quickstart.md @@ -2,6 +2,10 @@ title: API Quick Start Guide --- + + + + You can access Rancher's resources through the Kubernetes API. This guide will help you get started on using this API as a Rancher user. 1. In the upper left corner, click **☰ > Global Settings**. diff --git a/docs/api/workflows/projects.md b/docs/api/workflows/projects.md index ddc2f8c5aae..549ceff5423 100644 --- a/docs/api/workflows/projects.md +++ b/docs/api/workflows/projects.md @@ -2,6 +2,10 @@ title: Projects --- + + + + ## Creating a Project Project resources may only be created on the management cluster. See below for [creating namespaces under projects in a managed cluster](#creating-a-namespace-in-a-project). @@ -107,3 +111,5 @@ Delete the project under the cluster namespace: ```bash kubectl --namespace c-m-abcde delete project p-vwxyz ``` + +Note that this command doesn't delete the namespaces and resources that formerly belonged to the project. diff --git a/docs/faq/container-network-interface-providers.md b/docs/faq/container-network-interface-providers.md index a8662eaf14a..cb65dd9238d 100644 --- a/docs/faq/container-network-interface-providers.md +++ b/docs/faq/container-network-interface-providers.md @@ -184,8 +184,6 @@ The following table summarizes the different features available for each CNI net ## CNI Community Popularity -import CNIPopularityTable from '/shared-files/_cni-popularity.md'; - ## Which CNI Provider Should I Use? diff --git a/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md b/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md index a9ff741e47a..4448a2d739e 100644 --- a/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md +++ b/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI. diff --git a/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md b/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md index 3932fd5c4b9..6a5107aea05 100644 --- a/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md +++ b/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md @@ -28,10 +28,13 @@ The kubeconfig can also be manually targeted for the intended cluster with the ` Review the list of known issues for each Rancher version, which can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository](../resources/choose-a-rancher-version.md#helm-chart-repositories) aren't supported. + ### Helm Version 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](/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md)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-gapped installs: Populate private registry diff --git a/docs/getting-started/installation-and-upgrade/installation-and-upgrade.md b/docs/getting-started/installation-and-upgrade/installation-and-upgrade.md index f9067e831b7..6a930db2b05 100644 --- a/docs/getting-started/installation-and-upgrade/installation-and-upgrade.md +++ b/docs/getting-started/installation-and-upgrade/installation-and-upgrade.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + This section provides an overview of the architecture options of installing Rancher, describing advantages of each option. diff --git a/docs/getting-started/installation-and-upgrade/installation-references/installation-references.md b/docs/getting-started/installation-and-upgrade/installation-references/installation-references.md index 67a379702cd..ded2dd3a77a 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/installation-references.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/installation-references.md @@ -3,7 +3,7 @@ title: Installation References --- - + Please see the following reference guides for other installation resources: [Rancher Helm chart options](helm-chart-options.md), [TLS settings](tls-settings.md), and [feature flags](feature-flags.md). \ No newline at end of file diff --git a/docs/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md b/docs/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md index d866b032994..9bbc10f9326 100644 --- a/docs/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md +++ b/docs/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md @@ -4,7 +4,7 @@ description: Learn the node requirements for each node running Rancher server wh --- - + This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster. diff --git a/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md b/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md index 792a49a26a4..dda0f2301f4 100644 --- a/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md +++ b/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md @@ -3,7 +3,7 @@ title: Air-Gapped Helm CLI Install --- - + This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. diff --git a/docs/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md b/docs/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md index c5bd443da43..aaca1603ad0 100644 --- a/docs/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md +++ b/docs/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md @@ -3,7 +3,7 @@ title: Other Installation Methods --- - + ### Air Gapped Installations diff --git a/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md b/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md index 9d4a4c8393e..c2a6ace6343 100644 --- a/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md +++ b/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md @@ -10,6 +10,8 @@ Now that you have a running RKE cluster, you can install Rancher in it. For secu ### Install the Helm CLI + + Install the [Helm](https://helm.sh/docs/intro/install/) CLI on a host where you have a kubeconfig to access your Kubernetes cluster: ``` diff --git a/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md b/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md index 39b75558e22..e705d3b4a16 100644 --- a/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md +++ b/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md @@ -3,7 +3,7 @@ title: Installing Rancher behind an HTTP Proxy --- - + In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment. diff --git a/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md b/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md index 049bf762a2a..526b43b682c 100644 --- a/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md +++ b/docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md @@ -4,7 +4,7 @@ description: For development and testing environments only, use a Docker install --- - + Rancher can be installed by running a single Docker container. diff --git a/docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md b/docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md index 8d98fe60458..6118e567f0c 100644 --- a/docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md +++ b/docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md @@ -10,6 +10,8 @@ This section contains the requirements for Helm, which is the tool used to insta > The installation instructions have been updated for 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/) [This section](/versioned_docs/version-2.0-2.4/pages-for-subheaders/helm2.md) provides a copy of the older high-availability Rancher installation instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. + + - Helm v3.2.x or higher is required to install or upgrade Rancher v2.5. - Helm v2.16.0 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using. - Helm v2.15.0 should not be used, because of an issue with converting/comparing numbers. diff --git a/docs/getting-started/installation-and-upgrade/resources/resources.md b/docs/getting-started/installation-and-upgrade/resources/resources.md index 5d4fbf24fc1..b5c215c5755 100644 --- a/docs/getting-started/installation-and-upgrade/resources/resources.md +++ b/docs/getting-started/installation-and-upgrade/resources/resources.md @@ -3,7 +3,7 @@ title: Resources --- - + ### Docker Installations diff --git a/docs/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md b/docs/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md index dd00964ef02..ff5f495f501 100644 --- a/docs/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md +++ b/docs/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md @@ -145,6 +145,8 @@ Before you can perform the upgrade, you must prepare your air gapped environment --set cainjector.image.repository=/quay.io/jetstack/cert-manager-cainjector ``` + + The Helm 2 command is as follows: ```plain diff --git a/docs/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md b/docs/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md index a0500a27747..8da9e993a43 100644 --- a/docs/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md +++ b/docs/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md @@ -1,6 +1,6 @@ --- -title: Rancher AWS Marketplace Quick Start -description: Use Amazon EKS to deploy Rancher server. +title: Rancher Prime AWS Marketplace Quick Start +description: Deploy SUSE Rancher from the AWS Marketplace listing. --- @@ -9,6 +9,6 @@ description: Use Amazon EKS to deploy Rancher server. import YouTube from '@site/src/components/YouTube' -Amazon Elastic Kubernetes Service (EKS) can quickly [deploy Rancher to Amazon Web Services (AWS)](https://documentation.suse.com/trd/kubernetes/single-html/gs_rancher_aws-marketplace/). To learn more, see our [Amazon Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-go7ent7goo5ae). Watch the demo for a walkthrough of AWS Marketplace SUSE Rancher setup: +You can quickly deploy Rancher Prime on Amazon Elastic Kubernetes Service (EKS.) To learn more, see the [instructions](https://suse-enceladus.github.io/marketplace-docs/rancher-prime/aws/?repository=rancher-payg-billing-adapter-llc-prd) under Usage Information in the [AWS Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c). - +# diff --git a/docs/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md b/docs/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md index 2c45cf300ed..af0c27aac71 100644 --- a/docs/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md +++ b/docs/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md @@ -3,7 +3,7 @@ title: Deploying Rancher Server --- - + Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. diff --git a/docs/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md b/docs/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md index e6042decd34..3a7034c05df 100644 --- a/docs/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md +++ b/docs/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md @@ -3,7 +3,7 @@ title: Deploying Workloads --- - + These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. diff --git a/docs/getting-started/quick-start-guides/quick-start-guides.md b/docs/getting-started/quick-start-guides/quick-start-guides.md index 955135a1d48..424fe7d8802 100644 --- a/docs/getting-started/quick-start-guides/quick-start-guides.md +++ b/docs/getting-started/quick-start-guides/quick-start-guides.md @@ -3,7 +3,7 @@ title: Rancher Deployment Quick Start Guides --- - + :::caution diff --git a/docs/how-to-guides/advanced-user-guides/advanced-user-guides.md b/docs/how-to-guides/advanced-user-guides/advanced-user-guides.md index b5b3d241037..68ffc4c7ed3 100644 --- a/docs/how-to-guides/advanced-user-guides/advanced-user-guides.md +++ b/docs/how-to-guides/advanced-user-guides/advanced-user-guides.md @@ -3,7 +3,7 @@ title: Advanced User Guides --- - + Advanced user guides are "problem-oriented" docs in which users learn how to answer questions or solve problems. The major difference between these and the new user guides is that these guides are geared toward more experienced or advanced users who have more technical needs from their documentation. These users already have an understanding of Rancher and its functions. They know what they need to accomplish; they just need additional guidance to complete some more complex task they they have encountered while working. diff --git a/docs/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md b/docs/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md index 790b7e1b6c1..a7c6ed43472 100644 --- a/docs/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md +++ b/docs/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md @@ -3,7 +3,7 @@ title: CIS Scan Guides --- - + - [Install rancher-cis-benchmark](install-rancher-cis-benchmark.md) diff --git a/docs/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md b/docs/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md index 778f2b05451..c829938c3c0 100644 --- a/docs/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md +++ b/docs/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md @@ -3,7 +3,7 @@ title: Enabling Experimental Features --- - + Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an [unsupported storage type](unsupported-storage-drivers.md) outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default. diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md index 4682e638ed0..cbdeee0602b 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md @@ -3,7 +3,7 @@ title: Setup Guide --- - + This section describes how to enable Istio and start using it in your projects. diff --git a/docs/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md b/docs/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md index ca734c02b26..a0ed1060085 100644 --- a/docs/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md +++ b/docs/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md @@ -3,7 +3,7 @@ title: Project 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/docs/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md b/docs/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md index 0b16e16d3bc..1554ad8121e 100644 --- a/docs/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md +++ b/docs/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md @@ -3,7 +3,7 @@ title: Project Administration --- - + _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/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md b/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md index fe129e27bb4..ec292886fb3 100644 --- a/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md +++ b/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md @@ -46,7 +46,7 @@ To use your own dashboard: ### 2. Create a ConfigMap using the Grafana JSON model -Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. cattle-dashboards by default). +Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. `cattle-dashboards` by default). The ConfigMap should look like this: @@ -65,19 +65,26 @@ data: By default, Grafana is configured to watch all ConfigMaps with the `grafana_dashboard` label within the `cattle-dashboards` namespace. -To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section.](#configuring-namespaces-for-the-grafana-dashboard-configmap) +To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section](#configuring-namespaces-for-the-grafana-dashboard-configmap). -To create the ConfigMap in the Rancher UI, +To create the ConfigMap through the Rancher UI, first make sure that you are currently logged in to the Grafana UI, to ensure that dashboards import without encountering permissions issues. Then, return to the Rancher UI and perform the following steps: 1. In the upper left corner, click **☰ > Cluster Management**. 1. On the **Clusters** page, go to the cluster where you want to see the visualizations and click **Explore**. 1. Click **More Resources > Core > ConfigMaps**. 1. Click **Create**. -1. Set up the key-value pairs similar to the example above. When entering the value for `.json`, click **Read from File** to upload the JSON data model as the value. +1. On the **Data** tab, set up the key-value pairs similar to the example above. When entering the value for `.json`, click **Read from File** to upload the JSON data model as the value. +1. On the **Labels & Annotations** tab, click **Add Label** and enter `grafana_dashboard` as the key, and `1` as the value. 1. Click **Create**. **Result:** After the ConfigMap is created, it should show up on the Grafana UI and be persisted even if the Grafana pod is restarted. +:::note + +The actual key-value pair may differ if you have modified the Helm chart to watch a different dashboard label and value. + +::: + Dashboards that are persisted using ConfigMaps cannot be deleted or edited from the Grafana UI. If you attempt to delete the dashboard in the Grafana UI, you will see the error message "Dashboard cannot be deleted because it was provisioned." To delete the dashboard, you will need to delete the ConfigMap. diff --git a/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md b/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md index 8d8d50df647..d5ac47c78f4 100644 --- a/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md +++ b/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md @@ -3,7 +3,7 @@ title: Monitoring/Alerting Guides --- - + - [Enable monitoring](enable-monitoring.md) diff --git a/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md b/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md index 4651e682528..c266c30f1c6 100644 --- a/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md +++ b/docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md @@ -3,7 +3,7 @@ title: Prometheus Federator Guides --- - + - [Enable Prometheus Operator](enable-prometheus-federator.md) diff --git a/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md b/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md index 35de246d3de..16d99c82a75 100644 --- a/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md +++ b/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md @@ -3,7 +3,7 @@ title: Advanced Configuration --- - + ### Alertmanager diff --git a/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md b/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md index 46e41afd605..9fa587aef2b 100644 --- a/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md +++ b/docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md @@ -3,7 +3,7 @@ title: Configuration --- - + This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md index c4c78f06e08..959fba86e28 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md @@ -3,7 +3,7 @@ title: About Provisioning Drivers --- - + Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md) or [nodes in an infrastructure provider](../../launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md) to allow Rancher to deploy and manage Kubernetes. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md index eab13feb274..228ec4c0992 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md @@ -3,7 +3,7 @@ title: RKE Templates --- - + RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md index 8db0c73fb3c..d569a9d8849 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md @@ -4,7 +4,7 @@ weight: 10 --- - + One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows your users to use one set of credentials to authenticate with any of your Kubernetes clusters. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md index 64b34293ccd..d41f2373ee8 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md @@ -3,7 +3,7 @@ title: Authentication, Permissions and Global Settings --- - + After installation, the [system administrator](manage-role-based-access-control-rbac/global-permissions.md) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md index e10056cc0ae..4bdda220525 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md @@ -3,7 +3,7 @@ title: Configuring Microsoft Active Directory Federation Service (SAML) --- - + If your organization uses Microsoft Active Directory Federation Services (AD FS) for user authentication, you can configure Rancher to allow your users to log in using their AD FS credentials. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md index 9285e08ef8b..e7d4c5724a4 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md @@ -3,7 +3,7 @@ title: Configuring OpenLDAP --- - + If your organization uses LDAP for user authentication, you can configure Rancher to communicate with an OpenLDAP server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the organisation's central user repository, while allowing end-users to authenticate with their LDAP credentials when logging in to the Rancher UI. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md index 482adb05a97..a57f4882050 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md @@ -3,7 +3,7 @@ title: Configuring Shibboleth (SAML) --- - + If your organization uses Shibboleth Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in to Rancher using their Shibboleth credentials. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md index dfae1c35f46..a516c10fe5b 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md @@ -12,7 +12,7 @@ Global Permissions define user authorization outside the scope of any particular - **Administrator:** These users have full control over the entire Rancher system and all clusters within it. -- **Restricted Admin:** These users have full control over downstream clusters, but cannot alter the local Kubernetes cluster. +- **Restricted Admin (Deprecated) :** These users have full control over downstream clusters, but cannot alter the local Kubernetes cluster. - **Standard User:** These users can create new clusters and use them. Standard users can also assign other users permissions to their clusters. @@ -20,77 +20,6 @@ Global Permissions define user authorization outside the scope of any particular You cannot update or delete the built-in Global Permissions. -## Restricted Admin - -A new `restricted-admin` role was created in Rancher v2.5 in order to prevent privilege escalation from the local Rancher server Kubernetes cluster. This role has full administrator access to all downstream clusters managed by Rancher, but it does not have permission to alter the local Kubernetes cluster. - -The `restricted-admin` can create other `restricted-admin` users with an equal level of access. - -A new setting was added to Rancher to set the initial bootstrapped administrator to have the `restricted-admin` role. This applies to the first user created when the Rancher server is started for the first time. If the environment variable is set, then no global administrator would be created, and it would be impossible to create the global administrator through Rancher. - -To bootstrap Rancher with the `restricted-admin` as the initial user, the Rancher server should be started with the following environment variable: - -``` -CATTLE_RESTRICTED_DEFAULT_ADMIN=true -``` -### List of `restricted-admin` Permissions - -The following table lists the permissions and actions that a `restricted-admin` should have in comparison with the `Administrator` and `Standard User` roles: - -| Category | Action | Global Admin | Standard User | Restricted Admin | Notes for Restricted Admin role | -| -------- | ------ | ------------ | ------------- | ---------------- | ------------------------------- | -| Local Cluster functions | Manage Local Cluster (List, Edit, Import Host) | Yes | No | No | | -| | Create Projects/namespaces | Yes | No | No | | -| | Add cluster/project members | Yes | No | No | | -| | Global DNS | Yes | No | No | | -| | Access to management cluster for CRDs and CRs | Yes | No | Yes | | -| | Save as RKE Template | Yes | No | No | | -| Security | | | | | | -| Enable auth | Configure Authentication | Yes | No | Yes | | -| Roles | Create/Assign GlobalRoles | Yes | No (Can list) | Yes | Auth webhook allows creating globalrole for perms already present | -| | Create/Assign ClusterRoles | Yes | No (Can list) | Yes | Not in local cluster | -| | Create/Assign ProjectRoles | Yes | No (Can list) | Yes | Not in local cluster | -| Users | Add User/Edit/Delete/Deactivate User | Yes | No | Yes | | -| Groups | Assign Global role to groups | Yes | No | Yes | As allowed by the webhook | -| | Refresh Groups | Yes | No | Yes | | -| PSP's | Manage PSP templates | Yes | No (Can list) | Yes | Same privileges as Global Admin for PSPs | -| Tools | | | | | | -| | Manage RKE Templates | Yes | No | Yes | | -| | Manage Global Catalogs | Yes | No | Yes | Cannot edit/delete built-in system catalog. Can manage Helm library | -| | Cluster Drivers | Yes | No | Yes | | -| | Node Drivers | Yes | No | Yes | | -| | GlobalDNS Providers | Yes | Yes (Self) | Yes | | -| | GlobalDNS Entries | Yes | Yes (Self) | Yes | | -| Settings | | | | | | -| | Manage Settings | Yes | No (Can list) | No (Can list) | | -| User | | | | | | -| | Manage API Keys | Yes (Manage all) | Yes (Manage self) | Yes (Manage self) | | -| | Manage Node Templates | Yes | Yes (Manage self) | Yes (Manage self) | Can only manage their own node templates and not those created by other users | -| | Manage Cloud Credentials | Yes | Yes (Manage self) | Yes (Manage self) | Can only manage their own cloud credentials and not those created by other users | -| Downstream Cluster | Create Cluster | Yes | Yes | Yes | | -| | Edit Cluster | Yes | Yes | Yes | | -| | Rotate Certificates | Yes | | Yes | | -| | Snapshot Now | Yes | | Yes | | -| | Restore Snapshot | Yes | | Yes | | -| | Save as RKE Template | Yes | No | Yes | | -| | Run CIS Scan | Yes | Yes | Yes | | -| | Add Members | Yes | Yes | Yes | | -| | Create Projects | Yes | Yes | Yes | | -| Feature Charts since v2.5 | | | | | | -| | Install Fleet | Yes | | Yes | Should not be able to run Fleet in local cluster | -| | Deploy EKS cluster | Yes | Yes | Yes | | -| | Deploy GKE cluster | Yes | Yes | Yes | | -| | Deploy AKS cluster | Yes | Yes | Yes | | - - -### Changing Global Administrators to Restricted Admins - -If Rancher already has a global administrator, they should change all global administrators over to the new `restricted-admin` role. - -This can be done through **Security > Users** and moving any Administrator role over to Restricted Administrator. - -Signed-in users can change themselves over to the `restricted-admin` if they wish, but they should only do that as the last step, otherwise they won't have the permissions to do so. - ## Global Permission Assignment Global permissions for local users are assigned differently than users who log in to Rancher using external authentication. @@ -135,13 +64,15 @@ The default roles, Administrator and Standard User, each come with multiple glob Administrators can enforce custom global permissions in multiple ways: -- [Changing the default permissions for new users](#configuring-default-global-permissions) -- [Configuring global permissions for individual users](#configuring-global-permissions-for-individual-users) -- [Configuring global permissions for groups](#configuring-global-permissions-for-groups) +- [Creating custom global roles](#custom-globalroles). +- [Changing the default permissions for new users](#configuring-default-global-permissions). +- [Configuring global permissions for individual users](#configuring-global-permissions-for-individual-users). +- [Configuring global permissions for groups](#configuring-global-permissions-for-groups). -### Custom Global Permissions Reference +### Combining Built-in GlobalRoles -The following table lists each custom global permission available and whether it is included in the default global permissions, `Administrator`, `Standard User` and `User-Base`. +Rancher provides several GlobalRoles which grant granular permissions for certain common use cases. +The following table lists each built-in global permission and whether it is included in the default global permissions, `Administrator`, `Standard User` and `User-Base`. | Custom Global Permission | Administrator | Standard User | User-Base | | ---------------------------------- | ------------- | ------------- |-----------| @@ -171,6 +102,112 @@ For details on which Kubernetes resources correspond to each global permission, ::: +### Custom GlobalRoles + +You can create custom GlobalRoles to satisfy use cases not directly addressed by built-in GlobalRoles. + +Create custom GlobalRoles through the UI or through automation (such as the Rancher Kubernetes API). You can specify the same type of rules as the rules for upstream roles and clusterRoles. + +#### Escalate and Bind verbs + +When giving permissions on GlobalRoles, keep in mind that Rancher respects the `escalate` and `bind` verbs, in a similar fashion to [Kubernetes](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#restrictions-on-role-creation-or-update). + +Both of these verbs, which are given on the GlobalRoles resource, can grant users the permission to bypass Rancher's privilege escalation checks. This potentially allows users to become admins. Since this represents a serious security risk, `bind` and `escalate` should be distributed to users with great caution. + +The `escalate` verb allows users to change a GlobalRole and add any permission, even if the users doesn't have the permissions in the current GlobalRole or the new version of the GlobalRole. + +The `bind` verb allows users to create a GlobalRoleBinding to the specified GlobalRole, even if they do not have the permissions in the GlobalRole. + +:::danger + +The wildcard verb `*` also includes the `bind` and `escalate` verbs. This means that giving `*` on GlobalRoles to a user also gives them both `escalate` and `bind`. + +::: + +##### Custom GlobalRole Examples + +To grant permission to escalate only the `test-gr` GlobalRole: + +```yaml +rules: +- apiGroups: + - 'management.cattle.io' + resources: + - 'globalroles' + resourceNames: + - 'test-gr' + verbs: + - 'escalate' +``` + +To grant permission to escalate all GlobalRoles: + +```yaml +rules: +- apiGroups: + - 'management.cattle.io' + resources: + - 'globalroles' + verbs: + - 'escalate' +``` + +To grant permission to create bindings (which bypass escalation checks) to only the `test-gr` GlobalRole: + +```yaml +rules: +- apiGroups: + - 'management.cattle.io' + resources: + - 'globalroles' + resourceNames: + - 'test-gr' + verbs: + - 'bind' +- apiGroups: + - 'management.cattle.io' + resources: + - 'globalrolebindings' + verbs: + - 'create' +``` + +Granting `*` permissions (which includes both `escalate` and `bind`): + +```yaml +rules: +- apiGroups: + - 'management.cattle.io' + resources: + - 'globalroles' + verbs: + - '*' +``` + +#### GlobalRole Permissions on Downstream Clusters + +GlobalRoles can grant one or more RoleTemplates on every downstream cluster through the `inheritedClusterRoles` field. Values in this field must refer to a RoleTemplate which exists and has a `context` of Cluster. + +With this field, users gain the specified permissions on all current or future downstream clusters. For example, consider the following GlobalRole: + +```yaml +apiVersion: management.cattle.io/v3 +kind: GlobalRole +displayName: All Downstream Owner +metadata: + name: all-downstream-owner +inheritedClusterRoles: +- cluster-owner +``` + +Any user with this permission will be a cluster-owner on all downstream clusters. If a new cluster is added, regardless of type, the user will be an owner on that cluster as well. + +:::danger + +Using this field on [default GlobalRoles](#configuring-default-global-permissions) may result in users gaining excessive permissions. + +::: + ### Configuring Default Global Permissions If you want to restrict the default permissions for new users, you can remove the `user` permission as default role and then assign multiple individual permissions as default instead. Conversely, you can also add administrative permissions on top of a set of other standard permissions. @@ -249,3 +286,79 @@ To refresh group memberships, 1. Click **Refresh Group Memberships**. **Result:** Any changes to the group members' permissions will take effect. + +## Restricted Admin + +:::warning Deprecated + +The Restricted Admin role is deprecated, and will be removed in a future version of Rancher (2.10 or higher). You should make a custom role with the desired permissions instead of relying on this built-in role. + +::: + +A new `restricted-admin` role was created in Rancher v2.5 in order to prevent privilege escalation on the local Rancher server Kubernetes cluster. This role has full administrator access to all downstream clusters managed by Rancher, but it does not have permission to alter the local Kubernetes cluster. + +The `restricted-admin` can create other `restricted-admin` users with an equal level of access. + +A new setting was added to Rancher to set the initial bootstrapped administrator to have the `restricted-admin` role. This applies to the first user created when the Rancher server is started for the first time. If the environment variable is set, then no global administrator would be created, and it would be impossible to create the global administrator through Rancher. + +To bootstrap Rancher with the `restricted-admin` as the initial user, the Rancher server should be started with the following environment variable: + +``` +CATTLE_RESTRICTED_DEFAULT_ADMIN=true +``` +### List of `restricted-admin` Permissions + +The following table lists the permissions and actions that a `restricted-admin` should have in comparison with the `Administrator` and `Standard User` roles: + +| Category | Action | Global Admin | Standard User | Restricted Admin | Notes for Restricted Admin role | +| -------- | ------ | ------------ | ------------- | ---------------- | ------------------------------- | +| Local Cluster functions | Manage Local Cluster (List, Edit, Import Host) | Yes | No | No | | +| | Create Projects/namespaces | Yes | No | No | | +| | Add cluster/project members | Yes | No | No | | +| | Global DNS | Yes | No | No | | +| | Access to management cluster for CRDs and CRs | Yes | No | Yes | | +| | Save as RKE Template | Yes | No | No | | +| Security | | | | | | +| Enable auth | Configure Authentication | Yes | No | Yes | | +| Roles | Create/Assign GlobalRoles | Yes | No (Can list) | Yes | Auth webhook allows creating globalrole for perms already present | +| | Create/Assign ClusterRoles | Yes | No (Can list) | Yes | Not in local cluster | +| | Create/Assign ProjectRoles | Yes | No (Can list) | Yes | Not in local cluster | +| Users | Add User/Edit/Delete/Deactivate User | Yes | No | Yes | | +| Groups | Assign Global role to groups | Yes | No | Yes | As allowed by the webhook | +| | Refresh Groups | Yes | No | Yes | | +| PSP's | Manage PSP templates | Yes | No (Can list) | Yes | Same privileges as Global Admin for PSPs | +| Tools | | | | | | +| | Manage RKE Templates | Yes | No | Yes | | +| | Manage Global Catalogs | Yes | No | Yes | Cannot edit/delete built-in system catalog. Can manage Helm library | +| | Cluster Drivers | Yes | No | Yes | | +| | Node Drivers | Yes | No | Yes | | +| | GlobalDNS Providers | Yes | Yes (Self) | Yes | | +| | GlobalDNS Entries | Yes | Yes (Self) | Yes | | +| Settings | | | | | | +| | Manage Settings | Yes | No (Can list) | No (Can list) | | +| User | | | | | | +| | Manage API Keys | Yes (Manage all) | Yes (Manage self) | Yes (Manage self) | | +| | Manage Node Templates | Yes | Yes (Manage self) | Yes (Manage self) | Can only manage their own node templates and not those created by other users | +| | Manage Cloud Credentials | Yes | Yes (Manage self) | Yes (Manage self) | Can only manage their own cloud credentials and not those created by other users | +| Downstream Cluster | Create Cluster | Yes | Yes | Yes | | +| | Edit Cluster | Yes | Yes | Yes | | +| | Rotate Certificates | Yes | | Yes | | +| | Snapshot Now | Yes | | Yes | | +| | Restore Snapshot | Yes | | Yes | | +| | Save as RKE Template | Yes | No | Yes | | +| | Run CIS Scan | Yes | Yes | Yes | | +| | Add Members | Yes | Yes | Yes | | +| | Create Projects | Yes | Yes | Yes | | +| Feature Charts since v2.5 | | | | | | +| | Install Fleet | Yes | | Yes | Should not be able to run Fleet in local cluster | +| | Deploy EKS cluster | Yes | Yes | Yes | | +| | Deploy GKE cluster | Yes | Yes | Yes | | +| | Deploy AKS cluster | Yes | Yes | Yes | | + +### Changing Global Administrators to Restricted Admins + +In previous version, the docs recommended that all users should be changed over to Restricted Admin if the role was in use. Users are now encouraged to use a custom-built role using the cluster permissions feature, and migrate any current restricted admins to use that approach. + +This can be done through **Security > Users** and moving any Administrator role over to Restricted Administrator. + +Signed-in users can change themselves over to the `restricted-admin` if they wish, but they should only do that as the last step, otherwise they won't have the permissions to do so. diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md index 82038ecfc7e..d6a6d8d8f76 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md @@ -3,7 +3,7 @@ title: Managing Role-Based Access Control (RBAC) --- - + Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication](../authentication-config/authentication-config.md), users can either be local or external. diff --git a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 01f2ca76c51..c5afbae3842 100644 --- a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -4,7 +4,7 @@ keywords: [rancher backup restore, rancher backup and restore, backup restore ra --- - + In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster. @@ -91,10 +91,10 @@ A migration is performed by following [these steps.](migrate-rancher-to-new-clus ## Default Storage Location Configuration -Configure a storage location where all backups are saved by default. You will have the option to override this with each backup, but will be limited to using an S3-compatible or Minio object store. +Configure a default storage location for your backups. There are various configuration options, such as specifying an S3-compatible object store as the location for individual backups or choosing an existing `StorageClass` during installation of the `backup-restore-operator` Helm chart. You also have the option to override the configured storage location with each backup, but are limited to using an S3-compatible or Minio object store. For information on configuring these options, refer to [this page.](../../../reference-guides/backup-restore-configuration/storage-configuration.md) -### Example values.yaml for the rancher-backup Helm Chart +### Example YAML File: Rancher Backup Helm Chart -The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-valuesyaml-for-the-rancher-backup-helm-chart) can be used to configure the `rancher-backup` operator when the Helm CLI is used to install it. +The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-yaml-file-rancher-backup-helm-chart) can be used to configure the `backup-restore-operator` when the Helm CLI is used to install it. diff --git a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 9e670da901d..89faf8d11bf 100644 --- a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -27,7 +27,8 @@ Since Rancher can be installed on any Kubernetes cluster, you can use this backu ### 1. Install the rancher-backup Helm chart -Install the [rancher-backup chart](https://github.com/rancher/backup-restore-operator/tags), using a version in the 2.x.x major version range: + +Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-operator/tags): 1. Add the Helm repository: @@ -36,13 +37,14 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope helm repo update ``` - 1. Select and set `CHART_VERSION` variable with a 2.x.x rancher-backup release version: + 1. Set a `CHART_VERSION` variable, selecting a `rancher-backup` chart version compatible with your version of Rancher. See the [support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions), within the **Rancher Apps / Cluster Tools** section, to see which `rancher-backup` versions are supported: + ```bash - helm search repo --versions rancher-charts/rancher-backup - CHART_VERSION=<2.x.x> + CHART_VERSION= ``` 1. Install the charts: + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION @@ -50,7 +52,7 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope :::note - The above assumes an environment with outbound connectivity to Docker Hub + The above assumes an environment with outbound connectivity to Docker Hub. For an **air-gapped environment**, use the Helm value below to pull the `backup-restore-operator` image from your private registry when installing the rancher-backup Helm chart. diff --git a/docs/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md b/docs/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md index 2d4bd5cdcb0..7c3d85b867f 100644 --- a/docs/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md +++ b/docs/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md @@ -3,7 +3,7 @@ title: Deploying Applications across Clusters --- - + Rancher offers several ways to deploy applications across clusters, depending on version. diff --git a/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index fa99b770228..e96f0cab855 100644 --- a/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -3,7 +3,7 @@ title: Helm Charts in Rancher --- - + In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps**. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster. diff --git a/docs/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md b/docs/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md index ccdca3126b8..7a79e5f5622 100644 --- a/docs/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md +++ b/docs/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md @@ -3,7 +3,7 @@ title: Don't have infrastructure for your Kubernetes cluster? Try one of these t --- - + To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](ha-k3s-kubernetes-cluster.md) diff --git a/docs/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md b/docs/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md index 9291d55bee4..00c22ead1c3 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md @@ -3,7 +3,7 @@ title: "Don't have a Kubernetes cluster? Try one of these tutorials." --- - + This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md index d3609540e2a..14ae384e387 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md @@ -3,7 +3,7 @@ title: Checklist for Production-Ready Clusters --- - + In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md index f088c16e1c4..230a3d6212b 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md @@ -4,7 +4,7 @@ description: Provisioning Kubernetes Clusters --- - + Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md index 981c0533930..267d9b1c1ba 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md @@ -12,7 +12,7 @@ You can migrate from an in-tree to an out-of-tree AWS cloud provider on Kubernet To migrate from the in-tree cloud provider to the out-of-tree AWS cloud provider, you must stop the existing cluster's kube controller manager and install the AWS cloud controller manager. There are many ways to do this. Refer to the official AWS documentation on the [external cloud controller manager](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for details. -If it's acceptable to have some downtime, you can [switch to an external cloud provider](../set-up-cloud-providers/amazon.md#using-the-out-of-tree-aws-cloud-provider), which removes in-tree components and then deploy charts to install the AWS cloud controller manager. +If it's acceptable to have some downtime during migration, follow the instructions to [set up an external cloud provider](../set-up-cloud-providers/amazon.md#using-the-out-of-tree-aws-cloud-provider). These instructions outline how to configure the out-of-tree cloud provider for a newly provisioned cluster. During set up, there will be some downtime, as there is a time gap between when the old cloud provider stops running and when the new cloud provider starts to run. If your setup can't tolerate any control plane downtime, you must enable leader migration. This facilitates a smooth transition from the controllers in the kube controller manager to their counterparts in the cloud controller manager. Refer to the official AWS documentation on [Using leader migration](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for more details. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md index 11c5e5590e3..d6c9834b666 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md @@ -3,7 +3,7 @@ title: Setting up Cloud Providers --- - + A _cloud provider_ is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md index 070c16dc420..ea0cc4ff394 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md @@ -3,7 +3,7 @@ title: Setting up Clusters from Hosted Kubernetes Providers --- - + In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md index 91cee26d619..4c5f811c5e6 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on Windows Clusters --- - + When provisioning a [custom cluster](../../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md index e0f5e51e4b4..8d084cb00d7 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md @@ -4,7 +4,7 @@ description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs --- - + The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md index 132e0f2627d..7879660225d 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md @@ -3,7 +3,7 @@ title: Kubernetes Resources --- - + You can view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md index b3f3976e6e3..934a552f019 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md @@ -4,7 +4,7 @@ description: Learn how you can set up load balancers and ingress controllers to --- - + Within Rancher, you can set up load balancers and ingress controllers to redirect service requests. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md index c20787712ae..b9bd0fa0a47 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md @@ -4,7 +4,7 @@ description: "Learn about the two constructs with which you can build any comple --- - + You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services. diff --git a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md index e62d67c8323..7c7faea2e8d 100644 --- a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md +++ b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md @@ -3,7 +3,7 @@ title: Launching Kubernetes with Rancher --- - + You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, you can choose between [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) or [RKE2](https://docs.rke2.io) distributions. Rancher can launch Kubernetes on any computers, including: diff --git a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md index 9c761b50475..8d498ac35e6 100644 --- a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md +++ b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md @@ -4,7 +4,7 @@ description: Use Rancher to create a Nutanix AOS (AHV) cluster. It may consist o --- - + [Nutanix Acropolis Operating System](https://www.nutanix.com/products/acropolis) (Nutanix AOS) is an operating system for the Nutanix hyper-converged infrastructure platform. AOS comes with a built-in hypervisor called [Acropolis Hypervisor](https://www.nutanix.com/products/ahv), or AHV. By using Rancher with Nutanix AOS (AHV), you can bring cloud operations on-premises. diff --git a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md index 88bac5263d0..6e7580f8e16 100644 --- a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md +++ b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on New Nodes in an Infrastructure Provider --- - + When you create an RKE or RKE2 cluster using a node template in Rancher, each resulting node pool is shown in a new **Machine Pools** tab. You can see the machine pools by doing the following: diff --git a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md index 9890f087ece..e1d63847e59 100644 --- a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md +++ b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md @@ -4,7 +4,7 @@ description: Use Rancher to create a vSphere cluster. It may consist of groups o --- - + import YouTube from '@site/src/components/YouTube' diff --git a/docs/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md b/docs/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md index a4929ee26cf..ca181ffc07a 100644 --- a/docs/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md +++ b/docs/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md @@ -3,7 +3,7 @@ title: Cluster Access --- - + This section is about what tools can be used to access clusters managed by Rancher. diff --git a/docs/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md b/docs/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md index 58a71adce61..8b2d0db56c7 100644 --- a/docs/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md +++ b/docs/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md @@ -4,7 +4,7 @@ description: "Learn about the two ways with which you can create persistent stor --- - + 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/docs/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md b/docs/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md index 127153dd06b..01a5ca7d2d6 100644 --- a/docs/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md +++ b/docs/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md @@ -3,7 +3,7 @@ title: Cluster Autoscaler --- - + In this section, you'll learn how to install and use the [Kubernetes cluster-autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/) on Rancher custom clusters using AWS EC2 Auto Scaling Groups. diff --git a/docs/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md b/docs/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md index fc05cfd581b..eafa50faff9 100644 --- a/docs/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md +++ b/docs/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md @@ -3,7 +3,7 @@ title: Cluster Administration --- - + After you provision a cluster in Rancher, you can begin using powerful Kubernetes features to deploy and scale your containerized applications in development, testing, or production environments. diff --git a/docs/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md b/docs/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md index b1d89e54c05..d4b85fec0c2 100644 --- a/docs/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md +++ b/docs/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md @@ -3,7 +3,7 @@ title: Provisioning Storage Examples --- - + Rancher supports persistent storage with a variety of volume plugins. However, before you use any of these plugins to bind persistent storage to your workloads, you have to configure the storage itself, whether its a cloud-based solution from a service-provider or an on-prem solution that you manage yourself. diff --git a/docs/how-to-guides/new-user-guides/new-user-guides.md b/docs/how-to-guides/new-user-guides/new-user-guides.md index e2e68ff0089..cc86980e4ad 100644 --- a/docs/how-to-guides/new-user-guides/new-user-guides.md +++ b/docs/how-to-guides/new-user-guides/new-user-guides.md @@ -3,7 +3,7 @@ title: New User Guides --- - + New user guides, also known as **tutorials**, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing". diff --git a/docs/integrations-in-rancher/cis-scans/cis-scans.md b/docs/integrations-in-rancher/cis-scans/cis-scans.md index c6423844d0c..f170f997d66 100644 --- a/docs/integrations-in-rancher/cis-scans/cis-scans.md +++ b/docs/integrations-in-rancher/cis-scans/cis-scans.md @@ -3,7 +3,7 @@ title: CIS Scans --- - + Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. The CIS scans can run on any Kubernetes cluster, including hosted Kubernetes providers such as EKS, AKS, and GKE. diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md b/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md index 13b1398077e..cd143d64ef4 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md @@ -3,7 +3,7 @@ title: AWS Marketplace Integration --- - + ## Overview diff --git a/docs/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md b/docs/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md index 6f90a2c3ff4..ab6234b156d 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md +++ b/docs/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md @@ -3,7 +3,7 @@ title: Cloud Marketplace Integration --- - + Rancher offers integration with cloud marketplaces to easily purchase support for installations hosted on certain cloud providers. In addition, this integration also provides the ability to generate a supportconfig bundle which can be provided to rancher support. diff --git a/docs/integrations-in-rancher/elemental/elemental.md b/docs/integrations-in-rancher/elemental/elemental.md index 5e93a4b3538..a408aa19a55 100644 --- a/docs/integrations-in-rancher/elemental/elemental.md +++ b/docs/integrations-in-rancher/elemental/elemental.md @@ -2,6 +2,10 @@ title: Operating System Management with Elemental --- + + + + Elemental enables cloud-native host management. Elemental allows you to onboard any machine in any location, whether its in a datacenter or on the edge, and integrate them seamlessly into Kubernetes while managing your workflows (e.g., OS updates). ## Elemental with Rancher diff --git a/docs/integrations-in-rancher/epinio/epinio.md b/docs/integrations-in-rancher/epinio/epinio.md deleted file mode 100644 index fe8e4197f90..00000000000 --- a/docs/integrations-in-rancher/epinio/epinio.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Application Development Engine with Epinio ---- - - - - - -Epinio is a Kubernetes-based Application Development Platform. It helps operators and developers collaborate without conflict, and accelerates the development process. With Epinio, teams can move from application sources to a live URL in a single step. - -## Epinio with Rancher - -Epinio's integration with Rancher gives developers a jump start, without having to deal with the installation process or configuration. You can install Epinio directly from the Rancher UI's Apps page. - -## Epinio with Rancher Prime - -Rancher Prime customers can expect better integration of Epinio with other areas in the Rancher ecosystem such as: - -- Better integration with Rancher authentication. -- Integration with Neuvector and Kubewarden. -- Custom Helm chart templates with preset annotations to seamlessly integrate with monitoring and other key tools. -- Improved service marketplace. diff --git a/docs/integrations-in-rancher/fleet/architecture.md b/docs/integrations-in-rancher/fleet/architecture.md index f012a3a9921..dcdd07ce36f 100644 --- a/docs/integrations-in-rancher/fleet/architecture.md +++ b/docs/integrations-in-rancher/fleet/architecture.md @@ -2,6 +2,10 @@ title: Architecture --- + + + + Fleet can manage deployments from git of raw Kubernetes YAML, Helm charts, or Kustomize or any combination of the three. Regardless of the source, all resources are dynamically turned into Helm charts, and Helm is used as the engine to deploy everything in the cluster. This gives you a high degree of control, consistency, and auditability. Fleet focuses not only on the ability to scale, but to give one a high degree of control and visibility to exactly what is installed on the cluster. ![Architecture](/img/fleet-architecture.svg) diff --git a/docs/integrations-in-rancher/fleet/fleet.md b/docs/integrations-in-rancher/fleet/fleet.md index d8d1f44b282..878ecd75d85 100644 --- a/docs/integrations-in-rancher/fleet/fleet.md +++ b/docs/integrations-in-rancher/fleet/fleet.md @@ -2,6 +2,10 @@ title: Continuous Delivery with Fleet --- + + + + Fleet orchestrates and manages the continuous delivery of applications through the supply chain for fleets of clusters. Fleet organizes the supply chain to help teams deliver with confidence and trust in a timely manner using GitOps as a safe operating model. ## Fleet with Rancher diff --git a/docs/integrations-in-rancher/fleet/overview.md b/docs/integrations-in-rancher/fleet/overview.md index 2c21eaa0ae4..190f9b8906f 100644 --- a/docs/integrations-in-rancher/fleet/overview.md +++ b/docs/integrations-in-rancher/fleet/overview.md @@ -2,6 +2,10 @@ title: Overview --- + + + + Continuous Delivery with Fleet is GitOps at scale. Fleet is designed to manage up to a million clusters. It’s also lightweight enough that it works great for a [single cluster](https://fleet.rancher.io/installation#default-install) too, but it really shines when you get to a [large scale](https://fleet.rancher.io/installation#configuration-for-multi-cluster). By large scale we mean either a lot of clusters, a lot of deployments, or a lot of teams in a single organization. Fleet is a separate project from Rancher, and can be installed on any Kubernetes cluster with Helm. diff --git a/docs/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md b/docs/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md index e6a3f8cf961..1570da5b448 100644 --- a/docs/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md +++ b/docs/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md @@ -2,6 +2,10 @@ title: Using Fleet Behind a Proxy --- + + + + In this section, you'll learn how to enable Fleet in a setup that has a Rancher server with a public IP a Kubernetes cluster that has no public IP, but is configured to use a proxy. Rancher does not establish connections with registered downstream clusters. The Rancher agent deployed on the downstream cluster must be able to establish the connection with Rancher. diff --git a/docs/integrations-in-rancher/fleet/windows-support.md b/docs/integrations-in-rancher/fleet/windows-support.md index aea98b74dbc..15fd1ac2263 100644 --- a/docs/integrations-in-rancher/fleet/windows-support.md +++ b/docs/integrations-in-rancher/fleet/windows-support.md @@ -2,6 +2,10 @@ title: Windows Support --- + + + + Prior to Rancher v2.5.6, the `agent` did not have native Windows manifests on downstream clusters with Windows nodes. This would result in a failing `agent` pod for the cluster. If you are upgrading from an older version of Rancher to v2.5.6+, you can deploy a working `agent` with the following workflow *in the downstream cluster*: diff --git a/docs/integrations-in-rancher/harvester/harvester.md b/docs/integrations-in-rancher/harvester/harvester.md index c54b817839b..f187fe086af 100644 --- a/docs/integrations-in-rancher/harvester/harvester.md +++ b/docs/integrations-in-rancher/harvester/harvester.md @@ -2,6 +2,10 @@ title: Virtualization on Kubernetes with Harvester --- + + + + ## Harvester Introduced in Rancher v2.6.1, Harvester is an open-source hyper-converged infrastructure (HCI) software built on Kubernetes. Harvester installs on bare metal servers and provides integrated virtualization and distributed storage capabilities. Although Harvester operates using Kubernetes, it does not require knowledge of Kubernetes concepts, making it more user-friendly. diff --git a/docs/integrations-in-rancher/harvester/overview.md b/docs/integrations-in-rancher/harvester/overview.md index 9f280c70782..cbf94de9cd3 100644 --- a/docs/integrations-in-rancher/harvester/overview.md +++ b/docs/integrations-in-rancher/harvester/overview.md @@ -2,6 +2,10 @@ title: Overview --- + + + + Introduced in Rancher v2.6.1, [Harvester](https://docs.harvesterhci.io/) is an open-source hyper-converged infrastructure (HCI) software built on Kubernetes. Harvester installs on bare metal servers and provides integrated virtualization and distributed storage capabilities. Although Harvester operates using Kubernetes, it does not require users to know Kubernetes concepts, making it a more user-friendly application. ### Feature Flag diff --git a/docs/integrations-in-rancher/integrations-in-rancher.mdx b/docs/integrations-in-rancher/integrations-in-rancher.mdx index f8420b32752..5f75b398ab7 100644 --- a/docs/integrations-in-rancher/integrations-in-rancher.mdx +++ b/docs/integrations-in-rancher/integrations-in-rancher.mdx @@ -1,17 +1,13 @@ --- title: Integrations in Rancher --- + + + + + import {Card, CardSection} from '@site/src/components/CardComponents'; -import { - ReadingModeMobileRegular, - QuestionRegular, - ArrowUpRegular, - PlayRegular, - FlowchartRegular, - RocketRegular -} from '@fluentui/react-icons'; -import { FaAws, FaGoogle, FaCloud, FaServer, faGear } from "react-icons/fa6"; -import HarvesterIcon from '@site/static/img/harvester_logo_horizontal.svg'; +import {RocketRegular} from '@fluentui/react-icons'; Prime is the Rancher ecosystem’s enterprise offering, with additional security, extended lifecycles, and access to Prime-exclusive documentation. Rancher Prime installation assets are hosted on a trusted SUSE registry, owned and managed by Rancher. The trusted Prime registry includes only stable releases that have been community-tested. @@ -47,10 +43,6 @@ To learn more and get started with Rancher Prime, please visit [this page](https title="Operating System Management with Elemental" to="./integrations-in-rancher/elemental" /> - - diff --git a/docs/integrations-in-rancher/istio/configuration-options/configuration-options.md b/docs/integrations-in-rancher/istio/configuration-options/configuration-options.md index 35546a12f03..5f553689ab0 100644 --- a/docs/integrations-in-rancher/istio/configuration-options/configuration-options.md +++ b/docs/integrations-in-rancher/istio/configuration-options/configuration-options.md @@ -3,7 +3,7 @@ title: Configuration Options --- - + ### Egress Support diff --git a/docs/integrations-in-rancher/istio/istio.md b/docs/integrations-in-rancher/istio/istio.md index c622d0d2180..0f865ef5363 100644 --- a/docs/integrations-in-rancher/istio/istio.md +++ b/docs/integrations-in-rancher/istio/istio.md @@ -3,7 +3,7 @@ title: Istio --- - + [Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices. diff --git a/docs/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md b/docs/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md index 689dd6423ed..c36a1519f76 100644 --- a/docs/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md +++ b/docs/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md @@ -2,6 +2,10 @@ title: Kubernetes Distributions --- + + + + ## K3s K3s is a lightweight, fully compliant Kubernetes distribution designed for a range of use cases, including edge computing, IoT, CI/CD, development and embedding Kubernetes into applications. It simplifies Kubernetes management by packaging the system as a single binary, using sqlite3 as the default storage, and offering a user-friendly launcher. K3s includes essential features like local storage and load balancing, Helm chart controller and the Traefik CNI. It minimizes external dependencies and provides a streamlined Kubernetes experience. K3s was donated to the CNCF as a Sandbox Project in June 2020. diff --git a/docs/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md b/docs/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md index eb1020ac1a2..b1099777da3 100644 --- a/docs/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md +++ b/docs/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md @@ -3,7 +3,7 @@ title: Custom Resource Configuration --- - + The following Custom Resource Definitions are used to configure logging: diff --git a/docs/integrations-in-rancher/logging/logging.md b/docs/integrations-in-rancher/logging/logging.md index a79c896ec6e..2813d8fa681 100644 --- a/docs/integrations-in-rancher/logging/logging.md +++ b/docs/integrations-in-rancher/logging/logging.md @@ -4,7 +4,7 @@ description: Rancher integrates with popular logging services. Learn the require --- - + The [Logging operator](https://kube-logging.github.io/docs/) now powers Rancher's logging solution in place of the former, in-house solution. diff --git a/docs/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md b/docs/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md index 48b4114d458..06bd0ac2297 100644 --- a/docs/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md +++ b/docs/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md @@ -4,7 +4,7 @@ description: Prometheus lets you view metrics from your different Rancher and Ku --- - + The `rancher-monitoring` application can quickly deploy leading open-source monitoring and alerting solutions onto your cluster. @@ -55,7 +55,13 @@ For a list of monitoring components exposed in the Rancher UI, along with common ## Role-based Access Control -For information on configuring access to monitoring, see [this page.](rbac-for-monitoring.md) +For more information on configuring access to monitoring, see [this page.](rbac-for-monitoring.md) + +:::note + +Rancher and Project read permissions don't necessarily apply to monitoring resources. See [monitoring-ui-view](rbac-for-monitoring.md#additional-monitoring-clusterroles) for more details. + +::: ## Guides diff --git a/docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md b/docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md index 1caa47cc30b..583611b99c0 100644 --- a/docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md +++ b/docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md @@ -112,7 +112,7 @@ Monitoring also creates additional `ClusterRoles` that aren't assigned to users | Role | Purpose | | ------------------------------| ---------------------------| -| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users with write access to the project to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting Read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Alertmanager, and Grafana UIs through the Rancher proxy. | +| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users with write access to the project to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting Read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Alertmanager, and Grafana UIs through the Rancher proxy.

This role doesn't grant access to monitoring endpoints. As a result, users with this role won't be able to view cluster monitoring graphs and dashboards in the Rancher UI; however, they are able to access the monitoring Grafana, Prometheus, and Alertmanager UIs if provided those links. | :::note @@ -216,7 +216,11 @@ In addition to these default roles, the following Rancher project roles can be a |--------------------------|-------------------------------|-------|------| | View Monitoring* | [monitoring-ui-view](#additional-monitoring-clusterroles) | 2.4.8+ | 9.4.204+ | -\* A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project. +:::note + +A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project. + +::: ### Differences in 2.5.x diff --git a/docs/integrations-in-rancher/opa-gatekeeper.md b/docs/integrations-in-rancher/opa-gatekeeper.md index f2185dff685..cea9732b36c 100644 --- a/docs/integrations-in-rancher/opa-gatekeeper.md +++ b/docs/integrations-in-rancher/opa-gatekeeper.md @@ -6,6 +6,8 @@ title: OPA Gatekeeper + + To ensure consistency and compliance, every organization needs the ability to define and enforce policies in its environment in an automated way. [OPA (Open Policy Agent)](https://www.openpolicyagent.org/) is a policy engine that facilitates policy-based control for cloud native environments. Rancher provides the ability to enable OPA Gatekeeper in Kubernetes clusters, and also installs a couple of built-in policy definitions, which are also called constraint templates. OPA provides a high-level declarative language that lets you specify policy as code and ability to extend simple APIs to offload policy decision-making. diff --git a/docs/integrations-in-rancher/opni/opni.md b/docs/integrations-in-rancher/opni/opni.md deleted file mode 100644 index 96ec3eb7336..00000000000 --- a/docs/integrations-in-rancher/opni/opni.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Observability with Opni ---- - - - - - -Opni is a multi-cluster and multi-tenant observability platform. Purpose-built on Kubernetes, Opni simplifies the process of creating and managing backends, agents, and data related to logging, monitoring, and tracing. With built-in AIOps, Opni allows users to swiftly detect anomalous activities in their data. - -Opni components work together to provide a comprehensive observability platform. Key components include: - -- Observability Backends: Opni Logging enhances Opensearch for easy searching, visualization, and analysis of logs, traces and Kubernetes events. Opni Monitoring extends Cortex for multi-cluster, long-term storage of Prometheus metrics. -- Observability Agents: Agents are software that collects observability data (logs, metrics, traces, and events) from their host and sends it to an observability backend. The Opni agent enables collection of logs, Kubernetes events, OpenTelemetry traces, and Prometheus metrics. -- AIOps: Applies AL and machine learning to IT and observability data. Open AIOps features include log anomaly detection using pretrained models for Kubernetes control plane, Rancher and Longhorn. -- Alerting and SLOs: Triggers and reliability targets for services enables utilizing Opni data to effectively make informed decisions regarding software operations. - -## Opni with Rancher - -Opni’s Helm charts are currently maintained in a charts-specific branch of the Opni GitHub project. Once this branch is added as a repository in Rancher, the Opni installation can be performed through the Rancher UI. Efforts are underway now to streamline this process by including these charts directly within Rancher itself, and offering Opni as a fully integrated Rancher App. - -Opni’s log anomaly detection process includes purpose-built, pre-trained models for RKE2, K3s, Longhorn and Rancher agent logs. This advanced modeling ensures first class support for log anomaly detection for the core suite of Rancher products. - diff --git a/docs/reference-guides/about-the-api/about-the-api.md b/docs/reference-guides/about-the-api/about-the-api.md index 0247bebda24..21f3c03bdc1 100644 --- a/docs/reference-guides/about-the-api/about-the-api.md +++ b/docs/reference-guides/about-the-api/about-the-api.md @@ -3,7 +3,7 @@ title: API --- - + ## How to use the API diff --git a/docs/reference-guides/backup-restore-configuration/backup-restore-configuration.md b/docs/reference-guides/backup-restore-configuration/backup-restore-configuration.md index 1f74b2fad9b..ad817581489 100644 --- a/docs/reference-guides/backup-restore-configuration/backup-restore-configuration.md +++ b/docs/reference-guides/backup-restore-configuration/backup-restore-configuration.md @@ -3,7 +3,7 @@ title: Rancher Backup Configuration Reference --- - + - [Backup configuration](backup-configuration.md) diff --git a/docs/reference-guides/backup-restore-configuration/storage-configuration.md b/docs/reference-guides/backup-restore-configuration/storage-configuration.md index a901bde4190..64d9a810a44 100644 --- a/docs/reference-guides/backup-restore-configuration/storage-configuration.md +++ b/docs/reference-guides/backup-restore-configuration/storage-configuration.md @@ -52,9 +52,8 @@ It is highly recommended to use a Persistent Volume with a reclaim policy of "Re ::: -## Example values.yaml for the rancher-backup Helm Chart +## Example YAML File: Rancher Backup Helm Chart -The documented `values.yaml` file that can be used to configure `rancher-backup` operator when the Helm CLI is used can be found in the [backup-restore-operator repository.](https://github.com/rancher/backup-restore-operator/blob/master/charts/rancher-backup/values.yaml) +The documented `values.yaml` file that can be used to configure the `backup-restore-operator` when the Helm CLI is used can be found in the [backup-restore-operator repository.](https://github.com/rancher/backup-restore-operator/blob/master/charts/rancher-backup/values.yaml) For more information about `values.yaml` files and configuring Helm charts during installation, refer to the [Helm documentation.](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing) - diff --git a/docs/reference-guides/best-practices/best-practices.md b/docs/reference-guides/best-practices/best-practices.md index 546ae01be94..d2520a3e785 100644 --- a/docs/reference-guides/best-practices/best-practices.md +++ b/docs/reference-guides/best-practices/best-practices.md @@ -3,7 +3,7 @@ title: Best Practices Guide --- - + The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers. diff --git a/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md b/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md index 72c44ac9a78..ea4697f8e76 100644 --- a/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md +++ b/docs/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md @@ -3,7 +3,7 @@ title: Best Practices for Rancher Managed Clusters --- - + ### Logging diff --git a/docs/reference-guides/best-practices/rancher-server/rancher-server.md b/docs/reference-guides/best-practices/rancher-server/rancher-server.md index a79561ced2c..8e24e145482 100644 --- a/docs/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/docs/reference-guides/best-practices/rancher-server/rancher-server.md @@ -3,7 +3,7 @@ title: Best Practices for the Rancher Server --- - + This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. diff --git a/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 896a4978b12..50687cdd32c 100644 --- a/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -21,6 +21,26 @@ This guide describes the best practices and tuning approaches to scale Rancher s When scaling up Rancher, one typical bottleneck is resource growth in the upstream (local) Kubernetes cluster. The upstream cluster contains information for all downstream clusters. Many operations that apply to downstream clusters create new objects in the upstream cluster and require computation from handlers running in the upstream cluster. +### Minimizing Third-Party Software on the Upstream Cluster + +Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. + +Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. + +Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + +On the other hand, the following software are found to interfere with Rancher performance at scale: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + ### Managing Your Object Counts Etcd is the backing database for Kubernetes and for Rancher. The database may eventually encounter limitations to the number of a single Kubernetes resource type it can store. Exact limits vary and depend on a number of factors. However, experience indicates that performance issues frequently arise once a single resource type's object count exceeds 60,000. Often that type is `RoleBinding`. diff --git a/docs/reference-guides/cli-with-rancher/cli-with-rancher.md b/docs/reference-guides/cli-with-rancher/cli-with-rancher.md index a0e50c51b71..a18cabf5abb 100644 --- a/docs/reference-guides/cli-with-rancher/cli-with-rancher.md +++ b/docs/reference-guides/cli-with-rancher/cli-with-rancher.md @@ -3,7 +3,7 @@ title: CLI with Rancher --- - + Interact with Rancher using command line interface (CLI) tools from your workstation. The following docs will describe the [Rancher CLI](rancher-cli.md) and [kubectl Utility](kubectl-utility.md). \ No newline at end of file diff --git a/docs/reference-guides/cli-with-rancher/rancher-cli.md b/docs/reference-guides/cli-with-rancher/rancher-cli.md index 03860d29c94..e93d9805480 100644 --- a/docs/reference-guides/cli-with-rancher/rancher-cli.md +++ b/docs/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,18 +68,24 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| `machines, [machine]` | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| `up` | Applies compose config. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | - ### Rancher CLI Help Once logged into Rancher Server using the CLI, enter `./rancher --help` for a list of commands. diff --git a/docs/reference-guides/cluster-configuration/cluster-configuration.md b/docs/reference-guides/cluster-configuration/cluster-configuration.md index b9f319f98e1..139023b17d7 100644 --- a/docs/reference-guides/cluster-configuration/cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/cluster-configuration.md @@ -3,7 +3,7 @@ title: Cluster Configuration --- - + After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. diff --git a/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md b/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md index 897728cd346..e0c92a52f0f 100644 --- a/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md @@ -3,7 +3,7 @@ title: Downstream Cluster Configuration --- - + The following docs will discuss [node template configuration](node-template-configuration/node-template-configuration.md) and [machine configuration](machine-configuration/machine-configuration.md). \ No newline at end of file diff --git a/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md b/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md index b28ccd669dd..cff1dada268 100644 --- a/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md +++ b/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md @@ -3,7 +3,7 @@ title: Machine Configuration --- - + Machine configuration is the arrangement of resources assigned to a virtual machine. Please see the docs for [Amazon EC2](amazon-ec2.md), [DigitalOcean](digitalocean.md), and [Azure](azure.md) to learn more. \ No newline at end of file diff --git a/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md b/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md index bbe4d6127c3..e0f9ba4105d 100644 --- a/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md +++ b/docs/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md @@ -3,7 +3,7 @@ title: Node Template Configuration --- - + To learn about node template config, refer to [EC2 Node Template Configuration](amazon-ec2.md), [DigitalOcean Node Template Configuration](digitalocean.md), [Azure Node Template Configuration](azure.md), [vSphere Node Template Configuration](vsphere.md), and [Nutanix Node Template Configuration](nutanix.md). diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index 752fac44a2d..c7936942596 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -101,6 +101,13 @@ Also, if you provide the launch template, you can only update the template versi | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | | Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | +:::caution + +You can't directly update a node group to a newer Kubernetes version if the node group was created from a custom launch template. You must create a new launch template with the proper Kubernetes version, and associate the node group with the new template. + +::: + + #### Rancher-managed Launch Templates If you do not specify a launch template, then you will be able to configure the above options in the Rancher UI and all of them can be updated after creation. In order to take advantage of all of these options, Rancher will create and manage a launch template for you. Each cluster in Rancher will have one Rancher-managed launch template and each managed node group that does not have a specified launch template will have one version of the managed launch template. The name of this launch template will have the prefix "rancher-managed-lt-" followed by the display name of the cluster. In addition, the Rancher-managed launch template will be tagged with the key "rancher-managed-template" and value "do-not-modify-or-delete" to help identify it as Rancher-managed. It is important that this launch template and its versions not be modified, deleted, or used with any other clusters or managed node groups. Doing so could result in your node groups being "degraded" and needing to be destroyed and recreated. diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md index 8b63d9b8490..ad39397675d 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md @@ -3,7 +3,7 @@ title: GKE Cluster Configuration Reference --- - + ## Changes in Rancher v2.6 diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md index e4da90d371a..0e2aa590833 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md @@ -3,7 +3,7 @@ title: Rancher Server Configuration --- - + - [RKE1 Cluster Configuration](rke1-cluster-configuration.md) diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md index cca7752af30..45e8fba4b02 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md @@ -4,7 +4,7 @@ description: To create a cluster with custom nodes, you’ll need to access serv --- - + When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. diff --git a/docs/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md b/docs/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md index 62bade46a2a..7fea6f9a7d9 100644 --- a/docs/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md +++ b/docs/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md @@ -3,7 +3,7 @@ title: Monitoring V2 Configuration --- - + The following sections will explain important options essential to configuring Monitoring V2 in Rancher: diff --git a/docs/reference-guides/monitoring-v2-configuration/receivers.md b/docs/reference-guides/monitoring-v2-configuration/receivers.md index dc459f34378..79d9749dc18 100644 --- a/docs/reference-guides/monitoring-v2-configuration/receivers.md +++ b/docs/reference-guides/monitoring-v2-configuration/receivers.md @@ -24,8 +24,6 @@ This section assumes familiarity with how monitoring components work together. F ::: -To create notification receivers in the Rancher UI, - @@ -152,24 +150,20 @@ The Teams receiver is not a native receiver and must be enabled before it can be 1. Select the **Teams** option and click **Install**. 1. Take note of the namespace used as it will be required in a later step. -### Configure the Teams Receiver +### Configuring the Teams Receiver -The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration. +1. To configure the Teams receiver, update its ConfigMap. The following example is a minimal Teams receiver configuration: -```yaml -[Microsoft Teams] -teams-instance-1: https://your-teams-webhook-url -``` + ```yaml + [Microsoft Teams] + connector: https://your-teams-webhook-url + ``` -When configuration is complete, add the receiver using the steps in [this section](#creating-receivers-in-the-rancher-ui). +2. After you update the configuration, follow the instructions in [Creating Receivers in the Rancher UI](#creating-receivers-in-the-rancher-ui) to add the receiver. Use the example below to form your URL. Make sure to replace `` with the namespace of the `rancher-alerting-drivers` app: -Use the example below as the URL where: - -- `ns-1` is replaced with the namespace where the `rancher-alerting-drivers` app is installed - -```yaml -url: http://rancher-alerting-drivers-prom2teams.ns-1.svc:8089/v2/teams-instance-1 -``` + ```yaml + url: http://rancher-alerting-drivers-prom2teams..svc:8089/v2/connector + ``` @@ -187,7 +181,7 @@ The SMS receiver is not a native receiver and must be enabled before it can be u 1. Select the **SMS** option and click **Install**. 1. Take note of the namespace used as it will be required in a later step. -### Configure the SMS Receiver +### Configuring the SMS Receiver The SMS receiver can be configured by updating its ConfigMap. For example, the following is a minimal SMS receiver configuration. diff --git a/docs/reference-guides/prometheus-federator/prometheus-federator.md b/docs/reference-guides/prometheus-federator/prometheus-federator.md index 4b1e8a21143..5166ab8732f 100644 --- a/docs/reference-guides/prometheus-federator/prometheus-federator.md +++ b/docs/reference-guides/prometheus-federator/prometheus-federator.md @@ -3,7 +3,7 @@ title: Prometheus Federator --- - + Prometheus Federator, also referred to as Project Monitoring v2, deploys a Helm Project Operator (based on the [rancher/helm-project-operator](https://github.com/rancher/helm-project-operator)), an operator that manages deploying Helm charts each containing a Project Monitoring Stack, where each stack contains: diff --git a/docs/reference-guides/rancher-cluster-tools.md b/docs/reference-guides/rancher-cluster-tools.md index ca037f533de..5221e0f150e 100644 --- a/docs/reference-guides/rancher-cluster-tools.md +++ b/docs/reference-guides/rancher-cluster-tools.md @@ -41,8 +41,11 @@ For more information, refer to the monitoring documentation [here.](../integrati Rancher's integration with Istio was improved in Rancher v2.5. For more information, refer to the Istio documentation [here.](../integrations-in-rancher/istio/istio.md) + ## OPA Gatekeeper + + [OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper) is an open-source project that provides integration between OPA and Kubernetes to provide policy control via admission controller webhooks. For details on how to enable Gatekeeper in Rancher, refer to the [OPA Gatekeeper section.](../integrations-in-rancher/opa-gatekeeper.md) ## CIS Scans diff --git a/docs/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md b/docs/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md index 97ef05d0b6b..0e01bd3d293 100644 --- a/docs/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md +++ b/docs/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md @@ -3,7 +3,7 @@ title: Architecture --- - + This section focuses on the [Rancher server and its components](rancher-server-and-components.md) and how [Rancher communicates with downstream Kubernetes clusters](communicating-with-downstream-user-clusters.md). diff --git a/docs/reference-guides/rancher-security/hardening-guides/hardening-guides.md b/docs/reference-guides/rancher-security/hardening-guides/hardening-guides.md index 1ab615e083e..14366baeee7 100644 --- a/docs/reference-guides/rancher-security/hardening-guides/hardening-guides.md +++ b/docs/reference-guides/rancher-security/hardening-guides/hardening-guides.md @@ -3,7 +3,7 @@ title: Self-Assessment and Hardening Guides for Rancher --- - + Rancher provides specific security hardening guides for each supported Rancher version's Kubernetes distributions. diff --git a/docs/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md b/docs/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md index 285577fbca5..88f00624b20 100644 --- a/docs/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md +++ b/docs/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md @@ -3,7 +3,7 @@ title: K3s Hardening Guide --- - + This document provides prescriptive guidance for how to harden a K3s cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/docs/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md b/docs/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md index 838589b82ad..c7992611f8a 100644 --- a/docs/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md +++ b/docs/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md @@ -3,7 +3,7 @@ title: RKE Hardening Guide --- - + This document provides prescriptive guidance for how to harden an RKE cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/docs/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md b/docs/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md index 0cce6028916..a69c97665bb 100644 --- a/docs/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md +++ b/docs/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md @@ -3,7 +3,7 @@ title: RKE2 Hardening Guide --- - + This document provides prescriptive guidance for how to harden an RKE2 cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/docs/reference-guides/rancher-security/rancher-security.md b/docs/reference-guides/rancher-security/rancher-security.md index c39e0aaaed6..2a6fed33f3d 100644 --- a/docs/reference-guides/rancher-security/rancher-security.md +++ b/docs/reference-guides/rancher-security/rancher-security.md @@ -3,7 +3,7 @@ title: Security --- - + diff --git a/docs/reference-guides/rancher-security/rancher-webhook-hardening.md b/docs/reference-guides/rancher-security/rancher-webhook-hardening.md index 0362deecc5c..ed331807d11 100644 --- a/docs/reference-guides/rancher-security/rancher-webhook-hardening.md +++ b/docs/reference-guides/rancher-security/rancher-webhook-hardening.md @@ -2,6 +2,10 @@ title: Hardening the Rancher Webhook --- + + + + Rancher Webhook is an important component within Rancher, playing a role in enforcing security requirements for Rancher and its workloads. To decrease its attack surface, access to it should be limited to the only valid caller it has: the Kubernetes API server. This can be done by using network policies and authentication independently or in conjunction with each other to harden the webhook against attacks. ## Block External Traffic Using Network Policies diff --git a/docs/reference-guides/rancher-security/security-advisories-and-cves.md b/docs/reference-guides/rancher-security/security-advisories-and-cves.md index ad7fb02ad7b..0891c0d180c 100644 --- a/docs/reference-guides/rancher-security/security-advisories-and-cves.md +++ b/docs/reference-guides/rancher-security/security-advisories-and-cves.md @@ -10,6 +10,11 @@ Rancher is committed to informing the community of security issues in our produc | ID | Description | Date | Resolution | |----|-------------|------|------------| +| [CVE-2024-22030](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2024-22030) | A vulnerability was discovered in Rancher's and Fleet's agents, currently deemed a medium to high severity CVE, that under very specific circumstances allows a malicious actor to take over existing Rancher nodes. The attacker would need to have control of an expired domain or execute a DNS spoofing/hijacking attack against the domain in order to exploit this vulnerability. The targeted domain is the one used as the Rancher URL (the server-url of the Rancher cluster). At the moment there is no fix available and it affects all supported versions of Rancher. Customers and users are advised to follow the recommendations and best practices described in our [blog post](https://www.suse.com/c/rancher-security-update/). | 16 Feb 2024 | Pending | +| [CVE-2023-32193](https://github.com/rancher/norman/security/advisories/GHSA-r8f4-hv23-6qp6) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Norman). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32192](https://github.com/rancher/apiserver/security/advisories/GHSA-833m-37f7-jq55) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Apiserver). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-22649](https://github.com/rancher/rancher/security/advisories/GHSA-xfj7-qf8w-2gcr) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, in which sensitive data may be leaked into Rancher's audit logs. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32194](https://github.com/rancher/rancher/security/advisories/GHSA-c85r-fwc7-45vc) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where granting a `create` or `*` global role for a resource type of "namespaces"; no matter the API group, the subject will receive `*` permissions for core namespaces. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | | [CVE-2023-22648](https://github.com/rancher/rancher/security/advisories/GHSA-vf6j-6739-78m8) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which permission changes in Azure AD are not reflected to users until they logout and log back into the Rancher UI. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | | [CVE-2022-43760](https://github.com/rancher/rancher/security/advisories/GHSA-46v3-ggjg-qq3x) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | | [CVE-2020-10676](https://github.com/rancher/rancher/security/advisories/GHSA-8vhc-hwhc-cpj4) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which users with update privileges on a namespace, can move that namespace into a project they don't have access to. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | diff --git a/docs/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md b/docs/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md index f2d93d01bb1..75df1de0d00 100644 --- a/docs/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md +++ b/docs/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md @@ -3,7 +3,7 @@ title: SELinux RPM --- - + [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. diff --git a/docs/reference-guides/rancher-webhook.md b/docs/reference-guides/rancher-webhook.md index 046b638ba41..b2237a1d442 100644 --- a/docs/reference-guides/rancher-webhook.md +++ b/docs/reference-guides/rancher-webhook.md @@ -9,7 +9,7 @@ title: Rancher Webhook Rancher-Webhook is an essential component of Rancher that works in conjunction with Kubernetes to enhance security and enable critical features for Rancher-managed clusters. It integrates with Kubernetes' extensible admission controllers, as described in the [Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/), which allows Rancher-Webhook to inspect specific requests sent to the Kubernetes API server, and add custom, Rancher-specific validation and mutations to the requests that are specific to Rancher. Rancher-Webhook manages the resources to be validated using the `rancher.cattle.io` `ValidatingWebhookConfiguration` and the `rancher.cattle.io` `MutatingWebhookConfiguration`, and will override any manual edits. -Rancher deploys Rancher-Webhook as a separate deployment and service in both local and downstream clusters. Rancher manages Rancher-Webhook using Helm. It's important to note that Rancher may override modifications made by users to the Helm release. +Rancher deploys Rancher-Webhook as a separate deployment and service in both local and downstream clusters. Rancher manages Rancher-Webhook using Helm. It's important to note that Rancher may override modifications made by users to the Helm release. To safely modify these values see [Customizing Rancher-Webhook Configuration](#customizing-rancher-webhook-configuration). Each Rancher version is designed to be compatible with a single version of the webhook. The compatible versions are provided below for convenience. @@ -17,10 +17,11 @@ Each Rancher version is designed to be compatible with a single version of the w -| Rancher Version | Webhook Version | -|-----------------|:---------------:| -| v2.8.0 | v0.4.2 | -| v2.8.1 | v0.4.2 | +| Rancher Version | Webhook Version | Availability in Prime | Availability in Community | +|-----------------|-----------------|-----------------------|---------------------------| +| v2.8.2 | v0.4.2 | ✓ | ✓ | +| v2.8.1 | v0.4.2 | ✓ | ✓ | +| v2.8.0 | v0.4.2 | ✗ | ✓ | ## Why Do We Need It? @@ -48,20 +49,59 @@ To bypass the webhook, impersonate both the `rancher-webhook-sudo` service accou kubectl create -f example.yaml --as=system:serviceaccount:cattle-system:rancher-webhook-sudo --as-group=system:masters ``` +## Customizing Rancher-Webhook Configuration + +You can add custom Helm values when you install Rancher-Webhook via Helm. During a Helm install of the Rancher-Webhook chart, Rancher checks for custom Helm values. These custom values must be defined in a ConfigMap named `rancher-config`, in the `cattle-system` namespace, under the data key, `rancher-webhook`. The value of this key must be valid YAML. +``` yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: rancher-config + namespace: cattle-system + labels: + app.kubernetes.io/part-of: "rancher" +data: + rancher-webhook: '{"port": 9553, "priorityClassName": "system-node-critical"}' + +``` + +Rancher redeploys the Rancher-Webhook chart when changes to the ConfigMap values are detected. + +### Customizing Rancher-Webhook During Rancher Installation + +When you use Helm to install the Rancher chart, you can add custom Helm values to the Rancher-Webhook of the local cluster. All values in the Rancher-Webhook chart are accessible as nested variables under the `webhook` name. +These values are synced to the `rancher-config` ConfigMap during installation. + +```bash +helm install rancher rancher-/rancher \ + --namespace cattle-system \ + ... + --set webhook.port=9553 \ + --set webhook.priorityClassName="system-node-critical" +``` + ## Common Issues ### EKS Cluster with Calico CNI Users running an EKS cluster with Calico CNI may run into errors when the Kubernetes API server attempts to contact the Rancher-Webhook. -One workaround for this issue [documented by Calico](https://docs.tigera.io/calico/latest/getting-started/kubernetes/managed-public-cloud/eks#install-eks-with-calico-networking) involves setting `hostNetwork=true` for the webhook deployment. Users can change this using the Helm commands below on the affected clusters. +One workaround for this issue, as [documented by Calico](https://docs.tigera.io/calico/latest/getting-started/kubernetes/managed-public-cloud/eks#install-eks-with-calico-networking) involves setting `hostNetwork=true` for the webhook deployment. You can change this value by adding the Helm value `global.hostNetwork=true` to the `rancher-config` ConfigMap. See [Customizing Rancher-Webhook Configuration](#customizing-rancher-webhook-configuration) for more info. ``` bash -helm repo add rancher-charts https://charts.rancher.io -helm upgrade --reuse-values rancher-webhook rancher-charts/rancher-webhook -n cattle-system --set global.hostNetwork=true +apiVersion: v1 +kind: ConfigMap +metadata: + name: rancher-config + namespace: cattle-system + labels: + app.kubernetes.io/part-of: "rancher" +data: + rancher-webhook: '{"global": {"hostNetwork": true}}' ``` + **Note:** This temporary workaround may violate an environment's security policy. This workaround also requires that port 9443 is unused on the host network. -**Note:** Helm uses secrets by default. This is a datatype that some webhook versions validate to store information. In these cases, directly update the deployment with the hostNetwork=true value using kubectl, then run the Helm commands listed above to prevent drift between the Helm configuration and the actual state of the cluster. +**Note:** By default, Helm stores information as secrets. Secrets are a resource that some webhook versions validate. In these cases, directly update the deployment with the `hostNetwork=true` value using kubectl, then update the webhook configuration as specified above. ### Private GKE Cluster diff --git a/docs/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md b/docs/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md index e605bd0c77a..bc0f02856a7 100644 --- a/docs/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md +++ b/docs/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md @@ -3,7 +3,7 @@ title: Single Node Rancher in Docker --- - + The following docs will discuss [HTTP proxy configuration](http-proxy-configuration.md) and [advanced options](advanced-options.md) for Docker installs. \ No newline at end of file diff --git a/docs/reference-guides/user-settings/user-settings.md b/docs/reference-guides/user-settings/user-settings.md index 496fde5638c..5a618c1024d 100644 --- a/docs/reference-guides/user-settings/user-settings.md +++ b/docs/reference-guides/user-settings/user-settings.md @@ -3,7 +3,7 @@ title: User Settings --- - + Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. diff --git a/docs/security/security-scan/security-scan.md b/docs/security/security-scan/security-scan.md index cacabb6266d..8c58771c736 100644 --- a/docs/security/security-scan/security-scan.md +++ b/docs/security/security-scan/security-scan.md @@ -3,7 +3,7 @@ title: Security Scans --- - + https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides The documentation about CIS security scans has moved [here.](../../how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md) diff --git a/docs/shared-files/_common-ports-table.md b/docs/shared-files/_common-ports-table.md index 1835beba031..4016670ef3d 100644 --- a/docs/shared-files/_common-ports-table.md +++ b/docs/shared-files/_common-ports-table.md @@ -1,19 +1,18 @@ -| Protocol | Port | Description | -|:--------: |:----------------: |---------------------------------------------------------------------------------- | -| TCP | 22 | Node driver SSH provisioning | -| TCP | 179 | Calico BGP Port | -| TCP | 2376 | Node driver Docker daemon TLS port | -| TCP | 2379 | etcd client requests | -| TCP | 2380 | etcd peer communication | -| UDP | 8472 | Canal/Flannel VXLAN overlay networking | -| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | -| TCP | 8443 | Rancher webhook | -| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | -| TCP | 9100 | Default port required by Monitoring to scrape metrics from Linux node-exporters | -| TCP | 9443 | Rancher webhook | -| TCP | 9796 | Default port required by Monitoring to scrape metrics from Windows node-exporters | -| TCP | 6783 | Weave Port | -| UDP | 6783-6784 | Weave UDP Ports | -| TCP | 10250 | Metrics server communication with all nodes API | -| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | -| TCP/UDP | 30000-32767 | NodePort port range | +| Protocol | Port | Description | +|:--------: |:----------------: |---------------------------------------------------------------------------------------------| +| TCP | 22 | Node driver SSH provisioning | +| TCP | 179 | Calico BGP Port | +| TCP | 2376 | Node driver Docker daemon TLS port | +| TCP | 2379 | etcd client requests | +| TCP | 2380 | etcd peer communication | +| UDP | 8472 | Canal/Flannel VXLAN overlay networking | +| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | +| TCP | 8443 | Rancher webhook | +| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | +| TCP | 9443 | Rancher webhook | +| TCP | 9796 | Default port required by Monitoring to scrape metrics from Linux and Windows node-exporters | +| TCP | 6783 | Weave Port | +| UDP | 6783-6784 | Weave UDP Ports | +| TCP | 10250 | Metrics server communication with all nodes API | +| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | +| TCP/UDP | 30000-32767 | NodePort port range | diff --git a/docs/troubleshooting/kubernetes-components/kubernetes-components.md b/docs/troubleshooting/kubernetes-components/kubernetes-components.md index 53863435277..b7995b5921c 100644 --- a/docs/troubleshooting/kubernetes-components/kubernetes-components.md +++ b/docs/troubleshooting/kubernetes-components/kubernetes-components.md @@ -3,7 +3,7 @@ title: Kubernetes Components --- - + The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) clusters. diff --git a/i18n/zh/docusaurus-theme-classic/footer.json b/i18n/zh/docusaurus-theme-classic/footer.json index 07aa991f00e..231806094e0 100644 --- a/i18n/zh/docusaurus-theme-classic/footer.json +++ b/i18n/zh/docusaurus-theme-classic/footer.json @@ -1,6 +1,6 @@ { "copyright": { - "message": "Copyright © 2023 SUSE Rancher. All Rights Reserved.", + "message": "Copyright © 2024 SUSE Rancher. All Rights Reserved.", "description": "The footer copyright" } } diff --git a/package.json b/package.json index e7d60f81353..4b7bac95674 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", - "build": "NODE_OPTIONS='--max-old-space-size=6144' docusaurus build", + "build": "NODE_OPTIONS='--max-old-space-size=7168' docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear", diff --git a/shared-files/_cni-popularity.md b/shared-files/_cni-popularity.md index e2b5bf845c9..1135809c068 100644 --- a/shared-files/_cni-popularity.md +++ b/shared-files/_cni-popularity.md @@ -1,10 +1,10 @@ -The following table summarizes different GitHub metrics to give you an idea of each project's popularity and activity levels. This data was collected in January 2024. +The following table summarizes different GitHub metrics to give you an idea of each project's popularity and activity levels. This data was collected in February 2024. | Provider | Project | Stars | Forks | Contributors | | ---- | ---- | ---- | ---- | ---- | | Canal | https://github.com/projectcalico/canal | 708 | 103 | 20 | -| Flannel | https://github.com/flannel-io/flannel | 8.3k | 2.9k | 231 | -| Calico | https://github.com/projectcalico/calico | 5.2k | 1.2k | 332 | -| Weave | https://github.com/weaveworks/weave/ | 6.5k | 670 | 87 | -| Cilium | https://github.com/cilium/cilium | 17.6k | 2.6k | 689 | +| Flannel | https://github.com/flannel-io/flannel | 8.4k | 2.9k | 231 | +| Calico | https://github.com/projectcalico/calico | 5.3k | 1.2k | 336 | +| Weave | https://github.com/weaveworks/weave/ | 6.6k | 679 | 87 | +| Cilium | https://github.com/cilium/cilium | 18k | 2.6k | 706 | diff --git a/shared-files/_deprecation-helm2.md b/shared-files/_deprecation-helm2.md new file mode 100644 index 00000000000..7bb9bb3a8e3 --- /dev/null +++ b/shared-files/_deprecation-helm2.md @@ -0,0 +1,5 @@ +:::warning + +Helm v2 support is deprecated as of the Rancher v2.7 line and will be removed in Rancher v2.9. + +::: diff --git a/shared-files/_deprecation-opa-gatekeeper.md b/shared-files/_deprecation-opa-gatekeeper.md new file mode 100644 index 00000000000..3a88f57b0d6 --- /dev/null +++ b/shared-files/_deprecation-opa-gatekeeper.md @@ -0,0 +1,5 @@ +:::warning + +OPA Gatekeeper is deprecated and will be removed in a future release. As a replacement for OPA Gatekeeper, consider switching to Kubewarden. + +::: diff --git a/sidebars.js b/sidebars.js index 2503691bcbe..e80a933e2bc 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1175,7 +1175,6 @@ const sidebars = { }, "integrations-in-rancher/kubewarden/kubewarden", "integrations-in-rancher/elemental/elemental", - "integrations-in-rancher/opni/opni", { "type": "category", "label": "Continuous Delivery with Fleet", @@ -1191,7 +1190,6 @@ const sidebars = { ] }, "integrations-in-rancher/rancher-desktop", - "integrations-in-rancher/epinio/epinio", { type: 'category', label: 'Cloud Marketplace Integration', diff --git a/src/pages/versions.md b/src/pages/versions.md index 2ab2238df0e..446d0180d4b 100644 --- a/src/pages/versions.md +++ b/src/pages/versions.md @@ -6,118 +6,216 @@ title: Rancher Documentation Versions ### Current versions -Below are the documentation and release notes for the currently released version of Rancher 2.8.x: +Here you can find links to supporting documentation for the current released version of Rancher v2.8, and its availability for [Rancher Prime](/v2.8/getting-started/quick-start-guides/deploy-rancher-manager/prime) and the Community version of Rancher:
- + + + + + + + + + - + + + + + +
v2.8.1VersionDocumentationRelease NotesSupport MatrixPrimeCommunity
v2.8.2 DocumentationRelease NotesRelease NotesSupport Matrix
✓
✓
+ +Here you can find links to supporting documentation for the current released version of Rancher v2.7, and its availability for [Rancher Prime](/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/prime) and the Community version of Rancher: + + + + + + + + + + + + + + + +
VersionDocumentationRelease NotesSupport MatrixPrimeCommunity
v2.7.11DocumentationRelease Notes
N/A
✓
N/A
-Below are the documentation and release notes for the currently released version of Rancher 2.7.x: +Here you can find links to supporting documentation for the current released version of Rancher v2.6: - - - - + + + + -
v2.7.9DocumentationRelease NotesSupport MatrixVersionDocumentationRelease NotesSupport Matrix
- -Below are the documentation and release notes for the currently released version of Rancher 2.6.x: - - - + - - + +
v2.6.13v2.6.14 DocumentationRelease NotesSupport MatrixRelease NotesSupport Matrix
### Past versions -Below are the documentation and release notes for previous versions of Rancher 2.8.x: +Here you can find links to supporting documentation for previous versions of Rancher v2.8, and their availability for [Rancher Prime](/v2.8/getting-started/quick-start-guides/deploy-rancher-manager/prime) and the Community version of Rancher: + + + + + + + + + + + + + + + + + +
VersionDocumentationRelease NotesSupport MatrixPrimeCommunity
v2.8.1DocumentationRelease NotesSupport Matrix
✓
✓
v2.8.0 Documentation Release Notes
N/A
N/A
✓

-Below are the documentation and release notes for previous versions of Rancher 2.7.x: +Here you can find links to supporting documentation for previous versions of Rancher v2.7, and their availability for [Rancher Prime](/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/prime) and the Community version of Rancher: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VersionDocumentationRelease NotesSupport MatrixPrimeCommunity
v2.7.10DocumentationRelease NotesSupport Matrix
✓
✓
v2.7.9DocumentationRelease NotesSupport Matrix
✓
✓
v2.7.8 Documentation Release Notes
N/A
N/A
✓
v2.7.7 Documentation Release Notes
N/A
N/A
✓
v2.7.6 Documentation Release Notes Support Matrix
✓
✓
v2.7.5 Documentation Release Notes Support Matrix
✓
✓
v2.7.4 Documentation Release Notes Support Matrix
✓
✓
v2.7.3 Documentation Release Notes Support Matrix
✓
✓
v2.7.2 Documentation Release Notes Support Matrix
✓
✓
v2.7.1 Documentation Release Notes Support Matrix
✓
✓
v2.7.0 Documentation Release Notes Support Matrix
✓
✓

-Below are the documentation and release notes for previous versions of Rancher 2.6.x: +Here you can find links to supporting documentation for previous versions of Rancher v2.6: + + + + + + + + + + + + @@ -202,9 +300,15 @@ Below are the documentation and release notes for previous versions of Rancher 2 ### Legacy versions (EOL) -Below are the documentation and release notes for legacy versions of Rancher 2.5.x: +Here you can find links to supporting documentation for legacy versions of Rancher v2.5:
VersionDocumentationRelease NotesSupport Matrix
v2.6.13DocumentationRelease NotesSupport Matrix
v2.6.12 Documentation
+ + + + + + @@ -317,11 +421,15 @@ Below are the documentation and release notes for legacy versions of Rancher 2.5
-Below is the documentation for legacy versions of Rancher 2.0 - 2.4.x: +Here you can find links to supporting documentation for legacy versions of v2.0-v2.4:
VersionDocumentationRelease NotesSupport Matrix
v2.5.17 Documentation
- + + + + +
v2.0 - v2.4VersionDocumentation
v2.0-v2.4 Documentation
\ No newline at end of file diff --git a/src/theme/MDXComponents.js b/src/theme/MDXComponents.js new file mode 100644 index 00000000000..e13c8e76ba4 --- /dev/null +++ b/src/theme/MDXComponents.js @@ -0,0 +1,26 @@ +// Import the original mapper +import MDXComponents from '@theme-original/MDXComponents'; + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +import { CardSection, Card } from '../components/CardComponents'; + +import CNIPopularityTable from '/shared-files/_cni-popularity.md'; +import DeprecationOPAGatekeeper from '/shared-files/_deprecation-opa-gatekeeper.md'; +import DeprecationHelm2 from '/shared-files/_deprecation-helm2.md'; + +export default { + // Re-use the default mapping + ...MDXComponents, + + Tabs: Tabs, + TabItem: TabItem, + + CardSection, + Card, + + CNIPopularityTable, + DeprecationOPAGatekeeper, + DeprecationHelm2, +}; diff --git a/src/theme/MDXComponents/A.js b/src/theme/MDXComponents/A.js deleted file mode 100644 index 95d0f65e3a8..00000000000 --- a/src/theme/MDXComponents/A.js +++ /dev/null @@ -1,5 +0,0 @@ -import React from 'react'; -import Link from '@docusaurus/Link'; -export default function MDXA(props) { - return ; -} diff --git a/src/theme/MDXComponents/Code.js b/src/theme/MDXComponents/Code.js deleted file mode 100644 index 1fffc81f55a..00000000000 --- a/src/theme/MDXComponents/Code.js +++ /dev/null @@ -1,42 +0,0 @@ -import React, {isValidElement} from 'react'; -import CodeBlock from '@theme/CodeBlock'; -export default function MDXCode(props) { - const inlineElements = [ - 'a', - 'abbr', - 'b', - 'br', - 'button', - 'cite', - 'code', - 'del', - 'dfn', - 'em', - 'i', - 'img', - 'input', - 'ins', - 'kbd', - 'label', - 'object', - 'output', - 'q', - 'ruby', - 's', - 'small', - 'span', - 'strong', - 'sub', - 'sup', - 'time', - 'u', - 'var', - 'wbr', - ]; - const shouldBeInline = React.Children.toArray(props.children).every( - (el) => - (typeof el === 'string' && !el.includes('\n')) || - (isValidElement(el) && inlineElements.includes(el.props?.mdxType)), - ); - return shouldBeInline ? : ; -} diff --git a/src/theme/MDXComponents/Details.js b/src/theme/MDXComponents/Details.js deleted file mode 100644 index e434109be22..00000000000 --- a/src/theme/MDXComponents/Details.js +++ /dev/null @@ -1,16 +0,0 @@ -import React from 'react'; -import Details from '@theme/Details'; -export default function MDXDetails(props) { - const items = React.Children.toArray(props.children); - // Split summary item from the rest to pass it as a separate prop to the - // Details theme component - const summary = items.find( - (item) => React.isValidElement(item) && item.props?.mdxType === 'summary', - ); - const children = <>{items.filter((item) => item !== summary)}; - return ( -
- {children} -
- ); -} diff --git a/src/theme/MDXComponents/Head.js b/src/theme/MDXComponents/Head.js deleted file mode 100644 index 6f702303cb6..00000000000 --- a/src/theme/MDXComponents/Head.js +++ /dev/null @@ -1,17 +0,0 @@ -import React from 'react'; -import Head from '@docusaurus/Head'; -// MDX elements are wrapped through the MDX pragma. In some cases (notably usage -// with Head/Helmet) we need to unwrap those elements. -function unwrapMDXElement(element) { - if (element.props?.mdxType && element.props.originalType) { - const {mdxType, originalType, ...newProps} = element.props; - return React.createElement(element.props.originalType, newProps); - } - return element; -} -export default function MDXHead(props) { - const unwrappedChildren = React.Children.map(props.children, (child) => - React.isValidElement(child) ? unwrapMDXElement(child) : child, - ); - return {unwrappedChildren}; -} diff --git a/src/theme/MDXComponents/Heading.js b/src/theme/MDXComponents/Heading.js deleted file mode 100644 index a96288c66f2..00000000000 --- a/src/theme/MDXComponents/Heading.js +++ /dev/null @@ -1,5 +0,0 @@ -import React from 'react'; -import Heading from '@theme/Heading'; -export default function MDXHeading(props) { - return ; -} diff --git a/src/theme/MDXComponents/MDXComponents.js b/src/theme/MDXComponents/MDXComponents.js deleted file mode 100644 index ee1fadd357d..00000000000 --- a/src/theme/MDXComponents/MDXComponents.js +++ /dev/null @@ -1,18 +0,0 @@ -// Import the original mapper -import MDXComponents from '@theme-original/MDXComponents'; - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -import { CardSection, Card } from '../components/CardComponents'; - -export default { - // Re-use the default mapping - ...MDXComponents, - - Tabs, - TabItem, - - CardSection, - Card, -}; diff --git a/src/theme/MDXComponents/Pre.js b/src/theme/MDXComponents/Pre.js deleted file mode 100644 index 8a47cc760c3..00000000000 --- a/src/theme/MDXComponents/Pre.js +++ /dev/null @@ -1,13 +0,0 @@ -import React, {isValidElement} from 'react'; -import CodeBlock from '@theme/CodeBlock'; -export default function MDXPre(props) { - return ( - - ); -} diff --git a/src/theme/MDXComponents/index.js b/src/theme/MDXComponents/index.js deleted file mode 100644 index 9b2418a4b6e..00000000000 --- a/src/theme/MDXComponents/index.js +++ /dev/null @@ -1,33 +0,0 @@ -import React from 'react'; -import MDXHead from '@theme/MDXComponents/Head'; -import MDXCode from '@theme/MDXComponents/Code'; -import MDXA from '@theme/MDXComponents/A'; -import MDXPre from '@theme/MDXComponents/Pre'; -import MDXDetails from '@theme/MDXComponents/Details'; -import MDXHeading from '@theme/MDXComponents/Heading'; -import MDXUl from '@theme/MDXComponents/Ul'; -import MDXImg from '@theme/MDXComponents/Img'; -import Admonition from '@theme/Admonition'; -import Mermaid from '@theme/Mermaid'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -const MDXComponents = { - head: MDXHead, - code: MDXCode, - a: MDXA, - pre: MDXPre, - details: MDXDetails, - ul: MDXUl, - img: MDXImg, - h1: (props) => , - h2: (props) => , - h3: (props) => , - h4: (props) => , - h5: (props) => , - h6: (props) => , - admonition: Admonition, - mermaid: Mermaid, - Tabs: Tabs, - TabItem: TabItem, -}; -export default MDXComponents; diff --git a/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/cis-scans/cis-scans.md b/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/cis-scans/cis-scans.md index 6a63409dc8d..dfeab9ea06a 100644 --- a/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/cis-scans/cis-scans.md +++ b/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/cis-scans/cis-scans.md @@ -3,7 +3,7 @@ title: CIS Scans --- - + _Available as of v2.4.0_ diff --git a/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/istio/istio.md index a424fe60752..18b81c820c1 100644 --- a/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/istio/istio.md @@ -3,7 +3,7 @@ title: Istio --- - + _Available as of v2.3.0_ diff --git a/versioned_docs/version-2.0-2.4/faq/container-network-interface-providers.md b/versioned_docs/version-2.0-2.4/faq/container-network-interface-providers.md index 4c2662c0a91..8c9b3a5351b 100644 --- a/versioned_docs/version-2.0-2.4/faq/container-network-interface-providers.md +++ b/versioned_docs/version-2.0-2.4/faq/container-network-interface-providers.md @@ -136,8 +136,6 @@ The following table summarizes the different features available for each CNI net ### CNI Community Popularity -import CNIPopularityTable from '/shared-files/_cni-popularity.md'; - ### Which CNI Provider Should I Use? diff --git a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md index a3c8f5b3a1f..61f6e6b0a6e 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md +++ b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + ## Prerequisite diff --git a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-and-upgrade.md b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-and-upgrade.md index 266ed2c9aec..bee5ca461e1 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-and-upgrade.md +++ b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-and-upgrade.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + This section provides an overview of the architecture options of installing Rancher, describing advantages of each option. diff --git a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md index 80ba5da35ac..f741601ed89 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md +++ b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md @@ -4,7 +4,7 @@ description: Learn the node requirements for each node running Rancher server wh --- - + This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster. diff --git a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md index 7b5813c98f8..9c9996e529c 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md +++ b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md @@ -3,7 +3,7 @@ title: Air Gapped Helm CLI Install --- - + This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. diff --git a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md index 39b75558e22..e705d3b4a16 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md +++ b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md @@ -3,7 +3,7 @@ title: Installing Rancher behind an HTTP Proxy --- - + In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment. diff --git a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md index 0f7b4da1631..34350b4fef1 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md +++ b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md @@ -4,7 +4,7 @@ description: For development and testing environments only, use a Docker install --- - + Rancher can be installed by running a single Docker container. diff --git a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/resources/resources.md b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/resources/resources.md index 15d5c33e131..8303051e5c4 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/resources/resources.md +++ b/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/resources/resources.md @@ -3,7 +3,7 @@ title: Resources --- - + ### Docker Installations diff --git a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md index a4082fe9e8d..7e5728912a4 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md +++ b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md @@ -3,7 +3,7 @@ title: Deploying Rancher Server --- - + Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. diff --git a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md index 1f7d7df5017..a8967891a35 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md +++ b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md @@ -2,6 +2,10 @@ title: Manual Quick Start --- + + + + Howdy Partner! This tutorial walks you through: - Installation of Rancher 2.x diff --git a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md index e6042decd34..3a7034c05df 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md +++ b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md @@ -3,7 +3,7 @@ title: Deploying Workloads --- - + These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. diff --git a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/quick-start-guides.md b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/quick-start-guides.md index e5b7bce7295..232fb088fe8 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/quick-start-guides.md +++ b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/quick-start-guides.md @@ -3,7 +3,7 @@ title: Rancher Deployment Quick Start Guides --- - + >**Note:** The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation](../installation-and-upgrade/installation-and-upgrade.md). diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/advanced-user-guides.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/advanced-user-guides.md index b5b3d241037..68ffc4c7ed3 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/advanced-user-guides.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/advanced-user-guides.md @@ -3,7 +3,7 @@ title: Advanced User Guides --- - + Advanced user guides are "problem-oriented" docs in which users learn how to answer questions or solve problems. The major difference between these and the new user guides is that these guides are geared toward more experienced or advanced users who have more technical needs from their documentation. These users already have an understanding of Rancher and its functions. They know what they need to accomplish; they just need additional guidance to complete some more complex task they they have encountered while working. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md index a96fa4fc9d8..5130640e2a3 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md @@ -3,7 +3,7 @@ title: CIS Scan Guides --- - + - [Run a Scan](run-a-scan.md) diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md index b6f779e7b5a..59f6f649581 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md @@ -3,7 +3,7 @@ title: Setup Guide --- - + This section describes how to enable Istio and start using it in your projects. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md index 19b054cfa9b..779957df112 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md @@ -3,7 +3,7 @@ title: Project Resource Quotas --- - + _Available as of v2.1.0_ diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md index 6166aaf3e3d..af7484c6329 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md @@ -3,7 +3,7 @@ title: Project Administration --- - + _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/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md index dd5e55cefe9..395ba4ed672 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md @@ -2,6 +2,10 @@ title: Backing up Rancher Installed on an RKE Kubernetes Cluster --- + + + + This section describes how to create backups of your high-availability Rancher install. In an RKE installation, the cluster data is replicated on each of three etcd nodes in the cluster, providing redundancy and data duplication in case one of the nodes fails. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 1bda37e264a..44d6ac9a85c 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -4,7 +4,7 @@ keywords: [rancher v2.0-v2.4 backup restore, rancher v2.0-v2.4 backup and restor --- - + This section is devoted to protecting your data in a disaster scenario. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md index 073b4ae43f6..7efdc85fc41 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md @@ -2,6 +2,10 @@ title: Restoring Backups—Kubernetes installs --- + + + + This procedure describes how to use RKE to restore a snapshot of the Rancher Kubernetes cluster. This will restore the Kubernetes configuration and the Rancher database and state. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 94585bc8eda..009221ac22e 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -4,7 +4,7 @@ description: Rancher enables the use of catalogs to repeatedly deploy applicatio --- - + Rancher provides the ability to use a catalog of Helm charts that make it easy to repeatedly deploy applications. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md index ccdca3126b8..7a79e5f5622 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md @@ -3,7 +3,7 @@ title: Don't have infrastructure for your Kubernetes cluster? Try one of these t --- - + To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](ha-k3s-kubernetes-cluster.md) diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md index 2d724a0005c..714755763ad 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md @@ -3,7 +3,7 @@ title: "Don't have a Kubernetes cluster? Try one of these tutorials." --- - + This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md index a86df4c7fd7..8ffce977eb9 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md @@ -3,7 +3,7 @@ title: Checklist for Production-Ready Clusters --- - + In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md index 9ed2d5ec9c4..9778c4b0db7 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md @@ -4,7 +4,7 @@ description: Provisioning Kubernetes Clusters --- - + Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md index 15865a23234..be4fc8c113c 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md @@ -3,7 +3,7 @@ title: Setting up Clusters from Hosted Kubernetes Providers --- - + In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md index d21dda386c8..d0d1b233373 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md @@ -4,7 +4,7 @@ description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs --- - + The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md index aeeb2a07a98..1df605165d2 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md @@ -3,7 +3,7 @@ title: Kubernetes Resources --- - + ## Workloads diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md index be4e6c4074b..3e166096ded 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md @@ -4,7 +4,7 @@ description: Learn how you can set up load balancers and ingress controllers to --- - + Within Rancher, you can set up load balancers and ingress controllers to redirect service requests. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md index c20787712ae..b9bd0fa0a47 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md @@ -4,7 +4,7 @@ description: "Learn about the two constructs with which you can build any comple --- - + You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services. diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/new-user-guides.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/new-user-guides.md index e2e68ff0089..cc86980e4ad 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/new-user-guides.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/new-user-guides.md @@ -3,7 +3,7 @@ title: New User Guides --- - + New user guides, also known as **tutorials**, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing". diff --git a/versioned_docs/version-2.0-2.4/rancher-manager.md b/versioned_docs/version-2.0-2.4/rancher-manager.md index 2e65a444a6b..4ecdcc75d0b 100644 --- a/versioned_docs/version-2.0-2.4/rancher-manager.md +++ b/versioned_docs/version-2.0-2.4/rancher-manager.md @@ -3,6 +3,10 @@ title: "Rancher 2.0-2.4" description: "Rancher adds significant value on top of Kubernetes: managing hundreds of clusters from one interface, centralizing RBAC, enabling monitoring and alerting. Read more." slug: / --- + + + + Rancher was originally built to work with multiple orchestrators, and it included its own orchestrator called Cattle. With the rise of Kubernetes in the marketplace, Rancher 2.x exclusively deploys and manages Kubernetes clusters running anywhere, on any provider. Rancher can provision Kubernetes from a hosted provider, provision compute nodes and then install Kubernetes onto them, or import existing Kubernetes clusters running anywhere. diff --git a/versioned_docs/version-2.0-2.4/reference-guides/about-the-api/about-the-api.md b/versioned_docs/version-2.0-2.4/reference-guides/about-the-api/about-the-api.md index 8842281f1cc..f6f7c531057 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/about-the-api/about-the-api.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/about-the-api/about-the-api.md @@ -3,7 +3,7 @@ title: API --- - + ## How to use the API diff --git a/versioned_docs/version-2.0-2.4/reference-guides/best-practices/best-practices.md b/versioned_docs/version-2.0-2.4/reference-guides/best-practices/best-practices.md index 546ae01be94..d2520a3e785 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/best-practices/best-practices.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/best-practices/best-practices.md @@ -3,7 +3,7 @@ title: Best Practices Guide --- - + The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers. diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/cli-with-rancher.md b/versioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/cli-with-rancher.md index a0e50c51b71..a18cabf5abb 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/cli-with-rancher.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/cli-with-rancher/cli-with-rancher.md @@ -3,7 +3,7 @@ title: CLI with Rancher --- - + Interact with Rancher using command line interface (CLI) tools from your workstation. The following docs will describe the [Rancher CLI](rancher-cli.md) and [kubectl Utility](kubectl-utility.md). \ No newline at end of file diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/cluster-configuration.md b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/cluster-configuration.md index a0b3b35e894..5508edbcd0e 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/cluster-configuration.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/cluster-configuration.md @@ -3,7 +3,7 @@ title: Cluster Configuration --- - + After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md index fc90e697d37..e6b5b618d66 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md @@ -3,7 +3,7 @@ title: Downstream Cluster Configuration --- - + The following docs will discuss [node template configuration](node-template-configuration/node-template-configuration.md). \ No newline at end of file diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md index 94dca9f7f29..4657f28683a 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md @@ -3,7 +3,7 @@ title: Node Template Configuration --- - + To learn about node template config, refer to [EC2 Node Template Configuration](amazon-ec2.md), [DigitalOcean Node Template Configuration](digitalocean.md), [Azure Node Template Configuration](azure.md), and [vSphere Node Template Configuration](vsphere/vsphere.md). diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md index c388a000a71..514a66ce196 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md @@ -3,7 +3,7 @@ title: Rancher Server Configuration --- - + - [RKE1 Cluster Configuration](rke1-cluster-configuration.md) diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md index 35d21695ee6..ee304df4897 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md @@ -4,7 +4,7 @@ description: To create a cluster with custom nodes, you’ll need to access serv --- - + When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. diff --git a/versioned_docs/version-2.0-2.4/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md b/versioned_docs/version-2.0-2.4/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md index 3943af76df0..a3df555f326 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md @@ -3,7 +3,7 @@ title: Architecture --- - + This section focuses on the [Rancher server and its components](rancher-server-and-components.md) and how [Rancher communicates with downstream Kubernetes clusters](communicating-with-downstream-user-clusters.md). diff --git a/versioned_docs/version-2.0-2.4/reference-guides/rancher-security/rancher-security.md b/versioned_docs/version-2.0-2.4/reference-guides/rancher-security/rancher-security.md index f0475b469e3..14bcde93599 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/rancher-security/rancher-security.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/rancher-security/rancher-security.md @@ -3,7 +3,7 @@ title: Security --- - + diff --git a/versioned_docs/version-2.0-2.4/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md b/versioned_docs/version-2.0-2.4/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md index e605bd0c77a..bc0f02856a7 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md @@ -3,7 +3,7 @@ title: Single Node Rancher in Docker --- - + The following docs will discuss [HTTP proxy configuration](http-proxy-configuration.md) and [advanced options](advanced-options.md) for Docker installs. \ No newline at end of file diff --git a/versioned_docs/version-2.0-2.4/reference-guides/user-settings/user-settings.md b/versioned_docs/version-2.0-2.4/reference-guides/user-settings/user-settings.md index 9010babf5b4..150447863ee 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/user-settings/user-settings.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/user-settings/user-settings.md @@ -3,7 +3,7 @@ title: User Settings --- - + Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. diff --git a/versioned_docs/version-2.0-2.4/security/security-scan/security-scan.md b/versioned_docs/version-2.0-2.4/security/security-scan/security-scan.md index cacabb6266d..8c58771c736 100644 --- a/versioned_docs/version-2.0-2.4/security/security-scan/security-scan.md +++ b/versioned_docs/version-2.0-2.4/security/security-scan/security-scan.md @@ -3,7 +3,7 @@ title: Security Scans --- - + https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides The documentation about CIS security scans has moved [here.](../../how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md) diff --git a/versioned_docs/version-2.0-2.4/shared-files/_common-ports-table.md b/versioned_docs/version-2.0-2.4/shared-files/_common-ports-table.md index 70749ce3979..2af23350dc0 100644 --- a/versioned_docs/version-2.0-2.4/shared-files/_common-ports-table.md +++ b/versioned_docs/version-2.0-2.4/shared-files/_common-ports-table.md @@ -1,19 +1,18 @@ -| Protocol | Port | Description | -|:--------: |:----------------: |---------------------------------------------------------------------------------- | -| TCP | 22 | Node driver SSH provisioning | -| TCP | 179 | Calico BGP Port | -| TCP | 2376 | Node driver Docker daemon TLS port | -| TCP | 2379 | etcd client requests | -| TCP | 2380 | etcd peer communication | -| UDP | 8472 | Canal/Flannel VXLAN overlay networking | -| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | -| TCP | 8443 | Rancher webhook | -| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | -| TCP | 9100 | Default port required by Monitoring to scrape metrics from Linux node-exporters | -| TCP | 9443 | Rancher webhook | -| TCP | 9796 | Default port required by Monitoring to scrape metrics from Windows node-exporters | -| TCP | 6783 | Weave Port | -| UDP | 6783-6784 | Weave UDP Ports | -| TCP | 10250 | kubelet API | -| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | -| TCP/UDP | 30000-32767 | NodePort port range | +| Protocol | Port | Description | +|:--------: |:----------------: |-------------------------------------------------------------------------------------------- | +| TCP | 22 | Node driver SSH provisioning | +| TCP | 179 | Calico BGP Port | +| TCP | 2376 | Node driver Docker daemon TLS port | +| TCP | 2379 | etcd client requests | +| TCP | 2380 | etcd peer communication | +| UDP | 8472 | Canal/Flannel VXLAN overlay networking | +| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | +| TCP | 8443 | Rancher webhook | +| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | +| TCP | 9443 | Rancher webhook | +| TCP | 9796 | Default port required by Monitoring to scrape metrics from Linux and Windows node-exporters | +| TCP | 6783 | Weave Port | +| UDP | 6783-6784 | Weave UDP Ports | +| TCP | 10250 | kubelet API | +| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | +| TCP/UDP | 30000-32767 | NodePort port range | diff --git a/versioned_docs/version-2.0-2.4/troubleshooting/kubernetes-components/kubernetes-components.md b/versioned_docs/version-2.0-2.4/troubleshooting/kubernetes-components/kubernetes-components.md index 873326222c3..6ce57f84652 100644 --- a/versioned_docs/version-2.0-2.4/troubleshooting/kubernetes-components/kubernetes-components.md +++ b/versioned_docs/version-2.0-2.4/troubleshooting/kubernetes-components/kubernetes-components.md @@ -3,7 +3,7 @@ title: Kubernetes Components --- - + The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) clusters. diff --git a/versioned_docs/version-2.5/explanations/integrations-in-rancher/cis-scans/cis-scans.md b/versioned_docs/version-2.5/explanations/integrations-in-rancher/cis-scans/cis-scans.md index a32e08df517..f31e0ebae52 100644 --- a/versioned_docs/version-2.5/explanations/integrations-in-rancher/cis-scans/cis-scans.md +++ b/versioned_docs/version-2.5/explanations/integrations-in-rancher/cis-scans/cis-scans.md @@ -3,7 +3,7 @@ title: CIS Scans --- - + Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. diff --git a/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/configuration-options/configuration-options.md b/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/configuration-options/configuration-options.md index 35546a12f03..5f553689ab0 100644 --- a/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/configuration-options/configuration-options.md +++ b/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/configuration-options/configuration-options.md @@ -3,7 +3,7 @@ title: Configuration Options --- - + ### Egress Support diff --git a/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/istio.md index 19478290a6e..c7fdc274cc2 100644 --- a/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.5/explanations/integrations-in-rancher/istio/istio.md @@ -3,7 +3,7 @@ title: Istio --- - + [Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices. diff --git a/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md b/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md index eb1020ac1a2..b1099777da3 100644 --- a/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md +++ b/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md @@ -3,7 +3,7 @@ title: Custom Resource Configuration --- - + The following Custom Resource Definitions are used to configure logging: diff --git a/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/logging.md b/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/logging.md index 365b2f0e9bb..23c3f2321d1 100644 --- a/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/logging.md +++ b/versioned_docs/version-2.5/explanations/integrations-in-rancher/logging/logging.md @@ -4,7 +4,7 @@ description: Rancher integrates with popular logging services. Learn the require --- - + The [Logging operator](https://kube-logging.github.io/docs/) now powers Rancher's logging solution in place of the former, in-house solution. diff --git a/versioned_docs/version-2.5/explanations/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md b/versioned_docs/version-2.5/explanations/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md index 68cf956ff93..d5f65a61fb9 100644 --- a/versioned_docs/version-2.5/explanations/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md +++ b/versioned_docs/version-2.5/explanations/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md @@ -4,7 +4,7 @@ description: Prometheus lets you view metrics from your different Rancher and Ku --- - + Using the `rancher-monitoring` application, you can quickly deploy leading open-source monitoring and alerting solutions onto your cluster. diff --git a/versioned_docs/version-2.5/faq/container-network-interface-providers.md b/versioned_docs/version-2.5/faq/container-network-interface-providers.md index 3e11f8cb90b..2368ea0fc81 100644 --- a/versioned_docs/version-2.5/faq/container-network-interface-providers.md +++ b/versioned_docs/version-2.5/faq/container-network-interface-providers.md @@ -134,8 +134,6 @@ The following table summarizes the different features available for each CNI net ### CNI Community Popularity -import CNIPopularityTable from '/shared-files/_cni-popularity.md'; - ### Which CNI Provider Should I Use? diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md index a4e12232854..860088f4f8b 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI. diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-and-upgrade.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-and-upgrade.md index 8203215c499..1f4fa367011 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-and-upgrade.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-and-upgrade.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + This section provides an overview of the architecture options of installing Rancher, describing advantages of each option. diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md index cb9326b18d1..8b1a63c970c 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md @@ -4,7 +4,7 @@ description: Learn the node requirements for each node running Rancher server wh --- - + This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster. diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md index 144f2306c3c..529b96e3c50 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md @@ -3,7 +3,7 @@ title: Air Gapped Helm CLI Install --- - + This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md index 948146ac2de..6745fe50063 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md @@ -3,7 +3,7 @@ title: Other Installation Methods --- - + ### Air Gapped Installations diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md index 39b75558e22..e705d3b4a16 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md @@ -3,7 +3,7 @@ title: Installing Rancher behind an HTTP Proxy --- - + In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment. diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md index 40f3d5da007..9876d863eb9 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md @@ -4,7 +4,7 @@ description: For development and testing environments only, use a Docker install --- - + Rancher can be installed by running a single Docker container. diff --git a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/resources/resources.md b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/resources/resources.md index d946b92535c..acf358c96bd 100644 --- a/versioned_docs/version-2.5/getting-started/installation-and-upgrade/resources/resources.md +++ b/versioned_docs/version-2.5/getting-started/installation-and-upgrade/resources/resources.md @@ -3,7 +3,7 @@ title: Resources --- - + ### Docker Installations diff --git a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md index a4082fe9e8d..7e5728912a4 100644 --- a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md +++ b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md @@ -3,7 +3,7 @@ title: Deploying Rancher Server --- - + Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. diff --git a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md index 9854f712fc2..4c1ea062eaa 100644 --- a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md +++ b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md @@ -2,6 +2,10 @@ title: Manual Quick Start --- + + + + Howdy Partner! This tutorial walks you through: - Installation of Rancher 2.x diff --git a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md index e6042decd34..3a7034c05df 100644 --- a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md +++ b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md @@ -3,7 +3,7 @@ title: Deploying Workloads --- - + These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. diff --git a/versioned_docs/version-2.5/getting-started/quick-start-guides/quick-start-guides.md b/versioned_docs/version-2.5/getting-started/quick-start-guides/quick-start-guides.md index a7344a939f2..2fd1390072e 100644 --- a/versioned_docs/version-2.5/getting-started/quick-start-guides/quick-start-guides.md +++ b/versioned_docs/version-2.5/getting-started/quick-start-guides/quick-start-guides.md @@ -3,7 +3,7 @@ title: Rancher Deployment Quick Start Guides --- - + >**Note:** The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation](../installation-and-upgrade/installation-and-upgrade.md). diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/advanced-user-guides.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/advanced-user-guides.md index b5b3d241037..68ffc4c7ed3 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/advanced-user-guides.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/advanced-user-guides.md @@ -3,7 +3,7 @@ title: Advanced User Guides --- - + Advanced user guides are "problem-oriented" docs in which users learn how to answer questions or solve problems. The major difference between these and the new user guides is that these guides are geared toward more experienced or advanced users who have more technical needs from their documentation. These users already have an understanding of Rancher and its functions. They know what they need to accomplish; they just need additional guidance to complete some more complex task they they have encountered while working. diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md index 790b7e1b6c1..a7c6ed43472 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md @@ -3,7 +3,7 @@ title: CIS Scan Guides --- - + - [Install rancher-cis-benchmark](install-rancher-cis-benchmark.md) diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md index 28ae10f8adc..e8d1210fecc 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md @@ -3,7 +3,7 @@ title: Setup Guide --- - + This section describes how to enable Istio and start using it in your projects. diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md index c9f84358a51..50b6a50d5fa 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md @@ -3,7 +3,7 @@ title: Project 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/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md index a1aa02b8cb7..4e2e4d74e85 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md @@ -3,7 +3,7 @@ title: Project Administration --- - + _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/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md index 348cf62df1c..99bfa07abc1 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md @@ -3,7 +3,7 @@ title: Monitoring/Alerting Guides --- - + - [Enable monitoring](enable-monitoring.md) diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md index 35de246d3de..16d99c82a75 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md @@ -3,7 +3,7 @@ title: Advanced Configuration --- - + ### Alertmanager diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md index 59d970103d2..91690613723 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md @@ -3,7 +3,7 @@ title: Configuration --- - + This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 0f3272d9b10..eb07c014ac1 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -4,7 +4,7 @@ keywords: [rancher v2.5 backup restore, rancher v2.5 backup and restore, backup --- - + In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md index d9edf14f8a9..e2166d3370d 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md @@ -3,7 +3,7 @@ title: Deploying Applications across Clusters --- - + Rancher offers several ways to deploy applications across clusters, depending on version. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md index 826e1335dda..1bdd81ec787 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md @@ -2,6 +2,10 @@ title: Fleet - GitOps at Scale --- + + + + _Available as of Rancher v2.5_ Fleet is GitOps at scale. Fleet is designed to manage up to a million clusters. It's also lightweight enough that it works great for a [single cluster](https://fleet.rancher.io/installation#default-install) too, but it really shines when you get to a [large scale.](https://fleet.rancher.io/installation#configuration-for-multi-cluster) By large scale we mean either a lot of clusters, a lot of deployments, or a lot of teams in a single organization. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md index ccdca3126b8..7a79e5f5622 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md @@ -3,7 +3,7 @@ title: Don't have infrastructure for your Kubernetes cluster? Try one of these t --- - + To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](ha-k3s-kubernetes-cluster.md) diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md index 941663ebf16..9a16092ead2 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md @@ -3,7 +3,7 @@ title: "Don't have a Kubernetes cluster? Try one of these tutorials." --- - + This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md index 319c18120ad..456cf423d94 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md @@ -3,7 +3,7 @@ title: Checklist for Production-Ready Clusters --- - + In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md index a90adc950cf..76f7dbf8ea1 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md @@ -4,7 +4,7 @@ description: Provisioning Kubernetes Clusters --- - + Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md index 3466178d940..76f95c5cfe7 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md @@ -3,7 +3,7 @@ title: Setting up Clusters from Hosted Kubernetes Providers --- - + In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md index 2dd99fb627a..9e1073555d1 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md @@ -4,7 +4,7 @@ description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs --- - + The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md index f2787843506..990a8efa844 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md @@ -3,7 +3,7 @@ title: Kubernetes Resources --- - + > The Cluster Explorer is a new feature in Rancher v2.5 that allows you to view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI. This section will be updated to reflect the way that Kubernetes resources are handled in Rancher v2.5. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md index a7a9cf3ae3e..6163d2d99b5 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md @@ -4,7 +4,7 @@ description: Learn how you can set up load balancers and ingress controllers to --- - + Within Rancher, you can set up load balancers and ingress controllers to redirect service requests. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md index c20787712ae..b9bd0fa0a47 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md @@ -4,7 +4,7 @@ description: "Learn about the two constructs with which you can build any comple --- - + You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/new-user-guides.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/new-user-guides.md index e2e68ff0089..cc86980e4ad 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/new-user-guides.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/new-user-guides.md @@ -3,7 +3,7 @@ title: New User Guides --- - + New user guides, also known as **tutorials**, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing". diff --git a/versioned_docs/version-2.5/rancher-manager.md b/versioned_docs/version-2.5/rancher-manager.md index 61301b036ef..7331d55d008 100644 --- a/versioned_docs/version-2.5/rancher-manager.md +++ b/versioned_docs/version-2.5/rancher-manager.md @@ -3,6 +3,10 @@ title: "Rancher 2.5" description: "Rancher adds significant value on top of Kubernetes: managing hundreds of clusters from one interface, centralizing RBAC, enabling monitoring and alerting. Read more." slug: / --- + + + + Rancher was originally built to work with multiple orchestrators, and it included its own orchestrator called Cattle. With the rise of Kubernetes in the marketplace, Rancher 2 exclusively deploys and manages Kubernetes clusters running anywhere, on any provider. Rancher can provision Kubernetes from a hosted provider, provision compute nodes and then install Kubernetes onto them, or import existing Kubernetes clusters running anywhere. diff --git a/versioned_docs/version-2.5/reference-guides/about-the-api/about-the-api.md b/versioned_docs/version-2.5/reference-guides/about-the-api/about-the-api.md index b908f599058..baba9f081d6 100644 --- a/versioned_docs/version-2.5/reference-guides/about-the-api/about-the-api.md +++ b/versioned_docs/version-2.5/reference-guides/about-the-api/about-the-api.md @@ -3,7 +3,7 @@ title: API --- - + ## How to use the API diff --git a/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/backup-restore-configuration.md b/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/backup-restore-configuration.md index 1f74b2fad9b..ad817581489 100644 --- a/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/backup-restore-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/backup-restore-configuration.md @@ -3,7 +3,7 @@ title: Rancher Backup Configuration Reference --- - + - [Backup configuration](backup-configuration.md) diff --git a/versioned_docs/version-2.5/reference-guides/best-practices/best-practices.md b/versioned_docs/version-2.5/reference-guides/best-practices/best-practices.md index 546ae01be94..d2520a3e785 100644 --- a/versioned_docs/version-2.5/reference-guides/best-practices/best-practices.md +++ b/versioned_docs/version-2.5/reference-guides/best-practices/best-practices.md @@ -3,7 +3,7 @@ title: Best Practices Guide --- - + The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers. diff --git a/versioned_docs/version-2.5/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md b/versioned_docs/version-2.5/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md index 72c44ac9a78..ea4697f8e76 100644 --- a/versioned_docs/version-2.5/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md +++ b/versioned_docs/version-2.5/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md @@ -3,7 +3,7 @@ title: Best Practices for Rancher Managed Clusters --- - + ### Logging diff --git a/versioned_docs/version-2.5/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.5/reference-guides/best-practices/rancher-server/rancher-server.md index a79561ced2c..8e24e145482 100644 --- a/versioned_docs/version-2.5/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.5/reference-guides/best-practices/rancher-server/rancher-server.md @@ -3,7 +3,7 @@ title: Best Practices for the Rancher Server --- - + This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. diff --git a/versioned_docs/version-2.5/reference-guides/cli-with-rancher/cli-with-rancher.md b/versioned_docs/version-2.5/reference-guides/cli-with-rancher/cli-with-rancher.md index a0e50c51b71..a18cabf5abb 100644 --- a/versioned_docs/version-2.5/reference-guides/cli-with-rancher/cli-with-rancher.md +++ b/versioned_docs/version-2.5/reference-guides/cli-with-rancher/cli-with-rancher.md @@ -3,7 +3,7 @@ title: CLI with Rancher --- - + Interact with Rancher using command line interface (CLI) tools from your workstation. The following docs will describe the [Rancher CLI](rancher-cli.md) and [kubectl Utility](kubectl-utility.md). \ No newline at end of file diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/cluster-configuration.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/cluster-configuration.md index 262c6812bbe..4a0fc238604 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/cluster-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/cluster-configuration.md @@ -3,7 +3,7 @@ title: Cluster Configuration --- - + After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md index fc90e697d37..e6b5b618d66 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md @@ -3,7 +3,7 @@ title: Downstream Cluster Configuration --- - + The following docs will discuss [node template configuration](node-template-configuration/node-template-configuration.md). \ No newline at end of file diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md index 5b782d7dab1..d4e076027ae 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md @@ -3,7 +3,7 @@ title: Node Template Configuration --- - + To learn about node template config, refer to [EC2 Node Template Configuration](amazon-ec2.md), [DigitalOcean Node Template Configuration](digitalocean.md), [Azure Node Template Configuration](azure.md), and [vSphere Node Template Configuration](vsphere.md). diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md index e2bdaab0e33..f3ba98c2cf0 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md @@ -3,7 +3,7 @@ title: GKE Cluster Configuration Reference --- - + diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md index d358cfc3e1c..341d79c60a6 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md @@ -3,7 +3,7 @@ title: Rancher Server Configuration --- - + - [RKE1 Cluster Configuration](rke1-cluster-configuration.md) diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md index db7779554ad..85877147526 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md @@ -4,7 +4,7 @@ description: To create a cluster with custom nodes, you’ll need to access serv --- - + When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. diff --git a/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md b/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md index 62bade46a2a..7fea6f9a7d9 100644 --- a/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md @@ -3,7 +3,7 @@ title: Monitoring V2 Configuration --- - + The following sections will explain important options essential to configuring Monitoring V2 in Rancher: diff --git a/versioned_docs/version-2.5/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md b/versioned_docs/version-2.5/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md index c4d55d8c63e..4f62034f2b8 100644 --- a/versioned_docs/version-2.5/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md +++ b/versioned_docs/version-2.5/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md @@ -3,7 +3,7 @@ title: Architecture --- - + This section focuses on the [Rancher server and its components](rancher-server-and-components.md) and how [Rancher communicates with downstream Kubernetes clusters](communicating-with-downstream-user-clusters.md). diff --git a/versioned_docs/version-2.5/reference-guides/rancher-security/rancher-security.md b/versioned_docs/version-2.5/reference-guides/rancher-security/rancher-security.md index 8ec8b2ad23e..2027340c382 100644 --- a/versioned_docs/version-2.5/reference-guides/rancher-security/rancher-security.md +++ b/versioned_docs/version-2.5/reference-guides/rancher-security/rancher-security.md @@ -3,7 +3,7 @@ title: Security --- - +
diff --git a/versioned_docs/version-2.5/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md b/versioned_docs/version-2.5/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md index 052154b145b..2ff65d2695d 100644 --- a/versioned_docs/version-2.5/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md +++ b/versioned_docs/version-2.5/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md @@ -3,7 +3,7 @@ title: SELinux RPM --- - + _Available as of v2.5.8_ diff --git a/versioned_docs/version-2.5/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md b/versioned_docs/version-2.5/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md index e605bd0c77a..bc0f02856a7 100644 --- a/versioned_docs/version-2.5/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md +++ b/versioned_docs/version-2.5/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md @@ -3,7 +3,7 @@ title: Single Node Rancher in Docker --- - + The following docs will discuss [HTTP proxy configuration](http-proxy-configuration.md) and [advanced options](advanced-options.md) for Docker installs. \ No newline at end of file diff --git a/versioned_docs/version-2.5/reference-guides/user-settings/user-settings.md b/versioned_docs/version-2.5/reference-guides/user-settings/user-settings.md index 1750815d3d8..22e9a3ba404 100644 --- a/versioned_docs/version-2.5/reference-guides/user-settings/user-settings.md +++ b/versioned_docs/version-2.5/reference-guides/user-settings/user-settings.md @@ -3,7 +3,7 @@ title: User Settings --- - + Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. diff --git a/versioned_docs/version-2.5/security/security-scan/security-scan.md b/versioned_docs/version-2.5/security/security-scan/security-scan.md index cacabb6266d..8c58771c736 100644 --- a/versioned_docs/version-2.5/security/security-scan/security-scan.md +++ b/versioned_docs/version-2.5/security/security-scan/security-scan.md @@ -3,7 +3,7 @@ title: Security Scans --- - + https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides The documentation about CIS security scans has moved [here.](../../how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md) diff --git a/versioned_docs/version-2.5/shared-files/_common-ports-table.md b/versioned_docs/version-2.5/shared-files/_common-ports-table.md index 1835beba031..c48798abab0 100644 --- a/versioned_docs/version-2.5/shared-files/_common-ports-table.md +++ b/versioned_docs/version-2.5/shared-files/_common-ports-table.md @@ -1,19 +1,18 @@ -| Protocol | Port | Description | -|:--------: |:----------------: |---------------------------------------------------------------------------------- | -| TCP | 22 | Node driver SSH provisioning | -| TCP | 179 | Calico BGP Port | -| TCP | 2376 | Node driver Docker daemon TLS port | -| TCP | 2379 | etcd client requests | -| TCP | 2380 | etcd peer communication | -| UDP | 8472 | Canal/Flannel VXLAN overlay networking | -| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | -| TCP | 8443 | Rancher webhook | -| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | -| TCP | 9100 | Default port required by Monitoring to scrape metrics from Linux node-exporters | -| TCP | 9443 | Rancher webhook | -| TCP | 9796 | Default port required by Monitoring to scrape metrics from Windows node-exporters | -| TCP | 6783 | Weave Port | -| UDP | 6783-6784 | Weave UDP Ports | -| TCP | 10250 | Metrics server communication with all nodes API | -| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | -| TCP/UDP | 30000-32767 | NodePort port range | +| Protocol | Port | Description | +|:--------: |:----------------: |-------------------------------------------------------------------------------------------- | +| TCP | 22 | Node driver SSH provisioning | +| TCP | 179 | Calico BGP Port | +| TCP | 2376 | Node driver Docker daemon TLS port | +| TCP | 2379 | etcd client requests | +| TCP | 2380 | etcd peer communication | +| UDP | 8472 | Canal/Flannel VXLAN overlay networking | +| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | +| TCP | 8443 | Rancher webhook | +| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | +| TCP | 9443 | Rancher webhook | +| TCP | 9796 | Default port required by Monitoring to scrape metrics from Linux and Windows node-exporters | +| TCP | 6783 | Weave Port | +| UDP | 6783-6784 | Weave UDP Ports | +| TCP | 10250 | Metrics server communication with all nodes API | +| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | +| TCP/UDP | 30000-32767 | NodePort port range | diff --git a/versioned_docs/version-2.5/troubleshooting/kubernetes-components/kubernetes-components.md b/versioned_docs/version-2.5/troubleshooting/kubernetes-components/kubernetes-components.md index 873326222c3..6ce57f84652 100644 --- a/versioned_docs/version-2.5/troubleshooting/kubernetes-components/kubernetes-components.md +++ b/versioned_docs/version-2.5/troubleshooting/kubernetes-components/kubernetes-components.md @@ -3,7 +3,7 @@ title: Kubernetes Components --- - + The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) clusters. diff --git a/versioned_docs/version-2.6/faq/container-network-interface-providers.md b/versioned_docs/version-2.6/faq/container-network-interface-providers.md index a8662eaf14a..cb65dd9238d 100644 --- a/versioned_docs/version-2.6/faq/container-network-interface-providers.md +++ b/versioned_docs/version-2.6/faq/container-network-interface-providers.md @@ -184,8 +184,6 @@ The following table summarizes the different features available for each CNI net ## CNI Community Popularity -import CNIPopularityTable from '/shared-files/_cni-popularity.md'; - ## Which CNI Provider Should I Use? diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md index 650cbc32f80..01dbf360e55 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI. diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-and-upgrade.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-and-upgrade.md index f9067e831b7..6a930db2b05 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-and-upgrade.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-and-upgrade.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + This section provides an overview of the architecture options of installing Rancher, describing advantages of each option. diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/installation-references.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/installation-references.md index 67a379702cd..ded2dd3a77a 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/installation-references.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/installation-references.md @@ -3,7 +3,7 @@ title: Installation References --- - + Please see the following reference guides for other installation resources: [Rancher Helm chart options](helm-chart-options.md), [TLS settings](tls-settings.md), and [feature flags](feature-flags.md). \ No newline at end of file diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md index 403489ad548..ec217101ebd 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md @@ -4,7 +4,7 @@ description: Learn the node requirements for each node running Rancher server wh --- - + This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster. diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md index 792a49a26a4..dda0f2301f4 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md @@ -3,7 +3,7 @@ title: Air-Gapped Helm CLI Install --- - + This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md index c5bd443da43..aaca1603ad0 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md @@ -3,7 +3,7 @@ title: Other Installation Methods --- - + ### Air Gapped Installations diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md index 39b75558e22..e705d3b4a16 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md @@ -3,7 +3,7 @@ title: Installing Rancher behind an HTTP Proxy --- - + In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment. diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md index 049bf762a2a..526b43b682c 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md @@ -4,7 +4,7 @@ description: For development and testing environments only, use a Docker install --- - + Rancher can be installed by running a single Docker container. diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/resources/resources.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/resources/resources.md index 5d4fbf24fc1..b5c215c5755 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/resources/resources.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/resources/resources.md @@ -3,7 +3,7 @@ title: Resources --- - + ### Docker Installations diff --git a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md index a0500a27747..8da9e993a43 100644 --- a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md +++ b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md @@ -1,6 +1,6 @@ --- -title: Rancher AWS Marketplace Quick Start -description: Use Amazon EKS to deploy Rancher server. +title: Rancher Prime AWS Marketplace Quick Start +description: Deploy SUSE Rancher from the AWS Marketplace listing. --- @@ -9,6 +9,6 @@ description: Use Amazon EKS to deploy Rancher server. import YouTube from '@site/src/components/YouTube' -Amazon Elastic Kubernetes Service (EKS) can quickly [deploy Rancher to Amazon Web Services (AWS)](https://documentation.suse.com/trd/kubernetes/single-html/gs_rancher_aws-marketplace/). To learn more, see our [Amazon Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-go7ent7goo5ae). Watch the demo for a walkthrough of AWS Marketplace SUSE Rancher setup: +You can quickly deploy Rancher Prime on Amazon Elastic Kubernetes Service (EKS.) To learn more, see the [instructions](https://suse-enceladus.github.io/marketplace-docs/rancher-prime/aws/?repository=rancher-payg-billing-adapter-llc-prd) under Usage Information in the [AWS Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c). - +# diff --git a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md index c48daaad125..046c0f495b7 100644 --- a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md +++ b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md @@ -3,7 +3,7 @@ title: Deploying Rancher Server --- - + Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. diff --git a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md index e6042decd34..3a7034c05df 100644 --- a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md +++ b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md @@ -3,7 +3,7 @@ title: Deploying Workloads --- - + These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. diff --git a/versioned_docs/version-2.6/getting-started/quick-start-guides/quick-start-guides.md b/versioned_docs/version-2.6/getting-started/quick-start-guides/quick-start-guides.md index 955135a1d48..424fe7d8802 100644 --- a/versioned_docs/version-2.6/getting-started/quick-start-guides/quick-start-guides.md +++ b/versioned_docs/version-2.6/getting-started/quick-start-guides/quick-start-guides.md @@ -3,7 +3,7 @@ title: Rancher Deployment Quick Start Guides --- - + :::caution diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/advanced-user-guides.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/advanced-user-guides.md index b5b3d241037..68ffc4c7ed3 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/advanced-user-guides.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/advanced-user-guides.md @@ -3,7 +3,7 @@ title: Advanced User Guides --- - + Advanced user guides are "problem-oriented" docs in which users learn how to answer questions or solve problems. The major difference between these and the new user guides is that these guides are geared toward more experienced or advanced users who have more technical needs from their documentation. These users already have an understanding of Rancher and its functions. They know what they need to accomplish; they just need additional guidance to complete some more complex task they they have encountered while working. diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md index 790b7e1b6c1..a7c6ed43472 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md @@ -3,7 +3,7 @@ title: CIS Scan Guides --- - + - [Install rancher-cis-benchmark](install-rancher-cis-benchmark.md) diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md index e633292728b..8f6a4c14fcb 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md @@ -3,7 +3,7 @@ title: Enabling Experimental Features --- - + Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an [unsupported storage type](unsupported-storage-drivers.md) outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default. diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md index 4682e638ed0..cbdeee0602b 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md @@ -3,7 +3,7 @@ title: Setup Guide --- - + This section describes how to enable Istio and start using it in your projects. diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md index ca734c02b26..a0ed1060085 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md @@ -3,7 +3,7 @@ title: Project 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/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md index 3d606e52911..b3e711ea661 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md @@ -3,7 +3,7 @@ title: Project Administration --- - + _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/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md index 348cf62df1c..99bfa07abc1 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md @@ -3,7 +3,7 @@ title: Monitoring/Alerting Guides --- - + - [Enable monitoring](enable-monitoring.md) diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md index 4651e682528..c266c30f1c6 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md @@ -3,7 +3,7 @@ title: Prometheus Federator Guides --- - + - [Enable Prometheus Operator](enable-prometheus-federator.md) diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md index 35de246d3de..16d99c82a75 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md @@ -3,7 +3,7 @@ title: Advanced Configuration --- - + ### Alertmanager diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md index f400f720459..b4ae1e536e5 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md @@ -3,7 +3,7 @@ title: Configuration --- - + This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md index 6f6ed6821da..1be09c75749 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md @@ -3,7 +3,7 @@ title: About Provisioning Drivers --- - + Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md) or [nodes in an infrastructure provider](../../launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md) to allow Rancher to deploy and manage Kubernetes. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md index eab13feb274..228ec4c0992 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md @@ -3,7 +3,7 @@ title: RKE Templates --- - + RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md index 6278f99fd5a..910f2990b5a 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md @@ -4,7 +4,7 @@ weight: 10 --- - + One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows your users to use one set of credentials to authenticate with any of your Kubernetes clusters. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md index 4623dd0c202..f132535d7a1 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md @@ -3,7 +3,7 @@ title: Authentication, Permissions and Global Configuration --- - + After installation, the [system administrator](manage-role-based-access-control-rbac/global-permissions.md) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md index e10056cc0ae..4bdda220525 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md @@ -3,7 +3,7 @@ title: Configuring Microsoft Active Directory Federation Service (SAML) --- - + If your organization uses Microsoft Active Directory Federation Services (AD FS) for user authentication, you can configure Rancher to allow your users to log in using their AD FS credentials. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md index 9285e08ef8b..e7d4c5724a4 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md @@ -3,7 +3,7 @@ title: Configuring OpenLDAP --- - + If your organization uses LDAP for user authentication, you can configure Rancher to communicate with an OpenLDAP server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the organisation's central user repository, while allowing end-users to authenticate with their LDAP credentials when logging in to the Rancher UI. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md index a72b36e3120..22a9dd65c82 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md @@ -2,6 +2,10 @@ title: Configuring Shibboleth (SAML) --- + + + + If your organization uses Shibboleth Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in to Rancher using their Shibboleth credentials. In this configuration, when Rancher users log in, they will be redirected to the Shibboleth IdP to enter their credentials. After authentication, they will be redirected back to the Rancher UI. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md index 82038ecfc7e..d6a6d8d8f76 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md @@ -3,7 +3,7 @@ title: Managing Role-Based Access Control (RBAC) --- - + Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication](../authentication-config/authentication-config.md), users can either be local or external. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 2384c8723f5..3fb275389dc 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -4,7 +4,7 @@ keywords: [rancher v2.6 backup restore, rancher v2.6 backup and restore, backup --- - + In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 9b135096c62..346c54d50c7 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -25,7 +25,8 @@ Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. ### 1. Install the rancher-backup Helm chart -Install the [rancher-backup chart](https://github.com/rancher/backup-restore-operator/tags), using a version in the 2.x.x major version range: + +Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-operator/tags): 1. Add the Helm repository: @@ -34,13 +35,14 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope helm repo update ``` - 1. Select and set `CHART_VERSION` variable with a 2.x.x rancher-backup release version: + 1. Set a `CHART_VERSION` variable, selecting a `rancher-backup` chart version compatible with your version of Rancher. See the [support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions), within the **Rancher Apps / Cluster Tools** section, to see which `rancher-backup` versions are supported: + ```bash - helm search repo --versions rancher-charts/rancher-backup - CHART_VERSION=<2.x.x> + CHART_VERSION= ``` 1. Install the charts: + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION @@ -48,7 +50,7 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope :::note - The above assumes an environment with outbound connectivity to Docker Hub + The above assumes an environment with outbound connectivity to Docker Hub. For an **air-gapped environment**, use the Helm value below to pull the `backup-restore-operator` image from your private registry when installing the rancher-backup Helm chart. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md index 3ac107d94a6..4009c168a4f 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md @@ -3,7 +3,7 @@ title: Deploying Applications across Clusters --- - + Rancher offers several ways to deploy applications across clusters, depending on version. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 1aa87914c9e..a389601dec2 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -3,7 +3,7 @@ title: Helm Charts in Rancher --- - + In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+). It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md index ccdca3126b8..7a79e5f5622 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md @@ -3,7 +3,7 @@ title: Don't have infrastructure for your Kubernetes cluster? Try one of these t --- - + To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](ha-k3s-kubernetes-cluster.md) diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md index 9291d55bee4..00c22ead1c3 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md @@ -3,7 +3,7 @@ title: "Don't have a Kubernetes cluster? Try one of these tutorials." --- - + This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md index d3609540e2a..14ae384e387 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md @@ -3,7 +3,7 @@ title: Checklist for Production-Ready Clusters --- - + In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md index f088c16e1c4..230a3d6212b 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md @@ -4,7 +4,7 @@ description: Provisioning Kubernetes Clusters --- - + Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md index 11c5e5590e3..d6c9834b666 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md @@ -3,7 +3,7 @@ title: Setting up Cloud Providers --- - + A _cloud provider_ is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md index 070c16dc420..ea0cc4ff394 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md @@ -3,7 +3,7 @@ title: Setting up Clusters from Hosted Kubernetes Providers --- - + In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md index 0bbab68d9ae..3993c8b2c6a 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on Windows Clusters --- - + When provisioning a [custom cluster](../../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md index e0f5e51e4b4..8d084cb00d7 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md @@ -4,7 +4,7 @@ description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs --- - + The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md index 12d111b15b5..74ece7fc40c 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md @@ -3,7 +3,7 @@ title: Kubernetes Resources --- - + You can view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md index b3f3976e6e3..934a552f019 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md @@ -4,7 +4,7 @@ description: Learn how you can set up load balancers and ingress controllers to --- - + Within Rancher, you can set up load balancers and ingress controllers to redirect service requests. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md index c20787712ae..b9bd0fa0a47 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md @@ -4,7 +4,7 @@ description: "Learn about the two constructs with which you can build any comple --- - + You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md index e62d67c8323..7c7faea2e8d 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md @@ -3,7 +3,7 @@ title: Launching Kubernetes with Rancher --- - + You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, you can choose between [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) or [RKE2](https://docs.rke2.io) distributions. Rancher can launch Kubernetes on any computers, including: diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md index 9c761b50475..8d498ac35e6 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md @@ -4,7 +4,7 @@ description: Use Rancher to create a Nutanix AOS (AHV) cluster. It may consist o --- - + [Nutanix Acropolis Operating System](https://www.nutanix.com/products/acropolis) (Nutanix AOS) is an operating system for the Nutanix hyper-converged infrastructure platform. AOS comes with a built-in hypervisor called [Acropolis Hypervisor](https://www.nutanix.com/products/ahv), or AHV. By using Rancher with Nutanix AOS (AHV), you can bring cloud operations on-premises. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md index e539adbb699..23ce9e9ab9d 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on New Nodes in an Infrastructure Provider --- - + When you create an RKE or RKE2 cluster using a node template in Rancher, each resulting node pool is shown in a new **Machine Pools** tab. You can see the machine pools by doing the following: diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md index 9890f087ece..e1d63847e59 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md @@ -4,7 +4,7 @@ description: Use Rancher to create a vSphere cluster. It may consist of groups o --- - + import YouTube from '@site/src/components/YouTube' diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md index 874a3475916..a1f9647729f 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md @@ -3,7 +3,7 @@ title: Cluster Access --- - + This section is about what tools can be used to access clusters managed by Rancher. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md index dc7e5cd56ac..b7f9af5c766 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md @@ -4,7 +4,7 @@ description: "Learn about the two ways with which you can create persistent stor --- - + 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/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md index 127153dd06b..01a5ca7d2d6 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md @@ -3,7 +3,7 @@ title: Cluster Autoscaler --- - + In this section, you'll learn how to install and use the [Kubernetes cluster-autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/) on Rancher custom clusters using AWS EC2 Auto Scaling Groups. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md index 3e403f3aaa7..0360a5339f2 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md @@ -3,7 +3,7 @@ title: Cluster Administration --- - + After you provision a cluster in Rancher, you can begin using powerful Kubernetes features to deploy and scale your containerized applications in development, testing, or production environments. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md index b1d89e54c05..d4b85fec0c2 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md @@ -3,7 +3,7 @@ title: Provisioning Storage Examples --- - + Rancher supports persistent storage with a variety of volume plugins. However, before you use any of these plugins to bind persistent storage to your workloads, you have to configure the storage itself, whether its a cloud-based solution from a service-provider or an on-prem solution that you manage yourself. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/new-user-guides.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/new-user-guides.md index e2e68ff0089..cc86980e4ad 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/new-user-guides.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/new-user-guides.md @@ -3,7 +3,7 @@ title: New User Guides --- - + New user guides, also known as **tutorials**, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing". diff --git a/versioned_docs/version-2.6/integrations-in-rancher/cis-scans/cis-scans.md b/versioned_docs/version-2.6/integrations-in-rancher/cis-scans/cis-scans.md index 7ab3cf4e9ee..62c45b49a07 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/cis-scans/cis-scans.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/cis-scans/cis-scans.md @@ -3,7 +3,7 @@ title: CIS Scans --- - + Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. The CIS scans can run on any Kubernetes cluster, including hosted Kubernetes providers such as EKS, AKS, and GKE. diff --git a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md index 13b1398077e..cd143d64ef4 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md @@ -3,7 +3,7 @@ title: AWS Marketplace Integration --- - + ## Overview diff --git a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index 73ede34ea42..e085f09a15b 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -2,6 +2,10 @@ title: Installing the Adapter --- + + + + > **Important:** If you are attempting to re-install the adapter, you may experience errant out-of-compliance messages for up to an hour. ### Rancher vs. Adapter Compatibility Matrix diff --git a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md index 3baacc0d602..8c2f5a673e7 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md @@ -3,7 +3,7 @@ title: Cloud Marketplace Integration --- - + Rancher offers integration with cloud marketplaces to easily purchase support for installations hosted on certain cloud providers. In addition, this integration also provides the ability to generate a supportconfig bundle which can be provided to rancher support. diff --git a/versioned_docs/version-2.6/integrations-in-rancher/istio/configuration-options/configuration-options.md b/versioned_docs/version-2.6/integrations-in-rancher/istio/configuration-options/configuration-options.md index 35546a12f03..5f553689ab0 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/istio/configuration-options/configuration-options.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/istio/configuration-options/configuration-options.md @@ -3,7 +3,7 @@ title: Configuration Options --- - + ### Egress Support diff --git a/versioned_docs/version-2.6/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.6/integrations-in-rancher/istio/istio.md index d8001214de9..af6af4e56e0 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/istio/istio.md @@ -3,7 +3,7 @@ title: Istio --- - + [Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices. diff --git a/versioned_docs/version-2.6/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md b/versioned_docs/version-2.6/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md index eb1020ac1a2..b1099777da3 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md @@ -3,7 +3,7 @@ title: Custom Resource Configuration --- - + The following Custom Resource Definitions are used to configure logging: diff --git a/versioned_docs/version-2.6/integrations-in-rancher/logging/logging.md b/versioned_docs/version-2.6/integrations-in-rancher/logging/logging.md index 5f6fd024184..6168cd29c26 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/logging/logging.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/logging/logging.md @@ -4,7 +4,7 @@ description: Rancher integrates with popular logging services. Learn the require --- - + The [Logging operator](https://kube-logging.github.io/docs/) now powers Rancher's logging solution in place of the former, in-house solution. diff --git a/versioned_docs/version-2.6/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md b/versioned_docs/version-2.6/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md index f76814cb3a0..30126f60741 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md @@ -4,7 +4,7 @@ description: Prometheus lets you view metrics from your different Rancher and Ku --- - + Using the `rancher-monitoring` application, you can quickly deploy leading open-source monitoring and alerting solutions onto your cluster. diff --git a/versioned_docs/version-2.6/reference-guides/about-the-api/about-the-api.md b/versioned_docs/version-2.6/reference-guides/about-the-api/about-the-api.md index 1dd830a0d8c..4fed2f13f75 100644 --- a/versioned_docs/version-2.6/reference-guides/about-the-api/about-the-api.md +++ b/versioned_docs/version-2.6/reference-guides/about-the-api/about-the-api.md @@ -3,7 +3,7 @@ title: API --- - + ## How to use the API diff --git a/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/backup-restore-configuration.md b/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/backup-restore-configuration.md index 1f74b2fad9b..ad817581489 100644 --- a/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/backup-restore-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/backup-restore-configuration.md @@ -3,7 +3,7 @@ title: Rancher Backup Configuration Reference --- - + - [Backup configuration](backup-configuration.md) diff --git a/versioned_docs/version-2.6/reference-guides/best-practices/best-practices.md b/versioned_docs/version-2.6/reference-guides/best-practices/best-practices.md index 546ae01be94..d2520a3e785 100644 --- a/versioned_docs/version-2.6/reference-guides/best-practices/best-practices.md +++ b/versioned_docs/version-2.6/reference-guides/best-practices/best-practices.md @@ -3,7 +3,7 @@ title: Best Practices Guide --- - + The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers. diff --git a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md index 72c44ac9a78..ea4697f8e76 100644 --- a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md +++ b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md @@ -3,7 +3,7 @@ title: Best Practices for Rancher Managed Clusters --- - + ### Logging diff --git a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/rancher-server.md index a79561ced2c..8e24e145482 100644 --- a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/rancher-server.md @@ -3,7 +3,7 @@ title: Best Practices for the Rancher Server --- - + This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. diff --git a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 896a4978b12..50687cdd32c 100644 --- a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -21,6 +21,26 @@ This guide describes the best practices and tuning approaches to scale Rancher s When scaling up Rancher, one typical bottleneck is resource growth in the upstream (local) Kubernetes cluster. The upstream cluster contains information for all downstream clusters. Many operations that apply to downstream clusters create new objects in the upstream cluster and require computation from handlers running in the upstream cluster. +### Minimizing Third-Party Software on the Upstream Cluster + +Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. + +Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. + +Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + +On the other hand, the following software are found to interfere with Rancher performance at scale: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + ### Managing Your Object Counts Etcd is the backing database for Kubernetes and for Rancher. The database may eventually encounter limitations to the number of a single Kubernetes resource type it can store. Exact limits vary and depend on a number of factors. However, experience indicates that performance issues frequently arise once a single resource type's object count exceeds 60,000. Often that type is `RoleBinding`. diff --git a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/cli-with-rancher.md b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/cli-with-rancher.md index a0e50c51b71..a18cabf5abb 100644 --- a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/cli-with-rancher.md +++ b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/cli-with-rancher.md @@ -3,7 +3,7 @@ title: CLI with Rancher --- - + Interact with Rancher using command line interface (CLI) tools from your workstation. The following docs will describe the [Rancher CLI](rancher-cli.md) and [kubectl Utility](kubectl-utility.md). \ No newline at end of file diff --git a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md index 1261e576130..17965c67cd1 100644 --- a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,15 +68,22 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| `machines, [machine]` | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| `up` | Applies compose config. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/cluster-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/cluster-configuration.md index 7b15f647a03..fb16d619292 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/cluster-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/cluster-configuration.md @@ -3,7 +3,7 @@ title: Cluster Configuration --- - + After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md index 897728cd346..e0c92a52f0f 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md @@ -3,7 +3,7 @@ title: Downstream Cluster Configuration --- - + The following docs will discuss [node template configuration](node-template-configuration/node-template-configuration.md) and [machine configuration](machine-configuration/machine-configuration.md). \ No newline at end of file diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md index b28ccd669dd..cff1dada268 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md @@ -3,7 +3,7 @@ title: Machine Configuration --- - + Machine configuration is the arrangement of resources assigned to a virtual machine. Please see the docs for [Amazon EC2](amazon-ec2.md), [DigitalOcean](digitalocean.md), and [Azure](azure.md) to learn more. \ No newline at end of file diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md index bbe4d6127c3..e0f9ba4105d 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md @@ -3,7 +3,7 @@ title: Node Template Configuration --- - + To learn about node template config, refer to [EC2 Node Template Configuration](amazon-ec2.md), [DigitalOcean Node Template Configuration](digitalocean.md), [Azure Node Template Configuration](azure.md), [vSphere Node Template Configuration](vsphere.md), and [Nutanix Node Template Configuration](nutanix.md). diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md index d1499f9932f..dea8738c63c 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md @@ -3,7 +3,7 @@ title: GKE Cluster Configuration Reference --- - + ## Changes in Rancher v2.6 diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md index e4da90d371a..0e2aa590833 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md @@ -3,7 +3,7 @@ title: Rancher Server Configuration --- - + - [RKE1 Cluster Configuration](rke1-cluster-configuration.md) diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md index cca7752af30..45e8fba4b02 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md @@ -4,7 +4,7 @@ description: To create a cluster with custom nodes, you’ll need to access serv --- - + When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. diff --git a/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md b/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md index 62bade46a2a..7fea6f9a7d9 100644 --- a/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md @@ -3,7 +3,7 @@ title: Monitoring V2 Configuration --- - + The following sections will explain important options essential to configuring Monitoring V2 in Rancher: diff --git a/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/receivers.md b/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/receivers.md index 631e589009c..fa55d466451 100644 --- a/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/receivers.md +++ b/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/receivers.md @@ -167,24 +167,20 @@ The Teams receiver is not a native receiver and must be enabled before it can be -### Configure the Teams Receiver +### Configuring the Teams Receiver -The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration. +1. To configure the Teams receiver, update its ConfigMap. The following example is a minimal Teams receiver configuration: -```yaml -[Microsoft Teams] -teams-instance-1: https://your-teams-webhook-url -``` + ```yaml + [Microsoft Teams] + connector: https://your-teams-webhook-url + ``` -When configuration is complete, add the receiver using the steps in [this section](#creating-receivers-in-the-rancher-ui). +2. After you update the configuration, follow the instructions in [Creating Receivers in the Rancher UI](#creating-receivers-in-the-rancher-ui) to add the receiver. Use the example below to form your URL. Make sure to replace `` with the namespace of the `rancher-alerting-drivers` app: -Use the example below as the URL where: - -- `ns-1` is replaced with the namespace where the `rancher-alerting-drivers` app is installed - -```yaml -url: http://rancher-alerting-drivers-prom2teams.ns-1.svc:8089/v2/teams-instance-1 -``` + ```yaml + url: http://rancher-alerting-drivers-prom2teams..svc:8089/v2/connector + ``` @@ -202,7 +198,7 @@ The SMS receiver is not a native receiver and must be enabled before it can be u 1. Select the **SMS** option and click **Install**. 1. Take note of the namespace used as it will be required in a later step. -### Configure the SMS Receiver +### Configuring the SMS Receiver The SMS receiver can be configured by updating its ConfigMap. For example, the following is a minimal SMS receiver configuration. diff --git a/versioned_docs/version-2.6/reference-guides/prometheus-federator/prometheus-federator.md b/versioned_docs/version-2.6/reference-guides/prometheus-federator/prometheus-federator.md index 4b1e8a21143..5166ab8732f 100644 --- a/versioned_docs/version-2.6/reference-guides/prometheus-federator/prometheus-federator.md +++ b/versioned_docs/version-2.6/reference-guides/prometheus-federator/prometheus-federator.md @@ -3,7 +3,7 @@ title: Prometheus Federator --- - + Prometheus Federator, also referred to as Project Monitoring v2, deploys a Helm Project Operator (based on the [rancher/helm-project-operator](https://github.com/rancher/helm-project-operator)), an operator that manages deploying Helm charts each containing a Project Monitoring Stack, where each stack contains: diff --git a/versioned_docs/version-2.6/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md b/versioned_docs/version-2.6/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md index 97ef05d0b6b..0e01bd3d293 100644 --- a/versioned_docs/version-2.6/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md +++ b/versioned_docs/version-2.6/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md @@ -3,7 +3,7 @@ title: Architecture --- - + This section focuses on the [Rancher server and its components](rancher-server-and-components.md) and how [Rancher communicates with downstream Kubernetes clusters](communicating-with-downstream-user-clusters.md). diff --git a/versioned_docs/version-2.6/reference-guides/rancher-security/rancher-security.md b/versioned_docs/version-2.6/reference-guides/rancher-security/rancher-security.md index 420cece1f1f..8b28ef1b3cb 100644 --- a/versioned_docs/version-2.6/reference-guides/rancher-security/rancher-security.md +++ b/versioned_docs/version-2.6/reference-guides/rancher-security/rancher-security.md @@ -3,7 +3,7 @@ title: Security --- - +
diff --git a/versioned_docs/version-2.6/reference-guides/rancher-security/security-advisories-and-cves.md b/versioned_docs/version-2.6/reference-guides/rancher-security/security-advisories-and-cves.md index b7dec08a23e..f52c4d1874f 100644 --- a/versioned_docs/version-2.6/reference-guides/rancher-security/security-advisories-and-cves.md +++ b/versioned_docs/version-2.6/reference-guides/rancher-security/security-advisories-and-cves.md @@ -10,6 +10,10 @@ Rancher is committed to informing the community of security issues in our produc | ID | Description | Date | Resolution | |----|-------------|------|------------| +| [CVE-2023-32193](https://github.com/rancher/norman/security/advisories/GHSA-r8f4-hv23-6qp6) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Norman). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32192](https://github.com/rancher/apiserver/security/advisories/GHSA-833m-37f7-jq55) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Apiserver). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-22649](https://github.com/rancher/rancher/security/advisories/GHSA-xfj7-qf8w-2gcr) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, in which sensitive data may be leaked into Rancher's audit logs. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32194](https://github.com/rancher/rancher/security/advisories/GHSA-c85r-fwc7-45vc) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where granting a `create` or `*` global role for a resource type of "namespaces"; no matter the API group, the subject will receive `*` permissions for core namespaces. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | | [CVE-2023-22648](https://github.com/rancher/rancher/security/advisories/GHSA-vf6j-6739-78m8) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which permission changes in Azure AD are not reflected to users until they logout and log back into the Rancher UI. | 31 May 2023 | Rancher [v2.6.13](https://github.com/rancher/rancher/releases/tag/v2.6.13) | | [CVE-2022-43760](https://github.com/rancher/rancher/security/advisories/GHSA-46v3-ggjg-qq3x) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI. | 31 May 2023 | Rancher [v2.6.13](https://github.com/rancher/rancher/releases/tag/v2.6.13) | | [CVE-2020-10676](https://github.com/rancher/rancher/security/advisories/GHSA-8vhc-hwhc-cpj4) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which users with update privileges on a namespace, can move that namespace into a project they don't have access to. | 31 May 2023 | Rancher [v2.6.13](https://github.com/rancher/rancher/releases/tag/v2.6.13) | diff --git a/versioned_docs/version-2.6/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md b/versioned_docs/version-2.6/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md index f2d93d01bb1..75df1de0d00 100644 --- a/versioned_docs/version-2.6/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md +++ b/versioned_docs/version-2.6/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md @@ -3,7 +3,7 @@ title: SELinux RPM --- - + [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. diff --git a/versioned_docs/version-2.6/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md b/versioned_docs/version-2.6/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md index e605bd0c77a..bc0f02856a7 100644 --- a/versioned_docs/version-2.6/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md +++ b/versioned_docs/version-2.6/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md @@ -3,7 +3,7 @@ title: Single Node Rancher in Docker --- - + The following docs will discuss [HTTP proxy configuration](http-proxy-configuration.md) and [advanced options](advanced-options.md) for Docker installs. \ No newline at end of file diff --git a/versioned_docs/version-2.6/reference-guides/user-settings/user-settings.md b/versioned_docs/version-2.6/reference-guides/user-settings/user-settings.md index 496fde5638c..5a618c1024d 100644 --- a/versioned_docs/version-2.6/reference-guides/user-settings/user-settings.md +++ b/versioned_docs/version-2.6/reference-guides/user-settings/user-settings.md @@ -3,7 +3,7 @@ title: User Settings --- - + Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. diff --git a/versioned_docs/version-2.6/security/security-scan/security-scan.md b/versioned_docs/version-2.6/security/security-scan/security-scan.md index cacabb6266d..8c58771c736 100644 --- a/versioned_docs/version-2.6/security/security-scan/security-scan.md +++ b/versioned_docs/version-2.6/security/security-scan/security-scan.md @@ -3,7 +3,7 @@ title: Security Scans --- - + https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides The documentation about CIS security scans has moved [here.](../../how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md) diff --git a/versioned_docs/version-2.6/shared-files/_common-ports-table.md b/versioned_docs/version-2.6/shared-files/_common-ports-table.md index 1835beba031..4016670ef3d 100644 --- a/versioned_docs/version-2.6/shared-files/_common-ports-table.md +++ b/versioned_docs/version-2.6/shared-files/_common-ports-table.md @@ -1,19 +1,18 @@ -| Protocol | Port | Description | -|:--------: |:----------------: |---------------------------------------------------------------------------------- | -| TCP | 22 | Node driver SSH provisioning | -| TCP | 179 | Calico BGP Port | -| TCP | 2376 | Node driver Docker daemon TLS port | -| TCP | 2379 | etcd client requests | -| TCP | 2380 | etcd peer communication | -| UDP | 8472 | Canal/Flannel VXLAN overlay networking | -| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | -| TCP | 8443 | Rancher webhook | -| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | -| TCP | 9100 | Default port required by Monitoring to scrape metrics from Linux node-exporters | -| TCP | 9443 | Rancher webhook | -| TCP | 9796 | Default port required by Monitoring to scrape metrics from Windows node-exporters | -| TCP | 6783 | Weave Port | -| UDP | 6783-6784 | Weave UDP Ports | -| TCP | 10250 | Metrics server communication with all nodes API | -| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | -| TCP/UDP | 30000-32767 | NodePort port range | +| Protocol | Port | Description | +|:--------: |:----------------: |---------------------------------------------------------------------------------------------| +| TCP | 22 | Node driver SSH provisioning | +| TCP | 179 | Calico BGP Port | +| TCP | 2376 | Node driver Docker daemon TLS port | +| TCP | 2379 | etcd client requests | +| TCP | 2380 | etcd peer communication | +| UDP | 8472 | Canal/Flannel VXLAN overlay networking | +| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | +| TCP | 8443 | Rancher webhook | +| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | +| TCP | 9443 | Rancher webhook | +| TCP | 9796 | Default port required by Monitoring to scrape metrics from Linux and Windows node-exporters | +| TCP | 6783 | Weave Port | +| UDP | 6783-6784 | Weave UDP Ports | +| TCP | 10250 | Metrics server communication with all nodes API | +| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | +| TCP/UDP | 30000-32767 | NodePort port range | diff --git a/versioned_docs/version-2.6/troubleshooting/kubernetes-components/kubernetes-components.md b/versioned_docs/version-2.6/troubleshooting/kubernetes-components/kubernetes-components.md index 53863435277..b7995b5921c 100644 --- a/versioned_docs/version-2.6/troubleshooting/kubernetes-components/kubernetes-components.md +++ b/versioned_docs/version-2.6/troubleshooting/kubernetes-components/kubernetes-components.md @@ -3,7 +3,7 @@ title: Kubernetes Components --- - + The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) clusters. diff --git a/versioned_docs/version-2.7/faq/container-network-interface-providers.md b/versioned_docs/version-2.7/faq/container-network-interface-providers.md index a8662eaf14a..cb65dd9238d 100644 --- a/versioned_docs/version-2.7/faq/container-network-interface-providers.md +++ b/versioned_docs/version-2.7/faq/container-network-interface-providers.md @@ -184,8 +184,6 @@ The following table summarizes the different features available for each CNI net ## CNI Community Popularity -import CNIPopularityTable from '/shared-files/_cni-popularity.md'; - ## Which CNI Provider Should I Use? diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md index a9ff741e47a..4448a2d739e 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md index 70c112fb611..bc75b3a4680 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md @@ -28,8 +28,11 @@ The kubeconfig can also be manually targeted for the intended cluster with the ` Review the list of known issues for each Rancher version, which can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository](../resources/choose-a-rancher-version.md#helm-chart-repositories) aren't supported. + ### Helm Version + + 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](/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md)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. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-and-upgrade.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-and-upgrade.md index f9067e831b7..6a930db2b05 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-and-upgrade.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-and-upgrade.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + This section provides an overview of the architecture options of installing Rancher, describing advantages of each option. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-references/installation-references.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-references/installation-references.md index 67a379702cd..ded2dd3a77a 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-references/installation-references.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-references/installation-references.md @@ -3,7 +3,7 @@ title: Installation References --- - + Please see the following reference guides for other installation resources: [Rancher Helm chart options](helm-chart-options.md), [TLS settings](tls-settings.md), and [feature flags](feature-flags.md). \ No newline at end of file diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md index d866b032994..9bbc10f9326 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md @@ -4,7 +4,7 @@ description: Learn the node requirements for each node running Rancher server wh --- - + This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md index 792a49a26a4..dda0f2301f4 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md @@ -3,7 +3,7 @@ title: Air-Gapped Helm CLI Install --- - + This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md index c5bd443da43..aaca1603ad0 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md @@ -3,7 +3,7 @@ title: Other Installation Methods --- - + ### Air Gapped Installations diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md index 9d4a4c8393e..c2a6ace6343 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md @@ -10,6 +10,8 @@ Now that you have a running RKE cluster, you can install Rancher in it. For secu ### Install the Helm CLI + + Install the [Helm](https://helm.sh/docs/intro/install/) CLI on a host where you have a kubeconfig to access your Kubernetes cluster: ``` diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md index 39b75558e22..e705d3b4a16 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md @@ -3,7 +3,7 @@ title: Installing Rancher behind an HTTP Proxy --- - + In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md index 049bf762a2a..526b43b682c 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md @@ -4,7 +4,7 @@ description: For development and testing environments only, use a Docker install --- - + Rancher can be installed by running a single Docker container. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/helm-version-requirements.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/helm-version-requirements.md index 8d98fe60458..6118e567f0c 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/helm-version-requirements.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/helm-version-requirements.md @@ -10,6 +10,8 @@ This section contains the requirements for Helm, which is the tool used to insta > The installation instructions have been updated for 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/) [This section](/versioned_docs/version-2.0-2.4/pages-for-subheaders/helm2.md) provides a copy of the older high-availability Rancher installation instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. + + - Helm v3.2.x or higher is required to install or upgrade Rancher v2.5. - Helm v2.16.0 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using. - Helm v2.15.0 should not be used, because of an issue with converting/comparing numbers. diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/resources.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/resources.md index 5d4fbf24fc1..b5c215c5755 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/resources.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/resources.md @@ -3,7 +3,7 @@ title: Resources --- - + ### Docker Installations diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md index dd00964ef02..ff5f495f501 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md @@ -145,6 +145,8 @@ Before you can perform the upgrade, you must prepare your air gapped environment --set cainjector.image.repository=/quay.io/jetstack/cert-manager-cainjector ``` + + The Helm 2 command is as follows: ```plain diff --git a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md index a0500a27747..8da9e993a43 100644 --- a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md +++ b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md @@ -1,6 +1,6 @@ --- -title: Rancher AWS Marketplace Quick Start -description: Use Amazon EKS to deploy Rancher server. +title: Rancher Prime AWS Marketplace Quick Start +description: Deploy SUSE Rancher from the AWS Marketplace listing. --- @@ -9,6 +9,6 @@ description: Use Amazon EKS to deploy Rancher server. import YouTube from '@site/src/components/YouTube' -Amazon Elastic Kubernetes Service (EKS) can quickly [deploy Rancher to Amazon Web Services (AWS)](https://documentation.suse.com/trd/kubernetes/single-html/gs_rancher_aws-marketplace/). To learn more, see our [Amazon Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-go7ent7goo5ae). Watch the demo for a walkthrough of AWS Marketplace SUSE Rancher setup: +You can quickly deploy Rancher Prime on Amazon Elastic Kubernetes Service (EKS.) To learn more, see the [instructions](https://suse-enceladus.github.io/marketplace-docs/rancher-prime/aws/?repository=rancher-payg-billing-adapter-llc-prd) under Usage Information in the [AWS Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c). - +# diff --git a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md index 2c45cf300ed..af0c27aac71 100644 --- a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md +++ b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md @@ -3,7 +3,7 @@ title: Deploying Rancher Server --- - + Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. diff --git a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md index e6042decd34..3a7034c05df 100644 --- a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md +++ b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md @@ -3,7 +3,7 @@ title: Deploying Workloads --- - + These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. diff --git a/versioned_docs/version-2.7/getting-started/quick-start-guides/quick-start-guides.md b/versioned_docs/version-2.7/getting-started/quick-start-guides/quick-start-guides.md index 955135a1d48..424fe7d8802 100644 --- a/versioned_docs/version-2.7/getting-started/quick-start-guides/quick-start-guides.md +++ b/versioned_docs/version-2.7/getting-started/quick-start-guides/quick-start-guides.md @@ -3,7 +3,7 @@ title: Rancher Deployment Quick Start Guides --- - + :::caution diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/advanced-user-guides.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/advanced-user-guides.md index b5b3d241037..68ffc4c7ed3 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/advanced-user-guides.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/advanced-user-guides.md @@ -3,7 +3,7 @@ title: Advanced User Guides --- - + Advanced user guides are "problem-oriented" docs in which users learn how to answer questions or solve problems. The major difference between these and the new user guides is that these guides are geared toward more experienced or advanced users who have more technical needs from their documentation. These users already have an understanding of Rancher and its functions. They know what they need to accomplish; they just need additional guidance to complete some more complex task they they have encountered while working. diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md index 790b7e1b6c1..a7c6ed43472 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md @@ -3,7 +3,7 @@ title: CIS Scan Guides --- - + - [Install rancher-cis-benchmark](install-rancher-cis-benchmark.md) diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md index 778f2b05451..c829938c3c0 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md @@ -3,7 +3,7 @@ title: Enabling Experimental Features --- - + Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an [unsupported storage type](unsupported-storage-drivers.md) outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default. diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md index 4682e638ed0..cbdeee0602b 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md @@ -3,7 +3,7 @@ title: Setup Guide --- - + This section describes how to enable Istio and start using it in your projects. diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md index ca734c02b26..a0ed1060085 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md @@ -3,7 +3,7 @@ title: Project 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/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md index 0b16e16d3bc..1554ad8121e 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md @@ -3,7 +3,7 @@ title: Project Administration --- - + _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/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md index fe129e27bb4..ec292886fb3 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md @@ -46,7 +46,7 @@ To use your own dashboard: ### 2. Create a ConfigMap using the Grafana JSON model -Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. cattle-dashboards by default). +Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. `cattle-dashboards` by default). The ConfigMap should look like this: @@ -65,19 +65,26 @@ data: By default, Grafana is configured to watch all ConfigMaps with the `grafana_dashboard` label within the `cattle-dashboards` namespace. -To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section.](#configuring-namespaces-for-the-grafana-dashboard-configmap) +To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section](#configuring-namespaces-for-the-grafana-dashboard-configmap). -To create the ConfigMap in the Rancher UI, +To create the ConfigMap through the Rancher UI, first make sure that you are currently logged in to the Grafana UI, to ensure that dashboards import without encountering permissions issues. Then, return to the Rancher UI and perform the following steps: 1. In the upper left corner, click **☰ > Cluster Management**. 1. On the **Clusters** page, go to the cluster where you want to see the visualizations and click **Explore**. 1. Click **More Resources > Core > ConfigMaps**. 1. Click **Create**. -1. Set up the key-value pairs similar to the example above. When entering the value for `.json`, click **Read from File** to upload the JSON data model as the value. +1. On the **Data** tab, set up the key-value pairs similar to the example above. When entering the value for `.json`, click **Read from File** to upload the JSON data model as the value. +1. On the **Labels & Annotations** tab, click **Add Label** and enter `grafana_dashboard` as the key, and `1` as the value. 1. Click **Create**. **Result:** After the ConfigMap is created, it should show up on the Grafana UI and be persisted even if the Grafana pod is restarted. +:::note + +The actual key-value pair may differ if you have modified the Helm chart to watch a different dashboard label and value. + +::: + Dashboards that are persisted using ConfigMaps cannot be deleted or edited from the Grafana UI. If you attempt to delete the dashboard in the Grafana UI, you will see the error message "Dashboard cannot be deleted because it was provisioned." To delete the dashboard, you will need to delete the ConfigMap. diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md index 8d8d50df647..d5ac47c78f4 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md @@ -3,7 +3,7 @@ title: Monitoring/Alerting Guides --- - + - [Enable monitoring](enable-monitoring.md) diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md index 4651e682528..c266c30f1c6 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md @@ -3,7 +3,7 @@ title: Prometheus Federator Guides --- - + - [Enable Prometheus Operator](enable-prometheus-federator.md) diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md index 35de246d3de..16d99c82a75 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md @@ -3,7 +3,7 @@ title: Advanced Configuration --- - + ### Alertmanager diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md index 46e41afd605..9fa587aef2b 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md @@ -3,7 +3,7 @@ title: Configuration --- - + This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md index 6f6ed6821da..1be09c75749 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md @@ -3,7 +3,7 @@ title: About Provisioning Drivers --- - + Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md) or [nodes in an infrastructure provider](../../launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md) to allow Rancher to deploy and manage Kubernetes. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md index eab13feb274..228ec4c0992 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md @@ -3,7 +3,7 @@ title: RKE Templates --- - + RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md index 8db0c73fb3c..d569a9d8849 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md @@ -4,7 +4,7 @@ weight: 10 --- - + One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows your users to use one set of credentials to authenticate with any of your Kubernetes clusters. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md index cc205b4ec02..a135c9d0125 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md @@ -3,7 +3,7 @@ title: Authentication, Permissions and Global Settings --- - + After installation, the [system administrator](manage-role-based-access-control-rbac/global-permissions.md) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries. @@ -82,4 +82,4 @@ The following features are available under **Global Configuration**: - **Global DNS Entries** - **Global DNS Providers** -As these are legacy features, please see the Rancher v2.0—v2.4 docs on [catalogs](../../../../version-2.0-2.4/pages-for-subheaders/helm-charts-in-rancher.md), [global DNS entries](../../../../version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#adding-a-global-dns-entry), and [global DNS providers](../../../../version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#editing-a-global-dns-provider) for more details. \ No newline at end of file +As these are legacy features, please see the Rancher v2.0—v2.4 docs on [catalogs](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), [global DNS entries](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#adding-a-global-dns-entry), and [global DNS providers](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#editing-a-global-dns-provider) for more details. \ No newline at end of file diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md index e10056cc0ae..4bdda220525 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md @@ -3,7 +3,7 @@ title: Configuring Microsoft Active Directory Federation Service (SAML) --- - + If your organization uses Microsoft Active Directory Federation Services (AD FS) for user authentication, you can configure Rancher to allow your users to log in using their AD FS credentials. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md index 9285e08ef8b..e7d4c5724a4 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md @@ -3,7 +3,7 @@ title: Configuring OpenLDAP --- - + If your organization uses LDAP for user authentication, you can configure Rancher to communicate with an OpenLDAP server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the organisation's central user repository, while allowing end-users to authenticate with their LDAP credentials when logging in to the Rancher UI. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md index 482adb05a97..a57f4882050 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md @@ -3,7 +3,7 @@ title: Configuring Shibboleth (SAML) --- - + If your organization uses Shibboleth Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in to Rancher using their Shibboleth credentials. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md index 82038ecfc7e..d6a6d8d8f76 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md @@ -3,7 +3,7 @@ title: Managing Role-Based Access Control (RBAC) --- - + Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication](../authentication-config/authentication-config.md), users can either be local or external. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 24833279d3f..6221b9b9e14 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -4,7 +4,7 @@ keywords: [rancher backup restore, rancher backup and restore, backup restore ra --- - + In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster. @@ -91,10 +91,10 @@ A migration is performed by following [these steps.](migrate-rancher-to-new-clus ## Default Storage Location Configuration -Configure a storage location where all backups are saved by default. You will have the option to override this with each backup, but will be limited to using an S3-compatible or Minio object store. +Configure a default storage location for your backups. There are various configuration options, such as specifying an S3-compatible object store as the location for individual backups or choosing an existing `StorageClass` during installation of the `backup-restore-operator` Helm chart. You also have the option to override the configured storage location with each backup, but are limited to using an S3-compatible or Minio object store. For information on configuring these options, refer to [this page.](../../../reference-guides/backup-restore-configuration/storage-configuration.md) -### Example values.yaml for the rancher-backup Helm Chart +### Example YAML File: Rancher Backup Helm Chart -The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-valuesyaml-for-the-rancher-backup-helm-chart) can be used to configure the `rancher-backup` operator when the Helm CLI is used to install it. +The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-yaml-file-rancher-backup-helm-chart) can be used to configure the `backup-restore-operator` when the Helm CLI is used to install it. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 9e670da901d..89faf8d11bf 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -27,7 +27,8 @@ Since Rancher can be installed on any Kubernetes cluster, you can use this backu ### 1. Install the rancher-backup Helm chart -Install the [rancher-backup chart](https://github.com/rancher/backup-restore-operator/tags), using a version in the 2.x.x major version range: + +Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-operator/tags): 1. Add the Helm repository: @@ -36,13 +37,14 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope helm repo update ``` - 1. Select and set `CHART_VERSION` variable with a 2.x.x rancher-backup release version: + 1. Set a `CHART_VERSION` variable, selecting a `rancher-backup` chart version compatible with your version of Rancher. See the [support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions), within the **Rancher Apps / Cluster Tools** section, to see which `rancher-backup` versions are supported: + ```bash - helm search repo --versions rancher-charts/rancher-backup - CHART_VERSION=<2.x.x> + CHART_VERSION= ``` 1. Install the charts: + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION @@ -50,7 +52,7 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope :::note - The above assumes an environment with outbound connectivity to Docker Hub + The above assumes an environment with outbound connectivity to Docker Hub. For an **air-gapped environment**, use the Helm value below to pull the `backup-restore-operator` image from your private registry when installing the rancher-backup Helm chart. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md index 2d4bd5cdcb0..7c3d85b867f 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md @@ -3,7 +3,7 @@ title: Deploying Applications across Clusters --- - + Rancher offers several ways to deploy applications across clusters, depending on version. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index fa99b770228..e96f0cab855 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -3,7 +3,7 @@ title: Helm Charts in Rancher --- - + In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps**. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md index ccdca3126b8..7a79e5f5622 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md @@ -3,7 +3,7 @@ title: Don't have infrastructure for your Kubernetes cluster? Try one of these t --- - + To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](ha-k3s-kubernetes-cluster.md) diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md index 9291d55bee4..00c22ead1c3 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md @@ -3,7 +3,7 @@ title: "Don't have a Kubernetes cluster? Try one of these tutorials." --- - + This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md index d3609540e2a..14ae384e387 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md @@ -3,7 +3,7 @@ title: Checklist for Production-Ready Clusters --- - + In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md index f088c16e1c4..230a3d6212b 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md @@ -4,7 +4,7 @@ description: Provisioning Kubernetes Clusters --- - + Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md index 11c5e5590e3..d6c9834b666 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md @@ -3,7 +3,7 @@ title: Setting up Cloud Providers --- - + A _cloud provider_ is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md index 070c16dc420..ea0cc4ff394 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md @@ -3,7 +3,7 @@ title: Setting up Clusters from Hosted Kubernetes Providers --- - + In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md index 91cee26d619..4c5f811c5e6 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on Windows Clusters --- - + When provisioning a [custom cluster](../../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md index e0f5e51e4b4..8d084cb00d7 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md @@ -4,7 +4,7 @@ description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs --- - + The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md index 132e0f2627d..7879660225d 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md @@ -3,7 +3,7 @@ title: Kubernetes Resources --- - + You can view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md index b3f3976e6e3..934a552f019 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md @@ -4,7 +4,7 @@ description: Learn how you can set up load balancers and ingress controllers to --- - + Within Rancher, you can set up load balancers and ingress controllers to redirect service requests. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md index c20787712ae..b9bd0fa0a47 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md @@ -4,7 +4,7 @@ description: "Learn about the two constructs with which you can build any comple --- - + You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md index e62d67c8323..7c7faea2e8d 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md @@ -3,7 +3,7 @@ title: Launching Kubernetes with Rancher --- - + You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, you can choose between [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) or [RKE2](https://docs.rke2.io) distributions. Rancher can launch Kubernetes on any computers, including: diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md index 9c761b50475..8d498ac35e6 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md @@ -4,7 +4,7 @@ description: Use Rancher to create a Nutanix AOS (AHV) cluster. It may consist o --- - + [Nutanix Acropolis Operating System](https://www.nutanix.com/products/acropolis) (Nutanix AOS) is an operating system for the Nutanix hyper-converged infrastructure platform. AOS comes with a built-in hypervisor called [Acropolis Hypervisor](https://www.nutanix.com/products/ahv), or AHV. By using Rancher with Nutanix AOS (AHV), you can bring cloud operations on-premises. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md index 88bac5263d0..6e7580f8e16 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on New Nodes in an Infrastructure Provider --- - + When you create an RKE or RKE2 cluster using a node template in Rancher, each resulting node pool is shown in a new **Machine Pools** tab. You can see the machine pools by doing the following: diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md index 9890f087ece..e1d63847e59 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md @@ -4,7 +4,7 @@ description: Use Rancher to create a vSphere cluster. It may consist of groups o --- - + import YouTube from '@site/src/components/YouTube' diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md index a4929ee26cf..ca181ffc07a 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md @@ -3,7 +3,7 @@ title: Cluster Access --- - + This section is about what tools can be used to access clusters managed by Rancher. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md index dc7e5cd56ac..b7f9af5c766 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md @@ -4,7 +4,7 @@ description: "Learn about the two ways with which you can create persistent stor --- - + 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/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md index 127153dd06b..01a5ca7d2d6 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md @@ -3,7 +3,7 @@ title: Cluster Autoscaler --- - + In this section, you'll learn how to install and use the [Kubernetes cluster-autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/) on Rancher custom clusters using AWS EC2 Auto Scaling Groups. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md index fc05cfd581b..eafa50faff9 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md @@ -3,7 +3,7 @@ title: Cluster Administration --- - + After you provision a cluster in Rancher, you can begin using powerful Kubernetes features to deploy and scale your containerized applications in development, testing, or production environments. diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md index b1d89e54c05..d4b85fec0c2 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md @@ -3,7 +3,7 @@ title: Provisioning Storage Examples --- - + Rancher supports persistent storage with a variety of volume plugins. However, before you use any of these plugins to bind persistent storage to your workloads, you have to configure the storage itself, whether its a cloud-based solution from a service-provider or an on-prem solution that you manage yourself. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cis-scans/cis-scans.md b/versioned_docs/version-2.7/integrations-in-rancher/cis-scans/cis-scans.md index c6423844d0c..f170f997d66 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cis-scans/cis-scans.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cis-scans/cis-scans.md @@ -3,7 +3,7 @@ title: CIS Scans --- - + Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. The CIS scans can run on any Kubernetes cluster, including hosted Kubernetes providers such as EKS, AKS, and GKE. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md index 13b1398077e..cd143d64ef4 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md @@ -3,7 +3,7 @@ title: AWS Marketplace Integration --- - + ## Overview diff --git a/versioned_docs/version-2.7/pages-for-subheaders/aws-marketplace-payg-integration.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/aws-marketplace-payg-integration.md similarity index 94% rename from versioned_docs/version-2.7/pages-for-subheaders/aws-marketplace-payg-integration.md rename to versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/aws-marketplace-payg-integration.md index 3cbf9e8803b..46400992753 100644 --- a/versioned_docs/version-2.7/pages-for-subheaders/aws-marketplace-payg-integration.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/aws-marketplace-payg-integration.md @@ -3,7 +3,7 @@ title: AWS Marketplace Pay-as-you-go (PAYG) Integration --- - + ## Overview @@ -19,8 +19,8 @@ Rancher Prime integrates with the [AWS Marketplace](https://aws.amazon.com/marke ## How to Use -1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md). -2. [Install the Rancher Prime PAYG offering on the AWS Marketplace](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md). +1. Complete the [prerequisite steps](prerequisites.md). +2. [Install the Rancher Prime PAYG offering on the AWS Marketplace](installing-rancher-prime.md). ## FAQ @@ -316,7 +316,7 @@ While it is not possible to transact/bill Rancher Prime in China, it is possible #### Can I still deploy Rancher using the "Rancher Setup" listing from the AWS Marketplace? -"Rancher Setup" is no longer available via AWS Marketplace. Customers should deploy an EKS Cluster to host Rancher. Follow the steps in this [guide](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) except for the Rancher installation. The Rancher product installation should be carried out as per [installing the Rancher Prime PAYG offering on Amazon's AWS Marketplace](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md). +"Rancher Setup" is no longer available via AWS Marketplace. Customers should deploy an EKS Cluster to host Rancher. Follow the steps in this [guide](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) except for the Rancher installation. The Rancher product installation should be carried out as per [installing the Rancher Prime PAYG offering on Amazon's AWS Marketplace](installing-rancher-prime.md). ### Billing @@ -362,7 +362,7 @@ Rancher Prime has different pricing tiers when purchasing via the AWS Marketplac If using the Rancher Prime listing in the AWS Marketplace, billing will commence from the time of deployment. -Rancher can be deployed manually using the standard documentation and repositories. When ready to benefit from a supported platform and have this billed via the AWS Marketplace, follow the available [documentation](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md) to deploy Rancher Prime from the AWS Marketplace and migrate. +Rancher can be deployed manually using the standard documentation and repositories. When ready to benefit from a supported platform and have this billed via the AWS Marketplace, follow the available [documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md) to deploy Rancher Prime from the AWS Marketplace and migrate. #### How does SUSE calculate the ‘average number of managed nodes’ to bill for? @@ -468,7 +468,7 @@ Yes. Simply deploy the AWS Marketplace listing for Rancher Prime. In order to benefit from monthly billing via the AWS Marketplace, the primary Rancher cluster needs to be deployed from the listing, it is then possible to migrate the existing Rancher configuration to the new deployment. -Please follow the [documentation](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md) and be sure to back up the existing Rancher configuration. +Please follow the [documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md) and be sure to back up the existing Rancher configuration. ### Technical (Product) @@ -476,7 +476,7 @@ Please follow the [documentation](../getting-started/installation-and-upgrade/in It is very simple to [open a support case](https://scc.suse.com/cloudsupport) with SUSE for Rancher Prime. Create a ‘supportconfig’ via the Rancher UI and upload the output to the SUSE Customer Center. The support config bundle can be exported from the Rancher console using the ‘Get Support’ button at the bottom of the page. For deployments when Rancher is managing multiple downstream clusters, export the support config bundle from the primary cluster only. -If the billing mechanism on the primary cluster is active, a support case will be opened. Further details can be found in the [documentation](../integrations-in-rancher/cloud-marketplace/supportconfig.md). +If the billing mechanism on the primary cluster is active, a support case will be opened. Further details can be found in the [documentation](../supportconfig.md). #### What are the resource requirements for installing Rancher on EKS? @@ -506,4 +506,4 @@ Yes. Nodes can run anywhere. SUSE Rancher will count the total number of nodes m #### How do I get fixes and updates for Rancher? -To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, please see [upgrading Rancher Prime PAYG cluster in AWS](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md). +To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, please see [upgrading Rancher Prime PAYG cluster in AWS](upgrading-rancher-payg-cluster.md). diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md index dd6ed7e4b1f..8fbc1fddb76 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md @@ -6,4 +6,4 @@ This page covers some common issues that might arise when setting up the Rancher ### Migrating Rancher to a different EKS Cluster -When you migrate Rancher to a different EKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target EKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the AWS Marketplace. +When you migrate Rancher to a different EKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target EKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the AWS Marketplace. diff --git a/versioned_docs/version-2.7/pages-for-subheaders/azure-marketplace-payg-integration.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/azure-marketplace-payg-integration.md similarity index 96% rename from versioned_docs/version-2.7/pages-for-subheaders/azure-marketplace-payg-integration.md rename to versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/azure-marketplace-payg-integration.md index 052cc94bca9..33c6cb21924 100644 --- a/versioned_docs/version-2.7/pages-for-subheaders/azure-marketplace-payg-integration.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/azure-marketplace-payg-integration.md @@ -3,7 +3,7 @@ title: Azure Marketplace Pay-as-you-go (PAYG) Integration --- - + ## Overview @@ -19,8 +19,8 @@ Rancher Prime integrates with the [Azure Marketplace](https://azuremarketplace.m ## How to Use -1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/prerequisites.md). -2. [Install the Rancher Prime PAYG offering on the Azure Marketplace](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md). +1. Complete the [prerequisite steps](prerequisites.md). +2. [Install the Rancher Prime PAYG offering on the Azure Marketplace](installing-rancher-prime.md). ## FAQ @@ -202,7 +202,7 @@ No. You need to deploy Rancher Prime with the Azure Marketplace listing and migr #### How do I get support? -It is very simple to [open a support case](https://scc.suse.com/cloudsupport) with SUSE for Rancher Prime. Create a ‘supportconfig’ via the Rancher UI (click Get Support under the hamburger menu and follow instructions), then upload the ‘supportconfig’ output to the SUSE Customer Center. If the billing mechanism is active, a support case will be opened. See Supportconfig bundle in the Rancher [documentation](../integrations-in-rancher/cloud-marketplace/supportconfig.md) for more details. +It is very simple to [open a support case](https://scc.suse.com/cloudsupport) with SUSE for Rancher Prime. Create a ‘supportconfig’ via the Rancher UI (click Get Support under the hamburger menu and follow instructions), then upload the ‘supportconfig’ output to the SUSE Customer Center. If the billing mechanism is active, a support case will be opened. See Supportconfig bundle in the Rancher [documentation](../supportconfig.md) for more details. :::note @@ -212,7 +212,7 @@ For deployments where Rancher Prime is managing multiple downstream clusters, be #### What are the resource requirements for installing Rancher on AKS? -Check the documentation for [best practices](../pages-for-subheaders/installation-requirements.md#hosted-kubernetes). +Check the documentation for [best practices](../../../getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md#hosted-kubernetes). #### Is there any difference between Rancher Prime from Azure Marketplace and the versions I can run in my own data center? @@ -232,4 +232,4 @@ If the Racher Prime cluster is offline or disconnected from the Azure billing fr #### How do I get fixes and updates for Rancher? -To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, please see [upgrading Rancher Prime PAYG cluster in Azure](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md). +To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, please see [upgrading Rancher Prime PAYG cluster in Azure](upgrading-rancher-payg-cluster.md). diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md index cd68e5462b8..07706e11a7c 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md @@ -6,4 +6,4 @@ This page covers some common issues that might arise when setting up the Rancher ### Migrating Rancher to a Different AKS Cluster -When you migrate Rancher to a different AKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target AKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the Azure Marketplace. +When you migrate Rancher to a different AKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target AKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the Azure Marketplace. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md index 5dda266f125..9c0ef08fe2f 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md @@ -71,7 +71,7 @@ On the **Extensions + applications** page, the **Provisioning State** may show * ## Log into the Rancher Dashboard -You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL `https://`. The `` is the hostname you entered when you [installed Rancher](#installing-rancher). +You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL `https://`. The `` is the hostname you entered when you [configured Rancher](#rancher-configuration). :::note diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md index 6f90a2c3ff4..ab6234b156d 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md @@ -3,7 +3,7 @@ title: Cloud Marketplace Integration --- - + Rancher offers integration with cloud marketplaces to easily purchase support for installations hosted on certain cloud providers. In addition, this integration also provides the ability to generate a supportconfig bundle which can be provided to rancher support. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/istio/configuration-options/configuration-options.md b/versioned_docs/version-2.7/integrations-in-rancher/istio/configuration-options/configuration-options.md index 35546a12f03..5f553689ab0 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/istio/configuration-options/configuration-options.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/istio/configuration-options/configuration-options.md @@ -3,7 +3,7 @@ title: Configuration Options --- - + ### Egress Support diff --git a/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md index c622d0d2180..0f865ef5363 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md @@ -3,7 +3,7 @@ title: Istio --- - + [Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md b/versioned_docs/version-2.7/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md index eb1020ac1a2..b1099777da3 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md @@ -3,7 +3,7 @@ title: Custom Resource Configuration --- - + The following Custom Resource Definitions are used to configure logging: diff --git a/versioned_docs/version-2.7/integrations-in-rancher/logging/logging.md b/versioned_docs/version-2.7/integrations-in-rancher/logging/logging.md index a79c896ec6e..2813d8fa681 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/logging/logging.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/logging/logging.md @@ -4,7 +4,7 @@ description: Rancher integrates with popular logging services. Learn the require --- - + The [Logging operator](https://kube-logging.github.io/docs/) now powers Rancher's logging solution in place of the former, in-house solution. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md b/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md index 38e7a9a12a2..da6460a0da7 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md @@ -4,14 +4,14 @@ description: Prometheus lets you view metrics from your different Rancher and Ku --- - + The `rancher-monitoring` application can quickly deploy leading open-source monitoring and alerting solutions onto your cluster. Introduced in Rancher v2.5, the application is powered by [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/grafana/), [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator), and the [Prometheus adapter.](https://github.com/DirectXMan12/k8s-prometheus-adapter) -For information on V1 monitoring and alerting, available in Rancher v2.2 up to v2.4, please see the Rancher v2.0—v2.4 docs on [cluster monitoring](../../../version-2.0-2.4/pages-for-subheaders/cluster-monitoring.md), [alerting](../../../version-2.0-2.4/pages-for-subheaders/cluster-alerts.md), [notifiers](../../../version-2.0-2.4/explanations/integrations-in-rancher/notifiers.md) and other [tools](../../../version-2.0-2.4/pages-for-subheaders/project-tools.md). +For information on V1 monitoring and alerting, available in Rancher v2.2 up to v2.4, please see the Rancher v2.0—v2.4 docs on [cluster monitoring](/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/cluster-monitoring/cluster-monitoring.md), [alerting](/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/cluster-alerts/cluster-alerts.md), [notifiers](/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/notifiers.md) and other [tools](/versioned_docs/version-2.0-2.4/reference-guides/rancher-project-tools/rancher-project-tools.md). Using the `rancher-monitoring` application, you can quickly deploy leading open-source monitoring and alerting solutions onto your cluster. @@ -55,7 +55,13 @@ For a list of monitoring components exposed in the Rancher UI, along with common ## Role-based Access Control -For information on configuring access to monitoring, see [this page.](rbac-for-monitoring.md) +For more information on configuring access to monitoring, see [this page.](rbac-for-monitoring.md) + +:::note + +Rancher and Project read permissions don't necessarily apply to monitoring resources. See [monitoring-ui-view](rbac-for-monitoring.md#additional-monitoring-clusterroles) for more details. + +::: ## Guides diff --git a/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md b/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md index 0072c5da17c..01d7c5dd6e5 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md @@ -112,7 +112,7 @@ Monitoring also creates additional `ClusterRoles` that aren't assigned to users | Role | Purpose | | ------------------------------| ---------------------------| -| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users with write access to the project to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting Read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Grafana, and Alertmanager UIs through the Rancher proxy. | +| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users with write access to the project to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting Read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Alertmanager, and Grafana UIs through the Rancher proxy.

This role doesn't grant access to monitoring endpoints. As a result, users with this role won't be able to view cluster monitoring graphs and dashboards in the Rancher UI; however, they are able to access the monitoring Grafana, Prometheus, and Alertmanager UIs if provided those links. | :::note @@ -216,7 +216,11 @@ In addition to these default roles, the following Rancher project roles can be a |--------------------------|-------------------------------|-------|------| | View Monitoring* | [monitoring-ui-view](#additional-monitoring-clusterroles) | 2.4.8+ | 9.4.204+ | -\* A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project. +:::note + + A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project. + +:::note ### Differences in 2.5.x diff --git a/versioned_docs/version-2.7/reference-guides/about-the-api/about-the-api.md b/versioned_docs/version-2.7/reference-guides/about-the-api/about-the-api.md index c8364cdc7d8..40068f7cfe5 100644 --- a/versioned_docs/version-2.7/reference-guides/about-the-api/about-the-api.md +++ b/versioned_docs/version-2.7/reference-guides/about-the-api/about-the-api.md @@ -3,7 +3,7 @@ title: API --- - + ## How to use the API diff --git a/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/backup-restore-configuration.md b/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/backup-restore-configuration.md index 1f74b2fad9b..ad817581489 100644 --- a/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/backup-restore-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/backup-restore-configuration.md @@ -3,7 +3,7 @@ title: Rancher Backup Configuration Reference --- - + - [Backup configuration](backup-configuration.md) diff --git a/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/storage-configuration.md b/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/storage-configuration.md index a901bde4190..64d9a810a44 100644 --- a/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/storage-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/storage-configuration.md @@ -52,9 +52,8 @@ It is highly recommended to use a Persistent Volume with a reclaim policy of "Re ::: -## Example values.yaml for the rancher-backup Helm Chart +## Example YAML File: Rancher Backup Helm Chart -The documented `values.yaml` file that can be used to configure `rancher-backup` operator when the Helm CLI is used can be found in the [backup-restore-operator repository.](https://github.com/rancher/backup-restore-operator/blob/master/charts/rancher-backup/values.yaml) +The documented `values.yaml` file that can be used to configure the `backup-restore-operator` when the Helm CLI is used can be found in the [backup-restore-operator repository.](https://github.com/rancher/backup-restore-operator/blob/master/charts/rancher-backup/values.yaml) For more information about `values.yaml` files and configuring Helm charts during installation, refer to the [Helm documentation.](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing) - diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/best-practices.md b/versioned_docs/version-2.7/reference-guides/best-practices/best-practices.md index 546ae01be94..d2520a3e785 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/best-practices.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/best-practices.md @@ -3,7 +3,7 @@ title: Best Practices Guide --- - + The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers. diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md index 72c44ac9a78..ea4697f8e76 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md @@ -3,7 +3,7 @@ title: Best Practices for Rancher Managed Clusters --- - + ### Logging diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md index a79561ced2c..8e24e145482 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md @@ -3,7 +3,7 @@ title: Best Practices for the Rancher Server --- - + This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 896a4978b12..50687cdd32c 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -21,6 +21,26 @@ This guide describes the best practices and tuning approaches to scale Rancher s When scaling up Rancher, one typical bottleneck is resource growth in the upstream (local) Kubernetes cluster. The upstream cluster contains information for all downstream clusters. Many operations that apply to downstream clusters create new objects in the upstream cluster and require computation from handlers running in the upstream cluster. +### Minimizing Third-Party Software on the Upstream Cluster + +Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. + +Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. + +Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + +On the other hand, the following software are found to interfere with Rancher performance at scale: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + ### Managing Your Object Counts Etcd is the backing database for Kubernetes and for Rancher. The database may eventually encounter limitations to the number of a single Kubernetes resource type it can store. Exact limits vary and depend on a number of factors. However, experience indicates that performance issues frequently arise once a single resource type's object count exceeds 60,000. Often that type is `RoleBinding`. diff --git a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/cli-with-rancher.md b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/cli-with-rancher.md index a0e50c51b71..a18cabf5abb 100644 --- a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/cli-with-rancher.md +++ b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/cli-with-rancher.md @@ -3,7 +3,7 @@ title: CLI with Rancher --- - + Interact with Rancher using command line interface (CLI) tools from your workstation. The following docs will describe the [Rancher CLI](rancher-cli.md) and [kubectl Utility](kubectl-utility.md). \ No newline at end of file diff --git a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md index 03860d29c94..9f5ff644b5a 100644 --- a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,15 +68,22 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| `machines, [machine]` | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| `up` | Applies compose config. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/cluster-configuration.md index 7b15f647a03..fb16d619292 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/cluster-configuration.md @@ -3,7 +3,7 @@ title: Cluster Configuration --- - + After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md index 897728cd346..e0c92a52f0f 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md @@ -3,7 +3,7 @@ title: Downstream Cluster Configuration --- - + The following docs will discuss [node template configuration](node-template-configuration/node-template-configuration.md) and [machine configuration](machine-configuration/machine-configuration.md). \ No newline at end of file diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md index b28ccd669dd..cff1dada268 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md @@ -3,7 +3,7 @@ title: Machine Configuration --- - + Machine configuration is the arrangement of resources assigned to a virtual machine. Please see the docs for [Amazon EC2](amazon-ec2.md), [DigitalOcean](digitalocean.md), and [Azure](azure.md) to learn more. \ No newline at end of file diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md index bbe4d6127c3..e0f9ba4105d 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md @@ -3,7 +3,7 @@ title: Node Template Configuration --- - + To learn about node template config, refer to [EC2 Node Template Configuration](amazon-ec2.md), [DigitalOcean Node Template Configuration](digitalocean.md), [Azure Node Template Configuration](azure.md), [vSphere Node Template Configuration](vsphere.md), and [Nutanix Node Template Configuration](nutanix.md). diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index 4a9bbe4f0ef..1be52f355ce 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -101,6 +101,12 @@ Also, if you provide the launch template, you can only update the template versi | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | | Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | +:::caution + +You can't directly update a node group to a newer Kubernetes version if the node group was created from a custom launch template. You must create a new launch template with the proper Kubernetes version, and associate the node group with the new template. + +::: + #### Rancher-managed Launch Templates If you do not specify a launch template, then you will be able to configure the above options in the Rancher UI and all of them can be updated after creation. In order to take advantage of all of these options, Rancher will create and manage a launch template for you. Each cluster in Rancher will have one Rancher-managed launch template and each managed node group that does not have a specified launch template will have one version of the managed launch template. The name of this launch template will have the prefix "rancher-managed-lt-" followed by the display name of the cluster. In addition, the Rancher-managed launch template will be tagged with the key "rancher-managed-template" and value "do-not-modify-or-delete" to help identify it as Rancher-managed. It is important that this launch template and its versions not be modified, deleted, or used with any other clusters or managed node groups. Doing so could result in your node groups being "degraded" and needing to be destroyed and recreated. diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md index 8b63d9b8490..ad39397675d 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md @@ -3,7 +3,7 @@ title: GKE Cluster Configuration Reference --- - + ## Changes in Rancher v2.6 diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md index e4da90d371a..0e2aa590833 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md @@ -3,7 +3,7 @@ title: Rancher Server Configuration --- - + - [RKE1 Cluster Configuration](rke1-cluster-configuration.md) diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md index cca7752af30..45e8fba4b02 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md @@ -4,7 +4,7 @@ description: To create a cluster with custom nodes, you’ll need to access serv --- - + When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. diff --git a/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md b/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md index 62bade46a2a..7fea6f9a7d9 100644 --- a/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md @@ -3,7 +3,7 @@ title: Monitoring V2 Configuration --- - + The following sections will explain important options essential to configuring Monitoring V2 in Rancher: diff --git a/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/receivers.md b/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/receivers.md index dc459f34378..79d9749dc18 100644 --- a/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/receivers.md +++ b/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/receivers.md @@ -24,8 +24,6 @@ This section assumes familiarity with how monitoring components work together. F ::: -To create notification receivers in the Rancher UI, - @@ -152,24 +150,20 @@ The Teams receiver is not a native receiver and must be enabled before it can be 1. Select the **Teams** option and click **Install**. 1. Take note of the namespace used as it will be required in a later step. -### Configure the Teams Receiver +### Configuring the Teams Receiver -The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration. +1. To configure the Teams receiver, update its ConfigMap. The following example is a minimal Teams receiver configuration: -```yaml -[Microsoft Teams] -teams-instance-1: https://your-teams-webhook-url -``` + ```yaml + [Microsoft Teams] + connector: https://your-teams-webhook-url + ``` -When configuration is complete, add the receiver using the steps in [this section](#creating-receivers-in-the-rancher-ui). +2. After you update the configuration, follow the instructions in [Creating Receivers in the Rancher UI](#creating-receivers-in-the-rancher-ui) to add the receiver. Use the example below to form your URL. Make sure to replace `` with the namespace of the `rancher-alerting-drivers` app: -Use the example below as the URL where: - -- `ns-1` is replaced with the namespace where the `rancher-alerting-drivers` app is installed - -```yaml -url: http://rancher-alerting-drivers-prom2teams.ns-1.svc:8089/v2/teams-instance-1 -``` + ```yaml + url: http://rancher-alerting-drivers-prom2teams..svc:8089/v2/connector + ``` @@ -187,7 +181,7 @@ The SMS receiver is not a native receiver and must be enabled before it can be u 1. Select the **SMS** option and click **Install**. 1. Take note of the namespace used as it will be required in a later step. -### Configure the SMS Receiver +### Configuring the SMS Receiver The SMS receiver can be configured by updating its ConfigMap. For example, the following is a minimal SMS receiver configuration. diff --git a/versioned_docs/version-2.7/reference-guides/prometheus-federator/prometheus-federator.md b/versioned_docs/version-2.7/reference-guides/prometheus-federator/prometheus-federator.md index 4b1e8a21143..5166ab8732f 100644 --- a/versioned_docs/version-2.7/reference-guides/prometheus-federator/prometheus-federator.md +++ b/versioned_docs/version-2.7/reference-guides/prometheus-federator/prometheus-federator.md @@ -3,7 +3,7 @@ title: Prometheus Federator --- - + Prometheus Federator, also referred to as Project Monitoring v2, deploys a Helm Project Operator (based on the [rancher/helm-project-operator](https://github.com/rancher/helm-project-operator)), an operator that manages deploying Helm charts each containing a Project Monitoring Stack, where each stack contains: diff --git a/versioned_docs/version-2.7/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md b/versioned_docs/version-2.7/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md index 97ef05d0b6b..0e01bd3d293 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md @@ -3,7 +3,7 @@ title: Architecture --- - + This section focuses on the [Rancher server and its components](rancher-server-and-components.md) and how [Rancher communicates with downstream Kubernetes clusters](communicating-with-downstream-user-clusters.md). diff --git a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/hardening-guides.md b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/hardening-guides.md index 1ab615e083e..14366baeee7 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/hardening-guides.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/hardening-guides.md @@ -3,7 +3,7 @@ title: Self-Assessment and Hardening Guides for Rancher --- - + Rancher provides specific security hardening guides for each supported Rancher version's Kubernetes distributions. diff --git a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md index 285577fbca5..88f00624b20 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md @@ -3,7 +3,7 @@ title: K3s Hardening Guide --- - + This document provides prescriptive guidance for how to harden a K3s cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md index 838589b82ad..c7992611f8a 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md @@ -3,7 +3,7 @@ title: RKE Hardening Guide --- - + This document provides prescriptive guidance for how to harden an RKE cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md index 0cce6028916..a69c97665bb 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md @@ -3,7 +3,7 @@ title: RKE2 Hardening Guide --- - + This document provides prescriptive guidance for how to harden an RKE2 cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/versioned_docs/version-2.7/reference-guides/rancher-security/rancher-security.md b/versioned_docs/version-2.7/reference-guides/rancher-security/rancher-security.md index a051712aae3..70f92fa8d77 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-security/rancher-security.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-security/rancher-security.md @@ -3,7 +3,7 @@ title: Security --- - +
diff --git a/versioned_docs/version-2.7/reference-guides/rancher-security/security-advisories-and-cves.md b/versioned_docs/version-2.7/reference-guides/rancher-security/security-advisories-and-cves.md index ad7fb02ad7b..a142092fa2d 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-security/security-advisories-and-cves.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-security/security-advisories-and-cves.md @@ -10,6 +10,10 @@ Rancher is committed to informing the community of security issues in our produc | ID | Description | Date | Resolution | |----|-------------|------|------------| +| [CVE-2023-32193](https://github.com/rancher/norman/security/advisories/GHSA-r8f4-hv23-6qp6) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Norman). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32192](https://github.com/rancher/apiserver/security/advisories/GHSA-833m-37f7-jq55) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Apiserver). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-22649](https://github.com/rancher/rancher/security/advisories/GHSA-xfj7-qf8w-2gcr) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, in which sensitive data may be leaked into Rancher's audit logs. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32194](https://github.com/rancher/rancher/security/advisories/GHSA-c85r-fwc7-45vc) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where granting a `create` or `*` global role for a resource type of "namespaces"; no matter the API group, the subject will receive `*` permissions for core namespaces. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | | [CVE-2023-22648](https://github.com/rancher/rancher/security/advisories/GHSA-vf6j-6739-78m8) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which permission changes in Azure AD are not reflected to users until they logout and log back into the Rancher UI. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | | [CVE-2022-43760](https://github.com/rancher/rancher/security/advisories/GHSA-46v3-ggjg-qq3x) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | | [CVE-2020-10676](https://github.com/rancher/rancher/security/advisories/GHSA-8vhc-hwhc-cpj4) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which users with update privileges on a namespace, can move that namespace into a project they don't have access to. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | diff --git a/versioned_docs/version-2.7/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md b/versioned_docs/version-2.7/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md index f2d93d01bb1..75df1de0d00 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md @@ -3,7 +3,7 @@ title: SELinux RPM --- - + [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. diff --git a/versioned_docs/version-2.7/reference-guides/rancher-webhook.md b/versioned_docs/version-2.7/reference-guides/rancher-webhook.md index ca6b3ae3d58..000fd95d554 100644 --- a/versioned_docs/version-2.7/reference-guides/rancher-webhook.md +++ b/versioned_docs/version-2.7/reference-guides/rancher-webhook.md @@ -9,7 +9,8 @@ title: Rancher Webhook Rancher-Webhook is an essential component of Rancher that works in conjunction with Kubernetes to enhance security and enable critical features for Rancher-managed clusters. It integrates with Kubernetes' extensible admission controllers, as described in the [Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/), which allows Rancher-Webhook to inspect specific requests sent to the Kubernetes API server, and add custom, Rancher-specific validation and mutations to the requests that are specific to Rancher. Rancher-Webhook manages the resources to be validated using the `rancher.cattle.io` `ValidatingWebhookConfiguration` and the `rancher.cattle.io` `MutatingWebhookConfiguration`, and will override any manual edits. -Rancher deploys Rancher-Webhook as a separate deployment and service in both local and downstream clusters. Rancher manages Rancher-Webhook using Helm. It's important to note that Rancher may override modifications made by users to the Helm release. + +Rancher deploys Rancher-Webhook as a separate deployment and service in both local and downstream clusters. Rancher manages Rancher-Webhook using Helm. It's important to note that Rancher may override modifications made by users to the Helm release. To safely modify these values see [Customizing Rancher-Webhook Configuration](#customizing-rancher-webhook-configuration). Each Rancher version is designed to be compatible with a single version of the webhook. The compatible versions are provided below for convenience. @@ -17,18 +18,20 @@ Each Rancher version is designed to be compatible with a single version of the w -| Rancher Version | Webhook Version | -|-----------------|:---------------:| -| v2.7.0 | v0.3.0 | -| v2.7.1 | v0.3.0 | -| v2.7.2 | v0.3.2 | -| v2.7.3 | v0.3.3 | -| v2.7.4 | v0.3.4 | -| v2.7.5 | v0.3.5 | -| v2.7.6 | v0.3.5 | -| v2.7.7 | v0.3.6 | -| v2.7.8 | v0.3.6 | -| v2.7.9 | v0.3.6 | +| Rancher Version | Webhook Version | Availability in Prime | Availability in Community | +|-----------------|-----------------|-----------------------|---------------------------| +| v2.7.11 | v0.3.7 | ✓ | N/A | +| v2.7.10 | v0.3.6 | ✓ | ✓ | +| v2.7.9 | v0.3.6 | ✗ | ✓ | +| v2.7.8 | v0.3.6 | ✗ | ✓ | +| v2.7.7 | v0.3.6 | ✓ | ✓ | +| v2.7.6 | v0.3.5 | ✓ | ✓ | +| v2.7.5 | v0.3.5 | ✓ | ✓ | +| v2.7.4 | v0.3.4 | ✓ | ✓ | +| v2.7.3 | v0.3.3 | ✓ | ✓ | +| v2.7.2 | v0.3.2 | ✓ | ✓ | +| v2.7.1 | v0.3.0 | ✓ | ✓ | +| v2.7.0 | v0.3.0 | ✓ | ✓ | ## Why Do We Need It? @@ -56,6 +59,39 @@ To bypass the webhook, impersonate both the `rancher-webhook-sudo` service accou kubectl create -f example.yaml --as=system:serviceaccount:cattle-system:rancher-webhook-sudo --as-group=system:masters ``` +## Customizing Rancher-Webhook Configuration + +You can add custom Helm values when you install Rancher-Webhook via Helm. During a Helm install of the Rancher-Webhook chart, Rancher checks for custom Helm values. These custom values must be defined in a ConfigMap named `rancher-config`, in the `cattle-system` namespace, under the data key, `rancher-webhook`. The value of this key must be valid YAML. + +``` yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: rancher-config + namespace: cattle-system + labels: + app.kubernetes.io/part-of: "rancher" +data: + rancher-webhook: '{"port": 9553, "priorityClassName": "system-node-critical"}' + +``` + +Rancher redeploys the Rancher-Webhook chart when changes to the ConfigMap values are detected. + +### Customizing Rancher-Webhook During Rancher Installation + +When you use Helm to install the Rancher chart, you can add custom Helm values to the Rancher-Webhook of the local cluster. All values in the Rancher-Webhook chart are accessible as nested variables under the `webhook` name. + +These values are synced to the `rancher-config` ConfigMap during installation. + +```bash +helm install rancher rancher-/rancher \ + --namespace cattle-system \ + ... + --set webhook.port=9553 \ + --set webhook.priorityClassName="system-node-critical" +``` + ## Common Issues ### EKS Cluster with Calico CNI diff --git a/versioned_docs/version-2.7/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md b/versioned_docs/version-2.7/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md index e605bd0c77a..bc0f02856a7 100644 --- a/versioned_docs/version-2.7/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md +++ b/versioned_docs/version-2.7/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md @@ -3,7 +3,7 @@ title: Single Node Rancher in Docker --- - + The following docs will discuss [HTTP proxy configuration](http-proxy-configuration.md) and [advanced options](advanced-options.md) for Docker installs. \ No newline at end of file diff --git a/versioned_docs/version-2.7/reference-guides/user-settings/user-settings.md b/versioned_docs/version-2.7/reference-guides/user-settings/user-settings.md index 496fde5638c..5a618c1024d 100644 --- a/versioned_docs/version-2.7/reference-guides/user-settings/user-settings.md +++ b/versioned_docs/version-2.7/reference-guides/user-settings/user-settings.md @@ -3,7 +3,7 @@ title: User Settings --- - + Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. diff --git a/versioned_docs/version-2.7/security/security-scan/security-scan.md b/versioned_docs/version-2.7/security/security-scan/security-scan.md index cacabb6266d..8c58771c736 100644 --- a/versioned_docs/version-2.7/security/security-scan/security-scan.md +++ b/versioned_docs/version-2.7/security/security-scan/security-scan.md @@ -3,7 +3,7 @@ title: Security Scans --- - + https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides The documentation about CIS security scans has moved [here.](../../how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md) diff --git a/versioned_docs/version-2.7/shared-files/_common-ports-table.md b/versioned_docs/version-2.7/shared-files/_common-ports-table.md index 1835beba031..4016670ef3d 100644 --- a/versioned_docs/version-2.7/shared-files/_common-ports-table.md +++ b/versioned_docs/version-2.7/shared-files/_common-ports-table.md @@ -1,19 +1,18 @@ -| Protocol | Port | Description | -|:--------: |:----------------: |---------------------------------------------------------------------------------- | -| TCP | 22 | Node driver SSH provisioning | -| TCP | 179 | Calico BGP Port | -| TCP | 2376 | Node driver Docker daemon TLS port | -| TCP | 2379 | etcd client requests | -| TCP | 2380 | etcd peer communication | -| UDP | 8472 | Canal/Flannel VXLAN overlay networking | -| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | -| TCP | 8443 | Rancher webhook | -| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | -| TCP | 9100 | Default port required by Monitoring to scrape metrics from Linux node-exporters | -| TCP | 9443 | Rancher webhook | -| TCP | 9796 | Default port required by Monitoring to scrape metrics from Windows node-exporters | -| TCP | 6783 | Weave Port | -| UDP | 6783-6784 | Weave UDP Ports | -| TCP | 10250 | Metrics server communication with all nodes API | -| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | -| TCP/UDP | 30000-32767 | NodePort port range | +| Protocol | Port | Description | +|:--------: |:----------------: |---------------------------------------------------------------------------------------------| +| TCP | 22 | Node driver SSH provisioning | +| TCP | 179 | Calico BGP Port | +| TCP | 2376 | Node driver Docker daemon TLS port | +| TCP | 2379 | etcd client requests | +| TCP | 2380 | etcd peer communication | +| UDP | 8472 | Canal/Flannel VXLAN overlay networking | +| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | +| TCP | 8443 | Rancher webhook | +| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | +| TCP | 9443 | Rancher webhook | +| TCP | 9796 | Default port required by Monitoring to scrape metrics from Linux and Windows node-exporters | +| TCP | 6783 | Weave Port | +| UDP | 6783-6784 | Weave UDP Ports | +| TCP | 10250 | Metrics server communication with all nodes API | +| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | +| TCP/UDP | 30000-32767 | NodePort port range | diff --git a/versioned_docs/version-2.7/troubleshooting/kubernetes-components/kubernetes-components.md b/versioned_docs/version-2.7/troubleshooting/kubernetes-components/kubernetes-components.md index 53863435277..b7995b5921c 100644 --- a/versioned_docs/version-2.7/troubleshooting/kubernetes-components/kubernetes-components.md +++ b/versioned_docs/version-2.7/troubleshooting/kubernetes-components/kubernetes-components.md @@ -3,7 +3,7 @@ title: Kubernetes Components --- - + The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) clusters. diff --git a/versioned_docs/version-2.8/api/api-reference.mdx b/versioned_docs/version-2.8/api/api-reference.mdx index 794b4ad9b91..2ae392ecf47 100644 --- a/versioned_docs/version-2.8/api/api-reference.mdx +++ b/versioned_docs/version-2.8/api/api-reference.mdx @@ -2,6 +2,10 @@ title: API Reference --- + + + + :::note At this time, not all Rancher resources are available through the Rancher Kubernetes API. diff --git a/versioned_docs/version-2.8/api/quickstart.md b/versioned_docs/version-2.8/api/quickstart.md index a9acd862973..9ec6a5b4611 100644 --- a/versioned_docs/version-2.8/api/quickstart.md +++ b/versioned_docs/version-2.8/api/quickstart.md @@ -2,6 +2,10 @@ title: API Quick Start Guide --- + + + + You can access Rancher's resources through the Kubernetes API. This guide will help you get started on using this API as a Rancher user. 1. In the upper left corner, click **☰ > Global Settings**. diff --git a/versioned_docs/version-2.8/api/workflows/projects.md b/versioned_docs/version-2.8/api/workflows/projects.md index ddc2f8c5aae..b6f9a3b1d8b 100644 --- a/versioned_docs/version-2.8/api/workflows/projects.md +++ b/versioned_docs/version-2.8/api/workflows/projects.md @@ -2,6 +2,10 @@ title: Projects --- + + + + ## Creating a Project Project resources may only be created on the management cluster. See below for [creating namespaces under projects in a managed cluster](#creating-a-namespace-in-a-project). @@ -107,3 +111,5 @@ Delete the project under the cluster namespace: ```bash kubectl --namespace c-m-abcde delete project p-vwxyz ``` + +Note that this command doesn't delete the namespaces and resources that formerly belonged to the project. diff --git a/versioned_docs/version-2.8/faq/container-network-interface-providers.md b/versioned_docs/version-2.8/faq/container-network-interface-providers.md index a8662eaf14a..cb65dd9238d 100644 --- a/versioned_docs/version-2.8/faq/container-network-interface-providers.md +++ b/versioned_docs/version-2.8/faq/container-network-interface-providers.md @@ -184,8 +184,6 @@ The following table summarizes the different features available for each CNI net ## CNI Community Popularity -import CNIPopularityTable from '/shared-files/_cni-popularity.md'; - ## Which CNI Provider Should I Use? diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md index a9ff741e47a..4448a2d739e 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md index 157151bdc04..b629e768d54 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md @@ -28,8 +28,11 @@ The kubeconfig can also be manually targeted for the intended cluster with the ` Review the list of known issues for each Rancher version, which can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository](../resources/choose-a-rancher-version.md#helm-chart-repositories) aren't supported. + ### Helm Version + + 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](/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md)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. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-and-upgrade.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-and-upgrade.md index f9067e831b7..6a930db2b05 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-and-upgrade.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-and-upgrade.md @@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm --- - + This section provides an overview of the architecture options of installing Rancher, describing advantages of each option. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-references/installation-references.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-references/installation-references.md index 67a379702cd..ded2dd3a77a 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-references/installation-references.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-references/installation-references.md @@ -3,7 +3,7 @@ title: Installation References --- - + Please see the following reference guides for other installation resources: [Rancher Helm chart options](helm-chart-options.md), [TLS settings](tls-settings.md), and [feature flags](feature-flags.md). \ No newline at end of file diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md index 614ed36e51a..39f3df24ae4 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md @@ -4,7 +4,7 @@ description: Learn the node requirements for each node running Rancher server wh --- - + This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md index 792a49a26a4..dda0f2301f4 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install.md @@ -3,7 +3,7 @@ title: Air-Gapped Helm CLI Install --- - + This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md index c5bd443da43..aaca1603ad0 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods.md @@ -3,7 +3,7 @@ title: Other Installation Methods --- - + ### Air Gapped Installations diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md index 9d4a4c8393e..c2a6ace6343 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md @@ -10,6 +10,8 @@ Now that you have a running RKE cluster, you can install Rancher in it. For secu ### Install the Helm CLI + + Install the [Helm](https://helm.sh/docs/intro/install/) CLI on a host where you have a kubeconfig to access your Kubernetes cluster: ``` diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md index 39b75558e22..e705d3b4a16 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy.md @@ -3,7 +3,7 @@ title: Installing Rancher behind an HTTP Proxy --- - + In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md index 049bf762a2a..526b43b682c 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md @@ -4,7 +4,7 @@ description: For development and testing environments only, use a Docker install --- - + Rancher can be installed by running a single Docker container. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/helm-version-requirements.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/helm-version-requirements.md index 8d98fe60458..6118e567f0c 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/helm-version-requirements.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/helm-version-requirements.md @@ -10,6 +10,8 @@ This section contains the requirements for Helm, which is the tool used to insta > The installation instructions have been updated for 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/) [This section](/versioned_docs/version-2.0-2.4/pages-for-subheaders/helm2.md) provides a copy of the older high-availability Rancher installation instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. + + - Helm v3.2.x or higher is required to install or upgrade Rancher v2.5. - Helm v2.16.0 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using. - Helm v2.15.0 should not be used, because of an issue with converting/comparing numbers. diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/resources.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/resources.md index 5d4fbf24fc1..b5c215c5755 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/resources.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/resources.md @@ -3,7 +3,7 @@ title: Resources --- - + ### Docker Installations diff --git a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md index dd00964ef02..3590d08ce55 100644 --- a/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md +++ b/versioned_docs/version-2.8/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md @@ -145,6 +145,8 @@ Before you can perform the upgrade, you must prepare your air gapped environment --set cainjector.image.repository=/quay.io/jetstack/cert-manager-cainjector ``` + + The Helm 2 command is as follows: ```plain diff --git a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md index a0500a27747..8da9e993a43 100644 --- a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md +++ b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md @@ -1,6 +1,6 @@ --- -title: Rancher AWS Marketplace Quick Start -description: Use Amazon EKS to deploy Rancher server. +title: Rancher Prime AWS Marketplace Quick Start +description: Deploy SUSE Rancher from the AWS Marketplace listing. --- @@ -9,6 +9,6 @@ description: Use Amazon EKS to deploy Rancher server. import YouTube from '@site/src/components/YouTube' -Amazon Elastic Kubernetes Service (EKS) can quickly [deploy Rancher to Amazon Web Services (AWS)](https://documentation.suse.com/trd/kubernetes/single-html/gs_rancher_aws-marketplace/). To learn more, see our [Amazon Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-go7ent7goo5ae). Watch the demo for a walkthrough of AWS Marketplace SUSE Rancher setup: +You can quickly deploy Rancher Prime on Amazon Elastic Kubernetes Service (EKS.) To learn more, see the [instructions](https://suse-enceladus.github.io/marketplace-docs/rancher-prime/aws/?repository=rancher-payg-billing-adapter-llc-prd) under Usage Information in the [AWS Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c). - +# diff --git a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md index 2c45cf300ed..af0c27aac71 100644 --- a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md +++ b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager.md @@ -3,7 +3,7 @@ title: Deploying Rancher Server --- - + Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. diff --git a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md index e6042decd34..3a7034c05df 100644 --- a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md +++ b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-workloads/deploy-workloads.md @@ -3,7 +3,7 @@ title: Deploying Workloads --- - + These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. diff --git a/versioned_docs/version-2.8/getting-started/quick-start-guides/quick-start-guides.md b/versioned_docs/version-2.8/getting-started/quick-start-guides/quick-start-guides.md index 955135a1d48..424fe7d8802 100644 --- a/versioned_docs/version-2.8/getting-started/quick-start-guides/quick-start-guides.md +++ b/versioned_docs/version-2.8/getting-started/quick-start-guides/quick-start-guides.md @@ -3,7 +3,7 @@ title: Rancher Deployment Quick Start Guides --- - + :::caution diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/advanced-user-guides.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/advanced-user-guides.md index b5b3d241037..68ffc4c7ed3 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/advanced-user-guides.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/advanced-user-guides.md @@ -3,7 +3,7 @@ title: Advanced User Guides --- - + Advanced user guides are "problem-oriented" docs in which users learn how to answer questions or solve problems. The major difference between these and the new user guides is that these guides are geared toward more experienced or advanced users who have more technical needs from their documentation. These users already have an understanding of Rancher and its functions. They know what they need to accomplish; they just need additional guidance to complete some more complex task they they have encountered while working. diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md index 790b7e1b6c1..a7c6ed43472 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md @@ -3,7 +3,7 @@ title: CIS Scan Guides --- - + - [Install rancher-cis-benchmark](install-rancher-cis-benchmark.md) diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md index 778f2b05451..c829938c3c0 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md @@ -3,7 +3,7 @@ title: Enabling Experimental Features --- - + Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an [unsupported storage type](unsupported-storage-drivers.md) outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default. diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md index 4682e638ed0..cbdeee0602b 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide.md @@ -3,7 +3,7 @@ title: Setup Guide --- - + This section describes how to enable Istio and start using it in your projects. diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md index ca734c02b26..a0ed1060085 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas.md @@ -3,7 +3,7 @@ title: Project 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/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md index 0b16e16d3bc..1554ad8121e 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/manage-projects/manage-projects.md @@ -3,7 +3,7 @@ title: Project Administration --- - + _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/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md index fe129e27bb4..ec292886fb3 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md @@ -46,7 +46,7 @@ To use your own dashboard: ### 2. Create a ConfigMap using the Grafana JSON model -Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. cattle-dashboards by default). +Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. `cattle-dashboards` by default). The ConfigMap should look like this: @@ -65,19 +65,26 @@ data: By default, Grafana is configured to watch all ConfigMaps with the `grafana_dashboard` label within the `cattle-dashboards` namespace. -To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section.](#configuring-namespaces-for-the-grafana-dashboard-configmap) +To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section](#configuring-namespaces-for-the-grafana-dashboard-configmap). -To create the ConfigMap in the Rancher UI, +To create the ConfigMap through the Rancher UI, first make sure that you are currently logged in to the Grafana UI, to ensure that dashboards import without encountering permissions issues. Then, return to the Rancher UI and perform the following steps: 1. In the upper left corner, click **☰ > Cluster Management**. 1. On the **Clusters** page, go to the cluster where you want to see the visualizations and click **Explore**. 1. Click **More Resources > Core > ConfigMaps**. 1. Click **Create**. -1. Set up the key-value pairs similar to the example above. When entering the value for `.json`, click **Read from File** to upload the JSON data model as the value. +1. On the **Data** tab, set up the key-value pairs similar to the example above. When entering the value for `.json`, click **Read from File** to upload the JSON data model as the value. +1. On the **Labels & Annotations** tab, click **Add Label** and enter `grafana_dashboard` as the key, and `1` as the value. 1. Click **Create**. **Result:** After the ConfigMap is created, it should show up on the Grafana UI and be persisted even if the Grafana pod is restarted. +:::note + +The actual key-value pair may differ if you have modified the Helm chart to watch a different dashboard label and value. + +::: + Dashboards that are persisted using ConfigMaps cannot be deleted or edited from the Grafana UI. If you attempt to delete the dashboard in the Grafana UI, you will see the error message "Dashboard cannot be deleted because it was provisioned." To delete the dashboard, you will need to delete the ConfigMap. diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md index 8d8d50df647..d5ac47c78f4 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides.md @@ -3,7 +3,7 @@ title: Monitoring/Alerting Guides --- - + - [Enable monitoring](enable-monitoring.md) diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md index 4651e682528..c266c30f1c6 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides.md @@ -3,7 +3,7 @@ title: Prometheus Federator Guides --- - + - [Enable Prometheus Operator](enable-prometheus-federator.md) diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md index 35de246d3de..16d99c82a75 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration.md @@ -3,7 +3,7 @@ title: Advanced Configuration --- - + ### Alertmanager diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md index 46e41afd605..9fa587aef2b 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides.md @@ -3,7 +3,7 @@ title: Configuration --- - + This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md index c4c78f06e08..959fba86e28 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md @@ -3,7 +3,7 @@ title: About Provisioning Drivers --- - + Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md) or [nodes in an infrastructure provider](../../launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md) to allow Rancher to deploy and manage Kubernetes. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md index eab13feb274..228ec4c0992 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates.md @@ -3,7 +3,7 @@ title: RKE Templates --- - + RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md index 8db0c73fb3c..d569a9d8849 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config.md @@ -4,7 +4,7 @@ weight: 10 --- - + One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows your users to use one set of credentials to authenticate with any of your Kubernetes clusters. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md index 074ca71248c..594a2848536 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration.md @@ -3,7 +3,7 @@ title: Authentication, Permissions and Global Settings --- - + After installation, the [system administrator](manage-role-based-access-control-rbac/global-permissions.md) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md index e10056cc0ae..4bdda220525 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml.md @@ -3,7 +3,7 @@ title: Configuring Microsoft Active Directory Federation Service (SAML) --- - + If your organization uses Microsoft Active Directory Federation Services (AD FS) for user authentication, you can configure Rancher to allow your users to log in using their AD FS credentials. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md index 9285e08ef8b..e7d4c5724a4 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md @@ -3,7 +3,7 @@ title: Configuring OpenLDAP --- - + If your organization uses LDAP for user authentication, you can configure Rancher to communicate with an OpenLDAP server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the organisation's central user repository, while allowing end-users to authenticate with their LDAP credentials when logging in to the Rancher UI. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md index 21d81b924b8..ad271675dc8 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md @@ -3,7 +3,7 @@ title: Configuring Shibboleth (SAML) --- - + If your organization uses Shibboleth Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in to Rancher using their Shibboleth credentials. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md index bccfdc59a4e..a516c10fe5b 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md @@ -64,6 +64,7 @@ The default roles, Administrator and Standard User, each come with multiple glob Administrators can enforce custom global permissions in multiple ways: +- [Creating custom global roles](#custom-globalroles). - [Changing the default permissions for new users](#configuring-default-global-permissions). - [Configuring global permissions for individual users](#configuring-global-permissions-for-individual-users). - [Configuring global permissions for groups](#configuring-global-permissions-for-groups). @@ -207,7 +208,6 @@ Using this field on [default GlobalRoles](#configuring-default-global-permission ::: - ### Configuring Default Global Permissions If you want to restrict the default permissions for new users, you can remove the `user` permission as default role and then assign multiple individual permissions as default instead. Conversely, you can also add administrative permissions on top of a set of other standard permissions. @@ -355,7 +355,6 @@ The following table lists the permissions and actions that a `restricted-admin` | | Deploy GKE cluster | Yes | Yes | Yes | | | | Deploy AKS cluster | Yes | Yes | Yes | | - ### Changing Global Administrators to Restricted Admins In previous version, the docs recommended that all users should be changed over to Restricted Admin if the role was in use. Users are now encouraged to use a custom-built role using the cluster permissions feature, and migrate any current restricted admins to use that approach. @@ -363,5 +362,3 @@ In previous version, the docs recommended that all users should be changed over This can be done through **Security > Users** and moving any Administrator role over to Restricted Administrator. Signed-in users can change themselves over to the `restricted-admin` if they wish, but they should only do that as the last step, otherwise they won't have the permissions to do so. - - diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md index 82038ecfc7e..d6a6d8d8f76 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md @@ -3,7 +3,7 @@ title: Managing Role-Based Access Control (RBAC) --- - + Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication](../authentication-config/authentication-config.md), users can either be local or external. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 83b725e468e..e6ebbf13c5b 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -4,7 +4,7 @@ keywords: [rancher backup restore, rancher backup and restore, backup restore ra --- - + In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster. @@ -91,10 +91,10 @@ A migration is performed by following [these steps.](migrate-rancher-to-new-clus ## Default Storage Location Configuration -Configure a storage location where all backups are saved by default. You will have the option to override this with each backup, but will be limited to using an S3-compatible or Minio object store. +Configure a default storage location for your backups. There are various configuration options, such as specifying an S3-compatible object store as the location for individual backups or choosing an existing `StorageClass` during installation of the `backup-restore-operator` Helm chart. You also have the option to override the configured storage location with each backup, but are limited to using an S3-compatible or Minio object store. For information on configuring these options, refer to [this page.](../../../reference-guides/backup-restore-configuration/storage-configuration.md) -### Example values.yaml for the rancher-backup Helm Chart +### Example YAML File: Rancher Backup Helm Chart -The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-valuesyaml-for-the-rancher-backup-helm-chart) can be used to configure the `rancher-backup` operator when the Helm CLI is used to install it. +The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-yaml-file-rancher-backup-helm-chart) can be used to configure the `backup-restore-operator` when the Helm CLI is used to install it. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 9e670da901d..89faf8d11bf 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -27,7 +27,8 @@ Since Rancher can be installed on any Kubernetes cluster, you can use this backu ### 1. Install the rancher-backup Helm chart -Install the [rancher-backup chart](https://github.com/rancher/backup-restore-operator/tags), using a version in the 2.x.x major version range: + +Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-operator/tags): 1. Add the Helm repository: @@ -36,13 +37,14 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope helm repo update ``` - 1. Select and set `CHART_VERSION` variable with a 2.x.x rancher-backup release version: + 1. Set a `CHART_VERSION` variable, selecting a `rancher-backup` chart version compatible with your version of Rancher. See the [support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions), within the **Rancher Apps / Cluster Tools** section, to see which `rancher-backup` versions are supported: + ```bash - helm search repo --versions rancher-charts/rancher-backup - CHART_VERSION=<2.x.x> + CHART_VERSION= ``` 1. Install the charts: + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION @@ -50,7 +52,7 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope :::note - The above assumes an environment with outbound connectivity to Docker Hub + The above assumes an environment with outbound connectivity to Docker Hub. For an **air-gapped environment**, use the Helm value below to pull the `backup-restore-operator` image from your private registry when installing the rancher-backup Helm chart. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md index 2d4bd5cdcb0..7c3d85b867f 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters.md @@ -3,7 +3,7 @@ title: Deploying Applications across Clusters --- - + Rancher offers several ways to deploy applications across clusters, depending on version. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index fa99b770228..e96f0cab855 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -3,7 +3,7 @@ title: Helm Charts in Rancher --- - + In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps**. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md index ccdca3126b8..7a79e5f5622 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup.md @@ -3,7 +3,7 @@ title: Don't have infrastructure for your Kubernetes cluster? Try one of these t --- - + To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](ha-k3s-kubernetes-cluster.md) diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md index 9291d55bee4..00c22ead1c3 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup.md @@ -3,7 +3,7 @@ title: "Don't have a Kubernetes cluster? Try one of these tutorials." --- - + This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md index d3609540e2a..14ae384e387 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters.md @@ -3,7 +3,7 @@ title: Checklist for Production-Ready Clusters --- - + In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md index f088c16e1c4..230a3d6212b 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md @@ -4,7 +4,7 @@ description: Provisioning Kubernetes Clusters --- - + Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md index 981c0533930..267d9b1c1ba 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md @@ -12,7 +12,7 @@ You can migrate from an in-tree to an out-of-tree AWS cloud provider on Kubernet To migrate from the in-tree cloud provider to the out-of-tree AWS cloud provider, you must stop the existing cluster's kube controller manager and install the AWS cloud controller manager. There are many ways to do this. Refer to the official AWS documentation on the [external cloud controller manager](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for details. -If it's acceptable to have some downtime, you can [switch to an external cloud provider](../set-up-cloud-providers/amazon.md#using-the-out-of-tree-aws-cloud-provider), which removes in-tree components and then deploy charts to install the AWS cloud controller manager. +If it's acceptable to have some downtime during migration, follow the instructions to [set up an external cloud provider](../set-up-cloud-providers/amazon.md#using-the-out-of-tree-aws-cloud-provider). These instructions outline how to configure the out-of-tree cloud provider for a newly provisioned cluster. During set up, there will be some downtime, as there is a time gap between when the old cloud provider stops running and when the new cloud provider starts to run. If your setup can't tolerate any control plane downtime, you must enable leader migration. This facilitates a smooth transition from the controllers in the kube controller manager to their counterparts in the cloud controller manager. Refer to the official AWS documentation on [Using leader migration](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for more details. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md index 11c5e5590e3..d6c9834b666 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers.md @@ -3,7 +3,7 @@ title: Setting up Cloud Providers --- - + A _cloud provider_ is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md index 070c16dc420..ea0cc4ff394 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md @@ -3,7 +3,7 @@ title: Setting up Clusters from Hosted Kubernetes Providers --- - + In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md index 91cee26d619..4c5f811c5e6 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on Windows Clusters --- - + When provisioning a [custom cluster](../../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md index e0f5e51e4b4..8d084cb00d7 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md @@ -4,7 +4,7 @@ description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs --- - + The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md index 132e0f2627d..7879660225d 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md @@ -3,7 +3,7 @@ title: Kubernetes Resources --- - + You can view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md index b3f3976e6e3..934a552f019 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller.md @@ -4,7 +4,7 @@ description: Learn how you can set up load balancers and ingress controllers to --- - + Within Rancher, you can set up load balancers and ingress controllers to redirect service requests. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md index c20787712ae..b9bd0fa0a47 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md @@ -4,7 +4,7 @@ description: "Learn about the two constructs with which you can build any comple --- - + You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md index e62d67c8323..7c7faea2e8d 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md @@ -3,7 +3,7 @@ title: Launching Kubernetes with Rancher --- - + You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, you can choose between [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) or [RKE2](https://docs.rke2.io) distributions. Rancher can launch Kubernetes on any computers, including: diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md index 9c761b50475..8d498ac35e6 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md @@ -4,7 +4,7 @@ description: Use Rancher to create a Nutanix AOS (AHV) cluster. It may consist o --- - + [Nutanix Acropolis Operating System](https://www.nutanix.com/products/acropolis) (Nutanix AOS) is an operating system for the Nutanix hyper-converged infrastructure platform. AOS comes with a built-in hypervisor called [Acropolis Hypervisor](https://www.nutanix.com/products/ahv), or AHV. By using Rancher with Nutanix AOS (AHV), you can bring cloud operations on-premises. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md index 88bac5263d0..6e7580f8e16 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on New Nodes in an Infrastructure Provider --- - + When you create an RKE or RKE2 cluster using a node template in Rancher, each resulting node pool is shown in a new **Machine Pools** tab. You can see the machine pools by doing the following: diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md index 9890f087ece..e1d63847e59 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere.md @@ -4,7 +4,7 @@ description: Use Rancher to create a vSphere cluster. It may consist of groups o --- - + import YouTube from '@site/src/components/YouTube' diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md index a4929ee26cf..ca181ffc07a 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters.md @@ -3,7 +3,7 @@ title: Cluster Access --- - + This section is about what tools can be used to access clusters managed by Rancher. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md index 58a71adce61..8b2d0db56c7 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage.md @@ -4,7 +4,7 @@ description: "Learn about the two ways with which you can create persistent stor --- - + 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/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md index 127153dd06b..01a5ca7d2d6 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler.md @@ -3,7 +3,7 @@ title: Cluster Autoscaler --- - + In this section, you'll learn how to install and use the [Kubernetes cluster-autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/) on Rancher custom clusters using AWS EC2 Auto Scaling Groups. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md index fc05cfd581b..eafa50faff9 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md @@ -3,7 +3,7 @@ title: Cluster Administration --- - + After you provision a cluster in Rancher, you can begin using powerful Kubernetes features to deploy and scale your containerized applications in development, testing, or production environments. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md index b1d89e54c05..d4b85fec0c2 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples.md @@ -3,7 +3,7 @@ title: Provisioning Storage Examples --- - + Rancher supports persistent storage with a variety of volume plugins. However, before you use any of these plugins to bind persistent storage to your workloads, you have to configure the storage itself, whether its a cloud-based solution from a service-provider or an on-prem solution that you manage yourself. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/new-user-guides.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/new-user-guides.md index e2e68ff0089..cc86980e4ad 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/new-user-guides.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/new-user-guides.md @@ -3,7 +3,7 @@ title: New User Guides --- - + New user guides, also known as **tutorials**, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing". diff --git a/versioned_docs/version-2.8/integrations-in-rancher/cis-scans/cis-scans.md b/versioned_docs/version-2.8/integrations-in-rancher/cis-scans/cis-scans.md index c6423844d0c..f170f997d66 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/cis-scans/cis-scans.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/cis-scans/cis-scans.md @@ -3,7 +3,7 @@ title: CIS Scans --- - + Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. The CIS scans can run on any Kubernetes cluster, including hosted Kubernetes providers such as EKS, AKS, and GKE. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md b/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md index 13b1398077e..cd143d64ef4 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace.md @@ -3,7 +3,7 @@ title: AWS Marketplace Integration --- - + ## Overview diff --git a/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md b/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md index 6f90a2c3ff4..ab6234b156d 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/cloud-marketplace/cloud-marketplace.md @@ -3,7 +3,7 @@ title: Cloud Marketplace Integration --- - + Rancher offers integration with cloud marketplaces to easily purchase support for installations hosted on certain cloud providers. In addition, this integration also provides the ability to generate a supportconfig bundle which can be provided to rancher support. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/elemental/elemental.md b/versioned_docs/version-2.8/integrations-in-rancher/elemental/elemental.md index 5e93a4b3538..a408aa19a55 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/elemental/elemental.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/elemental/elemental.md @@ -2,6 +2,10 @@ title: Operating System Management with Elemental --- + + + + Elemental enables cloud-native host management. Elemental allows you to onboard any machine in any location, whether its in a datacenter or on the edge, and integrate them seamlessly into Kubernetes while managing your workflows (e.g., OS updates). ## Elemental with Rancher diff --git a/versioned_docs/version-2.8/integrations-in-rancher/epinio/epinio.md b/versioned_docs/version-2.8/integrations-in-rancher/epinio/epinio.md deleted file mode 100644 index fe8e4197f90..00000000000 --- a/versioned_docs/version-2.8/integrations-in-rancher/epinio/epinio.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Application Development Engine with Epinio ---- - - - - - -Epinio is a Kubernetes-based Application Development Platform. It helps operators and developers collaborate without conflict, and accelerates the development process. With Epinio, teams can move from application sources to a live URL in a single step. - -## Epinio with Rancher - -Epinio's integration with Rancher gives developers a jump start, without having to deal with the installation process or configuration. You can install Epinio directly from the Rancher UI's Apps page. - -## Epinio with Rancher Prime - -Rancher Prime customers can expect better integration of Epinio with other areas in the Rancher ecosystem such as: - -- Better integration with Rancher authentication. -- Integration with Neuvector and Kubewarden. -- Custom Helm chart templates with preset annotations to seamlessly integrate with monitoring and other key tools. -- Improved service marketplace. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/fleet/architecture.md b/versioned_docs/version-2.8/integrations-in-rancher/fleet/architecture.md index f012a3a9921..dcdd07ce36f 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/fleet/architecture.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/fleet/architecture.md @@ -2,6 +2,10 @@ title: Architecture --- + + + + Fleet can manage deployments from git of raw Kubernetes YAML, Helm charts, or Kustomize or any combination of the three. Regardless of the source, all resources are dynamically turned into Helm charts, and Helm is used as the engine to deploy everything in the cluster. This gives you a high degree of control, consistency, and auditability. Fleet focuses not only on the ability to scale, but to give one a high degree of control and visibility to exactly what is installed on the cluster. ![Architecture](/img/fleet-architecture.svg) diff --git a/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md b/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md index 09bc89db026..d80158b17b1 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md @@ -2,6 +2,10 @@ title: Continuous Delivery with Fleet --- + + + + Fleet orchestrates and manages the continuous delivery of applications through the supply chain for fleets of clusters. Fleet organizes the supply chain to help teams deliver with confidence and trust in a timely manner using GitOps as a safe operating model. ## Fleet with Rancher diff --git a/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md b/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md index 2c21eaa0ae4..190f9b8906f 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md @@ -2,6 +2,10 @@ title: Overview --- + + + + Continuous Delivery with Fleet is GitOps at scale. Fleet is designed to manage up to a million clusters. It’s also lightweight enough that it works great for a [single cluster](https://fleet.rancher.io/installation#default-install) too, but it really shines when you get to a [large scale](https://fleet.rancher.io/installation#configuration-for-multi-cluster). By large scale we mean either a lot of clusters, a lot of deployments, or a lot of teams in a single organization. Fleet is a separate project from Rancher, and can be installed on any Kubernetes cluster with Helm. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md b/versioned_docs/version-2.8/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md index e6a3f8cf961..1570da5b448 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/fleet/use-fleet-behind-a-proxy.md @@ -2,6 +2,10 @@ title: Using Fleet Behind a Proxy --- + + + + In this section, you'll learn how to enable Fleet in a setup that has a Rancher server with a public IP a Kubernetes cluster that has no public IP, but is configured to use a proxy. Rancher does not establish connections with registered downstream clusters. The Rancher agent deployed on the downstream cluster must be able to establish the connection with Rancher. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/fleet/windows-support.md b/versioned_docs/version-2.8/integrations-in-rancher/fleet/windows-support.md index aea98b74dbc..15fd1ac2263 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/fleet/windows-support.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/fleet/windows-support.md @@ -2,6 +2,10 @@ title: Windows Support --- + + + + Prior to Rancher v2.5.6, the `agent` did not have native Windows manifests on downstream clusters with Windows nodes. This would result in a failing `agent` pod for the cluster. If you are upgrading from an older version of Rancher to v2.5.6+, you can deploy a working `agent` with the following workflow *in the downstream cluster*: diff --git a/versioned_docs/version-2.8/integrations-in-rancher/harvester/harvester.md b/versioned_docs/version-2.8/integrations-in-rancher/harvester/harvester.md index c54b817839b..f187fe086af 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/harvester/harvester.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/harvester/harvester.md @@ -2,6 +2,10 @@ title: Virtualization on Kubernetes with Harvester --- + + + + ## Harvester Introduced in Rancher v2.6.1, Harvester is an open-source hyper-converged infrastructure (HCI) software built on Kubernetes. Harvester installs on bare metal servers and provides integrated virtualization and distributed storage capabilities. Although Harvester operates using Kubernetes, it does not require knowledge of Kubernetes concepts, making it more user-friendly. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/harvester/overview.md b/versioned_docs/version-2.8/integrations-in-rancher/harvester/overview.md index 9f280c70782..cbf94de9cd3 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/harvester/overview.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/harvester/overview.md @@ -2,6 +2,10 @@ title: Overview --- + + + + Introduced in Rancher v2.6.1, [Harvester](https://docs.harvesterhci.io/) is an open-source hyper-converged infrastructure (HCI) software built on Kubernetes. Harvester installs on bare metal servers and provides integrated virtualization and distributed storage capabilities. Although Harvester operates using Kubernetes, it does not require users to know Kubernetes concepts, making it a more user-friendly application. ### Feature Flag diff --git a/versioned_docs/version-2.8/integrations-in-rancher/integrations-in-rancher.mdx b/versioned_docs/version-2.8/integrations-in-rancher/integrations-in-rancher.mdx index f8420b32752..5f75b398ab7 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/integrations-in-rancher.mdx +++ b/versioned_docs/version-2.8/integrations-in-rancher/integrations-in-rancher.mdx @@ -1,17 +1,13 @@ --- title: Integrations in Rancher --- + + + + + import {Card, CardSection} from '@site/src/components/CardComponents'; -import { - ReadingModeMobileRegular, - QuestionRegular, - ArrowUpRegular, - PlayRegular, - FlowchartRegular, - RocketRegular -} from '@fluentui/react-icons'; -import { FaAws, FaGoogle, FaCloud, FaServer, faGear } from "react-icons/fa6"; -import HarvesterIcon from '@site/static/img/harvester_logo_horizontal.svg'; +import {RocketRegular} from '@fluentui/react-icons'; Prime is the Rancher ecosystem’s enterprise offering, with additional security, extended lifecycles, and access to Prime-exclusive documentation. Rancher Prime installation assets are hosted on a trusted SUSE registry, owned and managed by Rancher. The trusted Prime registry includes only stable releases that have been community-tested. @@ -47,10 +43,6 @@ To learn more and get started with Rancher Prime, please visit [this page](https title="Operating System Management with Elemental" to="./integrations-in-rancher/elemental" /> - - diff --git a/versioned_docs/version-2.8/integrations-in-rancher/istio/configuration-options/configuration-options.md b/versioned_docs/version-2.8/integrations-in-rancher/istio/configuration-options/configuration-options.md index 35546a12f03..5f553689ab0 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/istio/configuration-options/configuration-options.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/istio/configuration-options/configuration-options.md @@ -3,7 +3,7 @@ title: Configuration Options --- - + ### Egress Support diff --git a/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md index c622d0d2180..0f865ef5363 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md @@ -3,7 +3,7 @@ title: Istio --- - + [Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md b/versioned_docs/version-2.8/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md index 689dd6423ed..c36a1519f76 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md @@ -2,6 +2,10 @@ title: Kubernetes Distributions --- + + + + ## K3s K3s is a lightweight, fully compliant Kubernetes distribution designed for a range of use cases, including edge computing, IoT, CI/CD, development and embedding Kubernetes into applications. It simplifies Kubernetes management by packaging the system as a single binary, using sqlite3 as the default storage, and offering a user-friendly launcher. K3s includes essential features like local storage and load balancing, Helm chart controller and the Traefik CNI. It minimizes external dependencies and provides a streamlined Kubernetes experience. K3s was donated to the CNCF as a Sandbox Project in June 2020. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md b/versioned_docs/version-2.8/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md index eb1020ac1a2..b1099777da3 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration.md @@ -3,7 +3,7 @@ title: Custom Resource Configuration --- - + The following Custom Resource Definitions are used to configure logging: diff --git a/versioned_docs/version-2.8/integrations-in-rancher/logging/logging.md b/versioned_docs/version-2.8/integrations-in-rancher/logging/logging.md index a79c896ec6e..2813d8fa681 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/logging/logging.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/logging/logging.md @@ -4,7 +4,7 @@ description: Rancher integrates with popular logging services. Learn the require --- - + The [Logging operator](https://kube-logging.github.io/docs/) now powers Rancher's logging solution in place of the former, in-house solution. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md b/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md index 48b4114d458..06bd0ac2297 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md @@ -4,7 +4,7 @@ description: Prometheus lets you view metrics from your different Rancher and Ku --- - + The `rancher-monitoring` application can quickly deploy leading open-source monitoring and alerting solutions onto your cluster. @@ -55,7 +55,13 @@ For a list of monitoring components exposed in the Rancher UI, along with common ## Role-based Access Control -For information on configuring access to monitoring, see [this page.](rbac-for-monitoring.md) +For more information on configuring access to monitoring, see [this page.](rbac-for-monitoring.md) + +:::note + +Rancher and Project read permissions don't necessarily apply to monitoring resources. See [monitoring-ui-view](rbac-for-monitoring.md#additional-monitoring-clusterroles) for more details. + +::: ## Guides diff --git a/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md b/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md index a1711b57170..583611b99c0 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md @@ -112,7 +112,7 @@ Monitoring also creates additional `ClusterRoles` that aren't assigned to users | Role | Purpose | | ------------------------------| ---------------------------| -| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users with write access to the project to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting Read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Grafana, and Alertmanager UIs through the Rancher proxy. | +| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users with write access to the project to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting Read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Alertmanager, and Grafana UIs through the Rancher proxy.

This role doesn't grant access to monitoring endpoints. As a result, users with this role won't be able to view cluster monitoring graphs and dashboards in the Rancher UI; however, they are able to access the monitoring Grafana, Prometheus, and Alertmanager UIs if provided those links. | :::note @@ -216,7 +216,11 @@ In addition to these default roles, the following Rancher project roles can be a |--------------------------|-------------------------------|-------|------| | View Monitoring* | [monitoring-ui-view](#additional-monitoring-clusterroles) | 2.4.8+ | 9.4.204+ | -\* A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project. +:::note + +A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project. + +::: ### Differences in 2.5.x diff --git a/versioned_docs/version-2.8/integrations-in-rancher/opa-gatekeeper.md b/versioned_docs/version-2.8/integrations-in-rancher/opa-gatekeeper.md index f2185dff685..cea9732b36c 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/opa-gatekeeper.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/opa-gatekeeper.md @@ -6,6 +6,8 @@ title: OPA Gatekeeper + + To ensure consistency and compliance, every organization needs the ability to define and enforce policies in its environment in an automated way. [OPA (Open Policy Agent)](https://www.openpolicyagent.org/) is a policy engine that facilitates policy-based control for cloud native environments. Rancher provides the ability to enable OPA Gatekeeper in Kubernetes clusters, and also installs a couple of built-in policy definitions, which are also called constraint templates. OPA provides a high-level declarative language that lets you specify policy as code and ability to extend simple APIs to offload policy decision-making. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/opni/opni.md b/versioned_docs/version-2.8/integrations-in-rancher/opni/opni.md deleted file mode 100644 index 96ec3eb7336..00000000000 --- a/versioned_docs/version-2.8/integrations-in-rancher/opni/opni.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Observability with Opni ---- - - - - - -Opni is a multi-cluster and multi-tenant observability platform. Purpose-built on Kubernetes, Opni simplifies the process of creating and managing backends, agents, and data related to logging, monitoring, and tracing. With built-in AIOps, Opni allows users to swiftly detect anomalous activities in their data. - -Opni components work together to provide a comprehensive observability platform. Key components include: - -- Observability Backends: Opni Logging enhances Opensearch for easy searching, visualization, and analysis of logs, traces and Kubernetes events. Opni Monitoring extends Cortex for multi-cluster, long-term storage of Prometheus metrics. -- Observability Agents: Agents are software that collects observability data (logs, metrics, traces, and events) from their host and sends it to an observability backend. The Opni agent enables collection of logs, Kubernetes events, OpenTelemetry traces, and Prometheus metrics. -- AIOps: Applies AL and machine learning to IT and observability data. Open AIOps features include log anomaly detection using pretrained models for Kubernetes control plane, Rancher and Longhorn. -- Alerting and SLOs: Triggers and reliability targets for services enables utilizing Opni data to effectively make informed decisions regarding software operations. - -## Opni with Rancher - -Opni’s Helm charts are currently maintained in a charts-specific branch of the Opni GitHub project. Once this branch is added as a repository in Rancher, the Opni installation can be performed through the Rancher UI. Efforts are underway now to streamline this process by including these charts directly within Rancher itself, and offering Opni as a fully integrated Rancher App. - -Opni’s log anomaly detection process includes purpose-built, pre-trained models for RKE2, K3s, Longhorn and Rancher agent logs. This advanced modeling ensures first class support for log anomaly detection for the core suite of Rancher products. - diff --git a/versioned_docs/version-2.8/reference-guides/about-the-api/about-the-api.md b/versioned_docs/version-2.8/reference-guides/about-the-api/about-the-api.md index c8364cdc7d8..40068f7cfe5 100644 --- a/versioned_docs/version-2.8/reference-guides/about-the-api/about-the-api.md +++ b/versioned_docs/version-2.8/reference-guides/about-the-api/about-the-api.md @@ -3,7 +3,7 @@ title: API --- - + ## How to use the API diff --git a/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/backup-restore-configuration.md b/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/backup-restore-configuration.md index 1f74b2fad9b..ad817581489 100644 --- a/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/backup-restore-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/backup-restore-configuration.md @@ -3,7 +3,7 @@ title: Rancher Backup Configuration Reference --- - + - [Backup configuration](backup-configuration.md) diff --git a/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/storage-configuration.md b/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/storage-configuration.md index a901bde4190..64d9a810a44 100644 --- a/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/storage-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/storage-configuration.md @@ -52,9 +52,8 @@ It is highly recommended to use a Persistent Volume with a reclaim policy of "Re ::: -## Example values.yaml for the rancher-backup Helm Chart +## Example YAML File: Rancher Backup Helm Chart -The documented `values.yaml` file that can be used to configure `rancher-backup` operator when the Helm CLI is used can be found in the [backup-restore-operator repository.](https://github.com/rancher/backup-restore-operator/blob/master/charts/rancher-backup/values.yaml) +The documented `values.yaml` file that can be used to configure the `backup-restore-operator` when the Helm CLI is used can be found in the [backup-restore-operator repository.](https://github.com/rancher/backup-restore-operator/blob/master/charts/rancher-backup/values.yaml) For more information about `values.yaml` files and configuring Helm charts during installation, refer to the [Helm documentation.](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing) - diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/best-practices.md b/versioned_docs/version-2.8/reference-guides/best-practices/best-practices.md index 546ae01be94..d2520a3e785 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/best-practices.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/best-practices.md @@ -3,7 +3,7 @@ title: Best Practices Guide --- - + The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers. diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md index 72c44ac9a78..ea4697f8e76 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters.md @@ -3,7 +3,7 @@ title: Best Practices for Rancher Managed Clusters --- - + ### Logging diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md index a79561ced2c..8e24e145482 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md @@ -3,7 +3,7 @@ title: Best Practices for the Rancher Server --- - + This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 896a4978b12..50687cdd32c 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -21,6 +21,26 @@ This guide describes the best practices and tuning approaches to scale Rancher s When scaling up Rancher, one typical bottleneck is resource growth in the upstream (local) Kubernetes cluster. The upstream cluster contains information for all downstream clusters. Many operations that apply to downstream clusters create new objects in the upstream cluster and require computation from handlers running in the upstream cluster. +### Minimizing Third-Party Software on the Upstream Cluster + +Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. + +Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. + +Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + +On the other hand, the following software are found to interfere with Rancher performance at scale: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + ### Managing Your Object Counts Etcd is the backing database for Kubernetes and for Rancher. The database may eventually encounter limitations to the number of a single Kubernetes resource type it can store. Exact limits vary and depend on a number of factors. However, experience indicates that performance issues frequently arise once a single resource type's object count exceeds 60,000. Often that type is `RoleBinding`. diff --git a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/cli-with-rancher.md b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/cli-with-rancher.md index a0e50c51b71..a18cabf5abb 100644 --- a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/cli-with-rancher.md +++ b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/cli-with-rancher.md @@ -3,7 +3,7 @@ title: CLI with Rancher --- - + Interact with Rancher using command line interface (CLI) tools from your workstation. The following docs will describe the [Rancher CLI](rancher-cli.md) and [kubectl Utility](kubectl-utility.md). \ No newline at end of file diff --git a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md index 03860d29c94..e93d9805480 100644 --- a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,18 +68,24 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| `machines, [machine]` | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| `up` | Applies compose config. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | - ### Rancher CLI Help Once logged into Rancher Server using the CLI, enter `./rancher --help` for a list of commands. diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/cluster-configuration.md index 7b15f647a03..fb16d619292 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/cluster-configuration.md @@ -3,7 +3,7 @@ title: Cluster Configuration --- - + After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md index 897728cd346..e0c92a52f0f 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md @@ -3,7 +3,7 @@ title: Downstream Cluster Configuration --- - + The following docs will discuss [node template configuration](node-template-configuration/node-template-configuration.md) and [machine configuration](machine-configuration/machine-configuration.md). \ No newline at end of file diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md index b28ccd669dd..cff1dada268 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration.md @@ -3,7 +3,7 @@ title: Machine Configuration --- - + Machine configuration is the arrangement of resources assigned to a virtual machine. Please see the docs for [Amazon EC2](amazon-ec2.md), [DigitalOcean](digitalocean.md), and [Azure](azure.md) to learn more. \ No newline at end of file diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md index bbe4d6127c3..e0f9ba4105d 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration.md @@ -3,7 +3,7 @@ title: Node Template Configuration --- - + To learn about node template config, refer to [EC2 Node Template Configuration](amazon-ec2.md), [DigitalOcean Node Template Configuration](digitalocean.md), [Azure Node Template Configuration](azure.md), [vSphere Node Template Configuration](vsphere.md), and [Nutanix Node Template Configuration](nutanix.md). diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index ba6b826b4f1..a67d997b6c1 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -101,6 +101,12 @@ Also, if you provide the launch template, you can only update the template versi | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | | Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | +:::caution + +You can't directly update a node group to a newer Kubernetes version if the node group was created from a custom launch template. You must create a new launch template with the proper Kubernetes version, and associate the node group with the new template. + +::: + #### Rancher-managed Launch Templates If you do not specify a launch template, then you will be able to configure the above options in the Rancher UI and all of them can be updated after creation. In order to take advantage of all of these options, Rancher will create and manage a launch template for you. Each cluster in Rancher will have one Rancher-managed launch template and each managed node group that does not have a specified launch template will have one version of the managed launch template. The name of this launch template will have the prefix "rancher-managed-lt-" followed by the display name of the cluster. In addition, the Rancher-managed launch template will be tagged with the key "rancher-managed-template" and value "do-not-modify-or-delete" to help identify it as Rancher-managed. It is important that this launch template and its versions not be modified, deleted, or used with any other clusters or managed node groups. Doing so could result in your node groups being "degraded" and needing to be destroyed and recreated. diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md index 8b63d9b8490..ad39397675d 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration.md @@ -3,7 +3,7 @@ title: GKE Cluster Configuration Reference --- - + ## Changes in Rancher v2.6 diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md index e4da90d371a..0e2aa590833 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration.md @@ -3,7 +3,7 @@ title: Rancher Server Configuration --- - + - [RKE1 Cluster Configuration](rke1-cluster-configuration.md) diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md index d6386aa119e..ed1c7cdbe94 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md @@ -4,7 +4,7 @@ description: To create a cluster with custom nodes, you’ll need to access serv --- - + When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. diff --git a/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md b/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md index 62bade46a2a..7fea6f9a7d9 100644 --- a/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/monitoring-v2-configuration.md @@ -3,7 +3,7 @@ title: Monitoring V2 Configuration --- - + The following sections will explain important options essential to configuring Monitoring V2 in Rancher: diff --git a/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/receivers.md b/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/receivers.md index dc459f34378..79d9749dc18 100644 --- a/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/receivers.md +++ b/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/receivers.md @@ -24,8 +24,6 @@ This section assumes familiarity with how monitoring components work together. F ::: -To create notification receivers in the Rancher UI, - @@ -152,24 +150,20 @@ The Teams receiver is not a native receiver and must be enabled before it can be 1. Select the **Teams** option and click **Install**. 1. Take note of the namespace used as it will be required in a later step. -### Configure the Teams Receiver +### Configuring the Teams Receiver -The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration. +1. To configure the Teams receiver, update its ConfigMap. The following example is a minimal Teams receiver configuration: -```yaml -[Microsoft Teams] -teams-instance-1: https://your-teams-webhook-url -``` + ```yaml + [Microsoft Teams] + connector: https://your-teams-webhook-url + ``` -When configuration is complete, add the receiver using the steps in [this section](#creating-receivers-in-the-rancher-ui). +2. After you update the configuration, follow the instructions in [Creating Receivers in the Rancher UI](#creating-receivers-in-the-rancher-ui) to add the receiver. Use the example below to form your URL. Make sure to replace `` with the namespace of the `rancher-alerting-drivers` app: -Use the example below as the URL where: - -- `ns-1` is replaced with the namespace where the `rancher-alerting-drivers` app is installed - -```yaml -url: http://rancher-alerting-drivers-prom2teams.ns-1.svc:8089/v2/teams-instance-1 -``` + ```yaml + url: http://rancher-alerting-drivers-prom2teams..svc:8089/v2/connector + ``` @@ -187,7 +181,7 @@ The SMS receiver is not a native receiver and must be enabled before it can be u 1. Select the **SMS** option and click **Install**. 1. Take note of the namespace used as it will be required in a later step. -### Configure the SMS Receiver +### Configuring the SMS Receiver The SMS receiver can be configured by updating its ConfigMap. For example, the following is a minimal SMS receiver configuration. diff --git a/versioned_docs/version-2.8/reference-guides/prometheus-federator/prometheus-federator.md b/versioned_docs/version-2.8/reference-guides/prometheus-federator/prometheus-federator.md index 4b1e8a21143..5166ab8732f 100644 --- a/versioned_docs/version-2.8/reference-guides/prometheus-federator/prometheus-federator.md +++ b/versioned_docs/version-2.8/reference-guides/prometheus-federator/prometheus-federator.md @@ -3,7 +3,7 @@ title: Prometheus Federator --- - + Prometheus Federator, also referred to as Project Monitoring v2, deploys a Helm Project Operator (based on the [rancher/helm-project-operator](https://github.com/rancher/helm-project-operator)), an operator that manages deploying Helm charts each containing a Project Monitoring Stack, where each stack contains: diff --git a/versioned_docs/version-2.8/reference-guides/rancher-cluster-tools.md b/versioned_docs/version-2.8/reference-guides/rancher-cluster-tools.md index ca037f533de..5221e0f150e 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-cluster-tools.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-cluster-tools.md @@ -41,8 +41,11 @@ For more information, refer to the monitoring documentation [here.](../integrati Rancher's integration with Istio was improved in Rancher v2.5. For more information, refer to the Istio documentation [here.](../integrations-in-rancher/istio/istio.md) + ## OPA Gatekeeper + + [OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper) is an open-source project that provides integration between OPA and Kubernetes to provide policy control via admission controller webhooks. For details on how to enable Gatekeeper in Rancher, refer to the [OPA Gatekeeper section.](../integrations-in-rancher/opa-gatekeeper.md) ## CIS Scans diff --git a/versioned_docs/version-2.8/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md b/versioned_docs/version-2.8/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md index 97ef05d0b6b..0e01bd3d293 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-manager-architecture/rancher-manager-architecture.md @@ -3,7 +3,7 @@ title: Architecture --- - + This section focuses on the [Rancher server and its components](rancher-server-and-components.md) and how [Rancher communicates with downstream Kubernetes clusters](communicating-with-downstream-user-clusters.md). diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/hardening-guides.md b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/hardening-guides.md index 1ab615e083e..14366baeee7 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/hardening-guides.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/hardening-guides.md @@ -3,7 +3,7 @@ title: Self-Assessment and Hardening Guides for Rancher --- - + Rancher provides specific security hardening guides for each supported Rancher version's Kubernetes distributions. diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md index 285577fbca5..88f00624b20 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-hardening-guide.md @@ -3,7 +3,7 @@ title: K3s Hardening Guide --- - + This document provides prescriptive guidance for how to harden a K3s cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md index fa442feb275..cc91f95c044 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-hardening-guide.md @@ -3,7 +3,7 @@ title: RKE Hardening Guide --- - + This document provides prescriptive guidance for how to harden an RKE cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md index 0cce6028916..a69c97665bb 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-hardening-guide.md @@ -3,7 +3,7 @@ title: RKE2 Hardening Guide --- - + This document provides prescriptive guidance for how to harden an RKE2 cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls. diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-security.md b/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-security.md index dff8475c3ce..02d9b400b21 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-security.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-security.md @@ -3,7 +3,7 @@ title: Security --- - +
diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-webhook-hardening.md b/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-webhook-hardening.md index 0362deecc5c..ed331807d11 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-webhook-hardening.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/rancher-webhook-hardening.md @@ -2,6 +2,10 @@ title: Hardening the Rancher Webhook --- + + + + Rancher Webhook is an important component within Rancher, playing a role in enforcing security requirements for Rancher and its workloads. To decrease its attack surface, access to it should be limited to the only valid caller it has: the Kubernetes API server. This can be done by using network policies and authentication independently or in conjunction with each other to harden the webhook against attacks. ## Block External Traffic Using Network Policies diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/security-advisories-and-cves.md b/versioned_docs/version-2.8/reference-guides/rancher-security/security-advisories-and-cves.md index ad7fb02ad7b..a142092fa2d 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/security-advisories-and-cves.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/security-advisories-and-cves.md @@ -10,6 +10,10 @@ Rancher is committed to informing the community of security issues in our produc | ID | Description | Date | Resolution | |----|-------------|------|------------| +| [CVE-2023-32193](https://github.com/rancher/norman/security/advisories/GHSA-r8f4-hv23-6qp6) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Norman). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32192](https://github.com/rancher/apiserver/security/advisories/GHSA-833m-37f7-jq55) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI (Apiserver). | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-22649](https://github.com/rancher/rancher/security/advisories/GHSA-xfj7-qf8w-2gcr) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, in which sensitive data may be leaked into Rancher's audit logs. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | +| [CVE-2023-32194](https://github.com/rancher/rancher/security/advisories/GHSA-c85r-fwc7-45vc) | An issue was discovered in Rancher versions up to and including 2.6.13, 2.7.9 and 2.8.1, where granting a `create` or `*` global role for a resource type of "namespaces"; no matter the API group, the subject will receive `*` permissions for core namespaces. | 8 Feb 2024 | Rancher [v2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2), [v2.7.10](https://github.com/rancher/rancher/releases/tag/v2.7.10) and [v2.6.14](https://github.com/rancher/rancher/releases/tag/v2.6.14) | | [CVE-2023-22648](https://github.com/rancher/rancher/security/advisories/GHSA-vf6j-6739-78m8) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which permission changes in Azure AD are not reflected to users until they logout and log back into the Rancher UI. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | | [CVE-2022-43760](https://github.com/rancher/rancher/security/advisories/GHSA-46v3-ggjg-qq3x) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, where multiple Cross-Site Scripting (XSS) vulnerabilities can be exploited via the Rancher UI. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | | [CVE-2020-10676](https://github.com/rancher/rancher/security/advisories/GHSA-8vhc-hwhc-cpj4) | An issue was discovered in Rancher versions up to and including 2.6.12 and 2.7.3, in which users with update privileges on a namespace, can move that namespace into a project they don't have access to. | 31 May 2023 | Rancher [v2.7.4](https://github.com/rancher/rancher/releases/tag/v2.7.4) | diff --git a/versioned_docs/version-2.8/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md b/versioned_docs/version-2.8/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md index f2d93d01bb1..75df1de0d00 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-security/selinux-rpm/selinux-rpm.md @@ -3,7 +3,7 @@ title: SELinux RPM --- - + [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. diff --git a/versioned_docs/version-2.8/reference-guides/rancher-webhook.md b/versioned_docs/version-2.8/reference-guides/rancher-webhook.md index 046b638ba41..f998b2f2ed7 100644 --- a/versioned_docs/version-2.8/reference-guides/rancher-webhook.md +++ b/versioned_docs/version-2.8/reference-guides/rancher-webhook.md @@ -9,7 +9,8 @@ title: Rancher Webhook Rancher-Webhook is an essential component of Rancher that works in conjunction with Kubernetes to enhance security and enable critical features for Rancher-managed clusters. It integrates with Kubernetes' extensible admission controllers, as described in the [Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/), which allows Rancher-Webhook to inspect specific requests sent to the Kubernetes API server, and add custom, Rancher-specific validation and mutations to the requests that are specific to Rancher. Rancher-Webhook manages the resources to be validated using the `rancher.cattle.io` `ValidatingWebhookConfiguration` and the `rancher.cattle.io` `MutatingWebhookConfiguration`, and will override any manual edits. -Rancher deploys Rancher-Webhook as a separate deployment and service in both local and downstream clusters. Rancher manages Rancher-Webhook using Helm. It's important to note that Rancher may override modifications made by users to the Helm release. + +Rancher deploys Rancher-Webhook as a separate deployment and service in both local and downstream clusters. Rancher manages Rancher-Webhook using Helm. It's important to note that Rancher may override modifications made by users to the Helm release. To safely modify these values see [Customizing Rancher-Webhook Configuration](#customizing-rancher-webhook-configuration). Each Rancher version is designed to be compatible with a single version of the webhook. The compatible versions are provided below for convenience. @@ -17,10 +18,11 @@ Each Rancher version is designed to be compatible with a single version of the w -| Rancher Version | Webhook Version | -|-----------------|:---------------:| -| v2.8.0 | v0.4.2 | -| v2.8.1 | v0.4.2 | +| Rancher Version | Webhook Version | Availability in Prime | Availability in Community | +|-----------------|-----------------|-----------------------|---------------------------| +| v2.8.2 | v0.4.2 | ✓ | ✓ | +| v2.8.1 | v0.4.2 | ✓ | ✓ | +| v2.8.0 | v0.4.2 | ✗ | ✓ | ## Why Do We Need It? @@ -48,6 +50,39 @@ To bypass the webhook, impersonate both the `rancher-webhook-sudo` service accou kubectl create -f example.yaml --as=system:serviceaccount:cattle-system:rancher-webhook-sudo --as-group=system:masters ``` +## Customizing Rancher-Webhook Configuration + +You can add custom Helm values when you install Rancher-Webhook via Helm. During a Helm install of the Rancher-Webhook chart, Rancher checks for custom Helm values. These custom values must be defined in a ConfigMap named `rancher-config`, in the `cattle-system` namespace, under the data key, `rancher-webhook`. The value of this key must be valid YAML. + +``` yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: rancher-config + namespace: cattle-system + labels: + app.kubernetes.io/part-of: "rancher" +data: + rancher-webhook: '{"port": 9553, "priorityClassName": "system-node-critical"}' + +``` + +Rancher redeploys the Rancher-Webhook chart when changes to the ConfigMap values are detected. + +### Customizing Rancher-Webhook During Rancher Installation + +When you use Helm to install the Rancher chart, you can add custom Helm values to the Rancher-Webhook of the local cluster. All values in the Rancher-Webhook chart are accessible as nested variables under the `webhook` name. + +These values are synced to the `rancher-config` ConfigMap during installation. + +```bash +helm install rancher rancher-/rancher \ + --namespace cattle-system \ + ... + --set webhook.port=9553 \ + --set webhook.priorityClassName="system-node-critical" +``` + ## Common Issues ### EKS Cluster with Calico CNI diff --git a/versioned_docs/version-2.8/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md b/versioned_docs/version-2.8/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md index e605bd0c77a..bc0f02856a7 100644 --- a/versioned_docs/version-2.8/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md +++ b/versioned_docs/version-2.8/reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker.md @@ -3,7 +3,7 @@ title: Single Node Rancher in Docker --- - + The following docs will discuss [HTTP proxy configuration](http-proxy-configuration.md) and [advanced options](advanced-options.md) for Docker installs. \ No newline at end of file diff --git a/versioned_docs/version-2.8/reference-guides/user-settings/user-settings.md b/versioned_docs/version-2.8/reference-guides/user-settings/user-settings.md index 496fde5638c..5a618c1024d 100644 --- a/versioned_docs/version-2.8/reference-guides/user-settings/user-settings.md +++ b/versioned_docs/version-2.8/reference-guides/user-settings/user-settings.md @@ -3,7 +3,7 @@ title: User Settings --- - + Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. diff --git a/versioned_docs/version-2.8/security/security-scan/security-scan.md b/versioned_docs/version-2.8/security/security-scan/security-scan.md index cacabb6266d..8c58771c736 100644 --- a/versioned_docs/version-2.8/security/security-scan/security-scan.md +++ b/versioned_docs/version-2.8/security/security-scan/security-scan.md @@ -3,7 +3,7 @@ title: Security Scans --- - + https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides The documentation about CIS security scans has moved [here.](../../how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides.md) diff --git a/versioned_docs/version-2.8/shared-files/_common-ports-table.md b/versioned_docs/version-2.8/shared-files/_common-ports-table.md index 1835beba031..4016670ef3d 100644 --- a/versioned_docs/version-2.8/shared-files/_common-ports-table.md +++ b/versioned_docs/version-2.8/shared-files/_common-ports-table.md @@ -1,19 +1,18 @@ -| Protocol | Port | Description | -|:--------: |:----------------: |---------------------------------------------------------------------------------- | -| TCP | 22 | Node driver SSH provisioning | -| TCP | 179 | Calico BGP Port | -| TCP | 2376 | Node driver Docker daemon TLS port | -| TCP | 2379 | etcd client requests | -| TCP | 2380 | etcd peer communication | -| UDP | 8472 | Canal/Flannel VXLAN overlay networking | -| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | -| TCP | 8443 | Rancher webhook | -| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | -| TCP | 9100 | Default port required by Monitoring to scrape metrics from Linux node-exporters | -| TCP | 9443 | Rancher webhook | -| TCP | 9796 | Default port required by Monitoring to scrape metrics from Windows node-exporters | -| TCP | 6783 | Weave Port | -| UDP | 6783-6784 | Weave UDP Ports | -| TCP | 10250 | Metrics server communication with all nodes API | -| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | -| TCP/UDP | 30000-32767 | NodePort port range | +| Protocol | Port | Description | +|:--------: |:----------------: |---------------------------------------------------------------------------------------------| +| TCP | 22 | Node driver SSH provisioning | +| TCP | 179 | Calico BGP Port | +| TCP | 2376 | Node driver Docker daemon TLS port | +| TCP | 2379 | etcd client requests | +| TCP | 2380 | etcd peer communication | +| UDP | 8472 | Canal/Flannel VXLAN overlay networking | +| UDP | 4789 | Flannel VXLAN overlay networking on Windows cluster | +| TCP | 8443 | Rancher webhook | +| TCP | 9099 | Canal/Flannel livenessProbe/readinessProbe | +| TCP | 9443 | Rancher webhook | +| TCP | 9796 | Default port required by Monitoring to scrape metrics from Linux and Windows node-exporters | +| TCP | 6783 | Weave Port | +| UDP | 6783-6784 | Weave UDP Ports | +| TCP | 10250 | Metrics server communication with all nodes API | +| TCP | 10254 | Ingress controller livenessProbe/readinessProbe | +| TCP/UDP | 30000-32767 | NodePort port range | diff --git a/versioned_docs/version-2.8/troubleshooting/kubernetes-components/kubernetes-components.md b/versioned_docs/version-2.8/troubleshooting/kubernetes-components/kubernetes-components.md index 53863435277..b7995b5921c 100644 --- a/versioned_docs/version-2.8/troubleshooting/kubernetes-components/kubernetes-components.md +++ b/versioned_docs/version-2.8/troubleshooting/kubernetes-components/kubernetes-components.md @@ -3,7 +3,7 @@ title: Kubernetes Components --- - + The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) clusters. diff --git a/versioned_sidebars/version-2.7-sidebars.json b/versioned_sidebars/version-2.7-sidebars.json index 8fcf8c78100..f2463302321 100644 --- a/versioned_sidebars/version-2.7-sidebars.json +++ b/versioned_sidebars/version-2.7-sidebars.json @@ -1121,7 +1121,7 @@ "label": "AWS Marketplace Pay-as-you-go (PAYG)", "link": { "type": "doc", - "id": "pages-for-subheaders/aws-marketplace-payg-integration" + "id": "integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/aws-marketplace-payg-integration" }, "items": [ "integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites", @@ -1137,7 +1137,7 @@ "label": "Azure Marketplace Pay-as-you-go (PAYG)", "link": { "type": "doc", - "id": "pages-for-subheaders/azure-marketplace-payg-integration" + "id": "integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/azure-marketplace-payg-integration" }, "items": [ "integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/prerequisites", diff --git a/versioned_sidebars/version-2.8-sidebars.json b/versioned_sidebars/version-2.8-sidebars.json index 72f24e2636b..c1823a88108 100644 --- a/versioned_sidebars/version-2.8-sidebars.json +++ b/versioned_sidebars/version-2.8-sidebars.json @@ -1135,7 +1135,6 @@ }, "integrations-in-rancher/kubewarden/kubewarden", "integrations-in-rancher/elemental/elemental", - "integrations-in-rancher/opni/opni", { "type": "category", "label": "Continuous Delivery with Fleet", @@ -1151,7 +1150,6 @@ ] }, "integrations-in-rancher/rancher-desktop", - "integrations-in-rancher/epinio/epinio", { "type": "category", "label": "Cloud Marketplace Integration",