public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-10-16 06:36:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
de4bfcaabe2f457f34e646dcefd33e35ab2c8faf
rancher-docs/assets/js/4345bac2.a04e56a2.js
T

11 lines
260 KiB
JavaScript
Raw 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([[18004],{
/***/ 21093:
/***/ ((module) => {
module.exports = JSON.parse('{"pluginId":"default","version":"2.0-2.4","label":"v2.0-v2.4","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-2.0-2.4","isLast":false,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Rancher 2.0-2.4","href":"/v2.0-v2.4/","docId":"rancher-manager"},{"type":"category","label":"Getting Started","items":[{"type":"category","label":"Introduction","items":[{"type":"link","label":"Overview","href":"/v2.0-v2.4/getting-started/introduction/overview","docId":"getting-started/introduction/overview"},{"type":"link","label":"What Are Divio Docs?","href":"/v2.0-v2.4/getting-started/introduction/what-are-divio-docs","docId":"getting-started/introduction/what-are-divio-docs"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/introduction"},{"type":"category","label":"Quick Start Guides","items":[{"type":"link","label":"CLI with Rancher","href":"/v2.0-v2.4/getting-started/quick-start-guides/cli","docId":"getting-started/quick-start-guides/cli"},{"type":"category","label":"Deploy Rancher","items":[{"type":"link","label":"Rancher AWS Quick Start Guide","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/getting-started/quick-start-guides/deploy-rancher-manager/gcp","docId":"getting-started/quick-start-guides/deploy-rancher-manager/gcp"},{"type":"link","label":"Vagrant Quick Start","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/deploy-rancher-manager"},{"type":"category","label":"Deploy Rancher Workloads","items":[{"type":"link","label":"Workload with Ingress Quick Start","href":"/v2.0-v2.4/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.0-v2.4/getting-started/quick-start-guides/deploy-workloads/nodeports","docId":"getting-started/quick-start-guides/deploy-workloads/nodeports"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/deploy-rancher-workloads"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/quick-start-guides"},{"type":"category","label":"Installation and Upgrade","items":[{"type":"category","label":"Installation Requirements","items":[{"type":"link","label":"Installing Docker","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/installation-requirements"},{"type":"category","label":"Install/Upgrade on a Kubernetes Cluster","items":[{"type":"link","label":"Rollbacks","href":"/v2.0-v2.4/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":"Troubleshooting the Rancher Server Kubernetes Cluster","href":"/v2.0-v2.4/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"},{"type":"category","label":"Upgrades","items":[{"type":"link","label":"Migrating from a Kubernetes Install with an RKE Add-on","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on"},{"type":"link","label":"Upgrading to v2.0.7+ — Namespace Migration","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration"},{"type":"link","label":"Upgrading Rancher Installed on Kubernetes with Helm 2","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2","docId":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/upgrades"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/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.0-v2.4/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.0-v2.4/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":"Certificate Troubleshooting","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/rancher-behind-an-http-proxy"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/other-installation-methods"},{"type":"category","label":"Resources","items":[{"type":"link","label":"Choosing a Rancher Version","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/resources"},{"type":"link","label":"Upgrading and Rolling Back Kubernetes","href":"/v2.0-v2.4/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.0-v2.4/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":"Enable Experimental Features","items":[{"type":"link","label":"Running on ARM64 (Experimental)","href":"/v2.0-v2.4/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":"Allow Unsupported Storage Drivers","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/enable-experimental-features"},{"type":"category","label":"Advanced Use Cases","items":[{"type":"category","label":"Kubernetes Installation Using Helm 2","items":[{"type":"category","label":"Create Nodes and Load Balancer","items":[{"type":"link","label":"NGINX","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nginx","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nginx"},{"type":"link","label":"Amazon NLB","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nlb","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nlb"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2-create-nodes-lb"},{"type":"category","label":"Install Kubernetes with RKE","items":[{"type":"link","label":"Troubleshooting","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/kubernetes-rke/troubleshooting","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/kubernetes-rke/troubleshooting"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2-kubernetes-rke"},{"type":"category","label":"Initialize Helm: Install the Tiller Service","items":[{"type":"link","label":"Troubleshooting","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-init/troubleshooting","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-init/troubleshooting"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2-helm-init"},{"type":"category","label":"Install Rancher","items":[{"type":"link","label":"Adding Kubernetes TLS Secrets","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/tls-secrets","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/tls-secrets"},{"type":"link","label":"Chart Options","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/chart-options","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/chart-options"},{"type":"link","label":"Troubleshooting","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/troubleshooting","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/troubleshooting"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm-rancher"},{"type":"category","label":"RKE Add-On Install","items":[{"type":"category","label":"Kubernetes Install with External Load Balancer (TCP/Layer 4)","items":[{"type":"link","label":"Amazon NLB Configuration","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-4-lb/nlb","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-4-lb/nlb"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2-rke-add-on-layer-4-lb"},{"type":"category","label":"Kubernetes Install with External Load Balancer (HTTPS/Layer 7)","items":[{"type":"link","label":"Amazon ALB Configuration","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/alb","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/alb"},{"type":"link","label":"NGINX Configuration","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/nginx","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/nginx"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2-rke-add-on-layer-7-lb"},{"type":"link","label":"HTTP Proxy Configuration","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy"},{"type":"link","label":"Enable API Auditing","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/api-auditing","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/api-auditing"},{"type":"category","label":"Troubleshooting HA RKE Add-On Install","items":[{"type":"link","label":"Generic troubleshooting","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/generic-troubleshooting","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/generic-troubleshooting"},{"type":"link","label":"Failed to get job complete status","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/job-complete-status","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/job-complete-status"},{"type":"link","label":"404 - default backend","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/default-backend","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/default-backend"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2-rke-add-on-troubleshooting"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2-rke-add-on"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm2"},{"type":"category","label":"Installing Rancher in an Air Gapped Environment with Helm 2","items":[{"type":"link","label":"1. Prepare your Node(s)","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/prepare-nodes","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/prepare-nodes"},{"type":"link","label":"2. Collect and Publish Images to your Private Registry","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/populate-private-registry","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/populate-private-registry"},{"type":"link","label":"3. Install Kubernetes with RKE (Kubernetes Installs Only)","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/launch-kubernetes","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/launch-kubernetes"},{"type":"link","label":"4. Install Rancher","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/install-rancher","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/install-rancher"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/air-gap-helm2"},{"type":"link","label":"Opening Ports with firewalld","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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":"category","label":"cluster.yml Templates for RKE add-on installs","items":[{"type":"link","label":"Template for an RKE Cluster with a Self-signed Certificate and Layer 4 Load Balancer","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate"},{"type":"link","label":"Template for an RKE Cluster with a Certificate Signed by Recognized CA and a Layer 4 Load Balancer","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate-recognizedca","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate-recognizedca"},{"type":"link","label":"Template for an RKE Cluster with a Self-signed Certificate and SSL Termination on Layer 7 Load Balancer","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-certificate","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-certificate"},{"type":"link","label":"Template for an RKE Cluster with a Recognized CA Certificate and SSL Termination on Layer 7 Load Balancer","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-recognizedca","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-recognizedca"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cluster-yml"},{"type":"link","label":"Docker Install with TLS Termination at Layer-7 NGINX Load Balancer","href":"/v2.0-v2.4/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"},{"type":"category","label":"RKE Add-On","items":[{"type":"link","label":"Kubernetes Install with External Load Balancer (TCP/Layer 4)","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-4-lb","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-4-lb"},{"type":"link","label":"Kubernetes Install with External Load Balancer (HTTPS/Layer 7)","href":"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-7-lb","docId":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-7-lb"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/rke-add-on"}],"collapsed":true,"collapsible":true}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/advanced-options"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/installation-and-upgrade"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/getting-started"},{"type":"category","label":"How-to Guides","items":[{"type":"category","label":"New User Guides","items":[{"type":"category","label":"Kubernetes Cluster Setup","items":[{"type":"link","label":"About High-availability Installations","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/kubernetes-cluster-setup"},{"type":"category","label":"Infrastructure Setup","items":[{"type":"link","label":"Set up Infrastructure for a High Availability K3s Kubernetes Cluster","href":"/v2.0-v2.4/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":"Set up Infrastructure for a High Availability RKE Kubernetes Cluster","href":"/v2.0-v2.4/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 Nodes in Amazon EC2","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/infrastructure-setup"},{"type":"category","label":"Kubernetes Clusters in Rancher Setup","items":[{"type":"link","label":"Node Requirements for Rancher Managed Clusters","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/checklist-for-production-ready-clusters"},{"type":"category","label":"Set Up Clusters from Hosted Kubernetes Providers","items":[{"type":"link","label":"Creating a GKE Cluster","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers"},{"type":"category","label":"Launch Kubernetes with Rancher","items":[{"type":"category","label":"Use New Nodes in an Infra Provider","items":[{"type":"link","label":"Creating an Amazon EC2 Cluster","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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":"vSphere","items":[{"type":"link","label":"Provisioning Kubernetes Clusters in vSphere","href":"/v2.0-v2.4/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 vSphere Console","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/vsphere"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/use-new-nodes-in-an-infra-provider"},{"type":"category","label":"Use Windows Clusters","items":[{"type":"link","label":"Configuration for Storage Classes in Azure","href":"/v2.0-v2.4/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":"Networking Requirements for Host Gateway (L2bridge)","href":"/v2.0-v2.4/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"},{"type":"link","label":"v2.1.x and v2.2.x Windows Documentation (Experimental)","href":"/v2.0-v2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/v2.1-v2.2","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/v2.1-v2.2"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/use-windows-clusters"},{"type":"category","label":"Set Up Cloud Providers","items":[{"type":"category","label":"Other Cloud Providers","items":[{"type":"link","label":"Setting up the Amazon Cloud Provider","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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"},{"type":"link","label":"Setting up the vSphere Cloud Provider","href":"/v2.0-v2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/vsphere","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/vsphere"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/other-cloud-providers"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/set-up-cloud-providers"},{"type":"link","label":"Rancher Agents","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/launch-kubernetes-with-rancher"},{"type":"link","label":"Importing Existing Clusters","href":"/v2.0-v2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/import-existing-clusters","docId":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/import-existing-clusters"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/workloads-and-pods"},{"type":"category","label":"Horizontal Pod Autoscaler","items":[{"type":"link","label":"Manual HPA Installation for Clusters Created Before Rancher v2.0.7","href":"/v2.0-v2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/hpa-for-rancher-before-2.0.7","docId":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/hpa-for-rancher-before-2.0.7"},{"type":"link","label":"Background Information on HPAs","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/horizontal-pod-autoscaler"},{"type":"category","label":"Load Balancer and Ingress Controller","items":[{"type":"link","label":"Layer 4 and Layer 7 Load Balancing","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/load-balancer-and-ingress-controller"},{"type":"link","label":"Service Discovery","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/kubernetes-resources-setup"},{"type":"category","label":"Helm Charts in Rancher","items":[{"type":"link","label":"Enabling and Disabling Built-in Global Catalogs","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/built-in","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/built-in"},{"type":"link","label":"Creating Custom Catalogs","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs"},{"type":"link","label":"Custom Catalog Configuration Reference","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/catalog-config","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/catalog-config"},{"type":"link","label":"Creating Catalog Apps","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/creating-apps","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/creating-apps"},{"type":"link","label":"Managing Catalog Apps","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/managing-apps","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/managing-apps"},{"type":"link","label":"Multi-Cluster Apps","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/multi-cluster-apps","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/multi-cluster-apps"},{"type":"link","label":"Launching Catalog Apps","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/launching-apps","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/launching-apps"},{"type":"link","label":"Tutorial: Example Custom Chart Creation","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/tutorial","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/tutorial"},{"type":"link","label":"Global DNS","href":"/v2.0-v2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns","docId":"how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/helm-charts-in-rancher"},{"type":"link","label":"Deploying Applications across Clusters","href":"/v2.0-v2.4/how-to-guides/new-user-guides/deploy-apps-across-clusters","docId":"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 Installed with Docker","href":"/v2.0-v2.4/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.0-v2.4/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 Rancher Installed on a K3s Kubernetes Cluster","href":"/v2.0-v2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-k3s-installed-rancher","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-k3s-installed-rancher"},{"type":"link","label":"Restoring Rancher Installed on a K3s Kubernetes Cluster","href":"/v2.0-v2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-k3s-installed-rancher","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-k3s-installed-rancher"},{"type":"link","label":"Backing up Rancher Installed on an RKE Kubernetes Cluster","href":"/v2.0-v2.4/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 Backups—Kubernetes installs","href":"/v2.0-v2.4/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"},{"type":"link","label":"Rolling back to v2.0.0-v2.1.5","href":"/v2.0-v2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup/roll-back-to-v2.0-v2.1","docId":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup/roll-back-to-v2.0-v2.1"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/backup-restore-and-disaster-recovery"},{"type":"category","label":"Migrating from v1.6 to v2.x","items":[{"type":"link","label":"Kubernetes Introduction","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/kubernetes-introduction","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/kubernetes-introduction"},{"type":"link","label":"1. Get Started","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/install-and-configure-rancher","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/install-and-configure-rancher"},{"type":"link","label":"2. Migrate Your Services","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/migrate-services","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/migrate-services"},{"type":"link","label":"3. Expose Your Services","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/expose-services","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/expose-services"},{"type":"link","label":"4. Configure Health Checks","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/monitor-apps","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/monitor-apps"},{"type":"link","label":"5. Schedule Your Services","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/schedule-services","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/schedule-services"},{"type":"link","label":"6. Service Discovery","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/discover-services","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/discover-services"},{"type":"link","label":"7. Load Balancing","href":"/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/load-balancing","docId":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/load-balancing"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/migrate-from-v1.6-v2.x"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/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":"Authentication Config","items":[{"type":"link","label":"Users and Groups","href":"/v2.0-v2.4/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.0-v2.4/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":"Configure Google OAuth","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/authentication-config"},{"type":"category","label":"Configure Microsoft AD Federation Service (SAML)","items":[{"type":"link","label":"1. Configuring Microsoft AD FS for Rancher","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/configure-microsoft-ad-federation-service-saml"},{"type":"category","label":"Configure Shibboleth (SAML)","items":[{"type":"link","label":"Group Permissions with Shibboleth and OpenLDAP","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/configure-shibboleth-saml"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/about-authentication"},{"type":"category","label":"Manage Role-Based Access Control (RBAC)","items":[{"type":"link","label":"Global Permissions","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/manage-role-based-access-control-rbac"},{"type":"category","label":"About Provisioning Drivers","items":[{"type":"link","label":"Cluster Drivers","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/about-provisioning-drivers"},{"type":"category","label":"About RKE1 Templates","items":[{"type":"link","label":"Template Creator Permissions","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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":"Template Enforcement","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/about-rke1-templates"},{"type":"link","label":"Pod Security Policies","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/authentication-permissions-and-global-configuration"},{"type":"category","label":"Manage Clusters","items":[{"type":"category","label":"Access Clusters","items":[{"type":"link","label":"Access a Cluster with Kubectl and kubeconfig","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/access-clusters"},{"type":"link","label":"Backing up a Cluster","href":"/v2.0-v2.4/how-to-guides/advanced-user-guides/manage-clusters/backing-up-etcd","docId":"how-to-guides/advanced-user-guides/manage-clusters/backing-up-etcd"},{"type":"link","label":"Restoring a Cluster from Backup","href":"/v2.0-v2.4/how-to-guides/advanced-user-guides/manage-clusters/restoring-etcd","docId":"how-to-guides/advanced-user-guides/manage-clusters/restoring-etcd"},{"type":"category","label":"Install Cluster Autoscaler","items":[{"type":"link","label":"Cluster Autoscaler with AWS EC2 Auto Scaling Groups","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/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.0-v2.4/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.0-v2.4/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.0-v2.4/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":"GlusterFS Volumes","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/manage-persistent-storage"},{"type":"category","label":"Provisioning Storage Examples","items":[{"type":"link","label":"Creating Persistent Storage in Amazon\'s EBS","href":"/v2.0-v2.4/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.0-v2.4/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":"vSphere Storage","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/provisioning-storage-examples"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/create-kubernetes-persistent-storage"},{"type":"link","label":"Projects and Kubernetes Namespaces with Rancher","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/manage-clusters"},{"type":"category","label":"Manage Projects","items":[{"type":"link","label":"Adding Users to Projects","href":"/v2.0-v2.4/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.0-v2.4/how-to-guides/advanced-user-guides/manage-projects/manage-namespaces","docId":"how-to-guides/advanced-user-guides/manage-projects/manage-namespaces"},{"type":"link","label":"Rancher\'s CI/CD Pipelines","href":"/v2.0-v2.4/how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines","docId":"how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines"},{"type":"link","label":"Pod Security Policies","href":"/v2.0-v2.4/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":"Manage Project Resource Quotas","items":[{"type":"link","label":"How Resource Quotas Work in Rancher Projects","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/manage-project-resource-quotas"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/manage-projects"},{"type":"category","label":"Istio Setup Guide","items":[{"type":"link","label":"1. Enable Istio in the Cluster","href":"/v2.0-v2.4/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 with Pod Security Policies","href":"/v2.0-v2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster-with-psp","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster-with-psp"},{"type":"link","label":"2. Enable Istio in a Namespace","href":"/v2.0-v2.4/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":"3. Select the Nodes Where Istio Components Will be Deployed","href":"/v2.0-v2.4/how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors","docId":"how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors"},{"type":"link","label":"4. Add Deployments and Services with the Istio Sidecar","href":"/v2.0-v2.4/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":"5. Set up the Istio Gateway","href":"/v2.0-v2.4/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":"6. Set up Istio\'s Components for Traffic Management","href":"/v2.0-v2.4/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":"7. Generate and View Traffic","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/istio-setup-guide"},{"type":"category","label":"CIS Scan Guides","items":[{"type":"link","label":"Run a Scan","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/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":"Configure Alerts for Periodic Scan on a Schedule","href":"/v2.0-v2.4/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":"Delete a Report","href":"/v2.0-v2.4/how-to-guides/advanced-user-guides/cis-scan-guides/delete-a-report","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/delete-a-report"},{"type":"link","label":"Download a Report","href":"/v2.0-v2.4/how-to-guides/advanced-user-guides/cis-scan-guides/download-a-report","docId":"how-to-guides/advanced-user-guides/cis-scan-guides/download-a-report"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cis-scan-guides"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/advanced-user-guides"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/how-to-guides"},{"type":"category","label":"Reference Guides","items":[{"type":"category","label":"Best Practices","items":[{"type":"link","label":"Tips for Setting Up Containers","href":"/v2.0-v2.4/reference-guides/best-practices/containers","docId":"reference-guides/best-practices/containers"},{"type":"link","label":"Rancher Deployment Strategies","href":"/v2.0-v2.4/reference-guides/best-practices/deployment-strategies","docId":"reference-guides/best-practices/deployment-strategies"},{"type":"link","label":"Tips for Running Rancher","href":"/v2.0-v2.4/reference-guides/best-practices/deployment-types","docId":"reference-guides/best-practices/deployment-types"},{"type":"link","label":"Tips for Scaling, Security and Reliability","href":"/v2.0-v2.4/reference-guides/best-practices/management","docId":"reference-guides/best-practices/management"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/best-practices"},{"type":"category","label":"Rancher Architecture","items":[{"type":"link","label":"Rancher Server and Components","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/reference-guides/rancher-manager-architecture/architecture-recommendations","docId":"reference-guides/rancher-manager-architecture/architecture-recommendations"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/rancher-manager-architecture"},{"type":"category","label":"Cluster Configuration","items":[{"type":"category","label":"Rancher Server Configuration","items":[{"type":"link","label":"RKE Cluster Configuration Reference","href":"/v2.0-v2.4/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration","docId":"reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration"},{"type":"category","label":"Use Existing Nodes","items":[{"type":"link","label":"Rancher Agent Options","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/use-existing-nodes"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/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.0-v2.4/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.0-v2.4/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.0-v2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure"},{"type":"category","label":"Creating a vSphere Cluster","items":[{"type":"link","label":"vSphere Node Template Configuration in Rancher v2.3.3","href":"/v2.0-v2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.3","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.3"},{"type":"link","label":"vSphere Node Template Configuration in Rancher v2.3.0","href":"/v2.0-v2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.0","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.0"},{"type":"link","label":"vSphere Node Template Configuration in Rancher v2.2.0","href":"/v2.0-v2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.2.0","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.2.0"},{"type":"link","label":"vSphere Node Template Configuration in Rancher v2.0.4","href":"/v2.0-v2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.0.4","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.0.4"},{"type":"link","label":"vSphere Node Template Configuration in Rancher before v2.0.4","href":"/v2.0-v2.4/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/prior-to-v2.0.4","docId":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/prior-to-v2.0.4"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/creating-a-vsphere-cluster"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/node-template-configuration"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/downstream-cluster-configuration"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cluster-configuration"},{"type":"category","label":"Single-Node Rancher in Docker","items":[{"type":"link","label":"HTTP Proxy Configuration","href":"/v2.0-v2.4/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.0-v2.4/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.0-v2.4/pages-for-subheaders/single-node-rancher-in-docker"},{"type":"category","label":"Installation References","items":[{"type":"link","label":"Rancher Helm Chart Options","href":"/v2.0-v2.4/reference-guides/installation-references/helm-chart-options","docId":"reference-guides/installation-references/helm-chart-options"},{"type":"link","label":"TLS Settings","href":"/v2.0-v2.4/reference-guides/installation-references/tls-settings","docId":"reference-guides/installation-references/tls-settings"},{"type":"link","label":"Feature Flags","href":"/v2.0-v2.4/reference-guides/installation-references/feature-flags","docId":"reference-guides/installation-references/feature-flags"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/installation-references"},{"type":"link","label":"Creating an EKS Cluster","href":"/v2.0-v2.4/reference-guides/installation-references/amazon-eks-permissions","docId":"reference-guides/installation-references/amazon-eks-permissions"},{"type":"category","label":"Configure OpenLDAP","items":[{"type":"link","label":"OpenLDAP Configuration Reference","href":"/v2.0-v2.4/reference-guides/configure-openldap/openldap-config-reference","docId":"reference-guides/configure-openldap/openldap-config-reference"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/configure-openldap"},{"type":"link","label":"Kubernetes Concepts","href":"/v2.0-v2.4/reference-guides/kubernetes-concepts","docId":"reference-guides/kubernetes-concepts"},{"type":"category","label":"User Settings","items":[{"type":"link","label":"API Keys","href":"/v2.0-v2.4/reference-guides/user-settings/api-keys","docId":"reference-guides/user-settings/api-keys"},{"type":"link","label":"Managing Node Templates","href":"/v2.0-v2.4/reference-guides/user-settings/manage-node-templates","docId":"reference-guides/user-settings/manage-node-templates"},{"type":"link","label":"Managing Cloud Credentials","href":"/v2.0-v2.4/reference-guides/user-settings/manage-cloud-credentials","docId":"reference-guides/user-settings/manage-cloud-credentials"},{"type":"link","label":"User Preferences","href":"/v2.0-v2.4/reference-guides/user-settings/user-preferences","docId":"reference-guides/user-settings/user-preferences"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/user-settings"},{"type":"category","label":"CLI with Rancher","items":[{"type":"link","label":"Rancher CLI","href":"/v2.0-v2.4/reference-guides/cli-with-rancher/rancher-cli","docId":"reference-guides/cli-with-rancher/rancher-cli"},{"type":"link","label":"kubectl Utility","href":"/v2.0-v2.4/reference-guides/cli-with-rancher/kubectl-utility","docId":"reference-guides/cli-with-rancher/kubectl-utility"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cli-with-rancher"},{"type":"category","label":"About the API","items":[{"type":"link","label":"API Tokens","href":"/v2.0-v2.4/reference-guides/about-the-api/api-tokens","docId":"reference-guides/about-the-api/api-tokens"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/about-the-api"},{"type":"link","label":"Tools for Logging, Monitoring, and More","href":"/v2.0-v2.4/reference-guides/rancher-cluster-tools","docId":"reference-guides/rancher-cluster-tools"},{"type":"category","label":"Project Tools","items":[{"type":"link","label":"Project Alerts","href":"/v2.0-v2.4/reference-guides/rancher-project-tools/project-alerts","docId":"reference-guides/rancher-project-tools/project-alerts"},{"type":"link","label":"Project Logging","href":"/v2.0-v2.4/reference-guides/rancher-project-tools/project-logging","docId":"reference-guides/rancher-project-tools/project-logging"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/project-tools"},{"type":"link","label":"System Tools","href":"/v2.0-v2.4/reference-guides/system-tools","docId":"reference-guides/system-tools"},{"type":"link","label":"RKE1 Example YAML","href":"/v2.0-v2.4/reference-guides/rke1-template-example-yaml","docId":"reference-guides/rke1-template-example-yaml"},{"type":"category","label":"Pipelines","items":[{"type":"link","label":"Concepts","href":"/v2.0-v2.4/reference-guides/pipelines/concepts","docId":"reference-guides/pipelines/concepts"},{"type":"link","label":"Pipeline Configuration Reference","href":"/v2.0-v2.4/reference-guides/pipelines/pipeline-configuration","docId":"reference-guides/pipelines/pipeline-configuration"},{"type":"link","label":"Configuring Persistent Data for Pipeline Components","href":"/v2.0-v2.4/reference-guides/pipelines/configure-persistent-data","docId":"reference-guides/pipelines/configure-persistent-data"},{"type":"link","label":"Example Repositories","href":"/v2.0-v2.4/reference-guides/pipelines/example-repositories","docId":"reference-guides/pipelines/example-repositories"},{"type":"link","label":"Example YAML File","href":"/v2.0-v2.4/reference-guides/pipelines/example-yaml","docId":"reference-guides/pipelines/example-yaml"},{"type":"link","label":"v2.0.x Pipeline Documentation","href":"/v2.0-v2.4/reference-guides/pipelines/v2.0.x","docId":"reference-guides/pipelines/v2.0.x"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/pipelines"},{"type":"category","label":"Rancher Security","items":[{"type":"category","label":"Rancher v2.1 Hardening Guides","items":[{"type":"link","label":"CIS Benchmark Rancher Self-Assessment Guide v2.1","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.1-hardening-guides/self-assessment-guide-with-cis-v1.3-benchmark","docId":"reference-guides/rancher-security/rancher-v2.1-hardening-guides/self-assessment-guide-with-cis-v1.3-benchmark"},{"type":"link","label":"Hardening Guide v2.1","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.1-hardening-guides/hardening-guide-with-cis-v1.3-benchmark","docId":"reference-guides/rancher-security/rancher-v2.1-hardening-guides/hardening-guide-with-cis-v1.3-benchmark"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/rancher-v2.1-hardening-guides"},{"type":"category","label":"Rancher v2.2 Hardening Guides","items":[{"type":"link","label":"CIS Benchmark Rancher Self-Assessment Guide v2.2","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.2-hardening-guides/self-assessment-guide-with-cis-v1.4-benchmark","docId":"reference-guides/rancher-security/rancher-v2.2-hardening-guides/self-assessment-guide-with-cis-v1.4-benchmark"},{"type":"link","label":"Hardening Guide v2.2","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.2-hardening-guides/hardening-guide-with-cis-v1.4-benchmark","docId":"reference-guides/rancher-security/rancher-v2.2-hardening-guides/hardening-guide-with-cis-v1.4-benchmark"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/rancher-v2.2-hardening-guides"},{"type":"category","label":"Rancher v2.3 Hardening Guides","items":[{"type":"link","label":"CIS Benchmark Rancher Self-Assessment Guide v2.3","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-self-assessment-guide-with-cis-v1.4.1-benchmark","docId":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-self-assessment-guide-with-cis-v1.4.1-benchmark"},{"type":"link","label":"Hardening Guide v2.3","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-hardening-guide-with-cis-v1.4.1-benchmark","docId":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-hardening-guide-with-cis-v1.4.1-benchmark"},{"type":"link","label":"CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.3","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-self-assessment-guide-with-cis-v1.4.1-benchmark","docId":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-self-assessment-guide-with-cis-v1.4.1-benchmark"},{"type":"link","label":"Hardening Guide v2.3.3","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-hardening-guide-with-cis-v1.4.1-benchmark","docId":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-hardening-guide-with-cis-v1.4.1-benchmark"},{"type":"link","label":"CIS Benchmark Rancher Self-Assessment Guide - v2.3.5","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-self-assessment-guide-with-cis-v1.5-benchmark","docId":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-self-assessment-guide-with-cis-v1.5-benchmark"},{"type":"link","label":"Hardening Guide v2.3.5","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-hardening-guide-with-cis-v1.5-benchmark","docId":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-hardening-guide-with-cis-v1.5-benchmark"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/rancher-v2.3-hardening-guides"},{"type":"category","label":"Rancher v2.4 Hardening Guides","items":[{"type":"link","label":"CIS Benchmark Rancher Self-Assessment Guide - v2.4","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.4-hardening-guides/self-assessment-guide-with-cis-v1.5-benchmark","docId":"reference-guides/rancher-security/rancher-v2.4-hardening-guides/self-assessment-guide-with-cis-v1.5-benchmark"},{"type":"link","label":"Hardening Guide v2.4","href":"/v2.0-v2.4/reference-guides/rancher-security/rancher-v2.4-hardening-guides/hardening-guide-with-cis-v1.5-benchmark","docId":"reference-guides/rancher-security/rancher-v2.4-hardening-guides/hardening-guide-with-cis-v1.5-benchmark"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/rancher-v2.4-hardening-guides"},{"type":"link","label":"Rancher CVEs and Resolutions","href":"/v2.0-v2.4/reference-guides/rancher-security/security-advisories-and-cves","docId":"reference-guides/rancher-security/security-advisories-and-cves"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/rancher-security"},{"type":"link","label":"Migration Tools CLI Reference","href":"/v2.0-v2.4/reference-guides/v1.6-migration/migration-tools-cli-reference","docId":"reference-guides/v1.6-migration/migration-tools-cli-reference"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/reference-guides"},{"type":"category","label":"Explanations","items":[{"type":"category","label":"Integrations in Rancher","items":[{"type":"category","label":"CIS Scans","items":[{"type":"link","label":"Skipped and Not Applicable Tests","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests","docId":"explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cis-scans"},{"type":"category","label":"Istio","items":[{"type":"link","label":"CPU and Memory Allocations","href":"/v2.0-v2.4/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.0-v2.4/explanations/integrations-in-rancher/istio/rbac-for-istio","docId":"explanations/integrations-in-rancher/istio/rbac-for-istio"},{"type":"link","label":"Disabling Istio","href":"/v2.0-v2.4/explanations/integrations-in-rancher/istio/disable-istio","docId":"explanations/integrations-in-rancher/istio/disable-istio"},{"type":"link","label":"Release Notes","href":"/v2.0-v2.4/explanations/integrations-in-rancher/istio/release-notes","docId":"explanations/integrations-in-rancher/istio/release-notes"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/istio"},{"type":"category","label":"Logging","items":[{"type":"link","label":"Elasticsearch","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-logging/elasticsearch","docId":"explanations/integrations-in-rancher/cluster-logging/elasticsearch"},{"type":"link","label":"Fluentd","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-logging/fluentd","docId":"explanations/integrations-in-rancher/cluster-logging/fluentd"},{"type":"link","label":"Kafka","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-logging/kafka","docId":"explanations/integrations-in-rancher/cluster-logging/kafka"},{"type":"link","label":"Splunk","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-logging/splunk","docId":"explanations/integrations-in-rancher/cluster-logging/splunk"},{"type":"link","label":"Syslog","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-logging/syslog","docId":"explanations/integrations-in-rancher/cluster-logging/syslog"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cluster-logging"},{"type":"category","label":"Alerting","items":[{"type":"link","label":"Default Alerts for Cluster Monitoring","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-alerts/default-alerts","docId":"explanations/integrations-in-rancher/cluster-alerts/default-alerts"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cluster-alerts"},{"type":"category","label":"Monitoring","items":[{"type":"link","label":"Cluster Metrics","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-monitoring/cluster-metrics","docId":"explanations/integrations-in-rancher/cluster-monitoring/cluster-metrics"},{"type":"link","label":"Prometheus Custom Metrics Adapter","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-monitoring/custom-metrics","docId":"explanations/integrations-in-rancher/cluster-monitoring/custom-metrics"},{"type":"link","label":"Prometheus Expressions","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-monitoring/expression","docId":"explanations/integrations-in-rancher/cluster-monitoring/expression"},{"type":"link","label":"Project Monitoring","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-monitoring/project-monitoring","docId":"explanations/integrations-in-rancher/cluster-monitoring/project-monitoring"},{"type":"link","label":"Prometheus Configuration","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-monitoring/prometheus","docId":"explanations/integrations-in-rancher/cluster-monitoring/prometheus"},{"type":"link","label":"Viewing Metrics","href":"/v2.0-v2.4/explanations/integrations-in-rancher/cluster-monitoring/viewing-metrics","docId":"explanations/integrations-in-rancher/cluster-monitoring/viewing-metrics"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/cluster-monitoring"},{"type":"link","label":"OPA Gatekeeper","href":"/v2.0-v2.4/explanations/integrations-in-rancher/opa-gatekeeper","docId":"explanations/integrations-in-rancher/opa-gatekeeper"},{"type":"link","label":"Notifiers","href":"/v2.0-v2.4/explanations/integrations-in-rancher/notifiers","docId":"explanations/integrations-in-rancher/notifiers"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/integrations-in-rancher"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/explanations"},{"type":"category","label":"FAQ","items":[{"type":"link","label":"Installing and Configuring kubectl","href":"/v2.0-v2.4/faq/install-and-configure-kubectl","docId":"faq/install-and-configure-kubectl"},{"type":"link","label":"Technical","href":"/v2.0-v2.4/faq/technical-items","docId":"faq/technical-items"},{"type":"link","label":"Security","href":"/v2.0-v2.4/faq/security","docId":"faq/security"},{"type":"link","label":"Telemetry","href":"/v2.0-v2.4/faq/telemetry","docId":"faq/telemetry"},{"type":"link","label":"Questions about Upgrading to Rancher v2.x","href":"/v2.0-v2.4/faq/upgrades-to-2x","docId":"faq/upgrades-to-2x"},{"type":"link","label":"Networking","href":"/v2.0-v2.4/faq/networking","docId":"faq/networking"},{"type":"link","label":"Container Network Interface (CNI) Providers","href":"/v2.0-v2.4/faq/container-network-interface-providers","docId":"faq/container-network-interface-providers"},{"type":"link","label":"Rancher is No Longer Needed","href":"/v2.0-v2.4/faq/rancher-is-no-longer-needed","docId":"faq/rancher-is-no-longer-needed"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/faq"},{"type":"category","label":"Troubleshooting","items":[{"type":"category","label":"Kubernetes Components","items":[{"type":"link","label":"Troubleshooting etcd Nodes","href":"/v2.0-v2.4/troubleshooting/kubernetes-components/troubleshooting-etcd-nodes","docId":"troubleshooting/kubernetes-components/troubleshooting-etcd-nodes"},{"type":"link","label":"Troubleshooting Controlplane Nodes","href":"/v2.0-v2.4/troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes","docId":"troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes"},{"type":"link","label":"Troubleshooting nginx-proxy","href":"/v2.0-v2.4/troubleshooting/kubernetes-components/troubleshooting-nginx-proxy","docId":"troubleshooting/kubernetes-components/troubleshooting-nginx-proxy"},{"type":"link","label":"Troubleshooting Worker Nodes and Generic Components","href":"/v2.0-v2.4/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.0-v2.4/pages-for-subheaders/kubernetes-components"},{"type":"category","label":"Other Troubleshooting Tips","items":[{"type":"link","label":"Kubernetes resources","href":"/v2.0-v2.4/troubleshooting/other-troubleshooting-tips/kubernetes-resources","docId":"troubleshooting/other-troubleshooting-tips/kubernetes-resources"},{"type":"link","label":"Networking","href":"/v2.0-v2.4/troubleshooting/other-troubleshooting-tips/networking","docId":"troubleshooting/other-troubleshooting-tips/networking"},{"type":"link","label":"DNS","href":"/v2.0-v2.4/troubleshooting/other-troubleshooting-tips/dns","docId":"troubleshooting/other-troubleshooting-tips/dns"},{"type":"link","label":"Rancher HA","href":"/v2.0-v2.4/troubleshooting/other-troubleshooting-tips/rancher-ha","docId":"troubleshooting/other-troubleshooting-tips/rancher-ha"},{"type":"link","label":"Imported clusters","href":"/v2.0-v2.4/troubleshooting/other-troubleshooting-tips/registered-clusters","docId":"troubleshooting/other-troubleshooting-tips/registered-clusters"},{"type":"link","label":"Logging","href":"/v2.0-v2.4/troubleshooting/other-troubleshooting-tips/logging","docId":"troubleshooting/other-troubleshooting-tips/logging"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/pages-for-subheaders/other-troubleshooting-tips"}],"collapsed":true,"collapsible":true,"href":"/v2.0-v2.4/troubleshooting"},{"type":"link","label":"Contributing to Rancher","href":"/v2.0-v2.4/contribute-to-rancher","docId":"contribute-to-rancher"}]},"docs":{"backups/backup/backup":{"id":"backups/backup/backup","title":"Backup","description":"This section contains information about how to create backups of your Rancher data and how to restore them in a disaster scenario."},"backups/restore/restore":{"id":"backups/restore/restore","title":"Restore","description":"If you lose the data on your Rancher Server, you can restore it if you have backups stored in a safe location."},"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/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/cluster-alerts/default-alerts":{"id":"explanations/integrations-in-rancher/cluster-alerts/default-alerts","title":"Default Alerts for Cluster Monitoring","description":"When you create a cluster, some alert rules are predefined. These alerts notify you about signs that the cluster could be unhealthy. You can receive these alerts if you configure a notifier for them.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-logging/elasticsearch":{"id":"explanations/integrations-in-rancher/cluster-logging/elasticsearch","title":"Elasticsearch","description":"If your organization uses Elasticsearch, either on premise or in the cloud, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Elasticsearch deployment to view logs.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-logging/fluentd":{"id":"explanations/integrations-in-rancher/cluster-logging/fluentd","title":"Fluentd","description":"If your organization uses Fluentd, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Fluentd server to view logs.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-logging/kafka":{"id":"explanations/integrations-in-rancher/cluster-logging/kafka","title":"Kafka","description":"If your organization uses Kafka, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Kafka server to view logs.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-logging/splunk":{"id":"explanations/integrations-in-rancher/cluster-logging/splunk","title":"Splunk","description":"If your organization uses Splunk, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Splunk server to view logs.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-logging/syslog":{"id":"explanations/integrations-in-rancher/cluster-logging/syslog","title":"Syslog","description":"If your organization uses Syslog, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Syslog server to view logs.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-monitoring/cluster-metrics":{"id":"explanations/integrations-in-rancher/cluster-monitoring/cluster-metrics","title":"Cluster Metrics","description":"Available as of v2.2.0","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-monitoring/custom-metrics":{"id":"explanations/integrations-in-rancher/cluster-monitoring/custom-metrics","title":"Prometheus Custom Metrics Adapter","description":"After you\'ve enabled cluster level monitoring, You can view the metrics data from Rancher. You can also deploy the Prometheus custom metrics adapter then you can use the HPA with metrics stored in cluster monitoring.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-monitoring/expression":{"id":"explanations/integrations-in-rancher/cluster-monitoring/expression","title":"Prometheus Expressions","description":"The PromQL expressions in this doc can be used to configure alerts.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-monitoring/project-monitoring":{"id":"explanations/integrations-in-rancher/cluster-monitoring/project-monitoring","title":"Project Monitoring","description":"Available as of v2.2.4","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-monitoring/prometheus":{"id":"explanations/integrations-in-rancher/cluster-monitoring/prometheus","title":"Prometheus Configuration","description":"Available as of v2.2.0","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/cluster-monitoring/viewing-metrics":{"id":"explanations/integrations-in-rancher/cluster-monitoring/viewing-metrics","title":"Viewing Metrics","description":"Available as of v2.2.0","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":"Available as of v2.3.0","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 disable Istio in a cluster, namespace, or workload.","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 and how to configure access to the Kiali and Jaeger visualizations.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/istio/release-notes":{"id":"explanations/integrations-in-rancher/istio/release-notes","title":"Release Notes","description":"Istio 1.5.8","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/notifiers":{"id":"explanations/integrations-in-rancher/notifiers","title":"Notifiers","description":"Notifiers are services that inform you of alert events. You can configure notifiers to send alert notifications to staff best suited to take corrective action.","sidebar":"tutorialSidebar"},"explanations/integrations-in-rancher/opa-gatekeeper":{"id":"explanations/integrations-in-rancher/opa-gatekeeper","title":"OPA Gatekeeper","description":"Available as of v2.4.0","sidebar":"tutorialSidebar"},"faq":{"id":"faq","title":"FAQ","description":"This FAQ is a work in progress designed to answers 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/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":{"id":"faq/networking","title":"Networking","description":"Networking FAQ\'s","sidebar":"tutorialSidebar"},"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","description":"Is there a Hardening Guide?","sidebar":"tutorialSidebar"},"faq/technical-items":{"id":"faq/technical-items","title":"Technical","description":"How can I reset the administrator password?","sidebar":"tutorialSidebar"},"faq/telemetry":{"id":"faq/telemetry","title":"Telemetry","description":"What is Telemetry?","sidebar":"tutorialSidebar"},"faq/upgrades-to-2x":{"id":"faq/upgrades-to-2x","title":"Questions about Upgrading to Rancher v2.x","description":"This page contains frequently asked questions about the changes between Rancher v1.x and v2.x, and how to upgrade from Rancher v1.x to v2.x.","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-use-cases/air-gap-helm2/install-rancher":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/install-rancher","title":"4. Install Rancher","description":"This section is about how to deploy Rancher for your air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. There are tabs for either a high availability (recommended) or a Docker installation.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/launch-kubernetes":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/launch-kubernetes","title":"3. Install Kubernetes with RKE (Kubernetes Installs Only)","description":"This section is about how to prepare to launch a Kubernetes cluster which is used to deploy Rancher server for your air gapped environment.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/populate-private-registry":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/populate-private-registry","title":"2. Collect and Publish Images to your Private Registry","description":"Prerequisites: You must have a private registry available to use.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/prepare-nodes":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/prepare-nodes","title":"1. Prepare your Node(s)","description":"This section is about how to prepare your node(s) to install Rancher for your air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. There are tabs for either a high availability (recommended) or a Docker installation.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate","title":"Template for an RKE Cluster with a Self-signed Certificate and Layer 4 Load Balancer","description":"RKE uses a cluster.yml file to install and configure your Kubernetes cluster.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate-recognizedca":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate-recognizedca","title":"Template for an RKE Cluster with a Certificate Signed by Recognized CA and a Layer 4 Load Balancer","description":"RKE uses a cluster.yml file to install and configure your Kubernetes cluster.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-certificate":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-certificate","title":"Template for an RKE Cluster with a Self-signed Certificate and SSL Termination on Layer 7 Load Balancer","description":"RKE uses a cluster.yml file to install and configure your Kubernetes cluster.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-recognizedca":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-recognizedca","title":"Template for an RKE Cluster with a Recognized CA Certificate and SSL Termination on Layer 7 Load Balancer","description":"RKE uses a cluster.yml file to install and configure your Kubernetes cluster.","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/helm2/create-nodes-lb/nginx":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nginx","title":"NGINX","description":"NGINX will be configured as Layer 4 load balancer (TCP) that forwards connections to one of your Rancher nodes.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nlb":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nlb","title":"Amazon NLB","description":"Objectives","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-init/troubleshooting":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-init/troubleshooting","title":"Troubleshooting","description":"Helm commands show forbidden","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/chart-options":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/chart-options","title":"Chart Options","description":"Common Options","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/tls-secrets":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/tls-secrets","title":"Adding Kubernetes TLS Secrets","description":"Read about how to populate the Kubernetes TLS secret for a Rancher installation","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/troubleshooting":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/troubleshooting","title":"Troubleshooting","description":"Where is everything","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/kubernetes-rke/troubleshooting":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/kubernetes-rke/troubleshooting","title":"Troubleshooting","description":"canal Pods show READY 2/3","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/api-auditing":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/api-auditing","title":"Enable API Auditing","description":"Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-4-lb/nlb":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-4-lb/nlb","title":"Amazon NLB Configuration","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/alb":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/alb","title":"Amazon ALB Configuration","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/nginx":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/nginx","title":"NGINX Configuration","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy","title":"HTTP Proxy Configuration","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/default-backend":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/default-backend","title":"404 - default backend","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/generic-troubleshooting":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/generic-troubleshooting","title":"Generic troubleshooting","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/job-complete-status":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/job-complete-status","title":"Failed to get job complete status","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","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":"We recommend disabling firewalld. For Kubernetes 1.19.x and higher, firewalld must be turned off.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-4-lb":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-4-lb","title":"Kubernetes Install with External Load Balancer (TCP/Layer 4)","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-7-lb":{"id":"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-7-lb","title":"Kubernetes Install with External Load Balancer (HTTPS/Layer 7)","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","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/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":"Allow 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/rollbacks":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks","title":"Rollbacks","description":"Rolling Back to Rancher v2.2-v2.4","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/helm2":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2","title":"Upgrading Rancher Installed on Kubernetes with Helm 2","description":"Helm 3 has been released. If you are using Helm 2, we recommend migrating to Helm 3 because it is simpler to use and more secure than Helm 2.","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on","title":"Migrating from a Kubernetes Install with an RKE Add-on","description":"Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration":{"id":"getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration","title":"Upgrading to v2.0.7+ — Namespace Migration","description":"This section applies only to Rancher upgrades from v2.0.6 or earlier to v2.0.7 or later. Upgrades from v2.0.7 to later version are unaffected.","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/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/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. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. There are tabs for either a high availability (recommended) or a Docker installation.","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/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/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":"Certificate Troubleshooting","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/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/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":"Available as of v2.3.0","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/cli":{"id":"getting-started/quick-start-guides/cli","title":"CLI with Rancher","description":"Interact with Rancher using command line interface (CLI) tools from your workstation.","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 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 cluster attached.","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 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 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":"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/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"},"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/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":"Available as of v2.0.3","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":"Available as of v2.0.5","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":"Configure Google OAuth","description":"Available as of v2.3.0","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":"Available as of v2.2.0","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":"Available as of v2.0.7","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-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":"Available as of v2.0.7","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":"Available as of Rancher v2.4","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":"Available as of v2.2.0","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/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":"Template Enforcement","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/create-pod-security-policies":{"id":"how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies","title":"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/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":"Rancher provides a set of alerts for cluster scans. which are not configured to have notifiers by default:","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/delete-a-report":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/delete-a-report","title":"Delete a Report","description":"1. From the cluster view in Rancher, click Tools > CIS Scans.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/cis-scan-guides/download-a-report":{"id":"how-to-guides/advanced-user-guides/cis-scan-guides/download-a-report","title":"Download a Report","description":"1. From the cluster view in Rancher, click Tools > CIS Scans.","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":"Run a Scan","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":"Recurring scans can be scheduled to run on any RKE Kubernetes cluster.","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":"You can define a set of tests that will be skipped by the CIS scan when the next report is generated.","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":"1. Enable Istio in the Cluster","description":"This cluster uses the default Nginx controller to allow traffic into the cluster.","sidebar":"tutorialSidebar"},"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster-with-psp":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster-with-psp","title":"Enable Istio with Pod Security Policies","description":"Note: The following guide is only for RKE provisioned clusters.","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":"2. 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":"7. Generate and View Traffic","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/node-selectors":{"id":"how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors","title":"3. Select the Nodes Where Istio Components Will be Deployed","description":"Prerequisite: Your cluster needs a worker node that can designated for Istio. The worker node should meet the resource requirements.","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":"5. 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":"6. 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":"4. Add Deployments and Services with the Istio Sidecar","description":"Prerequisite: To enable Istio for a workload, the cluster and namespace must have Istio enabled.","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/backing-up-etcd":{"id":"how-to-guides/advanced-user-guides/manage-clusters/backing-up-etcd","title":"Backing up a Cluster","description":"Available as of v2.2.0","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/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/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/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/vsphere-storage":{"id":"how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage","title":"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/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/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/restoring-etcd":{"id":"how-to-guides/advanced-user-guides/manage-clusters/restoring-etcd","title":"Restoring a Cluster from Backup","description":"Available as of v2.2.0","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/ci-cd-pipelines":{"id":"how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines","title":"Rancher\'s CI/CD Pipelines","description":"Use Rancher’s CI/CD pipeline to automatically checkout code, run builds or scripts, publish Docker images, and deploy software to users","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":"Pod Security Policies","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/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":"Available as of v2.2.0","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-k3s-installed-rancher":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-k3s-installed-rancher","title":"Backing up Rancher Installed on a K3s Kubernetes Cluster","description":"When Rancher is installed on a high-availability Kubernetes cluster, we recommend using an external database to store the cluster data.","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 Rancher Installed on an RKE Kubernetes Cluster","description":"This section describes how to create backups of your high-availability Rancher install.","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-k3s-installed-rancher":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-k3s-installed-rancher","title":"Restoring Rancher Installed on a K3s Kubernetes Cluster","description":"When Rancher is installed on a high-availability Kubernetes cluster, we recommend using an external database to store the cluster data.","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 Backups—Kubernetes installs","description":"This procedure describes how to use RKE to restore a snapshot of the Rancher Kubernetes cluster.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup/roll-back-to-v2.0-v2.1":{"id":"how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup/roll-back-to-v2.0-v2.1","title":"Rolling back to v2.0.0-v2.1.5","description":"Rolling back to Rancher v2.0-v2.1 is no longer supported. The instructions for rolling back to these versions are preserved here and are intended to be used only in cases where upgrading to Rancher v2.2+ is not feasible.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/deploy-apps-across-clusters":{"id":"how-to-guides/new-user-guides/deploy-apps-across-clusters","title":"Deploying Applications across Clusters","description":"Available as of v2.2.0","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs","title":"Creating Custom Catalogs","description":"Custom catalogs can be added into Rancher at a global scope, cluster scope, or project scope.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/built-in":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/built-in","title":"Enabling and Disabling Built-in Global Catalogs","description":"There are default global catalogs packaged as part of Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/catalog-config":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/catalog-config","title":"Custom Catalog Configuration Reference","description":"Any user can create custom catalogs to add into Rancher. Besides the content of the catalog, users must ensure their catalogs are able to be added into Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/creating-apps":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/creating-apps","title":"Creating Catalog Apps","description":"Rancher\'s catalog service requires any custom catalogs to be structured in a specific format for the catalog service to be able to leverage it in Rancher.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns","title":"Global DNS","description":"Available as of v2.2.0","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/launching-apps":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/launching-apps","title":"Launching Catalog Apps","description":"Within a project, when you want to deploy applications from catalogs, the applications available in your project will be based on the scope of the catalogs.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/managing-apps":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/managing-apps","title":"Managing Catalog Apps","description":"After deploying an application, one of the benefits of using an application versus individual workloads/resources is the ease of being able to manage many workloads/resources applications. Apps can be cloned, upgraded or rolled back.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/multi-cluster-apps":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/multi-cluster-apps","title":"Multi-Cluster Apps","description":"Available as of v2.2.0","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/helm-charts-in-rancher/tutorial":{"id":"how-to-guides/new-user-guides/helm-charts-in-rancher/tutorial","title":"Tutorial: Example Custom Chart Creation","description":"In this tutorial, you\'ll learn how to create a Helm chart and deploy it to a repository. The repository can then be used as a source for a custom catalog 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":"Set 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":"Set 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/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/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-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/import-existing-clusters":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/import-existing-clusters","title":"Importing Existing Clusters","description":"Learn how you can create a cluster in Rancher by importing an existing Kubernetes cluster. Then, you can manage it using Rancher","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/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/vsphere":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/vsphere","title":"Setting up the vSphere Cloud Provider","description":"In this section, you\'ll learn how to set up the 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/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 vSphere Console","description":"This section describes how to create a vSphere username and password. You will need to 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 vSphere","description":"In this section, you\'ll learn how to use Rancher to install an RKE Kubernetes cluster in vSphere.","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":"Configuration for 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/v2.1-v2.2":{"id":"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/v2.1-v2.2","title":"v2.1.x and v2.2.x Windows Documentation (Experimental)","description":"Available from v2.1.0 to v2.1.9 and v2.2.0 to v2.2.3","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/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":"Available as of v2.2.0","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":"Creating a GKE Cluster","description":"Prerequisites in Google Kubernetes Engine","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":"Available as of v2.2.0","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":"Available as of v2.2.0","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/hpa-for-rancher-before-2.0.7":{"id":"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/hpa-for-rancher-before-2.0.7","title":"Manual HPA Installation for Clusters Created Before Rancher v2.0.7","description":"This section describes how to manually install HPAs for clusters created with Rancher before v2.0.7. This section also describes how to configure your HPA to scale up or down, and how to assign roles to your HPA.","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":"Available as of v2.3.0","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/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/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/migrate-from-v1.6-v2.x/discover-services":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/discover-services","title":"6. Service Discovery","description":"Service discovery is one of the core functionalities of any container-based environment. Once you have packaged and launched your application, the next step is making it discoverable to other containers in your environment or the external world. This document will describe how to use the service discovery support provided by Rancher v2.x so that you can find them by name.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/expose-services":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/expose-services","title":"3. Expose Your Services","description":"In testing environments, you usually need to route external traffic to your cluster containers by using an unadvertised IP and port number, providing users access to their apps. You can accomplish this goal using port mapping, which exposes a workload (i.e., service) publicly over a specific port, provided you know your node IP address(es). You can either map a port using HostPorts (which exposes a service on a specified port on a single node) or NodePorts (which exposes a service on all nodes on a single port).","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/install-and-configure-rancher":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/install-and-configure-rancher","title":"1. Get Started","description":"Get started with your migration to Rancher v2.x by installing Rancher and configuring your new Rancher environment.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/kubernetes-introduction":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/kubernetes-introduction","title":"Kubernetes Introduction","description":"Rancher v2.x is built on the Kubernetes container orchestrator. This shift in underlying technology for v2.x is a large departure from v1.6, which supported several popular container orchestrators. Since Rancher is now based entirely on Kubernetes, it\'s helpful to learn the Kubernetes basics.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/load-balancing":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/load-balancing","title":"7. Load Balancing","description":"If your applications are public-facing and consume significant traffic, you should place a load balancer in front of your cluster so that users can always access their apps without service interruption. Typically, you can fulfill a high volume of service requests by horizontally scaling your deployment, which spins up additional application containers as traffic ramps up. However, this technique requires routing that distributes traffic across your nodes efficiently. In cases where you need to accommodate public traffic that scales up and down, you\'ll need a load balancer.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/migrate-services":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/migrate-services","title":"2. Migrate Your Services","description":"Although your services from v1.6 won\'t work in Rancher v2.x by default, that doesn\'t mean you have to start again from square one, manually rebuilding your applications in v2.x. To help with migration from v1.6 to v2.x, Rancher has developed a migration tool. The migration-tools CLI is a utility that helps you recreate your applications in Rancher v2.x. This tool exports your Rancher v1.6 services as Compose files and converts them to a Kubernetes manifest that Rancher v2.x can consume.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/monitor-apps":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/monitor-apps","title":"4. Configure Health Checks","description":"Rancher v1.6 provided TCP and HTTP health checks on your nodes and services using its own health check microservice. These health checks monitored your containers to confirm they\'re operating as intended. If a container failed a health check, Rancher would destroy the unhealthy container and then replicates a healthy one to replace it.","sidebar":"tutorialSidebar"},"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/schedule-services":{"id":"how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/schedule-services","title":"5. Schedule Your Services","description":"In v1.6, objects called services were used to schedule containers to your cluster hosts. Services included the Docker image for an application, along with configuration settings for a desired state.","sidebar":"tutorialSidebar"},"installation/resources/chart-options/chart-options":{"id":"installation/resources/chart-options/chart-options","title":"Rancher Helm Chart Options","description":"The Rancher Helm chart options reference moved to this page."},"pages-for-subheaders/about-authentication":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/about-provisioning-drivers":{"id":"pages-for-subheaders/about-provisioning-drivers","title":"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"},"pages-for-subheaders/about-rke1-templates":{"id":"pages-for-subheaders/about-rke1-templates","title":"RKE Templates","description":"Available as of Rancher v2.3.0","sidebar":"tutorialSidebar"},"pages-for-subheaders/about-the-api":{"id":"pages-for-subheaders/about-the-api","title":"API","description":"How to use the API","sidebar":"tutorialSidebar"},"pages-for-subheaders/access-clusters":{"id":"pages-for-subheaders/access-clusters","title":"Cluster Access","description":"This section is about what tools can be used to access clusters managed by Rancher.","sidebar":"tutorialSidebar"},"pages-for-subheaders/advanced-options":{"id":"pages-for-subheaders/advanced-options","title":"Advanced","description":"The documents in this section contain resources for less common use cases.","sidebar":"tutorialSidebar"},"pages-for-subheaders/advanced-user-guides":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/air-gap-helm2":{"id":"pages-for-subheaders/air-gap-helm2","title":"Installing Rancher in an Air Gapped Environment with Helm 2","description":"After Helm 3 was released, the Rancher installation instructions were updated to use Helm 3.","sidebar":"tutorialSidebar"},"pages-for-subheaders/air-gapped-helm-cli-install":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/authentication-config":{"id":"pages-for-subheaders/authentication-config","title":"Authentication Config","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"},"pages-for-subheaders/authentication-permissions-and-global-configuration":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/backup-restore-and-disaster-recovery":{"id":"pages-for-subheaders/backup-restore-and-disaster-recovery","title":"Backups and Disaster Recovery","description":"This section is devoted to protecting your data in a disaster scenario.","sidebar":"tutorialSidebar"},"pages-for-subheaders/best-practices":{"id":"pages-for-subheaders/best-practices","title":"Best Practices Guide","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"},"pages-for-subheaders/checklist-for-production-ready-clusters":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/cis-scan-guides":{"id":"pages-for-subheaders/cis-scan-guides","title":"CIS Scan Guides","description":"- Run a Scan","sidebar":"tutorialSidebar"},"pages-for-subheaders/cis-scans":{"id":"pages-for-subheaders/cis-scans","title":"CIS Scans","description":"Available as of v2.4.0","sidebar":"tutorialSidebar"},"pages-for-subheaders/cli-with-rancher":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/cluster-alerts":{"id":"pages-for-subheaders/cluster-alerts","title":"Cluster Alerts","description":"To keep your clusters and applications healthy and driving your organizational productivity forward, you need to stay informed of events occurring in your clusters and projects, both planned and unplanned. When an event occurs, your alert is triggered, and you are sent a notification. You can then, if necessary, follow up with corrective actions.","sidebar":"tutorialSidebar"},"pages-for-subheaders/cluster-configuration":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/cluster-logging":{"id":"pages-for-subheaders/cluster-logging","title":"Cluster Logging","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"},"pages-for-subheaders/cluster-monitoring":{"id":"pages-for-subheaders/cluster-monitoring","title":"Integrating Rancher and Prometheus for Cluster Monitoring","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"},"pages-for-subheaders/cluster-yml":{"id":"pages-for-subheaders/cluster-yml","title":"cluster.yml Templates for RKE add-on installs","description":"These templates are intended to be used for RKE add-on installs, which are only supported up to Rancher v2.0.8. Please use the Rancher Helm chart if you are installing a newer Rancher version.","sidebar":"tutorialSidebar"},"pages-for-subheaders/configure-microsoft-ad-federation-service-saml":{"id":"pages-for-subheaders/configure-microsoft-ad-federation-service-saml","title":"Configuring Microsoft Active Directory Federation Service (SAML)","description":"Available as of v2.0.7","sidebar":"tutorialSidebar"},"pages-for-subheaders/configure-openldap":{"id":"pages-for-subheaders/configure-openldap","title":"Configuring OpenLDAP","description":"Available as of v2.0.5","sidebar":"tutorialSidebar"},"pages-for-subheaders/configure-shibboleth-saml":{"id":"pages-for-subheaders/configure-shibboleth-saml","title":"Configuring Shibboleth (SAML)","description":"Available as of v2.4.0","sidebar":"tutorialSidebar"},"pages-for-subheaders/create-kubernetes-persistent-storage":{"id":"pages-for-subheaders/create-kubernetes-persistent-storage","title":"Kubernetes Persistent Storage: 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"},"pages-for-subheaders/creating-a-vsphere-cluster":{"id":"pages-for-subheaders/creating-a-vsphere-cluster","title":"VSphere Node Template Configuration","description":"The vSphere node templates in Rancher were updated in the following Rancher versions. Refer to the newest configuration reference that is less than or equal to your Rancher version:","sidebar":"tutorialSidebar"},"pages-for-subheaders/deploy-rancher-manager":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/deploy-rancher-workloads":{"id":"pages-for-subheaders/deploy-rancher-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"},"pages-for-subheaders/downstream-cluster-configuration":{"id":"pages-for-subheaders/downstream-cluster-configuration","title":"Downstream Cluster Configuration","description":"The following docs will discuss node template configuration.","sidebar":"tutorialSidebar"},"pages-for-subheaders/enable-experimental-features":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/helm-charts-in-rancher":{"id":"pages-for-subheaders/helm-charts-in-rancher","title":"Helm Charts in Rancher","description":"Rancher enables the use of catalogs to repeatedly deploy applications easily. Catalogs are GitHub or Helm Chart repositories filled with deployment-ready apps.","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm-rancher":{"id":"pages-for-subheaders/helm-rancher","title":"4. Install Rancher","description":"Rancher installation is managed using the Helm package manager for Kubernetes. Use helm to install the prerequisite and charts to install Rancher.","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2":{"id":"pages-for-subheaders/helm2","title":"Kubernetes Installation Using Helm 2","description":"After Helm 3 was released, the Rancher installation instructions were updated to use Helm 3.","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2-create-nodes-lb":{"id":"pages-for-subheaders/helm2-create-nodes-lb","title":"1. Create Nodes and Load Balancer","description":"Use your provider of choice to provision 3 nodes and a Load Balancer endpoint for your RKE install.","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2-helm-init":{"id":"pages-for-subheaders/helm2-helm-init","title":"Initialize Helm: Install the Tiller Service","description":"With Helm, you can create configurable deployments instead of using static files. In order to use Helm, the Tiller service needs to be installed on your cluster.","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2-kubernetes-rke":{"id":"pages-for-subheaders/helm2-kubernetes-rke","title":"2. Install Kubernetes with RKE","description":"Use RKE to install Kubernetes with a high availability etcd configuration.","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2-rke-add-on":{"id":"pages-for-subheaders/helm2-rke-add-on","title":"RKE Add-On Install","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2-rke-add-on-layer-4-lb":{"id":"pages-for-subheaders/helm2-rke-add-on-layer-4-lb","title":"Kubernetes Install with External Load Balancer (TCP/Layer 4)","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2-rke-add-on-layer-7-lb":{"id":"pages-for-subheaders/helm2-rke-add-on-layer-7-lb","title":"Kubernetes Install with External Load Balancer (HTTPS/Layer 7)","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"pages-for-subheaders/helm2-rke-add-on-troubleshooting":{"id":"pages-for-subheaders/helm2-rke-add-on-troubleshooting","title":"Troubleshooting HA RKE Add-On Install","description":"#### Important: RKE add-on install is only supported up to Rancher v2.0.8","sidebar":"tutorialSidebar"},"pages-for-subheaders/horizontal-pod-autoscaler":{"id":"pages-for-subheaders/horizontal-pod-autoscaler","title":"The 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"},"pages-for-subheaders/infrastructure-setup":{"id":"pages-for-subheaders/infrastructure-setup","title":"Don\'t have infrastructure for your Kubernetes cluster? Try one of these tutorials.","description":"To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to this page.","sidebar":"tutorialSidebar"},"pages-for-subheaders/install-cluster-autoscaler":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster":{"id":"pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster","title":"Install 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"},"pages-for-subheaders/installation-and-upgrade":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/installation-references":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/installation-requirements":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/integrations-in-rancher":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/introduction":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/istio":{"id":"pages-for-subheaders/istio","title":"Istio","description":"Available as of v2.3.0","sidebar":"tutorialSidebar"},"pages-for-subheaders/istio-setup-guide":{"id":"pages-for-subheaders/istio-setup-guide","title":"Setup Guide","description":"This section describes how to enable Istio and start using it in your projects.","sidebar":"tutorialSidebar"},"pages-for-subheaders/kubernetes-cluster-setup":{"id":"pages-for-subheaders/kubernetes-cluster-setup","title":"Don\'t have a Kubernetes cluster? Try one of these tutorials.","description":"This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on.","sidebar":"tutorialSidebar"},"pages-for-subheaders/kubernetes-clusters-in-rancher-setup":{"id":"pages-for-subheaders/kubernetes-clusters-in-rancher-setup","title":"Setting up Kubernetes Clusters in Rancher","description":"Provisioning Kubernetes Clusters","sidebar":"tutorialSidebar"},"pages-for-subheaders/kubernetes-components":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/kubernetes-resources-setup":{"id":"pages-for-subheaders/kubernetes-resources-setup","title":"Kubernetes Resources","description":"Workloads","sidebar":"tutorialSidebar"},"pages-for-subheaders/launch-kubernetes-with-rancher":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/load-balancer-and-ingress-controller":{"id":"pages-for-subheaders/load-balancer-and-ingress-controller","title":"Set Up Load Balancer and Ingress Controller 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"},"pages-for-subheaders/manage-clusters":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/manage-persistent-storage":{"id":"pages-for-subheaders/manage-persistent-storage","title":"Manage Persistent Storage","description":"The following sections will explain how to manage persistent storage:","sidebar":"tutorialSidebar"},"pages-for-subheaders/manage-project-resource-quotas":{"id":"pages-for-subheaders/manage-project-resource-quotas","title":"Project Resource Quotas","description":"Available as of v2.1.0","sidebar":"tutorialSidebar"},"pages-for-subheaders/manage-projects":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/manage-role-based-access-control-rbac":{"id":"pages-for-subheaders/manage-role-based-access-control-rbac","title":"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"},"pages-for-subheaders/migrate-from-v1.6-v2.x":{"id":"pages-for-subheaders/migrate-from-v1.6-v2.x","title":"Migrating from v1.6 to v2.x","description":"Rancher v2.x has been rearchitected and rewritten with the goal of providing a complete management solution for Kubernetes and Docker. Due to these extensive changes, there is no direct upgrade path from v1.6 to v2.x, but rather a migration of your v1.6 services into v2.x as Kubernetes workloads. In v1.6, the most common orchestration used was Rancher\'s own engine called Cattle. The following guide explains and educates our Cattle users on running workloads in a Kubernetes environment.","sidebar":"tutorialSidebar"},"pages-for-subheaders/new-user-guides":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/node-template-configuration":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/other-cloud-providers":{"id":"pages-for-subheaders/other-cloud-providers","title":"Other Cloud Providers","description":"The following sections will outline how to set up the following cloud providers:","sidebar":"tutorialSidebar"},"pages-for-subheaders/other-installation-methods":{"id":"pages-for-subheaders/other-installation-methods","title":"Other Installation Methods","description":"Air Gapped Installations","sidebar":"tutorialSidebar"},"pages-for-subheaders/other-troubleshooting-tips":{"id":"pages-for-subheaders/other-troubleshooting-tips","title":"Other Troubleshooting Tips","description":"- Kubernetes Resources","sidebar":"tutorialSidebar"},"pages-for-subheaders/pipelines":{"id":"pages-for-subheaders/pipelines","title":"Pipelines","description":"Rancher\'s pipeline provides a simple CI/CD experience. Use it to automatically checkout code, run builds or scripts, publish Docker images or catalog applications, and deploy the updated software to users.","sidebar":"tutorialSidebar"},"pages-for-subheaders/project-tools":{"id":"pages-for-subheaders/project-tools","title":"Tools for Logging, Monitoring, and More","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"},"pages-for-subheaders/provisioning-storage-examples":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/quick-start-guides":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/rancher-behind-an-http-proxy":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/rancher-manager-architecture":{"id":"pages-for-subheaders/rancher-manager-architecture","title":"Architecture","description":"This section focuses on the Rancher server and its components and how Rancher communicates with downstream Kubernetes clusters.","sidebar":"tutorialSidebar"},"pages-for-subheaders/rancher-on-a-single-node-with-docker":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/rancher-security":{"id":"pages-for-subheaders/rancher-security","title":"Security","description":"Security policy","sidebar":"tutorialSidebar"},"pages-for-subheaders/rancher-server-configuration":{"id":"pages-for-subheaders/rancher-server-configuration","title":"Rancher Server Configuration","description":"- RKE1 Cluster Configuration","sidebar":"tutorialSidebar"},"pages-for-subheaders/rancher-v2.1-hardening-guides":{"id":"pages-for-subheaders/rancher-v2.1-hardening-guides","title":"Rancher v2.1","description":"Self Assessment Guide","sidebar":"tutorialSidebar"},"pages-for-subheaders/rancher-v2.2-hardening-guides":{"id":"pages-for-subheaders/rancher-v2.2-hardening-guides","title":"Rancher v2.2","description":"Self Assessment Guide","sidebar":"tutorialSidebar"},"pages-for-subheaders/rancher-v2.3-hardening-guides":{"id":"pages-for-subheaders/rancher-v2.3-hardening-guides","title":"Rancher v2.3.x","description":"The relevant Hardening Guide and Self Assessment guide depends on your Rancher version:","sidebar":"tutorialSidebar"},"pages-for-subheaders/rancher-v2.4-hardening-guides":{"id":"pages-for-subheaders/rancher-v2.4-hardening-guides","title":"Rancher v2.4","description":"Self Assessment Guide","sidebar":"tutorialSidebar"},"pages-for-subheaders/resources":{"id":"pages-for-subheaders/resources","title":"Resources","description":"Docker Installations","sidebar":"tutorialSidebar"},"pages-for-subheaders/rke-add-on":{"id":"pages-for-subheaders/rke-add-on","title":"RKE Add-On Install","description":"- Kubernetes Install with External Load Balancer (TCP/Layer 4)","sidebar":"tutorialSidebar"},"pages-for-subheaders/set-up-cloud-providers":{"id":"pages-for-subheaders/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. For more information, refer to the official Kubernetes documentation on cloud providers.","sidebar":"tutorialSidebar"},"pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/single-node-rancher-in-docker":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/upgrades":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/use-existing-nodes":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/use-new-nodes-in-an-infra-provider":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/use-windows-clusters":{"id":"pages-for-subheaders/use-windows-clusters","title":"Launching Kubernetes on Windows Clusters","description":"Available as of v2.3.0","sidebar":"tutorialSidebar"},"pages-for-subheaders/user-settings":{"id":"pages-for-subheaders/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"},"pages-for-subheaders/vsphere":{"id":"pages-for-subheaders/vsphere","title":"Creating a vSphere Cluster","description":"Use Rancher to create a 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"},"pages-for-subheaders/workloads-and-pods":{"id":"pages-for-subheaders/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"},"rancher-manager":{"id":"rancher-manager","title":"Rancher 2.0-2.4","description":"Rancher adds significant value on top of Kubernetes: managing hundreds of clusters from one interface, centralizing RBAC, enabling monitoring and alerting. Read more.","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/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/best-practices/containers":{"id":"reference-guides/best-practices/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/deployment-strategies":{"id":"reference-guides/best-practices/deployment-strategies","title":"Rancher Deployment Strategies","description":"There are two recommended deployment strategies. 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/deployment-types":{"id":"reference-guides/best-practices/deployment-types","title":"Tips for Running Rancher","description":"A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed \\"important.\\" Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment.","sidebar":"tutorialSidebar"},"reference-guides/best-practices/management":{"id":"reference-guides/best-practices/management","title":"Tips for Scaling, Security and Reliability","description":"Rancher allows you to set up numerous combinations of configurations. Some configurations are more appropriate for development and testing, while there are other best practices for production environments for maximum availability and fault tolerance. The following best practices should be followed for production.","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/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/vsphere/prior-to-v2.0.4":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/prior-to-v2.0.4","title":"vSphere Node Template Configuration in Rancher before v2.0.4","description":"Account Access","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.0.4":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.0.4","title":"vSphere Node Template Configuration in Rancher v2.0.4","description":"Account Access","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.2.0":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.2.0","title":"vSphere Node Template Configuration in Rancher v2.2.0","description":"Account Access","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.0":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.0","title":"vSphere Node Template Configuration in Rancher v2.3.0","description":"Account Access","sidebar":"tutorialSidebar"},"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.3":{"id":"reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.3","title":"vSphere Node Template Configuration in Rancher v2.3.3","description":"Account Access","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 Reference","description":"When Rancher installs Kubernetes, it uses RKE as the Kubernetes distribution.","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/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/amazon-eks-permissions":{"id":"reference-guides/installation-references/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/installation-references/feature-flags":{"id":"reference-guides/installation-references/feature-flags","title":"Feature Flags","description":"Feature flags were introduced to allow you to try experimental features that are not enabled by default.","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/tls-settings":{"id":"reference-guides/installation-references/tls-settings","title":"TLS Settings","description":"In Rancher v2.1.7, the default TLS configuration changed to only accept TLS 1.2 and secure TLS cipher suites. TLS 1.3 and TLS 1.3 exclusive cipher suites are not supported.","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/pipelines/concepts":{"id":"reference-guides/pipelines/concepts","title":"Concepts","description":"The purpose of this page is to explain common concepts and terminology related to pipelines.","sidebar":"tutorialSidebar"},"reference-guides/pipelines/configure-persistent-data":{"id":"reference-guides/pipelines/configure-persistent-data","title":"Configuring Persistent Data for Pipeline Components","description":"The pipelines\' internal Docker registry and the Minio workloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes.","sidebar":"tutorialSidebar"},"reference-guides/pipelines/example-repositories":{"id":"reference-guides/pipelines/example-repositories","title":"Example Repositories","description":"Rancher ships with several example repositories that you can use to familiarize yourself with pipelines. We recommend configuring and testing the example repository that most resembles your environment before using pipelines with your own repositories in a production environment. Use this example repository as a sandbox for repo configuration, build demonstration, etc. Rancher includes example repositories for:","sidebar":"tutorialSidebar"},"reference-guides/pipelines/example-yaml":{"id":"reference-guides/pipelines/example-yaml","title":"Example YAML File","description":"Pipelines can be configured either through the UI or using a yaml file in the repository, i.e. .rancher-pipeline.yml or .rancher-pipeline.yaml.","sidebar":"tutorialSidebar"},"reference-guides/pipelines/pipeline-configuration":{"id":"reference-guides/pipelines/pipeline-configuration","title":"Pipeline Configuration Reference","description":"In this section, you\'ll learn how to configure pipelines.","sidebar":"tutorialSidebar"},"reference-guides/pipelines/v2.0.x":{"id":"reference-guides/pipelines/v2.0.x","title":"v2.0.x Pipeline Documentation","description":"Note: This section describes the pipeline feature as implemented in Rancher v2.0.x. If you are using Rancher v2.1 or later, where pipelines have been significantly improved, please refer to the new documentation for v2.1 or later.","sidebar":"tutorialSidebar"},"reference-guides/rancher-cluster-tools":{"id":"reference-guides/rancher-cluster-tools","title":"Tools for Logging, Monitoring, and More","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 cluster 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-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/project-alerts":{"id":"reference-guides/rancher-project-tools/project-alerts","title":"Project Alerts","description":"To keep your clusters and applications healthy and driving your organizational productivity forward, you need to stay informed of events occurring in your clusters and projects, both planned and unplanned. When an event occurs, your alert is triggered, and you are sent a notification. You can then, if necessary, follow up with corrective actions.","sidebar":"tutorialSidebar"},"reference-guides/rancher-project-tools/project-logging":{"id":"reference-guides/rancher-project-tools/project-logging","title":"Project Logging","description":"Rancher can integrate with a variety of popular logging services and tools that exist outside of your Kubernetes clusters.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.1-hardening-guides/hardening-guide-with-cis-v1.3-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.1-hardening-guides/hardening-guide-with-cis-v1.3-benchmark","title":"Hardening Guide v2.1","description":"This document provides prescriptive guidance for hardening a production installation of Rancher v2.1.x. 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.1-hardening-guides/self-assessment-guide-with-cis-v1.3-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.1-hardening-guides/self-assessment-guide-with-cis-v1.3-benchmark","title":"CIS Benchmark Rancher Self-Assessment Guide v2.1","description":"This document is a companion to the Rancher v2.1 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.2-hardening-guides/hardening-guide-with-cis-v1.4-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.2-hardening-guides/hardening-guide-with-cis-v1.4-benchmark","title":"Hardening Guide v2.2","description":"This document provides prescriptive guidance for hardening a production installation of Rancher v2.2.x. 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.2-hardening-guides/self-assessment-guide-with-cis-v1.4-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.2-hardening-guides/self-assessment-guide-with-cis-v1.4-benchmark","title":"CIS Benchmark Rancher Self-Assessment Guide v2.2","description":"This document is a companion to the Rancher v2.2 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-hardening-guide-with-cis-v1.4.1-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-hardening-guide-with-cis-v1.4.1-benchmark","title":"Hardening Guide v2.3","description":"This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.0-v2.3.2. 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.3-hardening-guides/rancher-v2.3.0-self-assessment-guide-with-cis-v1.4.1-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-self-assessment-guide-with-cis-v1.4.1-benchmark","title":"CIS Benchmark Rancher Self-Assessment Guide v2.3","description":"This document is a companion to the Rancher v2.3 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-hardening-guide-with-cis-v1.4.1-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-hardening-guide-with-cis-v1.4.1-benchmark","title":"Hardening Guide v2.3.3","description":"This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.3. 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.3-hardening-guides/rancher-v2.3.3-self-assessment-guide-with-cis-v1.4.1-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-self-assessment-guide-with-cis-v1.4.1-benchmark","title":"CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.3","description":"This document is a companion to the Rancher v2.3.3 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-hardening-guide-with-cis-v1.5-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-hardening-guide-with-cis-v1.5-benchmark","title":"Hardening Guide v2.3.5","description":"This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.5. 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.3-hardening-guides/rancher-v2.3.5-self-assessment-guide-with-cis-v1.5-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-self-assessment-guide-with-cis-v1.5-benchmark","title":"CIS Benchmark Rancher Self-Assessment Guide - v2.3.5","description":"CIS Kubernetes Benchmark v1.5 - Rancher v2.3.5 with Kubernetes v1.15","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/rancher-v2.4-hardening-guides/hardening-guide-with-cis-v1.5-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.4-hardening-guides/hardening-guide-with-cis-v1.5-benchmark","title":"Hardening Guide v2.4","description":"This document provides prescriptive guidance for hardening a production installation of Rancher v2.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.4-hardening-guides/self-assessment-guide-with-cis-v1.5-benchmark":{"id":"reference-guides/rancher-security/rancher-v2.4-hardening-guides/self-assessment-guide-with-cis-v1.5-benchmark","title":"CIS Benchmark Rancher Self-Assessment Guide - v2.4","description":"CIS Kubernetes Benchmark v1.5 - Rancher v2.4 with Kubernetes v1.15","sidebar":"tutorialSidebar"},"reference-guides/rancher-security/security-advisories-and-cves":{"id":"reference-guides/rancher-security/security-advisories-and-cves","title":"Rancher CVEs and Resolutions","description":"Rancher is committed to informing the community of security issues in our products. Rancher will publish CVEs (Common Vulnerabilities and Exposures) for issues we have resolved.","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/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":"Available as of v2.2.0","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/v1.6-migration/migration-tools-cli-reference":{"id":"reference-guides/v1.6-migration/migration-tools-cli-reference","title":"Migration Tools CLI Reference","description":"The migration-tools CLI includes multiple commands and options to assist your migration from Rancher v1.6 to Rancher v2.x.","sidebar":"tutorialSidebar"},"security/rancher-2.3.x/rancher-v2.3.0/rancher-v2.3.0":{"id":"security/rancher-2.3.x/rancher-v2.3.0/rancher-v2.3.0","title":"Rancher v2.3.0","description":"Self Assessment Guide"},"security/rancher-2.3.x/rancher-v2.3.3/rancher-v2.3.3":{"id":"security/rancher-2.3.x/rancher-v2.3.3/rancher-v2.3.3","title":"Rancher v2.3.3","description":"Self Assessment Guide"},"security/rancher-2.3.x/rancher-v2.3.5/rancher-v2.3.5":{"id":"security/rancher-2.3.x/rancher-v2.3.5/rancher-v2.3.5","title":"Rancher v2.3.5","description":"Self Assessment Guide"},"security/security-scan/security-scan":{"id":"security/security-scan/security-scan","title":"Security Scans","description":"The documentation about CIS security scans has moved here."},"troubleshooting":{"id":"troubleshooting","title":"Troubleshooting","description":"This section contains information to help you troubleshoot issues when using Rancher.","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/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/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":"Imported clusters","description":"The commands/steps listed on this page can be used to check clusters that you are importing or that are imported in Rancher.","sidebar":"tutorialSidebar"}}}');
/***/ })
}]);
Reference in New Issue View Git Blame Copy Permalink