Files
rancher-docs/assets/js/833be8f7.efc2624e.js

11 lines
259 KiB
JavaScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"use strict";
(self["webpackChunkrancher_docs"] = self["webpackChunkrancher_docs"] || []).push([[69966],{
/***/ 24151:
/***/ ((module) => {
module.exports = JSON.parse('{"pluginId":"default","version":"2.5","label":"v2.5","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-2.5","isLast":false,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Rancher 2.5","href":"/v2.5/","docId":"rancher-manager"},{"type":"category","label":"Getting Started","items":[{"type":"category","label":"Introduction","items":[{"type":"link","label":"Overview","href":"/v2.5/getting-started/introduction/overview","docId":"getting-started/introduction/overview"},{"type":"link","label":"What Are Divio Docs?","href":"/v2.5/getting-started/introduction/what-are-divio-docs","docId":"getting-started/introduction/what-are-divio-docs"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/introduction/"},{"type":"category","label":"Quick Start Guides","items":[{"type":"category","label":"Deploying Rancher Server","items":[{"type":"link","label":"Rancher AWS Quick Start Guide","href":"/v2.5/getting-started/quick-start-guides/deploy-rancher-manager/aws","docId":"getting-started/quick-start-guides/deploy-rancher-manager/aws"},{"type":"link","label":"Rancher Azure Quick Start Guide","href":"/v2.5/getting-started/quick-start-guides/deploy-rancher-manager/azure","docId":"getting-started/quick-start-guides/deploy-rancher-manager/azure"},{"type":"link","label":"Rancher DigitalOcean Quick Start Guide","href":"/v2.5/getting-started/quick-start-guides/deploy-rancher-manager/digitalocean","docId":"getting-started/quick-start-guides/deploy-rancher-manager/digitalocean"},{"type":"link","label":"Rancher GCP Quick Start Guide","href":"/v2.5/getting-started/quick-start-guides/deploy-rancher-manager/gcp","docId":"getting-started/quick-start-guides/deploy-rancher-manager/gcp"},{"type":"link","label":"Rancher Vagrant Quick Start","href":"/v2.5/getting-started/quick-start-guides/deploy-rancher-manager/vagrant","docId":"getting-started/quick-start-guides/deploy-rancher-manager/vagrant"},{"type":"link","label":"Manual Quick Start","href":"/v2.5/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli","docId":"getting-started/quick-start-guides/deploy-rancher-manager/helm-cli"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/quick-start-guides/deploy-rancher-manager/"},{"type":"category","label":"Deploying Workloads","items":[{"type":"link","label":"Workload with Ingress Quick Start","href":"/v2.5/getting-started/quick-start-guides/deploy-workloads/workload-ingress","docId":"getting-started/quick-start-guides/deploy-workloads/workload-ingress"},{"type":"link","label":"Workload with NodePort Quick Start","href":"/v2.5/getting-started/quick-start-guides/deploy-workloads/nodeports","docId":"getting-started/quick-start-guides/deploy-workloads/nodeports"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/quick-start-guides/deploy-workloads/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/quick-start-guides/"},{"type":"category","label":"Installation and Upgrade","items":[{"type":"category","label":"Installation Requirements","items":[{"type":"link","label":"Installing Docker","href":"/v2.5/getting-started/installation-and-upgrade/installation-requirements/install-docker","docId":"getting-started/installation-and-upgrade/installation-requirements/install-docker"},{"type":"link","label":"Port Requirements","href":"/v2.5/getting-started/installation-and-upgrade/installation-requirements/port-requirements","docId":"getting-started/installation-and-upgrade/installation-requirements/port-requirements"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/installation-requirements/"},{"type":"category","label":"Install/Upgrade on a Kubernetes Cluster","items":[{"type":"link","label":"Rollbacks","href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks"},{"type":"link","label":"Upgrades","href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades"},{"type":"link","label":"Rendering the Helm Template in an Air Gapped Environment","href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades"},{"type":"link","label":"Installing Rancher on Amazon EKS","href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks"},{"type":"link","label":"Installing Rancher on Azure Kubernetes Service","href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks"},{"type":"link","label":"Installing Rancher on a Google Kubernetes Engine Cluster","href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke"},{"type":"link","label":"Troubleshooting the Rancher Server Kubernetes Cluster","href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/"},{"type":"category","label":"Other Installation Methods","items":[{"type":"category","label":"Air-Gapped Helm CLI Install","items":[{"type":"link","label":"1. Set up Infrastructure and Private Registry","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry","docId":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry"},{"type":"link","label":"2. Collect and Publish Images to your Private Registry","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images","docId":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images"},{"type":"link","label":"3. Install Kubernetes (Skip for Docker Installs)","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes","docId":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes"},{"type":"link","label":"4. Install Rancher","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha","docId":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha"},{"type":"link","label":"Docker Install Commands","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands","docId":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/"},{"type":"category","label":"Rancher on a Single Node with Docker","items":[{"type":"link","label":"Upgrading Rancher Installed with Docker","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher","docId":"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher"},{"type":"link","label":"Rolling Back Rancher Installed with Docker","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher","docId":"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher"},{"type":"link","label":"Troubleshooting Certificates","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting","docId":"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/"},{"type":"category","label":"Rancher Behind an HTTP Proxy","items":[{"type":"link","label":"1. Set up Infrastructure","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure","docId":"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure"},{"type":"link","label":"2. Install Kubernetes","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes","docId":"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes"},{"type":"link","label":"3. Install Rancher","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher","docId":"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/"},{"type":"category","label":"Install/Upgrade Rancher with RancherD","items":[{"type":"link","label":"Rollbacks","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/roll-back-rancherd","docId":"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/roll-back-rancherd"},{"type":"link","label":"Upgrades","href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/upgrade-rancherd","docId":"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/upgrade-rancherd"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/other-installation-methods/"},{"type":"category","label":"Resources","items":[{"type":"link","label":"Choosing a Rancher Version","href":"/v2.5/getting-started/installation-and-upgrade/resources/choose-a-rancher-version","docId":"getting-started/installation-and-upgrade/resources/choose-a-rancher-version"},{"type":"link","label":"Helm Version Requirements","href":"/v2.5/getting-started/installation-and-upgrade/resources/helm-version-requirements","docId":"getting-started/installation-and-upgrade/resources/helm-version-requirements"},{"type":"link","label":"Adding TLS Secrets","href":"/v2.5/getting-started/installation-and-upgrade/resources/add-tls-secrets","docId":"getting-started/installation-and-upgrade/resources/add-tls-secrets"},{"type":"link","label":"About Custom CA Root Certificates","href":"/v2.5/getting-started/installation-and-upgrade/resources/custom-ca-root-certificates","docId":"getting-started/installation-and-upgrade/resources/custom-ca-root-certificates"},{"type":"link","label":"Upgrading Cert-Manager","href":"/v2.5/getting-started/installation-and-upgrade/resources/upgrade-cert-manager","docId":"getting-started/installation-and-upgrade/resources/upgrade-cert-manager"},{"type":"link","label":"Upgrading Cert-Manager with Helm 2","href":"/v2.5/getting-started/installation-and-upgrade/resources/upgrade-cert-manager-helm-2","docId":"getting-started/installation-and-upgrade/resources/upgrade-cert-manager-helm-2"},{"type":"link","label":"Updating the Rancher Certificate","href":"/v2.5/getting-started/installation-and-upgrade/resources/update-rancher-certificate","docId":"getting-started/installation-and-upgrade/resources/update-rancher-certificate"},{"type":"link","label":"Setting up Local System Charts for Air Gapped Installations","href":"/v2.5/getting-started/installation-and-upgrade/resources/local-system-charts","docId":"getting-started/installation-and-upgrade/resources/local-system-charts"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/resources/"},{"type":"link","label":"Upgrading and Rolling Back Kubernetes","href":"/v2.5/getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes","docId":"getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes"},{"type":"link","label":"Upgrading Kubernetes without Upgrading Rancher","href":"/v2.5/getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher","docId":"getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher"},{"type":"category","label":"Advanced Options","items":[{"type":"category","label":"Enabling Experimental Features","items":[{"type":"link","label":"Running on ARM64 (Experimental)","href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64","docId":"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64"},{"type":"link","label":"Allowing Unsupported Storage Drivers","href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers","docId":"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers"},{"type":"link","label":"UI for Istio Virtual Services and Destination Rules","href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features","docId":"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/"},{"type":"category","label":"Advanced Use Cases","items":[{"type":"link","label":"Opening Ports with firewalld","href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld"},{"type":"link","label":"Tuning etcd for Large Installations","href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs"},{"type":"link","label":"Enabling the API Audit Log to Record System Events","href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log"},{"type":"link","label":"Docker Install with TLS Termination at Layer-7 NGINX Load Balancer","href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer"}],"collapsed":true,"collapsible":true}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/advanced-options/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started/installation-and-upgrade/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/getting-started"},{"type":"category","label":"How-to Guides","items":[{"type":"category","label":"New User Guides","items":[{"type":"category","label":"Setting up a Kubernetes Cluster for Rancher Server","items":[{"type":"link","label":"About High-availability Installations","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs","docId":"how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs"},{"type":"link","label":"Setting up a High-availability K3s Kubernetes Cluster for Rancher","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher","docId":"how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher"},{"type":"link","label":"Setting up a High-availability RKE Kubernetes Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher","docId":"how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher"},{"type":"link","label":"Setting up a High-availability RKE2 Kubernetes Cluster for Rancher","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher","docId":"how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-cluster-setup/"},{"type":"category","label":"Infrastructure Setup","items":[{"type":"link","label":"Setting up Infrastructure for a High Availability K3s Kubernetes Cluster","href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster","docId":"how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster"},{"type":"link","label":"Setting up Infrastructure for a High Availability RKE Kubernetes Cluster","href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster","docId":"how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster"},{"type":"link","label":"Setting up Infrastructure for a High Availability RKE2 Kubernetes Cluster","href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster","docId":"how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster"},{"type":"link","label":"Setting up Nodes in Amazon EC2","href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2","docId":"how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2"},{"type":"link","label":"Setting up a MySQL Database in Amazon RDS","href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds","docId":"how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds"},{"type":"link","label":"Setting up an NGINX Load Balancer","href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer","docId":"how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer"},{"type":"link","label":"Setting up Amazon ELB Network Load Balancer","href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer","docId":"how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/infrastructure-setup/"},{"type":"category","label":"Kubernetes Clusters in Rancher Setup","items":[{"type":"link","label":"Node Requirements for Rancher Managed Clusters","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters"},{"type":"category","label":"Checklist for Production-Ready Clusters","items":[{"type":"link","label":"Recommended Cluster Architecture","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture"},{"type":"link","label":"Roles for Nodes in Kubernetes","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/"},{"type":"category","label":"Setting up Clusters from Hosted Kubernetes Providers","items":[{"type":"link","label":"Managing GKE Clusters","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke"},{"type":"link","label":"Creating an AKS Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks"},{"type":"link","label":"Creating an Aliyun ACK Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba"},{"type":"link","label":"Creating a Tencent TKE Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent"},{"type":"link","label":"Creating a Huawei CCE Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/"},{"type":"category","label":"Launching Kubernetes with Rancher","items":[{"type":"category","label":"Launching New Nodes in an Infra Provider","items":[{"type":"link","label":"Creating an Amazon EC2 Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster"},{"type":"link","label":"Creating a DigitalOcean Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster"},{"type":"link","label":"Creating an Azure Cluster","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster"},{"type":"category","label":"Creating a VMware vSphere Cluster","items":[{"type":"link","label":"Provisioning Kubernetes Clusters in VMware vSphere","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere"},{"type":"link","label":"Creating Credentials in the VMware vSphere Console","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/"},{"type":"category","label":"Launching Kubernetes on Windows Clusters","items":[{"type":"link","label":"Configuring Storage Classes in Azure","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration"},{"type":"link","label":"Windows and Linux Cluster Feature Parity","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/windows-linux-cluster-feature-parity","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/windows-linux-cluster-feature-parity"},{"type":"link","label":"Networking Requirements for Host Gateway (L2bridge)","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/"},{"type":"category","label":"Setting up Cloud Providers","items":[{"type":"category","label":"Other Cloud Providers","items":[{"type":"link","label":"Setting up the Amazon Cloud Provider","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon"},{"type":"link","label":"Setting up the Azure Cloud Provider","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure"},{"type":"link","label":"Setting up the Google Compute Engine Cloud Provider","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/"},{"type":"category","label":"Creating a VMware vSphere Cluster","items":[{"type":"link","label":"Configuring an In-tree VMware vSphere Cloud Provider","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere"},{"type":"link","label":"Configuring an Out-of-tree vSphere Cloud Provider","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere"},{"type":"link","label":"Migrating vSphere In-tree Volumes to Out-of-tree","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/"},{"type":"link","label":"Rancher Agents","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/"},{"type":"link","label":"Registering Existing Clusters","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/"},{"type":"category","label":"Kubernetes Resources Setup","items":[{"type":"category","label":"Workloads and Pods","items":[{"type":"link","label":"Deploying Workloads","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads"},{"type":"link","label":"Rolling Back Workloads","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads"},{"type":"link","label":"Upgrading Workloads","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads"},{"type":"link","label":"Adding a Sidecar","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/"},{"type":"category","label":"Horizontal Pod Autoscaler","items":[{"type":"link","label":"Background Information on HPAs","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas"},{"type":"link","label":"Managing HPAs with the Rancher UI","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui"},{"type":"link","label":"Managing HPAs with kubectl","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl"},{"type":"link","label":"Testing HPAs with kubectl","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/"},{"type":"category","label":"Load Balancer and Ingress Controller","items":[{"type":"link","label":"Layer 4 and Layer 7 Load Balancing","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing"},{"type":"link","label":"Adding Ingresses to Your Project","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/"},{"type":"link","label":"Service Discovery","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/create-services","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/create-services"},{"type":"link","label":"Encrypting HTTP Communication","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication"},{"type":"link","label":"ConfigMaps","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps"},{"type":"link","label":"Secrets","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/secrets","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/secrets"},{"type":"link","label":"Kubernetes Registry and Docker Registry","href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/kubernetes-resources-setup/"},{"type":"link","label":"Helm Charts and Apps","href":"/v2.5/how-to-guides/new-user-guides/helm-charts-in-rancher","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher"},{"type":"category","label":"Deploying Apps Across Clusters","items":[{"type":"link","label":"Fleet - GitOps at Scale","href":"/v2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet","docId":"how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet"},{"type":"link","label":"Multi-cluster Apps","href":"/v2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps","docId":"how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/deploy-apps-across-clusters/"},{"type":"category","label":"Backup, Restore, and Disaster Recovery","items":[{"type":"link","label":"Backing up Rancher","href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher"},{"type":"link","label":"Restoring Rancher","href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher"},{"type":"link","label":"Migrating Rancher to a New Cluster","href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster"},{"type":"link","label":"Backing up Rancher Installed with Docker","href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher"},{"type":"link","label":"Restoring Backups—Docker Installs","href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher"},{"type":"link","label":"Backing up a Cluster","href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters"},{"type":"link","label":"Restoring a Cluster from Backup","href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/new-user-guides/"},{"type":"category","label":"Advanced User Guides","items":[{"type":"category","label":"Authentication, Permissions, and Global Configuration","items":[{"type":"category","label":"About Authentication","items":[{"type":"category","label":"Configuring Authentication","items":[{"type":"link","label":"Users and Groups","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups"},{"type":"link","label":"Local Authentication","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users"},{"type":"link","label":"Configuring Google OAuth","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth"},{"type":"link","label":"Configure Active Directory (AD)","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory"},{"type":"link","label":"Configuring FreeIPA","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa"},{"type":"link","label":"Configure Azure AD","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad"},{"type":"link","label":"Configure GitHub","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github"},{"type":"link","label":"Configure Keycloak (SAML)","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak"},{"type":"link","label":"Configure PingIdentity (SAML)","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity"},{"type":"link","label":"Configure Okta (SAML)","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/"},{"type":"category","label":"Configuring Microsoft AD Federation Service (SAML)","items":[{"type":"link","label":"1. Configuring Microsoft AD FS for Rancher","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher"},{"type":"link","label":"2. Configuring Rancher for Microsoft AD FS","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/"},{"type":"category","label":"Configuring Shibboleth (SAML)","items":[{"type":"link","label":"Group Permissions with Shibboleth and OpenLDAP","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/"},{"type":"category","label":"Managing Role-Based Access Control (RBAC)","items":[{"type":"link","label":"Global Permissions","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions"},{"type":"link","label":"Cluster and Project Roles","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles"},{"type":"link","label":"Custom Roles","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles"},{"type":"link","label":"Locked Roles","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/"},{"type":"category","label":"About Provisioning Drivers","items":[{"type":"link","label":"Cluster Drivers","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers"},{"type":"link","label":"Node Drivers","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/"},{"type":"category","label":"About RKE1 Templates","items":[{"type":"link","label":"Template Creator Permissions","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions"},{"type":"link","label":"Access and Sharing","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates"},{"type":"link","label":"Creating and Revising Templates","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates"},{"type":"link","label":"Enforcing Templates","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates"},{"type":"link","label":"Overriding Template Settings","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings"},{"type":"link","label":"Applying Templates","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates"},{"type":"link","label":"RKE Templates and Infrastructure","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure"},{"type":"link","label":"Example Scenarios","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/"},{"type":"link","label":"Creating Pod Security Policies","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies"},{"type":"link","label":"Configuring a Global Default Private Registry","href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry","docId":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/"},{"type":"category","label":"Cluster Administration","items":[{"type":"category","label":"Access Clusters","items":[{"type":"link","label":"Access a Cluster with Kubectl and kubeconfig","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig","docId":"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig"},{"type":"link","label":"How the Authorized Cluster Endpoint Works","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint","docId":"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint"},{"type":"link","label":"Adding Users to Clusters","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters","docId":"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/"},{"type":"category","label":"Install Cluster Autoscaler","items":[{"type":"link","label":"Cluster Autoscaler with AWS EC2 Auto Scaling Groups","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups","docId":"how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/"},{"type":"category","label":"Create Kubernetes Persistent Storage","items":[{"type":"category","label":"Manage Persistent Storage","items":[{"type":"link","label":"How Persistent Storage Works","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage"},{"type":"link","label":"Setting up Existing Storage","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage"},{"type":"link","label":"Dynamically Provisioning New Storage in Rancher","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage"},{"type":"link","label":"Using an External Ceph Driver","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver"},{"type":"link","label":"GlusterFS Volumes","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes"},{"type":"link","label":"iSCSI Volumes","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/"},{"type":"category","label":"Provisioning Storage Examples","items":[{"type":"link","label":"Creating Persistent Storage in Amazon\'s EBS","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs"},{"type":"link","label":"NFS Storage","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage"},{"type":"link","label":"VMware vSphere Storage","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage","docId":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/"},{"type":"link","label":"Projects and Kubernetes Namespaces with Rancher","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces","docId":"how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces"},{"type":"link","label":"Cloning Clusters","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration","docId":"how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration"},{"type":"link","label":"Certificate Rotation","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates","docId":"how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates"},{"type":"link","label":"Nodes and Node Pools","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools","docId":"how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools"},{"type":"link","label":"Removing Kubernetes Components from Nodes","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes","docId":"how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes"},{"type":"link","label":"Adding a Pod Security Policy","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy","docId":"how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy"},{"type":"link","label":"Assigning Pod Security Policies","href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies","docId":"how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-clusters/"},{"type":"category","label":"Project Administration","items":[{"type":"link","label":"Adding Users to Projects","href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects","docId":"how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects"},{"type":"link","label":"Namespaces","href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/manage-namespaces","docId":"how-to-guides/advanced-user-guides/manage-projects/manage-namespaces"},{"type":"link","label":"Applying Pod Security Policies to Projects","href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies","docId":"how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies"},{"type":"category","label":"Project Resource Quotas","items":[{"type":"link","label":"How Resource Quotas Work in Rancher Projects","href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas","docId":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas"},{"type":"link","label":"Overriding the Default Limit for a Namespace","href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces","docId":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces"},{"type":"link","label":"Setting Container Default Resource Limits","href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/set-container-default-resource-limits","docId":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/set-container-default-resource-limits"},{"type":"link","label":"Resource Quota Type Reference","href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types","docId":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/manage-projects/"},{"type":"category","label":"Monitoring/Alerting Guides","items":[{"type":"link","label":"Enable Monitoring","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring","docId":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring"},{"type":"link","label":"Uninstall Monitoring","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring","docId":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring"},{"type":"link","label":"Setting up Monitoring for a Workload","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads","docId":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads"},{"type":"link","label":"Customizing Grafana Dashboards","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard","docId":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard"},{"type":"link","label":"Persistent Grafana Dashboards","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard","docId":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard"},{"type":"link","label":"Debugging High Memory Usage","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage","docId":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage"},{"type":"link","label":"Migrating to Rancher v2.5 Monitoring","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring","docId":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/"},{"type":"category","label":"Monitoring V2 Configuration Guides","items":[{"type":"category","label":"Advanced Configuration","items":[{"type":"link","label":"Alertmanager Configuration","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager","docId":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager"},{"type":"link","label":"Prometheus Configuration","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus","docId":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus"},{"type":"link","label":"Configuring PrometheusRules","href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules","docId":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/"},{"type":"category","label":"Istio Setup Guides","items":[{"type":"link","label":"Enable Istio in the Cluster","href":"/v2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster"},{"type":"link","label":"Enable Istio in a Namespace","href":"/v2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace"},{"type":"link","label":"Add Deployments and Services with the Istio Sidecar","href":"/v2.5/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar"},{"type":"link","label":"Set up the Istio Gateway","href":"/v2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway"},{"type":"link","label":"Set up Istio\'s Components for Traffic Management","href":"/v2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management"},{"type":"link","label":"Generate and View Traffic from Istio","href":"/v2.5/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/istio-setup-guide/"},{"type":"category","label":"CIS Scan Guides","items":[{"type":"link","label":"Install Rancher CIS Benchmark","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark"},{"type":"link","label":"Uninstall Rancher CIS Benchmark","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark"},{"type":"link","label":"Run a Scan","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan"},{"type":"link","label":"Run a Scan Periodically on a Schedule","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule"},{"type":"link","label":"Skip Tests","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests"},{"type":"link","label":"View Reports","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/view-reports","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/view-reports"},{"type":"link","label":"Enable Alerting for Rancher CIS Benchmark","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark"},{"type":"link","label":"Configure Alerts for Periodic Scan on a Schedule","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule"},{"type":"link","label":"Create a Custom Benchmark Version for Running a Cluster Scan","href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/create-a-custom-benchmark-version-to-run","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/create-a-custom-benchmark-version-to-run"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides/advanced-user-guides/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/how-to-guides"},{"type":"category","label":"Reference Guides","items":[{"type":"category","label":"Best Practice Guides","items":[{"type":"category","label":"Rancher Server","items":[{"type":"link","label":"Installing Rancher in a VMware vSphere Environment","href":"/v2.5/reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere","docId":"reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere"},{"type":"link","label":"Rancher Deployment Strategy","href":"/v2.5/reference-guides/best-practices/rancher-server/rancher-deployment-strategy","docId":"reference-guides/best-practices/rancher-server/rancher-deployment-strategy"},{"type":"link","label":"Tips for Running Rancher","href":"/v2.5/reference-guides/best-practices/rancher-server/tips-for-running-rancher","docId":"reference-guides/best-practices/rancher-server/tips-for-running-rancher"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/best-practices/rancher-server/"},{"type":"category","label":"Rancher-Managed Clusters","items":[{"type":"link","label":"Logging Best Practices","href":"/v2.5/reference-guides/best-practices/rancher-managed-clusters/logging-best-practices","docId":"reference-guides/best-practices/rancher-managed-clusters/logging-best-practices"},{"type":"link","label":"Monitoring Best Practices","href":"/v2.5/reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices","docId":"reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices"},{"type":"link","label":"Tips for Setting Up Containers","href":"/v2.5/reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers","docId":"reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers"},{"type":"link","label":"Best Practices for Rancher Managed VMware vSphere Clusters","href":"/v2.5/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere","docId":"reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/best-practices/rancher-managed-clusters/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/best-practices/"},{"type":"category","label":"Rancher Architecture","items":[{"type":"link","label":"Rancher Server and Components","href":"/v2.5/reference-guides/rancher-manager-architecture/rancher-server-and-components","docId":"reference-guides/rancher-manager-architecture/rancher-server-and-components"},{"type":"link","label":"Communicating with Downstream User Clusters","href":"/v2.5/reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters","docId":"reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters"},{"type":"link","label":"Architecture Recommendations","href":"/v2.5/reference-guides/rancher-manager-architecture/architecture-recommendations","docId":"reference-guides/rancher-manager-architecture/architecture-recommendations"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/rancher-manager-architecture/"},{"type":"category","label":"Cluster Configuration","items":[{"type":"category","label":"Rancher Server Configuration","items":[{"type":"link","label":"RKE Cluster Configuration","href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration","docId":"reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration"},{"type":"link","label":"EKS Cluster Configuration Reference","href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration","docId":"reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration"},{"type":"category","label":"GKE Cluster Configuration Reference","items":[{"type":"link","label":"Private Clusters","href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters","docId":"reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/"},{"type":"category","label":"Use Existing Nodes","items":[{"type":"link","label":"Rancher Agent Options","href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options","docId":"reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/"},{"type":"link","label":"Syncing Hosted Clusters","href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters","docId":"reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters"},{"type":"link","label":"RancherD Configuration Reference","href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/rancherd-configuration-reference","docId":"reference-guides/cluster-configuration/rancher-server-configuration/rancherd-configuration-reference"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/cluster-configuration/rancher-server-configuration/"},{"type":"category","label":"Downstream Cluster Configuration","items":[{"type":"category","label":"Node Template Configuration","items":[{"type":"link","label":"EC2 Node Template Configuration","href":"/v2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2"},{"type":"link","label":"DigitalOcean Node Template Configuration","href":"/v2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean"},{"type":"link","label":"Azure Node Template Configuration","href":"/v2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure"},{"type":"link","label":"VMware vSphere Node Template Configuration","href":"/v2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/cluster-configuration/downstream-cluster-configuration/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/cluster-configuration/"},{"type":"category","label":"Single-Node Rancher in Docker","items":[{"type":"link","label":"HTTP Proxy Configuration","href":"/v2.5/reference-guides/single-node-rancher-in-docker/http-proxy-configuration","docId":"reference-guides/single-node-rancher-in-docker/http-proxy-configuration"},{"type":"link","label":"Advanced Options for Docker Installs","href":"/v2.5/reference-guides/single-node-rancher-in-docker/advanced-options","docId":"reference-guides/single-node-rancher-in-docker/advanced-options"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/single-node-rancher-in-docker/"},{"type":"category","label":"Installation References","items":[{"type":"link","label":"Rancher Helm Chart Options","href":"/v2.5/reference-guides/installation-references/helm-chart-options","docId":"reference-guides/installation-references/helm-chart-options"},{"type":"link","label":"TLS Settings","href":"/v2.5/reference-guides/installation-references/tls-settings","docId":"reference-guides/installation-references/tls-settings"},{"type":"link","label":"Feature Flags","href":"/v2.5/reference-guides/installation-references/feature-flags","docId":"reference-guides/installation-references/feature-flags"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/installation-references/"},{"type":"category","label":"Amazon EKS Permissions","items":[{"type":"link","label":"Minimum EKS Permissions","href":"/v2.5/reference-guides/amazon-eks-permissions/minimum-eks-permissions","docId":"reference-guides/amazon-eks-permissions/minimum-eks-permissions"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/amazon-eks-permissions/"},{"type":"category","label":"Backup & Restore Configuration","items":[{"type":"link","label":"Backup Configuration","href":"/v2.5/reference-guides/backup-restore-configuration/backup-configuration","docId":"reference-guides/backup-restore-configuration/backup-configuration"},{"type":"link","label":"Restore Configuration","href":"/v2.5/reference-guides/backup-restore-configuration/restore-configuration","docId":"reference-guides/backup-restore-configuration/restore-configuration"},{"type":"link","label":"Backup Storage Location Configuration","href":"/v2.5/reference-guides/backup-restore-configuration/storage-configuration","docId":"reference-guides/backup-restore-configuration/storage-configuration"},{"type":"link","label":"Backup and Restore Examples","href":"/v2.5/reference-guides/backup-restore-configuration/examples","docId":"reference-guides/backup-restore-configuration/examples"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/backup-restore-configuration/"},{"type":"category","label":"Configuring OpenLDAP","items":[{"type":"link","label":"OpenLDAP Configuration Reference","href":"/v2.5/reference-guides/configure-openldap/openldap-config-reference","docId":"reference-guides/configure-openldap/openldap-config-reference"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/configure-openldap/"},{"type":"link","label":"Kubernetes Concepts","href":"/v2.5/reference-guides/kubernetes-concepts","docId":"reference-guides/kubernetes-concepts"},{"type":"category","label":"Monitoring V2 Configuration","items":[{"type":"link","label":"Receiver Configuration","href":"/v2.5/reference-guides/monitoring-v2-configuration/receivers","docId":"reference-guides/monitoring-v2-configuration/receivers"},{"type":"link","label":"Route Configuration","href":"/v2.5/reference-guides/monitoring-v2-configuration/routes","docId":"reference-guides/monitoring-v2-configuration/routes"},{"type":"link","label":"ServiceMonitor and PodMonitor Configuration","href":"/v2.5/reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors","docId":"reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors"},{"type":"link","label":"Helm Chart Options","href":"/v2.5/reference-guides/monitoring-v2-configuration/helm-chart-options","docId":"reference-guides/monitoring-v2-configuration/helm-chart-options"},{"type":"link","label":"Monitoring V2 Configuration Examples","href":"/v2.5/reference-guides/monitoring-v2-configuration/examples","docId":"reference-guides/monitoring-v2-configuration/examples"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/monitoring-v2-configuration/"},{"type":"category","label":"User Settings","items":[{"type":"link","label":"API Keys","href":"/v2.5/reference-guides/user-settings/api-keys","docId":"reference-guides/user-settings/api-keys"},{"type":"link","label":"Managing Node Templates","href":"/v2.5/reference-guides/user-settings/manage-node-templates","docId":"reference-guides/user-settings/manage-node-templates"},{"type":"link","label":"Managing Cloud Credentials","href":"/v2.5/reference-guides/user-settings/manage-cloud-credentials","docId":"reference-guides/user-settings/manage-cloud-credentials"},{"type":"link","label":"User Preferences","href":"/v2.5/reference-guides/user-settings/user-preferences","docId":"reference-guides/user-settings/user-preferences"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/user-settings/"},{"type":"category","label":"CLI with Rancher","items":[{"type":"link","label":"Rancher CLI","href":"/v2.5/reference-guides/cli-with-rancher/rancher-cli","docId":"reference-guides/cli-with-rancher/rancher-cli"},{"type":"link","label":"kubectl Utility","href":"/v2.5/reference-guides/cli-with-rancher/kubectl-utility","docId":"reference-guides/cli-with-rancher/kubectl-utility"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/cli-with-rancher/"},{"type":"category","label":"About the API","items":[{"type":"link","label":"API Tokens","href":"/v2.5/reference-guides/about-the-api/api-tokens","docId":"reference-guides/about-the-api/api-tokens"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/about-the-api/"},{"type":"link","label":"Tools for Logging, Monitoring, and Visibility","href":"/v2.5/reference-guides/rancher-cluster-tools","docId":"reference-guides/rancher-cluster-tools"},{"type":"link","label":"Tools for Logging, Monitoring, and Visibility","href":"/v2.5/reference-guides/rancher-project-tools","docId":"reference-guides/rancher-project-tools"},{"type":"link","label":"System Tools","href":"/v2.5/reference-guides/system-tools","docId":"reference-guides/system-tools"},{"type":"link","label":"RKE1 Example YAML","href":"/v2.5/reference-guides/rke1-template-example-yaml","docId":"reference-guides/rke1-template-example-yaml"},{"type":"category","label":"Rancher Security Guides","items":[{"type":"category","label":"Rancher v2.6 Hardening Guides","items":[{"type":"link","label":"Hardening Guide with CIS 1.6 Benchmark","href":"/v2.5/reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.6-benchmark","docId":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.6-benchmark"},{"type":"link","label":"CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.5.4","href":"/v2.5/reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.6-benchmark","docId":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.6-benchmark"},{"type":"link","label":"Hardening Guide with CIS 1.6 Benchmark","href":"/v2.5/reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.6-benchmark","docId":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.6-benchmark"},{"type":"link","label":"CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.5.4","href":"/v2.5/reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.6-benchmark","docId":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.6-benchmark"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/rancher-security/rancher-v2.5-hardening-guides/"},{"type":"category","label":"SELinux RPM","items":[{"type":"link","label":"About rancher-selinux","href":"/v2.5/reference-guides/rancher-security/selinux-rpm/about-rancher-selinux","docId":"reference-guides/rancher-security/selinux-rpm/about-rancher-selinux"},{"type":"link","label":"About rke2-selinux","href":"/v2.5/reference-guides/rancher-security/selinux-rpm/about-rke2-selinux","docId":"reference-guides/rancher-security/selinux-rpm/about-rke2-selinux"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/rancher-security/selinux-rpm/"},{"type":"link","label":"Kubernetes Security Best Practices","href":"/v2.5/reference-guides/rancher-security/kubernetes-security-best-practices","docId":"reference-guides/rancher-security/kubernetes-security-best-practices"},{"type":"link","label":"Security Advisories and CVEs","href":"/v2.5/reference-guides/rancher-security/security-advisories-and-cves","docId":"reference-guides/rancher-security/security-advisories-and-cves"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides/rancher-security/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/reference-guides"},{"type":"category","label":"Explanations","items":[{"type":"category","label":"Integrations in Rancher","items":[{"type":"category","label":"CIS Scans","items":[{"type":"link","label":"Configuration","href":"/v2.5/explanations/integrations-in-rancher/cis-scans/configuration-reference","docId":"explanations/integrations-in-rancher/cis-scans/configuration-reference"},{"type":"link","label":"Roles-based Access Control","href":"/v2.5/explanations/integrations-in-rancher/cis-scans/rbac-for-cis-scans","docId":"explanations/integrations-in-rancher/cis-scans/rbac-for-cis-scans"},{"type":"link","label":"Skipped and Not Applicable Tests","href":"/v2.5/explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests","docId":"explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests"},{"type":"link","label":"Creating a Custom Benchmark Version for Running a Cluster Scan","href":"/v2.5/explanations/integrations-in-rancher/cis-scans/custom-benchmark","docId":"explanations/integrations-in-rancher/cis-scans/custom-benchmark"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/cis-scans/"},{"type":"category","label":"Fleet - GitOps at Scale","items":[{"type":"link","label":"Fleet Architecture","href":"/v2.5/explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture","docId":"explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture"},{"type":"link","label":"Windows Support","href":"/v2.5/explanations/integrations-in-rancher/fleet-gitops-at-scale/windows-support","docId":"explanations/integrations-in-rancher/fleet-gitops-at-scale/windows-support"},{"type":"link","label":"Using Fleet Behind a Proxy","href":"/v2.5/explanations/integrations-in-rancher/fleet-gitops-at-scale/use-fleet-behind-a-proxy","docId":"explanations/integrations-in-rancher/fleet-gitops-at-scale/use-fleet-behind-a-proxy"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/fleet-gitops-at-scale/"},{"type":"category","label":"Istio","items":[{"type":"link","label":"CPU and Memory Allocations","href":"/v2.5/explanations/integrations-in-rancher/istio/cpu-and-memory-allocations","docId":"explanations/integrations-in-rancher/istio/cpu-and-memory-allocations"},{"type":"link","label":"Role-based Access Control","href":"/v2.5/explanations/integrations-in-rancher/istio/rbac-for-istio","docId":"explanations/integrations-in-rancher/istio/rbac-for-istio"},{"type":"link","label":"Disabling Istio","href":"/v2.5/explanations/integrations-in-rancher/istio/disable-istio","docId":"explanations/integrations-in-rancher/istio/disable-istio"},{"type":"category","label":"Configuration Options","items":[{"type":"link","label":"Enable Istio with Pod Security Policies","href":"/v2.5/explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies","docId":"explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies"},{"type":"link","label":"Selectors and Scrape Configs","href":"/v2.5/explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations","docId":"explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations"},{"type":"link","label":"Additional Steps for Installing Istio on an RKE2 Cluster","href":"/v2.5/explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster","docId":"explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster"},{"type":"link","label":"Additional Steps for Project Network Isolation","href":"/v2.5/explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation","docId":"explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/istio/configuration-options/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/istio/"},{"type":"link","label":"Cloud Native Storage with Longhorn","href":"/v2.5/explanations/integrations-in-rancher/longhorn","docId":"explanations/integrations-in-rancher/longhorn"},{"type":"category","label":"Logging","items":[{"type":"link","label":"Logging Architecture","href":"/v2.5/explanations/integrations-in-rancher/logging/logging-architecture","docId":"explanations/integrations-in-rancher/logging/logging-architecture"},{"type":"link","label":"Migrating to Rancher v2.5 Logging","href":"/v2.5/explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging","docId":"explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging"},{"type":"link","label":"Role-based Access Control for Logging","href":"/v2.5/explanations/integrations-in-rancher/logging/rbac-for-logging","docId":"explanations/integrations-in-rancher/logging/rbac-for-logging"},{"type":"link","label":"rancher-logging Helm Chart Options","href":"/v2.5/explanations/integrations-in-rancher/logging/logging-helm-chart-options","docId":"explanations/integrations-in-rancher/logging/logging-helm-chart-options"},{"type":"link","label":"Working with Taints and Tolerations","href":"/v2.5/explanations/integrations-in-rancher/logging/taints-and-tolerations","docId":"explanations/integrations-in-rancher/logging/taints-and-tolerations"},{"type":"category","label":"Custom Resource Configuration","items":[{"type":"link","label":"Flows and ClusterFlows","href":"/v2.5/explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows","docId":"explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows"},{"type":"link","label":"Outputs and ClusterOutputs","href":"/v2.5/explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs","docId":"explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/logging/custom-resource-configuration/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/logging/"},{"type":"category","label":"Monitoring and Alerting","items":[{"type":"link","label":"How Monitoring Works","href":"/v2.5/explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works","docId":"explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works"},{"type":"link","label":"Role-based Access Control","href":"/v2.5/explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring","docId":"explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring"},{"type":"link","label":"Built-in Dashboards","href":"/v2.5/explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards","docId":"explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards"},{"type":"link","label":"Windows Cluster Support for Monitoring V2","href":"/v2.5/explanations/integrations-in-rancher/monitoring-and-alerting/windows-support","docId":"explanations/integrations-in-rancher/monitoring-and-alerting/windows-support"},{"type":"link","label":"PromQL Expression Reference","href":"/v2.5/explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions","docId":"explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/monitoring-and-alerting/"},{"type":"link","label":"OPA Gatekeeper","href":"/v2.5/explanations/integrations-in-rancher/opa-gatekeeper","docId":"explanations/integrations-in-rancher/opa-gatekeeper"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations/integrations-in-rancher/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/explanations"},{"type":"category","label":"FAQ","items":[{"type":"link","label":"Deprecated Features in Rancher v2.5","href":"/v2.5/faq/deprecated-features","docId":"faq/deprecated-features"},{"type":"link","label":"Installing and Configuring kubectl","href":"/v2.5/faq/install-and-configure-kubectl","docId":"faq/install-and-configure-kubectl"},{"type":"link","label":"Technical FAQ","href":"/v2.5/faq/technical-items","docId":"faq/technical-items"},{"type":"link","label":"Security FAQ","href":"/v2.5/faq/security","docId":"faq/security"},{"type":"link","label":"Telemetry FAQ","href":"/v2.5/faq/telemetry","docId":"faq/telemetry"},{"type":"link","label":"Container Network Interface (CNI) Providers","href":"/v2.5/faq/container-network-interface-providers","docId":"faq/container-network-interface-providers"},{"type":"link","label":"Rancher is No Longer Needed","href":"/v2.5/faq/rancher-is-no-longer-needed","docId":"faq/rancher-is-no-longer-needed"}],"collapsed":true,"collapsible":true,"href":"/v2.5/faq"},{"type":"category","label":"Troubleshooting","items":[{"type":"category","label":"Kubernetes Components","items":[{"type":"link","label":"Troubleshooting etcd Nodes","href":"/v2.5/troubleshooting/kubernetes-components/troubleshooting-etcd-nodes","docId":"troubleshooting/kubernetes-components/troubleshooting-etcd-nodes"},{"type":"link","label":"Troubleshooting Controlplane Nodes","href":"/v2.5/troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes","docId":"troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes"},{"type":"link","label":"Troubleshooting nginx-proxy","href":"/v2.5/troubleshooting/kubernetes-components/troubleshooting-nginx-proxy","docId":"troubleshooting/kubernetes-components/troubleshooting-nginx-proxy"},{"type":"link","label":"Troubleshooting Worker Nodes and Generic Components","href":"/v2.5/troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components","docId":"troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components"}],"collapsed":true,"collapsible":true,"href":"/v2.5/troubleshooting/kubernetes-components/"},{"type":"category","label":"Other Troubleshooting Tips","items":[{"type":"link","label":"Kubernetes resources","href":"/v2.5/troubleshooting/other-troubleshooting-tips/kubernetes-resources","docId":"troubleshooting/other-troubleshooting-tips/kubernetes-resources"},{"type":"link","label":"Networking","href":"/v2.5/troubleshooting/other-troubleshooting-tips/networking","docId":"troubleshooting/other-troubleshooting-tips/networking"},{"type":"link","label":"DNS","href":"/v2.5/troubleshooting/other-troubleshooting-tips/dns","docId":"troubleshooting/other-troubleshooting-tips/dns"},{"type":"link","label":"Rancher HA","href":"/v2.5/troubleshooting/other-troubleshooting-tips/rancher-ha","docId":"troubleshooting/other-troubleshooting-tips/rancher-ha"},{"type":"link","label":"Registered clusters","href":"/v2.5/troubleshooting/other-troubleshooting-tips/registered-clusters","docId":"troubleshooting/other-troubleshooting-tips/registered-clusters"},{"type":"link","label":"Logging","href":"/v2.5/troubleshooting/other-troubleshooting-tips/logging","docId":"troubleshooting/other-troubleshooting-tips/logging"},{"type":"link","label":"Rotation of Expired Webhook Certificates","href":"/v2.5/troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation","docId":"troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation"}],"collapsed":true,"collapsible":true,"href":"/v2.5/troubleshooting/other-troubleshooting-tips/"}],"collapsed":true,"collapsible":true,"href":"/v2.5/troubleshooting"},{"type":"link","label":"Contributing to Rancher","href":"/v2.5/contribute-to-rancher","docId":"contribute-to-rancher"}]},"docs":{"contribute-to-rancher":{"id":"contribute-to-rancher","title":"Contributing to Rancher","description":"Learn about the repositories used for Rancher and Rancher docs, how to build Rancher repositories, and what information to include when you file an issue.","sidebar":"tutorialSidebar"},"explanations":{"id":"explanations","title":"Explanations","description":"Explanatory docs are concerned primarily with providing theoretical knowledge for the \\"why\\" behind a task or a topic. Explanations are \\"understanding-oriented\\" in nature and will clarify a topic in order to broaden the user\'s knowledge. In this section, users can find additional context and background, alternatives or even opinions on topics, and often historical reasons, constraints, and insights into why a process works the way that it does.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cis-scans/cis-scans":{"id":"explanations/integrations-in-rancher/cis-scans/cis-scans","title":"CIS Scans","description":"Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cis-scans/configuration-reference":{"id":"explanations/integrations-in-rancher/cis-scans/configuration-reference","title":"Configuration","description":"This configuration reference is intended to help you manage the custom resources created by the rancher-cis-benchmark application. These resources are used for performing CIS scans on a cluster, skipping tests, setting the test profile that will be used during a scan, and other customization.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cis-scans/custom-benchmark":{"id":"explanations/integrations-in-rancher/cis-scans/custom-benchmark","title":"Creating a Custom Benchmark Version for Running a Cluster Scan","description":"Available as of v2.5.4","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cis-scans/rbac-for-cis-scans":{"id":"explanations/integrations-in-rancher/cis-scans/rbac-for-cis-scans","title":"Roles-based Access Control","description":"This section describes the permissions required to use the rancher-cis-benchmark App.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests":{"id":"explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests","title":"Skipped and Not Applicable Tests","description":"This section lists the tests that are skipped in the permissive test profile for RKE.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture":{"id":"explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture","title":"Fleet Architecture","description":"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.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale":{"id":"explanations/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale","title":"Continuous Delivery with Fleet","description":"Available as of Rancher v2.5","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/fleet-gitops-at-scale/use-fleet-behind-a-proxy":{"id":"explanations/integrations-in-rancher/fleet-gitops-at-scale/use-fleet-behind-a-proxy","title":"Using Fleet Behind a Proxy","description":"Available as of v2.5.8","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/fleet-gitops-at-scale/windows-support":{"id":"explanations/integrations-in-rancher/fleet-gitops-at-scale/windows-support","title":"Windows Support","description":"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.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/integrations-in-rancher":{"id":"explanations/integrations-in-rancher/integrations-in-rancher","title":"Integrations in Rancher","description":"Over time, Rancher has accrued several products and projects that have been integrated into the Rancher UI.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/configuration-options/configuration-options":{"id":"explanations/integrations-in-rancher/istio/configuration-options/configuration-options","title":"Configuration Options","description":"Egress Support","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster":{"id":"explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster","title":"Additional Steps for Installing Istio on an RKE2 Cluster","description":"Through the Cluster Explorer, when installing or upgrading Istio through Apps & Marketplace,","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies":{"id":"explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies","title":"Enable Istio with Pod Security Policies","description":"If you have restrictive Pod Security Policies enabled, then Istio may not be able to function correctly, because it needs certain permissions in order to install itself and manage pod infrastructure. In this section, we will configure a cluster with PSPs enabled for an Istio install, and also set up the Istio CNI plugin.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation":{"id":"explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation","title":"Additional Steps for Project Network Isolation","description":"In clusters where:","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations":{"id":"explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations","title":"Selectors and Scrape Configs","description":"The Monitoring app sets prometheus.prometheusSpec.ignoreNamespaceSelectors=false, which enables monitoring across all namespaces by default.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/cpu-and-memory-allocations":{"id":"explanations/integrations-in-rancher/istio/cpu-and-memory-allocations","title":"CPU and Memory Allocations","description":"This section describes the minimum recommended computing resources for the Istio components in a cluster.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/disable-istio":{"id":"explanations/integrations-in-rancher/istio/disable-istio","title":"Disabling Istio","description":"This section describes how to uninstall Istio in a cluster or disable a namespace, or workload.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/istio":{"id":"explanations/integrations-in-rancher/istio/istio","title":"Istio","description":"Istio 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.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/rbac-for-istio":{"id":"explanations/integrations-in-rancher/istio/rbac-for-istio","title":"Role-based Access Control","description":"This section describes the permissions required to access Istio features.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration":{"id":"explanations/integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration","title":"Custom Resource Configuration","description":"The following Custom Resource Definitions are used to configure logging:","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows":{"id":"explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows","title":"Flows and ClusterFlows","description":"See the Logging operator documentation for the full details on how to configure Flows and ClusterFlows.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs":{"id":"explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs","title":"Outputs and ClusterOutputs","description":"See the Logging operator documentation for the full details on how to configure Flows and ClusterFlows.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/logging":{"id":"explanations/integrations-in-rancher/logging/logging","title":"Rancher Integration with Logging Services","description":"Rancher integrates with popular logging services. Learn the requirements and benefits of integrating with logging services, and enable logging on your cluster.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/logging-architecture":{"id":"explanations/integrations-in-rancher/logging/logging-architecture","title":"Logging Architecture","description":"This section summarizes the architecture of the Rancher logging application.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/logging-helm-chart-options":{"id":"explanations/integrations-in-rancher/logging/logging-helm-chart-options","title":"rancher-logging Helm Chart Options","description":"Enable/Disable Windows Node Logging","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging":{"id":"explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging","title":"Migrating to Rancher v2.5 Logging","description":"Starting in v2.5, the logging feature available within Rancher has been completely overhauled. The Logging operator has been adopted; Rancher configures this tooling for use when deploying logging.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/rbac-for-logging":{"id":"explanations/integrations-in-rancher/logging/rbac-for-logging","title":"Role-based Access Control for Logging","description":"Rancher logging has two roles, logging-admin and logging-view.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/logging/taints-and-tolerations":{"id":"explanations/integrations-in-rancher/logging/taints-and-tolerations","title":"Working with Taints and Tolerations","description":"\\"Tainting\\" a Kubernetes node causes pods to repel running on that node.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/longhorn":{"id":"explanations/integrations-in-rancher/longhorn","title":"Cloud Native Storage with Longhorn","description":"Longhorn is a lightweight, reliable and easy-to-use distributed block storage system for Kubernetes.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards":{"id":"explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards","title":"Built-in Dashboards","description":"Grafana UI","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works":{"id":"explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works","title":"How Monitoring Works","description":"1. Architecture Overview","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting":{"id":"explanations/integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting","title":"Monitoring and Alerting","description":"Prometheus lets you view metrics from your different Rancher and Kubernetes objects. Learn about the scope of monitoring and how to enable cluster monitoring","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions":{"id":"explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions","title":"PromQL Expression Reference","description":"The PromQL expressions in this doc can be used to configure alerts.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring":{"id":"explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring","title":"Role-based Access Control","description":"This section describes the expectations for RBAC for Rancher Monitoring.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/monitoring-and-alerting/windows-support":{"id":"explanations/integrations-in-rancher/monitoring-and-alerting/windows-support","title":"Windows Cluster Support for Monitoring V2","description":"Available as of v2.5.8","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/opa-gatekeeper":{"id":"explanations/integrations-in-rancher/opa-gatekeeper","title":"OPA Gatekeeper","description":"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) 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.","sidebar":"tutorialSidebar"},"faq":{"id":"faq","title":"FAQ","description":"This FAQ is a work in progress designed to answer the questions our users most frequently ask about Rancher v2.x.","sidebar":"tutorialSidebar"},"faq/container-network-interface-providers":{"id":"faq/container-network-interface-providers","title":"Container Network Interface (CNI) Providers","description":"Learn about Container Network Interface (CNI), the CNI providers Rancher provides, the features they offer, and how to choose a provider for you","sidebar":"tutorialSidebar"},"faq/deprecated-features":{"id":"faq/deprecated-features","title":"Deprecated Features in Rancher v2.5","description":"What is Rancher\'s deprecation policy?","sidebar":"tutorialSidebar"},"faq/install-and-configure-kubectl":{"id":"faq/install-and-configure-kubectl","title":"Installing and Configuring kubectl","description":"kubectl is a CLI utility for running commands against Kubernetes clusters. It\'s required for many maintenance and administrative tasks in Rancher 2.x.","sidebar":"tutorialSidebar"},"faq/networking/networking":{"id":"faq/networking/networking","title":"Networking","description":"Networking FAQ\'s"},"faq/rancher-is-no-longer-needed":{"id":"faq/rancher-is-no-longer-needed","title":"Rancher is No Longer Needed","description":"This page is intended to answer questions about what happens if you don\'t want Rancher anymore, if you don\'t want a cluster to be managed by Rancher anymore, or if the Rancher server is deleted.","sidebar":"tutorialSidebar"},"faq/security":{"id":"faq/security","title":"Security FAQ","description":"Is there a Hardening Guide?","sidebar":"tutorialSidebar"},"faq/technical-items":{"id":"faq/technical-items","title":"Technical FAQ","description":"How can I reset the administrator password?","sidebar":"tutorialSidebar"},"faq/telemetry":{"id":"faq/telemetry","title":"Telemetry FAQ","description":"What is Telemetry?","sidebar":"tutorialSidebar"},"getting-started":{"id":"getting-started","title":"Getting Started","description":"To get up and running with Rancher quickly, we have included a Getting Started section.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-options":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-options","title":"Advanced","description":"The documents in this section contain resources for less common use cases.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer","title":"Docker Install with TLS Termination at Layer-7 NGINX Load Balancer","description":"For development and testing environments that have a special requirement to terminate TLS/SSL at a load balancer instead of your Rancher Server container, deploy Rancher and configure a load balancer to work with it conjunction.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log","title":"Enabling the API Audit Log to Record System Events","description":"You can enable the API audit log to record the sequence of system events initiated by individual users. You can know what happened, when it happened, who initiated it, and what cluster it affected. When you enable this feature, all requests to the Rancher API and all responses from it are written to a log.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld","title":"Opening Ports with firewalld","description":"Enabling firewalld can cause serious network communication problems.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs","title":"Tuning etcd for Large Installations","description":"When running larger Rancher installations with 15 or more clusters it is recommended to increase the default keyspace for etcd from the default 2GB. The maximum setting is 8GB and the host should have enough RAM to keep the entire dataset in memory. When increasing this value you should also increase the size of the host. The keyspace size can also be adjusted in smaller installations if you anticipate a high rate of change of pods during the garbage collection interval.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/enable-experimental-features":{"id":"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/enable-experimental-features","title":"Enabling Experimental Features","description":"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 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.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features":{"id":"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features","title":"UI for Istio Virtual Services and Destination Rules","description":"This feature enables a UI that lets you create, read, update and delete virtual services and destination rules, which are traffic management features of Istio.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64":{"id":"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64","title":"Running on ARM64 (Experimental)","description":"Important:","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers":{"id":"getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers","title":"Allowing Unsupported Storage Drivers","description":"This feature allows you to use types for storage providers and provisioners that are not enabled by default.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades","title":"Rendering the Helm Template in an Air Gapped Environment","description":"These instructions assume you have already followed the instructions for a Kubernetes upgrade on this page, including the prerequisites, up until step 3. Upgrade Rancher.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster","title":"Install/Upgrade Rancher on a Kubernetes Cluster","description":"Learn how to install Rancher in development and production environments. Read about single node and high availability installation","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks","title":"Installing Rancher on Azure Kubernetes Service","description":"This page covers how to install Rancher on Microsoft\'s Azure Kubernetes Service (AKS).","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks","title":"Installing Rancher on Amazon EKS","description":"This page covers installing Rancher on an Amazon EKS cluster.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke","title":"Installing Rancher on a Google Kubernetes Engine Cluster","description":"In this section, you\'ll learn how to install Rancher using Google Kubernetes Engine.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks","title":"Rollbacks","description":"Rolling Back to Rancher v2.5.0+","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting","title":"Troubleshooting the Rancher Server Kubernetes Cluster","description":"This section describes how to troubleshoot an installation of Rancher on a Kubernetes cluster.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades","title":"Upgrades","description":"The following instructions will guide you through upgrading a Rancher server that was installed on a Kubernetes cluster with Helm. These steps also apply to air gap installs with Helm.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/installation-and-upgrade":{"id":"getting-started/installation-and-upgrade/installation-and-upgrade","title":"Installing/Upgrading Rancher","description":"Learn how to install Rancher in development and production environments. Read about single node and high availability installation","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/installation-requirements/install-docker":{"id":"getting-started/installation-and-upgrade/installation-requirements/install-docker","title":"Installing Docker","description":"Docker is required to be installed on nodes where the Rancher server will be installed with Helm or Docker.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/installation-requirements/installation-requirements":{"id":"getting-started/installation-and-upgrade/installation-requirements/installation-requirements","title":"Installation Requirements","description":"Learn the node requirements for each node running Rancher server when you’re configuring Rancher to run either in a Docker or Kubernetes setup","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/installation-requirements/port-requirements":{"id":"getting-started/installation-and-upgrade/installation-requirements/port-requirements","title":"Port Requirements","description":"Read about port requirements needed in order for Rancher to operate properly, both for Rancher nodes and downstream Kubernetes cluster nodes","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install":{"id":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/air-gapped-helm-cli-install","title":"Air Gapped Helm CLI Install","description":"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.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands":{"id":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands","title":"Docker Install Commands","description":"The Docker installation is for Rancher users who want to test out Rancher.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry":{"id":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry","title":"1. Set up Infrastructure and Private Registry","description":"In this section, you will provision the underlying infrastructure for your Rancher management server in an air gapped environment. You will also set up the private Docker registry that must be available to your Rancher node(s).","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes":{"id":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes","title":"3. Install Kubernetes (Skip for Docker Installs)","description":"Skip this section if you are installing Rancher on a single node with Docker.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha":{"id":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha","title":"4. Install Rancher","description":"This section is about how to deploy Rancher for your air gapped environment in a high-availability Kubernetes installation. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images":{"id":"getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images","title":"2. Collect and Publish Images to your Private Registry","description":"This section describes how to set up your private registry so that when you install Rancher, Rancher will pull all the required images from this registry.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/install-rancher-on-linux":{"id":"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/install-rancher-on-linux","title":"Install/Upgrade Rancher with RancherD","description":"Note: RancherD was an experimental feature available as part of Rancher v2.5.4 through v2.5.10 but is now deprecated and not available for recent releases.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/roll-back-rancherd":{"id":"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/roll-back-rancherd","title":"Rollbacks","description":"Note: RancherD was an experimental feature available as part of Rancher v2.5.4 through v2.5.10 but is now deprecated and not available for recent releases.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/upgrade-rancherd":{"id":"getting-started/installation-and-upgrade/other-installation-methods/install-rancher-on-linux/upgrade-rancherd","title":"Upgrades","description":"Note: RancherD was an experimental feature available as part of Rancher v2.5.4 through v2.5.10 but is now deprecated and not available for recent releases.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods":{"id":"getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods","title":"Other Installation Methods","description":"Air Gapped Installations","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes","title":"2. Install Kubernetes","description":"Once the infrastructure is ready, you can continue with setting up an RKE cluster to install Rancher in.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher","title":"3. Install Rancher","description":"Now that you have a running RKE cluster, you can install Rancher in it. For security reasons all traffic to Rancher must be encrypted with TLS. For this tutorial you are going to automatically issue a self-signed certificate through cert-manager. In a real-world use-case you will likely use Let\'s Encrypt or provide your own certificate.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/rancher-behind-an-http-proxy","title":"Installing Rancher behind an HTTP Proxy","description":"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.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure","title":"1. Set up Infrastructure","description":"In this section, you will provision the underlying infrastructure for your Rancher management server with internet access through a HTTP proxy.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting","title":"Troubleshooting Certificates","description":"How Do I Know if My Certificates are in PEM Format?","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker","title":"Installing Rancher on a Single Node Using Docker","description":"For development and testing environments only, use a Docker install. Install Docker on a single Linux host, and deploy Rancher with a single Docker container.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher","title":"Rolling Back Rancher Installed with Docker","description":"If a Rancher upgrade does not complete successfully, you\'ll have to roll back to your Rancher setup that you were using before Docker Upgrade. Rolling back restores:","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher":{"id":"getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher","title":"Upgrading Rancher Installed with Docker","description":"The following instructions will guide you through upgrading a Rancher server that was installed with Docker.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/add-tls-secrets":{"id":"getting-started/installation-and-upgrade/resources/add-tls-secrets","title":"Adding TLS Secrets","description":"Kubernetes will create all the objects and services for Rancher, but it will not become available until we populate the tls-rancher-ingress secret in the cattle-system namespace with the certificate and key.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/choose-a-rancher-version":{"id":"getting-started/installation-and-upgrade/resources/choose-a-rancher-version","title":"Choosing a Rancher Version","description":"This section describes how to choose a Rancher version.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/custom-ca-root-certificates":{"id":"getting-started/installation-and-upgrade/resources/custom-ca-root-certificates","title":"About Custom CA Root Certificates","description":"If you\'re using Rancher in an internal production environment where you aren\'t exposing apps publicly, use a certificate from a private certificate authority (CA).","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/helm-version-requirements":{"id":"getting-started/installation-and-upgrade/resources/helm-version-requirements","title":"Helm Version Requirements","description":"This section contains the requirements for Helm, which is the tool used to install Rancher on a high-availability Kubernetes cluster.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/local-system-charts":{"id":"getting-started/installation-and-upgrade/resources/local-system-charts","title":"Setting up Local System Charts for Air Gapped Installations","description":"The System Charts repository contains all the catalog items required for features such as monitoring, logging, alerting and global DNS.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/resources":{"id":"getting-started/installation-and-upgrade/resources/resources","title":"Resources","description":"Docker Installations","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/update-rancher-certificate":{"id":"getting-started/installation-and-upgrade/resources/update-rancher-certificate","title":"Updating the Rancher Certificate","description":"Updating a Private CA Certificate","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/upgrade-cert-manager":{"id":"getting-started/installation-and-upgrade/resources/upgrade-cert-manager","title":"Upgrading Cert-Manager","description":"Rancher uses cert-manager to automatically generate and renew TLS certificates for HA deployments of Rancher. As of Fall 2019, three important changes to cert-manager are set to occur that you need to take action on if you have an HA deployment of Rancher:","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/resources/upgrade-cert-manager-helm-2":{"id":"getting-started/installation-and-upgrade/resources/upgrade-cert-manager-helm-2","title":"Upgrading Cert-Manager with Helm 2","description":"Rancher uses cert-manager to automatically generate and renew TLS certificates for HA deployments of Rancher. As of Fall 2019, three important changes to cert-manager are set to occur that you need to take action on if you have an HA deployment of Rancher:","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes":{"id":"getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes","title":"Upgrading and Rolling Back Kubernetes","description":"Following an upgrade to the latest version of Rancher, downstream Kubernetes clusters can be upgraded to use the latest supported version of Kubernetes.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher":{"id":"getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher","title":"Upgrading Kubernetes without Upgrading Rancher","description":"The RKE metadata feature allows you to provision clusters with new versions of Kubernetes as soon as they are released, without upgrading Rancher. This feature is useful for taking advantage of patch versions of Kubernetes, for example, if you want to upgrade to Kubernetes v1.14.7 when your Rancher server originally supported v1.14.6.","sidebar":"tutorialSidebar"},"getting-started/introduction/introduction":{"id":"getting-started/introduction/introduction","title":"Introduction","description":"The overview will discuss Rancher\'s features, capabilities, and how it makes running Kubernetes easy. The guide to the new Rancher docs structure, Divio, will explain more about the updated look and function of our docs.","sidebar":"tutorialSidebar"},"getting-started/introduction/overview":{"id":"getting-started/introduction/overview","title":"Overview","description":"Rancher is a container management platform built for organizations that deploy containers in production. Rancher makes it easy to run Kubernetes everywhere, meet IT requirements, and empower DevOps teams.","sidebar":"tutorialSidebar"},"getting-started/introduction/what-are-divio-docs":{"id":"getting-started/introduction/what-are-divio-docs","title":"What Are Divio Docs?","description":"The Divio documentation system is a software documentation paradigm that is based on functionality and the premise that the best documentation is specific, concise, and purposeful. Divio traditionally consists of four main categories: tutorials, how-to guides, reference guides, and explanations.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-rancher-manager/aws":{"id":"getting-started/quick-start-guides/deploy-rancher-manager/aws","title":"Rancher AWS Quick Start Guide","description":"Read this step by step Rancher AWS guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-rancher-manager/azure":{"id":"getting-started/quick-start-guides/deploy-rancher-manager/azure","title":"Rancher Azure Quick Start Guide","description":"Read this step by step Rancher Azure guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager":{"id":"getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager","title":"Deploying Rancher Server","description":"Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-rancher-manager/digitalocean":{"id":"getting-started/quick-start-guides/deploy-rancher-manager/digitalocean","title":"Rancher DigitalOcean Quick Start Guide","description":"Read this step by step Rancher DigitalOcean guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-rancher-manager/gcp":{"id":"getting-started/quick-start-guides/deploy-rancher-manager/gcp","title":"Rancher GCP Quick Start Guide","description":"Read this step by step Rancher GCP guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-rancher-manager/helm-cli":{"id":"getting-started/quick-start-guides/deploy-rancher-manager/helm-cli","title":"Manual Quick Start","description":"Howdy Partner! This tutorial walks you through:","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-rancher-manager/vagrant":{"id":"getting-started/quick-start-guides/deploy-rancher-manager/vagrant","title":"Rancher Vagrant Quick Start","description":"The following steps quickly deploy a Rancher Server with a single node cluster attached.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-workloads/deploy-workloads":{"id":"getting-started/quick-start-guides/deploy-workloads/deploy-workloads","title":"Deploying Workloads","description":"These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster.","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-workloads/nodeports":{"id":"getting-started/quick-start-guides/deploy-workloads/nodeports","title":"Workload with NodePort Quick Start","description":"Prerequisite","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/deploy-workloads/workload-ingress":{"id":"getting-started/quick-start-guides/deploy-workloads/workload-ingress","title":"Workload with Ingress Quick Start","description":"Prerequisite","sidebar":"tutorialSidebar"},"getting-started/quick-start-guides/quick-start-guides":{"id":"getting-started/quick-start-guides/quick-start-guides","title":"Rancher Deployment Quick Start Guides","description":"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.","sidebar":"tutorialSidebar"},"glossary":{"id":"glossary","title":"Glossary","description":"This page covers Rancher-specific terminology and symbols which might be unfamiliar, or which differ between Rancher versions."},"how-to-guides":{"id":"how-to-guides","title":"How-to Guides","description":"How-to guides serve to describe practical steps for users to accomplish some task. In Rancher, we break down how-to guides further into new user guides and advanced user guides.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/advanced-user-guides":{"id":"how-to-guides/advanced-user-guides/advanced-user-guides","title":"Advanced User Guides","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/about-authentication":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/about-authentication","title":"Authentication","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/authentication-config":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/authentication-config","title":"Configuring Authentication","description":"In the following tutorials, you will learn how to manage users and groups, create local users, configure Google OAuth, configure Active Directory (AD), configure OpenLDAP, configure FreeIPA, configure Azure AD, configure GitHub, configure Keycloak, configure PingIdentity (SAML), configure Okta (SAML), configure Shibboleth (SAML), and how to configure Microsoft AD Federation Service (SAML).","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory","title":"Configure Active Directory (AD)","description":"If your organization uses Microsoft Active Directory as central user repository, you can configure Rancher to communicate with an Active Directory server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the Active Directory, while allowing end-users to authenticate with their AD credentials when logging in to the Rancher UI.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad","title":"Configure Azure AD","description":"Microsoft Graph API","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa","title":"Configuring FreeIPA","description":"If your organization uses FreeIPA for user authentication, you can configure Rancher to allow your users to login using their FreeIPA credentials.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github","title":"Configure GitHub","description":"In environments using GitHub, you can configure Rancher to allow sign on using GitHub credentials.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth","title":"Configuring Google OAuth","description":"If your organization uses G Suite for user authentication, you can configure Rancher to allow your users to log in using their G Suite credentials.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak","title":"Configure Keycloak (SAML)","description":"Create a Keycloak SAML client and configure Rancher to work with Keycloak. By the end your users will be able to sign into Rancher using their Keycloak logins","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml","title":"Configure Okta (SAML)","description":"If your organization uses Okta Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity","title":"Configure PingIdentity (SAML)","description":"If your organization uses Ping Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users","title":"Local Authentication","description":"Local authentication is the default until you configure an external authentication provider. Rancher stores user account information, such as usernames and passwords, locally. By default, the admin user that logs in to Rancher for the first time is a local user.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups","title":"Users and Groups","description":"Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When you configure an external authentication provider, users from that provider will be able to log in to your Rancher server. When a user logs in, the authentication provider will supply your Rancher server with a list of groups to which the user belongs.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml","title":"Configuring Microsoft Active Directory Federation Service (SAML)","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher","title":"1. Configuring Microsoft AD FS for Rancher","description":"Before you configure Rancher to support Active Directory Federation Service (AD FS), you must add Rancher as a relying party trust in AD FS.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs","title":"2. Configuring Rancher for Microsoft AD FS","description":"After you complete Configuring Microsoft AD FS for Rancher, enter your Active Directory Federation Service (AD FS) information into Rancher so that AD FS users can authenticate with Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions","title":"Group Permissions with Shibboleth and OpenLDAP","description":"Because Shibboleth is a SAML provider, it doesn\'t support searching for groups. While a Shibboleth integration can validate user credentials, it can\'t be used to assign permissions to groups in Rancher without additional configuration.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/configure-shibboleth-saml":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/configure-shibboleth-saml","title":"Configuring Shibboleth (SAML)","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers","title":"About Provisioning Drivers","description":"Drivers in Rancher allow you to manage which providers can be used to deploy hosted Kubernetes clusters or nodes in an infrastructure provider to allow Rancher to deploy and manage Kubernetes.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers","title":"Cluster Drivers","description":"Cluster drivers are used to create clusters in a hosted Kubernetes provider, such as Google GKE. The availability of which cluster driver to display when creating clusters is defined by the cluster driver\'s status. Only active cluster drivers will be displayed as an option for creating clusters. By default, Rancher is packaged with several existing cloud provider cluster drivers, but you can also add custom cluster drivers to Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers","title":"Node Drivers","description":"Node drivers are used to provision hosts, which Rancher uses to launch and manage Kubernetes clusters. A node driver is the same as a Docker Machine driver. The availability of which node driver to display when creating node templates is defined based on the node driver\'s status. Only active node drivers will be displayed as an option for creating node templates. By default, Rancher is packaged with many existing Docker Machine drivers, but you can also create custom node drivers to add to Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates","title":"About RKE1 Templates","description":"RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates","title":"Access and Sharing","description":"If you are an RKE template owner, you can share it with users or groups of users, who can then use the template to create clusters.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates","title":"Applying Templates","description":"You can create a cluster from an RKE template that you created, or from a template that has been shared with you.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions","title":"Template Creator Permissions","description":"Administrators have the permission to create RKE templates, and only administrators can give that permission to other users.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates","title":"Enforcing Templates","description":"This section describes how template administrators can enforce templates in Rancher, restricting the ability of users to create clusters without a template.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases","title":"Example Scenarios","description":"These example scenarios describe how an organization could use templates to standardize cluster creation.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure","title":"RKE Templates and Infrastructure","description":"In Rancher, RKE templates are used to provision Kubernetes and define Rancher settings, while node templates are used to provision nodes.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates","title":"Creating and Revising Templates","description":"This section describes how to manage RKE templates and revisions. You an create, share, update, and delete templates from the Global view under Tools > RKE Templates.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings","title":"Overriding Template Settings","description":"When a user creates an RKE template, each setting in the template has a switch in the Rancher UI that indicates if users can override the setting. This switch marks those settings as Allow User Override.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration","title":"Authentication, Permissions and Global Configuration","description":"After installation, the system administrator should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies","title":"Creating Pod Security Policies","description":"Pod Security Policies (or PSPs) are objects that control security-sensitive aspects of pod specification (like root privileges).","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry","title":"Configuring a Global Default Private Registry","description":"You might want to use a private container registry to share your custom base images within your organization. With a private registry, you can keep a private, consistent, and centralized source of truth for the container images that are used in your clusters.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles","title":"Cluster and Project Roles","description":"Cluster and project roles define user authorization inside a cluster or project. You can manage these roles from the Global > Security > Roles page.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles","title":"Custom Roles","description":"Within Rancher, roles determine what actions a user can make within a cluster or project.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions","title":"Global Permissions","description":"Permissions are individual access rights that you can assign when selecting a custom permission for a user.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles","title":"Locked Roles","description":"You can set roles to a status of locked. Locking roles prevent them from being assigned users in the future.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac","title":"Managing Role-Based Access Control (RBAC)","description":"Within Rancher, each person authenticates as a user, which is a login that grants you access to Rancher. As mentioned in Authentication, users can either be local or external.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/cis-scan-guides","title":"CIS Scan Guides","description":"- Install rancher-cis-benchmark","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule","title":"Configure Alerts for Periodic Scan on a Schedule","description":"It is possible to run a ClusterScan on a schedule.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/create-a-custom-benchmark-version-to-run":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/create-a-custom-benchmark-version-to-run","title":"Create a Custom Benchmark Version for Running a Cluster Scan","description":"There could be some Kubernetes cluster setups that require custom configurations of the Benchmark tests. For example, the path to the Kubernetes config files or certs might be different than the standard location where the upstream CIS Benchmarks look for them.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark","title":"Enable Alerting for Rancher CIS Benchmark","description":"Alerts can be configured to be sent out for a scan that runs on a schedule.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark","title":"Install Rancher CIS Benchmark","description":"1. In the upper left corner, click ☰ > Cluster Management.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan","title":"Run a Scan","description":"When a ClusterScan custom resource is created, it launches a new CIS scan on the cluster for the chosen ClusterScanProfile.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule","title":"Run a Scan Periodically on a Schedule","description":"To run a ClusterScan on a schedule,","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests","title":"Skip Tests","description":"CIS scans can be run using test profiles with user-defined skips.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark","title":"Uninstall Rancher CIS Benchmark","description":"1. From the Cluster Dashboard, go to the left navigation bar and click Apps & Marketplace > Installed Apps.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/view-reports":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/view-reports","title":"View Reports","description":"To view the generated CIS scan reports,","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster","title":"Enable Istio in the Cluster","description":"Prerequisites:","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace","title":"Enable Istio in a Namespace","description":"You will need to manually enable Istio in each namespace that you want to be tracked or controlled by Istio. When Istio is enabled in a namespace, the Envoy sidecar proxy will be automatically injected into all new workloads that are deployed in the namespace.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic","title":"Generate and View Traffic from Istio","description":"This section describes how to view the traffic that is being managed by Istio.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/istio-setup-guide","title":"Istio Setup Guides","description":"This section describes how to enable Istio and start using it in your projects.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway","title":"Set up the Istio Gateway","description":"The gateway to each cluster can have its own port or load balancer, which is unrelated to a service mesh. By default, each Rancher-provisioned cluster has one NGINX ingress controller allowing traffic into the cluster.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management","title":"Set up Istio\'s Components for Traffic Management","description":"A central advantage of traffic management in Istio is that it allows dynamic request routing. Some common applications for dynamic request routing include canary deployments and blue/green deployments. The two key resources in Istio traffic management are virtual services and destination rules.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar","title":"Add Deployments and Services with the Istio Sidecar","description":"Prerequisite: To enable Istio for a workload, the cluster and namespace must have the Istio app installed.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/access-clusters":{"id":"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/access-clusters","title":"Access Clusters","description":"This section is about what tools can be used to access clusters managed by Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters":{"id":"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters","title":"Adding Users to Clusters","description":"If you want to provide a user with access and permissions to all projects, nodes, and resources within a cluster, assign the user a cluster membership.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint":{"id":"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint","title":"How the Authorized Cluster Endpoint Works","description":"This section describes how the kubectl CLI, the kubeconfig file, and the authorized cluster endpoint work together to allow you to access a downstream Kubernetes cluster directly, without authenticating through the Rancher server. It is intended to provide background information and context to the instructions for how to set up kubectl to directly access a cluster.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig":{"id":"how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig","title":"Access a Cluster with Kubectl and kubeconfig","description":"Learn how you can access and manage your Kubernetes clusters using kubectl with kubectl Shell or with kubectl CLI and kubeconfig file. A kubeconfig file is used to configure access to Kubernetes. When you create a cluster with Rancher, it automatically creates a kubeconfig for your cluster.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy":{"id":"how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy","title":"Adding a Pod Security Policy","description":"Prerequisite: The options below are available only for clusters that are launched using RKE.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies":{"id":"how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies","title":"Assigning Pod Security Policies","description":"Pod Security Policies are objects that control security-sensitive aspects of pod specification (like root privileges).","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes":{"id":"how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes","title":"Removing Kubernetes Components from Nodes","description":"Learn about cluster cleanup when removing nodes from your Rancher-launched Kubernetes cluster. What is removed, how to do it manually","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration":{"id":"how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration","title":"Cloning Clusters","description":"If you have a cluster in Rancher that you want to use as a template for creating similar clusters, you can use Rancher CLI to clone the cluster\'s configuration, edit it, and then use it to quickly launch the cloned cluster.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage","title":"Create Kubernetes Persistent Volumes and Storage Classes","description":"Learn about the two ways with which you can create persistent storage in Kubernetes: persistent volumes and storage classes","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes","title":"GlusterFS Volumes","description":"This section only applies to RKE clusters.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage","title":"How Persistent Storage Works","description":"A persistent volume (PV) is a piece of storage in the Kubernetes cluster, while a persistent volume claim (PVC) is a request for storage.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage","title":"Dynamically Provisioning New Storage in Rancher","description":"This section describes how to provision new persistent storage for workloads in Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes","title":"iSCSI Volumes","description":"In Rancher Launched Kubernetes clusters that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. This failure is likely due to an incompatibility issue involving the iSCSI initiator tool. You can resolve this issue by installing the iSCSI initiator tool on each of your cluster nodes.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/manage-persistent-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/manage-persistent-storage","title":"Manage Persistent Storage","description":"The following sections will explain how to manage persistent storage:","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage","title":"Setting up Existing Storage","description":"This section describes how to set up existing persistent storage for workloads in Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver","title":"Using an External Ceph Driver","description":"These instructions are about using the external Ceph driver in an RKE2 cluster. If you are using RKE, additional steps are required. For details, refer to this section.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage","title":"NFS Storage","description":"Before you can use the NFS storage volume plug-in with Rancher deployments, you need to provision an NFS server.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs","title":"Creating Persistent Storage in Amazon\'s EBS","description":"This section describes how to set up Amazon\'s Elastic Block Store in EC2.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/provisioning-storage-examples":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/provisioning-storage-examples","title":"Provisioning Storage Examples","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage","title":"VMware vSphere Storage","description":"To provide stateful workloads with vSphere storage, we recommend creating a vSphereVolume StorageClass. This practice dynamically provisions vSphere storage when workloads request volumes through a persistent volume claim.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler":{"id":"how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/install-cluster-autoscaler","title":"Cluster Autoscaler","description":"In this section, you\'ll learn how to install and use the Kubernetes cluster-autoscaler on Rancher custom clusters using AWS EC2 Auto Scaling Groups.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups":{"id":"how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups","title":"Cluster Autoscaler with AWS EC2 Auto Scaling Groups","description":"This guide will show you how to install and use Kubernetes cluster-autoscaler on Rancher custom clusters using AWS EC2 Auto Scaling Groups.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/manage-clusters":{"id":"how-to-guides/advanced-user-guides/manage-clusters/manage-clusters","title":"Cluster Administration","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools":{"id":"how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools","title":"Nodes and Node Pools","description":"After you launch a Kubernetes cluster in Rancher, you can manage individual nodes from the cluster\'s Node tab. Depending on the option used to provision the cluster, there are different node options available.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces":{"id":"how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces","title":"Projects and Kubernetes Namespaces with Rancher","description":"Rancher Projects ease the administrative burden of your cluster and support multi-tenancy. Learn to create projects and divide projects into Kubernetes namespaces","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates":{"id":"how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates","title":"Certificate Rotation","description":"Warning: Rotating Kubernetes certificates may result in your cluster being temporarily unavailable as components are restarted. For production environments, it\'s recommended to perform this action during a maintenance window.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects":{"id":"how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects","title":"Adding Users to Projects","description":"If you want to provide a user with access and permissions to specific projects and resources within a cluster, assign the user a project membership.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-namespaces":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-namespaces","title":"Namespaces","description":"Within Rancher, you can further divide projects into different namespaces, which are virtual clusters within a project backed by a physical cluster. Should you require another level of organization beyond projects and the default namespace, you can use multiple namespaces to isolate applications and resources.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies","title":"Applying Pod Security Policies to Projects","description":"These cluster options are only available for clusters in which Rancher has launched Kubernetes.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas","title":"How Resource Quotas Work in Rancher Projects","description":"Resource quotas in Rancher include the same functionality as the native version of Kubernetes. However, in Rancher, resource quotas have been extended so that you can apply them to projects.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/manage-project-resource-quotas","title":"Project Resource Quotas","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces","title":"Overriding the Default Limit for a Namespace","description":"Although the Namespace Default Limit propagates from the project to each namespace when created, in some cases, you may need to increase (or decrease) the quotas for a specific namespace. In this situation, you can override the default limits by editing the namespace.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types","title":"Resource Quota Type Reference","description":"When you create a resource quota, you are configuring the pool of resources available to the project. You can set the following resource limits for the following resource types.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/set-container-default-resource-limits":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/set-container-default-resource-limits","title":"Setting Container Default Resource Limits","description":"When setting resource quotas, if you set anything related to CPU or Memory (i.e. limits or reservations) on a project / namespace, all containers will require a respective CPU or Memory field set during creation. See the Kubernetes documentation for more details on why this is required.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/manage-projects/manage-projects":{"id":"how-to-guides/advanced-user-guides/manage-projects/manage-projects","title":"Project Administration","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard","title":"Persistent Grafana Dashboards","description":"To allow the Grafana dashboard to persist after the Grafana instance restarts, add the dashboard configuration JSON into a ConfigMap. ConfigMaps also allow the dashboards to be deployed with a GitOps or CD based approach. This allows the dashboard to be put under version control.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard","title":"Customizing Grafana Dashboards","description":"In this section, you\'ll learn how to customize the Grafana dashboard to show metrics that apply to a certain container.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage","title":"Debugging High Memory Usage","description":"Every time series in Prometheus is uniquely identified by its metric name and optional key-value pairs called labels.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring","title":"Enable Monitoring","description":"As an administrator or cluster owner, you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring","title":"Migrating to Rancher v2.5 Monitoring","description":"If you previously enabled Monitoring, Alerting, or Notifiers in Rancher before v2.5, there is no automatic upgrade path for switching to the new monitoring/alerting solution. Before deploying the new monitoring solution via Cluster Explore, you will need to disable and remove all existing custom alerts, notifiers and monitoring installations for the whole cluster and in all projects.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides","title":"Monitoring/Alerting Guides","description":"- Enable monitoring","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads","title":"Setting up Monitoring for a Workload","description":"If you only need CPU and memory time series for the workload, you don\'t need to deploy a ServiceMonitor or PodMonitor because the monitoring application already collects metrics data on resource usage by default.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring":{"id":"how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring","title":"Uninstall Monitoring","description":"1. From the Cluster Explorer, click Apps & Marketplace.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration":{"id":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration","title":"Advanced Configuration","description":"Alertmanager","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager":{"id":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager","title":"Alertmanager Configuration","description":"It is usually not necessary to directly edit the Alertmanager custom resource. For most use cases, you will only need to edit the Receivers and Routes to configure notifications.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus":{"id":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus","title":"Prometheus Configuration","description":"It is usually not necessary to directly edit the Prometheus custom resource because the monitoring application automatically updates it based on changes to ServiceMonitors and PodMonitors.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules":{"id":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules","title":"Configuring PrometheusRules","description":"A PrometheusRule defines a group of Prometheus alerting and/or recording rules.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides":{"id":"how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides","title":"Monitoring V2 Configuration Guides","description":"This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher","title":"Backing up Rancher Installed with Docker","description":"After completing your Docker installation of Rancher, we recommend creating backups of it on a regular basis. Having a recent backup will let you recover quickly from an unexpected disaster.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher","title":"Backing up Rancher","description":"In this section, you\'ll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer to the instructions for single node backups.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters","title":"Backing up a Cluster","description":"In the Rancher UI, etcd backup and recovery for Rancher launched Kubernetes clusters can be easily performed.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery","title":"Backup, Restore, and Disaster Recovery","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster","title":"Migrating Rancher to a New Cluster","description":"If you are migrating Rancher to a new Kubernetes cluster, you don\'t need to install Rancher on the new cluster first. If Rancher is restored to a new cluster with Rancher already installed, it can cause problems.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher","title":"Restoring Backups—Docker Installs","description":"If you encounter a disaster scenario, you can restore your Rancher Server to your most recent backup.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher","title":"Restoring Rancher","description":"A restore is performed by creating a Restore custom resource.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup","title":"Restoring a Cluster from Backup","description":"Etcd backup and recovery for Rancher launched Kubernetes clusters can be easily performed. Snapshots of the etcd database are taken and saved either locally onto the etcd nodes or to a S3 compatible target. The advantages of configuring S3 is that if all etcd nodes are lost, your snapshot is saved remotely and can be used to restore the cluster.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters":{"id":"how-to-guides/new-user-guides/deploy-apps-across-clusters/deploy-apps-across-clusters","title":"Deploying Applications across Clusters","description":"Rancher offers several ways to deploy applications across clusters, depending on version.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet":{"id":"how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet","title":"Fleet - GitOps at Scale","description":"Available as of Rancher v2.5","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps":{"id":"how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps","title":"Multi-cluster Apps","description":"As of Rancher v2.5, we now recommend using Fleet for deploying apps across clusters.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher","title":"Helm Charts and Apps","description":"In this section, you\'ll learn how to manage Helm chart repositories and apps in Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer":{"id":"how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer","title":"Setting up Amazon ELB Network Load Balancer","description":"This how-to guide describes how to set up a Network Load Balancer (NLB) in Amazon\'s EC2 service that will direct traffic to multiple instances on EC2.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster":{"id":"how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster","title":"Setting up Infrastructure for a High Availability K3s Kubernetes Cluster","description":"This tutorial is intended to help you provision the underlying infrastructure for a Rancher management server.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster":{"id":"how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster","title":"Setting up Infrastructure for a High Availability RKE Kubernetes Cluster","description":"This tutorial is intended to help you create a high-availability RKE cluster that can be used to install a Rancher server.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster":{"id":"how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster","title":"Setting up Infrastructure for a High Availability RKE2 Kubernetes Cluster","description":"This tutorial is intended to help you provision the underlying infrastructure for a Rancher management server.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup":{"id":"how-to-guides/new-user-guides/infrastructure-setup/infrastructure-setup","title":"Infrastructure Setup","description":"Don\'t have infrastructure for your Kubernetes cluster? Try one of these tutorials.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds":{"id":"how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds","title":"Setting up a MySQL Database in Amazon RDS","description":"This tutorial describes how to set up a MySQL database in Amazon\'s Relational Database Service (RDS).","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer":{"id":"how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer","title":"Setting up an NGINX Load Balancer","description":"NGINX will be configured as Layer 4 load balancer (TCP) that forwards connections to one of your Rancher nodes.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2":{"id":"how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2","title":"Setting up Nodes in Amazon EC2","description":"In this tutorial, you will learn one way to set up Linux nodes for the Rancher management server. These nodes will fulfill the node requirements for OS, Docker, hardware, and networking.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs":{"id":"how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs","title":"About High-availability Installations","description":"We recommend using Helm, a Kubernetes package manager, to install Rancher on a dedicated Kubernetes cluster. This is called a high-availability Kubernetes installation because increased availability is achieved by running Rancher on multiple nodes.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher":{"id":"how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher","title":"Setting up a High-availability K3s Kubernetes Cluster for Rancher","description":"This section describes how to install a Kubernetes cluster according to the best practices for the Rancher server environment.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup":{"id":"how-to-guides/new-user-guides/kubernetes-cluster-setup/kubernetes-cluster-setup","title":"Setting up a Kubernetes Cluster for Rancher Server","description":"Don\'t have a Kubernetes cluster? Try one of these tutorials.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher":{"id":"how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher","title":"Setting up a High-availability RKE Kubernetes Cluster","description":"This section describes how to install a Kubernetes cluster. This cluster should be dedicated to run only the Rancher server.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher":{"id":"how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher","title":"Setting up a High-availability RKE2 Kubernetes Cluster for Rancher","description":"Tested on v2.5.6","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/checklist-for-production-ready-clusters","title":"Checklist for Production-Ready Clusters","description":"In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture","title":"Recommended Cluster Architecture","description":"There are three roles that can be assigned to nodes: etcd, controlplane and worker.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes","title":"Roles for Nodes in Kubernetes","description":"This section describes the roles for etcd nodes, controlplane nodes, and worker nodes in Kubernetes, and how the roles work together in a cluster.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup","title":"Kubernetes Clusters in Rancher Setup","description":"Provisioning Kubernetes Clusters","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents","title":"Rancher Agents","description":"There are two different agent resources deployed on Rancher managed clusters:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher","title":"Launching Kubernetes with Rancher","description":"You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, it uses Rancher Kubernetes Engine (RKE), which is Rancher\'s own lightweight Kubernetes installer. It can launch Kubernetes on any computers, including:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon","title":"Setting up the Amazon Cloud Provider","description":"When using the Amazon cloud provider, you can leverage the following capabilities:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure","title":"Setting up the Azure Cloud Provider","description":"When using the Azure cloud provider, you can leverage the following capabilities:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine","title":"Setting up the Google Compute Engine Cloud Provider","description":"In this section, you\'ll learn how to enable the Google Compute Engine (GCE) cloud provider for custom clusters in Rancher. A custom cluster is one in which Rancher installs Kubernetes on existing nodes.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/other-cloud-providers":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/other-cloud-providers","title":"Other Cloud Providers","description":"The following sections will outline how to set up the following cloud providers:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/set-up-cloud-providers":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/set-up-cloud-providers","title":"Setting up Cloud Providers","description":"A cloud provider is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere","title":"Configuring an In-tree VMware vSphere Cloud Provider","description":"To set up the in-tree VMware vSphere cloud provider, follow these steps while creating the vSphere cluster in Rancher:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere","title":"Configuring an Out-of-tree vSphere Cloud Provider","description":"Available as of v2.5+","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree","title":"Migrating vSphere In-tree Volumes to Out-of-tree","description":"Available as of v2.5+","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/vsphere":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/vsphere","title":"Setting up the vSphere Cloud Provider","description":"In this section, you\'ll learn how to set up a vSphere cloud provider for a Rancher managed RKE Kubernetes cluster in vSphere.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster","title":"Creating a DigitalOcean Cluster","description":"In this section, you\'ll learn how to use Rancher to install an RKE Kubernetes cluster in DigitalOcean.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster","title":"Creating an Amazon EC2 Cluster","description":"Learn the prerequisites and steps required in order for you to create an Amazon EC2 cluster using Rancher","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster","title":"Creating an Azure Cluster","description":"In this section, you\'ll learn how to install an RKE Kubernetes cluster in Azure through Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider","title":"Launching Kubernetes on New Nodes in an Infrastructure Provider","description":"Using Rancher, you can create pools of nodes based on a node template. This node template defines the parameters you want to use to launch nodes in your infrastructure providers or cloud providers.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials","title":"Creating Credentials in the VMware vSphere Console","description":"This section describes how to create a VMware vSphere username and password. You must provide these vSphere credentials to Rancher, which allows Rancher to provision resources in vSphere.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere","title":"Provisioning Kubernetes Clusters in VMware vSphere","description":"In this section, you\'ll learn how to use Rancher to install an RKE Kubernetes cluster in VMware vSphere.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere","title":"Creating a VMware vSphere Cluster","description":"Use Rancher to create a VMware vSphere cluster. It may consist of groups of VMs with distinct properties which allow for fine-grained control over the sizing of nodes.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration","title":"Configuring Storage Classes in Azure","description":"If you are using Azure VMs for your nodes, you can use Azure files as a StorageClass for the cluster.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway","title":"Networking Requirements for Host Gateway (L2bridge)","description":"This section describes how to configure custom Windows clusters that are using Host Gateway (L2bridge) mode.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/use-windows-clusters":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/use-windows-clusters","title":"Launching Kubernetes on Windows Clusters","description":"When provisioning a custom cluster using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/windows-linux-cluster-feature-parity":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/windows-linux-cluster-feature-parity","title":"Windows and Linux Cluster Feature Parity","description":"Windows clusters do not share the same feature support as Linux clusters.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters","title":"Node Requirements for Rancher Managed Clusters","description":"This page describes the requirements for the Rancher managed Kubernetes clusters where your apps and services will be installed. These downstream clusters should be separate from the three-node cluster running Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters","title":"Registering Existing Clusters","description":"The cluster registration feature replaced the feature to import clusters.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks","title":"Creating an AKS Cluster","description":"You can use Rancher to create a cluster hosted in Microsoft Azure Kubernetes Service (AKS).","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba","title":"Creating an Aliyun ACK Cluster","description":"You can use Rancher to create a cluster hosted in Alibaba Cloud Kubernetes (ACK). Rancher has already implemented and packaged the cluster driver for ACK, but by default, this cluster driver is inactive. In order to launch ACK clusters, you will need to enable the ACK cluster driver. After enabling the cluster driver, you can start provisioning ACK clusters.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke","title":"Managing GKE Clusters","description":"Prerequisites","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei","title":"Creating a Huawei CCE Cluster","description":"You can use Rancher to create a cluster hosted in Huawei Cloud Container Engine (CCE). Rancher has already implemented and packaged the cluster driver for CCE, but by default, this cluster driver is inactive. In order to launch CCE clusters, you will need to enable the CCE cluster driver. After enabling the cluster driver, you can start provisioning CCE clusters.","sidebar":"tutorialSidebar"},"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":{"id":"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","title":"Setting up Clusters from Hosted Kubernetes Providers","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent","title":"Creating a Tencent TKE Cluster","description":"You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE). Rancher has already implemented and packaged the cluster driver for TKE, but by default, this cluster driver is inactive. In order to launch TKE clusters, you will need to enable the TKE cluster driver. After enabling the cluster driver, you can start provisioning TKE clusters.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps","title":"ConfigMaps","description":"While most types of Kubernetes secrets store sensitive information, ConfigMaps store general configuration information, such as a group of config files. Because ConfigMaps don\'t store sensitive information, they can be updated automatically, and therefore don\'t require their containers to be restarted following update (unlike most secret types, which require manual updates and a container restart to take effect).","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/create-services":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/create-services","title":"Service Discovery","description":"For every workload created, a complementing Service Discovery entry is created. This Service Discovery entry enables DNS resolution for the workload\'s pods using the following naming convention:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication","title":"Encrypting HTTP Communication","description":"Learn how to add an SSL (Secure Sockets Layer) certificate or TLS (Transport Layer Security) certificate to either a project, a namespace, or both, so that you can add it to deployments","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas","title":"Background Information on HPAs","description":"The Horizontal Pod Autoscaler (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it\'s running up or down. This section provides explanation on how HPA works with Kubernetes.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler","title":"Horizontal Pod Autoscaler","description":"Learn about the horizontal pod autoscaler (HPA). How to manage HPAs and how to test them with a service deployment","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl","title":"Managing HPAs with kubectl","description":"This section describes HPA management with kubectl. This document has instructions for how to:","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui","title":"Managing HPAs with the Rancher UI","description":"The Rancher UI supports creating, managing, and deleting HPAs. You can configure CPU or memory usage as the metric that the HPA uses to scale.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl","title":"Testing HPAs with kubectl","description":"This document describes how to check the status of your HPAs after scaling them up or down with your load testing tool. For information on how to check the status from the Rancher UI (at least version 2.3.x), refer to Managing HPAs with the Rancher UI.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries","title":"Kubernetes Registry and Docker Registry","description":"Learn about the Docker registry and Kubernetes registry, their use cases and how to use a private registry with the Rancher UI","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup","title":"Kubernetes Resources Setup","description":"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.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses","title":"Adding Ingresses to Your Project","description":"Ingresses can be added for workloads to provide load balancing, SSL termination and host/path-based routing. Learn how to add Rancher ingress to your project","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing","title":"Layer 4 and Layer 7 Load Balancing","description":"Kubernetes supports load balancing in two ways: Layer-4 Load Balancing and Layer-7 Load Balancing. Learn about the support for each way in different deployments","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/load-balancer-and-ingress-controller","title":"Load Balancer and Ingress Controller Setup within Rancher","description":"Learn how you can set up load balancers and ingress controllers to redirect service requests within Rancher, and learn about the limitations of load balancers","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/secrets":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/secrets","title":"Secrets","description":"Secrets store sensitive data like passwords, tokens, or keys. They may contain one or more key value pairs.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar","title":"Adding a Sidecar","description":"A sidecar is a container that extends or enhances the main container in a pod. The main container and the sidecar share a pod, and therefore share the same network space and storage. You can add sidecars to existing workloads by using the Add a Sidecar option.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads","title":"Deploying Workloads","description":"Read this step by step guide for deploying workloads. Deploy a workload to run an application in one or more containers.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads","title":"Rolling Back Workloads","description":"Sometimes there is a need to rollback to the previous version of the application, either for debugging purposes or because an upgrade did not go as planned.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads","title":"Upgrading Workloads","description":"When a new version of an application image is released on Docker Hub, you can upgrade any workloads running a previous version of the application to the new one.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/workloads-and-pods","title":"Kubernetes Workloads and Pods","description":"Learn about the two constructs with which you can build any complex containerized application in Kubernetes: Kubernetes workloads and pods","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/new-user-guides":{"id":"how-to-guides/new-user-guides/new-user-guides","title":"New User Guides","description":"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\\".","sidebar":"tutorialSidebar"},"rancher-manager":{"id":"rancher-manager","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.","sidebar":"tutorialSidebar"},"reference-guides":{"id":"reference-guides","title":"Reference Guides","description":"Reference guides are technical descriptions of processes or products that users can study. Reference guides are designed to be \\"information-oriented\\" and their primary function is to describe.","sidebar":"tutorialSidebar"},"reference-guides/about-the-api/about-the-api":{"id":"reference-guides/about-the-api/about-the-api","title":"API","description":"How to use the API","sidebar":"tutorialSidebar"},"reference-guides/about-the-api/api-tokens":{"id":"reference-guides/about-the-api/api-tokens","title":"API Tokens","description":"By default, some cluster-level API tokens are generated with infinite time-to-live (ttl=0). In other words, API tokens with ttl=0 never expire unless you invalidate them. Tokens are not invalidated by changing a password.","sidebar":"tutorialSidebar"},"reference-guides/amazon-eks-permissions/amazon-eks-permissions":{"id":"reference-guides/amazon-eks-permissions/amazon-eks-permissions","title":"Creating an EKS Cluster","description":"Amazon EKS provides a managed control plane for your Kubernetes cluster. Amazon EKS runs the Kubernetes control plane instances across multiple Availability Zones to ensure high availability. Rancher provides an intuitive user interface for managing and deploying the Kubernetes clusters you run in Amazon EKS. With this guide, you will use Rancher to quickly and easily launch an Amazon EKS Kubernetes cluster in your AWS account. For more information on Amazon EKS, see this documentation.","sidebar":"tutorialSidebar"},"reference-guides/amazon-eks-permissions/minimum-eks-permissions":{"id":"reference-guides/amazon-eks-permissions/minimum-eks-permissions","title":"Minimum EKS Permissions","description":"Documented here is a minimum set of permissions necessary to use all functionality of the EKS driver in Rancher. Additional permissions are required for Rancher to provision the Service Role and VPC resources. Optionally these resources can be created before the cluster creation and will be selectable when defining the cluster configuration.","sidebar":"tutorialSidebar"},"reference-guides/backup-restore-configuration/backup-configuration":{"id":"reference-guides/backup-restore-configuration/backup-configuration","title":"Backup Configuration","description":"The Backup Create page lets you configure a schedule, enable encryption and specify the storage location for your backups.","sidebar":"tutorialSidebar"},"reference-guides/backup-restore-configuration/backup-restore-configuration":{"id":"reference-guides/backup-restore-configuration/backup-restore-configuration","title":"Rancher Backup Configuration Reference","description":"- Backup configuration","sidebar":"tutorialSidebar"},"reference-guides/backup-restore-configuration/examples":{"id":"reference-guides/backup-restore-configuration/examples","title":"Backup and Restore Examples","description":"This section contains examples of Backup and Restore custom resources.","sidebar":"tutorialSidebar"},"reference-guides/backup-restore-configuration/restore-configuration":{"id":"reference-guides/backup-restore-configuration/restore-configuration","title":"Restore Configuration","description":"The Restore Create page lets you provide details of the backup to restore from","sidebar":"tutorialSidebar"},"reference-guides/backup-restore-configuration/storage-configuration":{"id":"reference-guides/backup-restore-configuration/storage-configuration","title":"Backup Storage Location Configuration","description":"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 object store.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/best-practices":{"id":"reference-guides/best-practices/best-practices","title":"Best Practice Guides","description":"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.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-managed-clusters/logging-best-practices":{"id":"reference-guides/best-practices/rancher-managed-clusters/logging-best-practices","title":"Logging Best Practices","description":"In this guide, we recommend best practices for cluster-level logging and application logging.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices":{"id":"reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices","title":"Monitoring Best Practices","description":"Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters":{"id":"reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters","title":"Best Practices for Rancher Managed Clusters","description":"Logging","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere":{"id":"reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere","title":"Best Practices for Rancher Managed VMware vSphere Clusters","description":"This guide outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers":{"id":"reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers","title":"Tips for Setting Up Containers","description":"Running well-built containers can greatly impact the overall performance and security of your environment.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere":{"id":"reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere","title":"Installing Rancher in a VMware vSphere Environment","description":"This guide outlines a reference architecture for installing Rancher on an RKE Kubernetes cluster in a VMware vSphere environment. It also desctibes standard vSphere best practices as documented by VMware.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-server/rancher-deployment-strategy":{"id":"reference-guides/best-practices/rancher-server/rancher-deployment-strategy","title":"Rancher Deployment Strategy","description":"There are two recommended deployment strategies for a Rancher server that manages downstream Kubernetes clusters. Each one has its own pros and cons. Read more about which one would fit best for your use case.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-server/rancher-server":{"id":"reference-guides/best-practices/rancher-server/rancher-server","title":"Best Practices for the Rancher Server","description":"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.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/rancher-server/tips-for-running-rancher":{"id":"reference-guides/best-practices/rancher-server/tips-for-running-rancher","title":"Tips for Running Rancher","description":"This guide is geared toward use cases where Rancher is used to manage downstream Kubernetes clusters. The high-availability setup is intended to prevent losing access to downstream clusters if the Rancher server is not available.","sidebar":"tutorialSidebar"},"reference-guides/cli-with-rancher/cli-with-rancher":{"id":"reference-guides/cli-with-rancher/cli-with-rancher","title":"CLI with Rancher","description":"Interact with Rancher using command line interface (CLI) tools from your workstation. The following docs will describe the Rancher CLI and kubectl Utility.","sidebar":"tutorialSidebar"},"reference-guides/cli-with-rancher/kubectl-utility":{"id":"reference-guides/cli-with-rancher/kubectl-utility","title":"kubectl Utility","description":"kubectl","sidebar":"tutorialSidebar"},"reference-guides/cli-with-rancher/rancher-cli":{"id":"reference-guides/cli-with-rancher/rancher-cli","title":"Rancher CLI","description":"Interact with Rancher using command line interface (CLI) tools from your workstation.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/cluster-configuration":{"id":"reference-guides/cluster-configuration/cluster-configuration","title":"Cluster Configuration","description":"After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration","title":"Downstream Cluster Configuration","description":"The following docs will discuss node template configuration.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2","title":"EC2 Node Template Configuration","description":"For more details about EC2, nodes, refer to the official documentation for the EC2 Management Console.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure","title":"Azure Node Template Configuration","description":"For more information about Azure, refer to the official Azure documentation.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean","title":"DigitalOcean Node Template Configuration","description":"Account access information is stored as a cloud credential. Cloud credentials are stored as Kubernetes secrets. Multiple node templates can use the same cloud credential. You can use an existing cloud credential or create a new one.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/node-template-configuration","title":"Node Template Configuration","description":"To learn about node template config, refer to EC2 Node Template Configuration, DigitalOcean Node Template Configuration, Azure Node Template Configuration, and vSphere Node Template Configuration.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere","title":"VMware vSphere Node Template Configuration","description":"The following node template configuration reference applies to Rancher v2.3.3+.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration","title":"EKS Cluster Configuration Reference","description":"Account Access","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration","title":"GKE Cluster Configuration Reference","description":"Changes in v2.5.8","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters","title":"Private Clusters","description":"Available as of v2.5.8","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration","title":"Rancher Server Configuration","description":"- RKE1 Cluster Configuration","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/rancherd-configuration-reference":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/rancherd-configuration-reference","title":"RancherD Configuration Reference","description":"Note: RancherD was an experimental feature available as part of Rancher v2.5.4 through v2.5.10 but is now deprecated and not available for recent releases.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration","title":"RKE Cluster Configuration","description":"In clusters launched by RKE, you can edit any of the remaining options that follow.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters","title":"Syncing Hosted Clusters","description":"Syncing is the feature for EKS and GKE clusters that causes Rancher to update the clusters\' values so they are up to date with their corresponding cluster object in the hosted Kubernetes provider. This enables Rancher to not be the sole owner of a hosted cluster’s state. Its largest limitation is that processing an update from Rancher and another source at the same time or within 5 minutes of one finishing may cause the state from one source to completely overwrite the other.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options","title":"Rancher Agent Options","description":"Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to create a cluster with custom nodes and add the options to the generated docker run command when adding a node.","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes":{"id":"reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes","title":"Launching Kubernetes on Existing Custom Nodes","description":"To create a cluster with custom nodes, you’ll need to access servers in your cluster and provision them according to Rancher requirements","sidebar":"tutorialSidebar"},"reference-guides/configure-openldap/configure-openldap":{"id":"reference-guides/configure-openldap/configure-openldap","title":"Configuring OpenLDAP","description":"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.","sidebar":"tutorialSidebar"},"reference-guides/configure-openldap/openldap-config-reference":{"id":"reference-guides/configure-openldap/openldap-config-reference","title":"OpenLDAP Configuration Reference","description":"For further details on configuring OpenLDAP authentication, refer to the official documentation.","sidebar":"tutorialSidebar"},"reference-guides/installation-references/feature-flags":{"id":"reference-guides/installation-references/feature-flags","title":"Feature Flags","description":"With feature flags, you can try out optional or experimental features.","sidebar":"tutorialSidebar"},"reference-guides/installation-references/helm-chart-options":{"id":"reference-guides/installation-references/helm-chart-options","title":"Rancher Helm Chart Options","description":"This page is a configuration reference for the Rancher Helm chart.","sidebar":"tutorialSidebar"},"reference-guides/installation-references/installation-references":{"id":"reference-guides/installation-references/installation-references","title":"Installation References","description":"Please see the following reference guides for other installation resources: Rancher Helm chart options, TLS settings, and feature flags.","sidebar":"tutorialSidebar"},"reference-guides/installation-references/tls-settings":{"id":"reference-guides/installation-references/tls-settings","title":"TLS Settings","description":"Changing the default TLS settings depends on the chosen installation method.","sidebar":"tutorialSidebar"},"reference-guides/kubernetes-concepts":{"id":"reference-guides/kubernetes-concepts","title":"Kubernetes Concepts","description":"This page explains concepts related to Kubernetes that are important for understanding how Rancher works. The descriptions below provide a simplified interview of Kubernetes components. For more details, refer to the official documentation on Kubernetes components.","sidebar":"tutorialSidebar"},"reference-guides/monitoring-v2-configuration/examples":{"id":"reference-guides/monitoring-v2-configuration/examples","title":"Monitoring V2 Configuration Examples","description":"ServiceMonitor","sidebar":"tutorialSidebar"},"reference-guides/monitoring-v2-configuration/helm-chart-options":{"id":"reference-guides/monitoring-v2-configuration/helm-chart-options","title":"Helm Chart Options","description":"Configuring Resource Limits and Requests","sidebar":"tutorialSidebar"},"reference-guides/monitoring-v2-configuration/monitoring-v2-configuration":{"id":"reference-guides/monitoring-v2-configuration/monitoring-v2-configuration","title":"Monitoring V2 Configuration","description":"The following sections will explain important options essential to configuring Monitoring V2 in Rancher:","sidebar":"tutorialSidebar"},"reference-guides/monitoring-v2-configuration/receivers":{"id":"reference-guides/monitoring-v2-configuration/receivers","title":"Receiver Configuration","description":"The Alertmanager Config Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus.","sidebar":"tutorialSidebar"},"reference-guides/monitoring-v2-configuration/routes":{"id":"reference-guides/monitoring-v2-configuration/routes","title":"Route Configuration","description":"The route configuration is the section of the Alertmanager custom resource that controls how the alerts fired by Prometheus are grouped and filtered before they reach the receiver.","sidebar":"tutorialSidebar"},"reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors":{"id":"reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors","title":"ServiceMonitor and PodMonitor Configuration","description":"ServiceMonitors and PodMonitors are both pseudo-CRDs that map the scrape configuration of the Prometheus custom resource.","sidebar":"tutorialSidebar"},"reference-guides/rancher-cluster-tools":{"id":"reference-guides/rancher-cluster-tools","title":"Tools for Logging, Monitoring, and Visibility","description":"Rancher contains a variety of tools that aren\'t included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently.","sidebar":"tutorialSidebar"},"reference-guides/rancher-manager-architecture/architecture-recommendations":{"id":"reference-guides/rancher-manager-architecture/architecture-recommendations","title":"Architecture Recommendations","description":"Kubernetes cluster. If you are installing Rancher on a single node, the main architecture recommendation that applies to your installation is that the node running Rancher should be separate from downstream clusters.","sidebar":"tutorialSidebar"},"reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters":{"id":"reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters","title":"Communicating with Downstream User Clusters","description":"This section describes how Rancher provisions and manages the downstream user clusters that run your apps and services.","sidebar":"tutorialSidebar"},"reference-guides/rancher-manager-architecture/rancher-manager-architecture":{"id":"reference-guides/rancher-manager-architecture/rancher-manager-architecture","title":"Rancher Architecture","description":"This section focuses on the Rancher server and its components and how Rancher communicates with downstream Kubernetes clusters.","sidebar":"tutorialSidebar"},"reference-guides/rancher-manager-architecture/rancher-server-and-components":{"id":"reference-guides/rancher-manager-architecture/rancher-server-and-components","title":"Rancher Server and Components","description":"The majority of Rancher 2.x software runs on the Rancher Server. Rancher Server includes all the software components used to manage the entire Rancher deployment.","sidebar":"tutorialSidebar"},"reference-guides/rancher-project-tools":{"id":"reference-guides/rancher-project-tools","title":"Tools for Logging, Monitoring, and Visibility","description":"Rancher contains a variety of tools that aren\'t included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/kubernetes-security-best-practices":{"id":"reference-guides/rancher-security/kubernetes-security-best-practices","title":"Kubernetes Security Best Practices","description":"Restricting cloud metadata API access","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-security":{"id":"reference-guides/rancher-security/rancher-security","title":"Rancher Security Guides","description":"Security policy","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.5-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.5-benchmark","title":"Hardening Guide with CIS 1.5 Benchmark","description":"This document provides prescriptive guidance for hardening a production installation of a RKE cluster to be used with Rancher v2.5. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS)."},"reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.6-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/hardening-guide-with-cis-v1.6-benchmark","title":"Hardening Guide with CIS 1.6 Benchmark","description":"This document provides prescriptive guidance for hardening a production installation of a RKE cluster to be used with Rancher v2.5.4. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.5-hardening-guides/rancher-v2.5-hardening-guides":{"id":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/rancher-v2.5-hardening-guides","title":"Self-Assessment and Hardening Guides for Rancher v2.5","description":"Rancher v2.5 introduced the capability to deploy Rancher on any Kubernetes cluster. For that reason, we now provide separate security hardening guides for Rancher deployments on each of Rancher\'s Kubernetes distributions.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.5-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.5-benchmark","title":"CIS 1.5 Benchmark - Self-Assessment Guide - Rancher v2.5","description":"CIS v1.5 Kubernetes Benchmark - Rancher v2.5 with Kubernetes v1.15"},"reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.6-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.5-hardening-guides/self-assessment-guide-with-cis-v1.6-benchmark","title":"CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.5.4","description":"CIS 1.6 Kubernetes Benchmark - Rancher v2.5.4 with Kubernetes v1.18","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/security-advisories-and-cves":{"id":"reference-guides/rancher-security/security-advisories-and-cves","title":"Security Advisories and CVEs","description":"Rancher is committed to informing the community of security issues in our products. Rancher will publish security advisories and CVEs (Common Vulnerabilities and Exposures) for issues we have resolved. New security advisories are also published in Rancher\'s GitHub security page.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/selinux-rpm/about-rancher-selinux":{"id":"reference-guides/rancher-security/selinux-rpm/about-rancher-selinux","title":"About rancher-selinux","description":"To allow Rancher to work with SELinux, some functionality has to be manually enabled for the SELinux nodes. To help with that, Rancher provides a SELinux RPM.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/selinux-rpm/about-rke2-selinux":{"id":"reference-guides/rancher-security/selinux-rpm/about-rke2-selinux","title":"About rke2-selinux","description":"rke2-selinux provides policies for RKE2. It is installed automatically when the RKE2 installer script detects that it is running on an RPM-based distro.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/selinux-rpm/selinux-rpm":{"id":"reference-guides/rancher-security/selinux-rpm/selinux-rpm","title":"SELinux RPM","description":"Available as of v2.5.8","sidebar":"tutorialSidebar"},"reference-guides/rke1-template-example-yaml":{"id":"reference-guides/rke1-template-example-yaml","title":"RKE1 Example YAML","description":"Below is an example RKE template configuration file for reference.","sidebar":"tutorialSidebar"},"reference-guides/single-node-rancher-in-docker/advanced-options":{"id":"reference-guides/single-node-rancher-in-docker/advanced-options","title":"Advanced Options for Docker Installs","description":"When installing Rancher, there are several advanced options that can be enabled:","sidebar":"tutorialSidebar"},"reference-guides/single-node-rancher-in-docker/http-proxy-configuration":{"id":"reference-guides/single-node-rancher-in-docker/http-proxy-configuration","title":"HTTP Proxy Configuration","description":"If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below.","sidebar":"tutorialSidebar"},"reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker":{"id":"reference-guides/single-node-rancher-in-docker/single-node-rancher-in-docker","title":"Single Node Rancher in Docker","description":"The following docs will discuss HTTP proxy configuration and advanced options for Docker installs.","sidebar":"tutorialSidebar"},"reference-guides/system-tools":{"id":"reference-guides/system-tools","title":"System Tools","description":"System Tools is a tool to perform operational tasks on Rancher Launched Kubernetes clusters or installations of Rancher on an RKE cluster. The tasks include:","sidebar":"tutorialSidebar"},"reference-guides/user-settings/api-keys":{"id":"reference-guides/user-settings/api-keys","title":"API Keys","description":"API Keys and User Authentication","sidebar":"tutorialSidebar"},"reference-guides/user-settings/manage-cloud-credentials":{"id":"reference-guides/user-settings/manage-cloud-credentials","title":"Managing Cloud Credentials","description":"When you create a cluster hosted by an infrastructure provider, node templates are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node.","sidebar":"tutorialSidebar"},"reference-guides/user-settings/manage-node-templates":{"id":"reference-guides/user-settings/manage-node-templates","title":"Managing Node Templates","description":"When you provision a cluster hosted by an infrastructure provider, node templates are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts:","sidebar":"tutorialSidebar"},"reference-guides/user-settings/user-preferences":{"id":"reference-guides/user-settings/user-preferences","title":"User Preferences","description":"Each user can choose preferences to personalize their Rancher experience. To change preference settings, open the User Settings menu and then select Preferences.","sidebar":"tutorialSidebar"},"reference-guides/user-settings/user-settings":{"id":"reference-guides/user-settings/user-settings","title":"User Settings","description":"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.","sidebar":"tutorialSidebar"},"security/security-scan/security-scan":{"id":"security/security-scan/security-scan","title":"Security Scans","description":"https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides"},"troubleshooting":{"id":"troubleshooting","title":"Troubleshooting","description":"This section contains information to help you troubleshoot issues when using Rancher.","sidebar":"tutorialSidebar"},"troubleshooting/kubernetes-components/kubernetes-components":{"id":"troubleshooting/kubernetes-components/kubernetes-components","title":"Kubernetes Components","description":"The commands and steps listed in this section apply to the core Kubernetes components on Rancher Launched Kubernetes clusters.","sidebar":"tutorialSidebar"},"troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes":{"id":"troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes","title":"Troubleshooting Controlplane Nodes","description":"This section applies to nodes with the controlplane role.","sidebar":"tutorialSidebar"},"troubleshooting/kubernetes-components/troubleshooting-etcd-nodes":{"id":"troubleshooting/kubernetes-components/troubleshooting-etcd-nodes","title":"Troubleshooting etcd Nodes","description":"This section contains commands and tips for troubleshooting nodes with the etcd role.","sidebar":"tutorialSidebar"},"troubleshooting/kubernetes-components/troubleshooting-nginx-proxy":{"id":"troubleshooting/kubernetes-components/troubleshooting-nginx-proxy","title":"Troubleshooting nginx-proxy","description":"The nginx-proxy container is deployed on every node that does not have the controlplane role. It provides access to all the nodes with the controlplane role by dynamically generating the NGINX configuration based on available nodes with the controlplane role.","sidebar":"tutorialSidebar"},"troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components":{"id":"troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components","title":"Troubleshooting Worker Nodes and Generic Components","description":"This section applies to every node as it includes components that run on nodes with any role.","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/dns":{"id":"troubleshooting/other-troubleshooting-tips/dns","title":"DNS","description":"The commands/steps listed on this page can be used to check name resolution issues in your cluster.","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation":{"id":"troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation","title":"Rotation of Expired Webhook Certificates","description":"For Rancher versions that have rancher-webhook installed, certain versions created certificates that will expire after one year. It will be necessary for you to rotate your webhook certificate if the certificate did not renew.","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/kubernetes-resources":{"id":"troubleshooting/other-troubleshooting-tips/kubernetes-resources","title":"Kubernetes resources","description":"The commands/steps listed on this page can be used to check the most important Kubernetes resources and apply to Rancher Launched Kubernetes clusters.","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/logging":{"id":"troubleshooting/other-troubleshooting-tips/logging","title":"Logging","description":"The following log levels are used in Rancher:","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/networking":{"id":"troubleshooting/other-troubleshooting-tips/networking","title":"Networking","description":"The commands/steps listed on this page can be used to check networking related issues in your cluster.","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/other-troubleshooting-tips":{"id":"troubleshooting/other-troubleshooting-tips/other-troubleshooting-tips","title":"Other Troubleshooting Tips","description":"- Kubernetes Resources","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/rancher-ha":{"id":"troubleshooting/other-troubleshooting-tips/rancher-ha","title":"Rancher HA","description":"The commands/steps listed on this page can be used to check your Rancher Kubernetes Installation.","sidebar":"tutorialSidebar"},"troubleshooting/other-troubleshooting-tips/registered-clusters":{"id":"troubleshooting/other-troubleshooting-tips/registered-clusters","title":"Registered clusters","description":"The commands/steps listed on this page can be used to check clusters that you are registering or that are registered in Rancher.","sidebar":"tutorialSidebar"}}}');
/***/ })
}]);