{ "tutorialSidebar": [ "rancher-manager", { "type": "category", "label": "Getting Started", "link": { "type": "doc", "id": "getting-started" }, "items": [ { "type": "category", "label": "Introduction", "link": { "type": "doc", "id": "pages-for-subheaders/introduction" }, "items": [ "getting-started/introduction/overview", "getting-started/introduction/what-are-divio-docs" ] }, { "type": "category", "label": "Quick Start Guides", "link": { "type": "doc", "id": "pages-for-subheaders/quick-start-guides" }, "items": [ "getting-started/quick-start-guides/cli", { "type": "category", "label": "Deploy Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/deploy-rancher-manager" }, "items": [ "getting-started/quick-start-guides/deploy-rancher-manager/aws", "getting-started/quick-start-guides/deploy-rancher-manager/azure", "getting-started/quick-start-guides/deploy-rancher-manager/digitalocean", "getting-started/quick-start-guides/deploy-rancher-manager/gcp", "getting-started/quick-start-guides/deploy-rancher-manager/vagrant", "getting-started/quick-start-guides/deploy-rancher-manager/helm-cli" ] }, { "type": "category", "label": "Deploy Rancher Workloads", "link": { "type": "doc", "id": "pages-for-subheaders/deploy-rancher-workloads" }, "items": [ "getting-started/quick-start-guides/deploy-workloads/workload-ingress", "getting-started/quick-start-guides/deploy-workloads/nodeports" ] } ] }, { "type": "category", "label": "Installation and Upgrade", "link": { "type": "doc", "id": "pages-for-subheaders/installation-and-upgrade" }, "items": [ { "type": "category", "label": "Installation Requirements", "link": { "type": "doc", "id": "pages-for-subheaders/installation-requirements" }, "items": [ "getting-started/installation-and-upgrade/installation-requirements/install-docker", "getting-started/installation-and-upgrade/installation-requirements/port-requirements" ] }, { "type": "category", "label": "Install/Upgrade on a Kubernetes Cluster", "link": { "type": "doc", "id": "pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster" }, "items": [ "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting", { "type": "category", "label": "Upgrades", "link": { "type": "doc", "id": "pages-for-subheaders/upgrades" }, "items": [ "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2" ] } ] }, { "type": "category", "label": "Other Installation Methods", "link": { "type": "doc", "id": "pages-for-subheaders/other-installation-methods" }, "items": [ { "type": "category", "label": "Air-Gapped Helm CLI Install", "link": { "type": "doc", "id": "pages-for-subheaders/air-gapped-helm-cli-install" }, "items": [ "getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry", "getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images", "getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes", "getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha" ] }, { "type": "category", "label": "Rancher on a Single Node with Docker", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-on-a-single-node-with-docker" }, "items": [ "getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher", "getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher", "getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting" ] }, { "type": "category", "label": "Rancher Behind an HTTP Proxy", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-behind-an-http-proxy" }, "items": [ "getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure", "getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes", "getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher" ] } ] }, { "type": "category", "label": "Resources", "link": { "type": "doc", "id": "pages-for-subheaders/resources" }, "items": [ "getting-started/installation-and-upgrade/resources/choose-a-rancher-version", "getting-started/installation-and-upgrade/resources/helm-version-requirements", "getting-started/installation-and-upgrade/resources/add-tls-secrets", "getting-started/installation-and-upgrade/resources/custom-ca-root-certificates", "getting-started/installation-and-upgrade/resources/upgrade-cert-manager", "getting-started/installation-and-upgrade/resources/upgrade-cert-manager-helm-2", "getting-started/installation-and-upgrade/resources/update-rancher-certificate", "getting-started/installation-and-upgrade/resources/local-system-charts" ] }, "getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes", "getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher", { "type": "category", "label": "Advanced Options", "link": { "type": "doc", "id": "pages-for-subheaders/advanced-options" }, "items": [ { "type": "category", "label": "Enable Experimental Features", "link": { "type": "doc", "id": "pages-for-subheaders/enable-experimental-features" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64", "getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers", "getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features" ] }, { "type": "category", "label": "Advanced Use Cases", "items": [ { "type": "category", "label": "Kubernetes Installation Using Helm 2", "link": { "type": "doc", "id": "pages-for-subheaders/helm2" }, "items": [ { "type": "category", "label": "Create Nodes and Load Balancer", "link": { "type": "doc", "id": "pages-for-subheaders/helm2-create-nodes-lb" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nginx", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/create-nodes-lb/nlb" ] }, { "type": "category", "label": "Install Kubernetes with RKE", "link": { "type": "doc", "id": "pages-for-subheaders/helm2-kubernetes-rke" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/kubernetes-rke/troubleshooting" ] }, { "type": "category", "label": "Initialize Helm: Install the Tiller Service", "link": { "type": "doc", "id": "pages-for-subheaders/helm2-helm-init" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-init/troubleshooting" ] }, { "type": "category", "label": "Install Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/helm-rancher" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/tls-secrets", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/chart-options", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm-rancher/troubleshooting" ] }, { "type": "category", "label": "RKE Add-On Install", "link": { "type": "doc", "id": "pages-for-subheaders/helm2-rke-add-on" }, "items": [ { "type": "category", "label": "Kubernetes Install with External Load Balancer (TCP/Layer 4)", "link": { "type": "doc", "id": "pages-for-subheaders/helm2-rke-add-on-layer-4-lb" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-4-lb/nlb" ] }, { "type": "category", "label": "Kubernetes Install with External Load Balancer (HTTPS/Layer 7)", "link": { "type": "doc", "id": "pages-for-subheaders/helm2-rke-add-on-layer-7-lb" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/alb", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/nginx" ] }, "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy", "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", "link": { "type": "doc", "id": "pages-for-subheaders/helm2-rke-add-on-troubleshooting" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/generic-troubleshooting", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/job-complete-status", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/troubleshooting/default-backend" ] } ] } ] }, { "type": "category", "label": "Installing Rancher in an Air Gapped Environment with Helm 2", "link": { "type": "doc", "id": "pages-for-subheaders/air-gap-helm2" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/prepare-nodes", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/populate-private-registry", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/launch-kubernetes", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/install-rancher" ] }, "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs", "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", "link": { "type": "doc", "id": "pages-for-subheaders/cluster-yml" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-certificate-recognizedca", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-certificate", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/cluster-yml-templates/node-externalssl-recognizedca" ] }, "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer", { "type": "category", "label": "RKE Add-On", "link": { "type": "doc", "id": "pages-for-subheaders/rke-add-on" }, "items": [ "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-4-lb", "getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/rke-add-on/layer-7-lb" ] } ] } ] } ] } ] }, { "type": "category", "label": "How-to Guides", "link": { "type": "doc", "id": "how-to-guides" }, "items": [ { "type": "category", "label": "New User Guides", "link": { "type": "doc", "id": "pages-for-subheaders/new-user-guides" }, "items": [ { "type": "category", "label": "Kubernetes Cluster Setup", "link": { "type": "doc", "id": "pages-for-subheaders/kubernetes-cluster-setup" }, "items": [ "how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs", "how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher", "how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher" ] }, { "type": "category", "label": "Infrastructure Setup", "link": { "type": "doc", "id": "pages-for-subheaders/infrastructure-setup" }, "items": [ "how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster", "how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster", "how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2", "how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds", "how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer", "how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer" ] }, { "type": "category", "label": "Kubernetes Clusters in Rancher Setup", "link": { "type": "doc", "id": "pages-for-subheaders/kubernetes-clusters-in-rancher-setup" }, "items": [ "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", "link": { "type": "doc", "id": "pages-for-subheaders/checklist-for-production-ready-clusters" }, "items": [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes" ] }, { "type": "category", "label": "Set Up Clusters from Hosted Kubernetes Providers", "link": { "type": "doc", "id": "pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers" }, "items": [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei" ] }, { "type": "category", "label": "Launch Kubernetes with Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/launch-kubernetes-with-rancher" }, "items": [ { "type": "category", "label": "Use New Nodes in an Infra Provider", "link": { "type": "doc", "id": "pages-for-subheaders/use-new-nodes-in-an-infra-provider" }, "items": [ "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", "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", "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", "link": { "type": "doc", "id": "pages-for-subheaders/vsphere" }, "items": [ "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", "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" ] } ] }, { "type": "category", "label": "Use Windows Clusters", "link": { "type": "doc", "id": "pages-for-subheaders/use-windows-clusters" }, "items": [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/v2.1-v2.2" ] }, { "type": "category", "label": "Set Up Cloud Providers", "link": { "type": "doc", "id": "pages-for-subheaders/set-up-cloud-providers" }, "items": [ { "type": "category", "label": "Other Cloud Providers", "link": { "type": "doc", "id": "pages-for-subheaders/other-cloud-providers" }, "items": [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure", "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", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/vsphere" ] } ] }, "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents" ] }, "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/import-existing-clusters" ] }, { "type": "category", "label": "Kubernetes Resources Setup", "link": { "type": "doc", "id": "pages-for-subheaders/kubernetes-resources-setup" }, "items": [ { "type": "category", "label": "Workloads and Pods", "link": { "type": "doc", "id": "pages-for-subheaders/workloads-and-pods" }, "items": [ "how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads", "how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads", "how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads", "how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar" ] }, { "type": "category", "label": "Horizontal Pod Autoscaler", "link": { "type": "doc", "id": "pages-for-subheaders/horizontal-pod-autoscaler" }, "items": [ "how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/hpa-for-rancher-before-2.0.7", "how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas", "how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui", "how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl", "how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl" ] }, { "type": "category", "label": "Load Balancer and Ingress Controller", "link": { "type": "doc", "id": "pages-for-subheaders/load-balancer-and-ingress-controller" }, "items": [ "how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing", "how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses" ] }, "how-to-guides/new-user-guides/kubernetes-resources-setup/create-services", "how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication", "how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps", "how-to-guides/new-user-guides/kubernetes-resources-setup/secrets", "how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries" ] }, { "type": "category", "label": "Helm Charts in Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/helm-charts-in-rancher" }, "items": [ "how-to-guides/new-user-guides/helm-charts-in-rancher/built-in", "how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs", "how-to-guides/new-user-guides/helm-charts-in-rancher/catalog-config", "how-to-guides/new-user-guides/helm-charts-in-rancher/creating-apps", "how-to-guides/new-user-guides/helm-charts-in-rancher/managing-apps", "how-to-guides/new-user-guides/helm-charts-in-rancher/multi-cluster-apps", "how-to-guides/new-user-guides/helm-charts-in-rancher/launching-apps", "how-to-guides/new-user-guides/helm-charts-in-rancher/tutorial", "how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns" ] }, "how-to-guides/new-user-guides/deploy-apps-across-clusters", { "type": "category", "label": "Backup, Restore, and Disaster Recovery", "link": { "type": "doc", "id": "pages-for-subheaders/backup-restore-and-disaster-recovery" }, "items": [ "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-k3s-installed-rancher", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-k3s-installed-rancher", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup", "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" ] }, { "type": "category", "label": "Migrating from v1.6 to v2.x", "link": { "type": "doc", "id": "pages-for-subheaders/migrate-from-v1.6-v2.x" }, "items": [ "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/kubernetes-introduction", "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/install-and-configure-rancher", "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/migrate-services", "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/expose-services", "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/monitor-apps", "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/schedule-services", "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/discover-services", "how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/load-balancing" ] } ] }, { "type": "category", "label": "Advanced User Guides", "link": { "type": "doc", "id": "pages-for-subheaders/advanced-user-guides" }, "items": [ { "type": "category", "label": "Authentication, Permissions, and Global Configuration", "link": { "type": "doc", "id": "pages-for-subheaders/authentication-permissions-and-global-configuration" }, "items": [ { "type": "category", "label": "About Authentication", "link": { "type": "doc", "id": "pages-for-subheaders/about-authentication" }, "items": [ { "type": "category", "label": "Authentication Config", "link": { "type": "doc", "id": "pages-for-subheaders/authentication-config" }, "items": [ "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml" ] }, { "type": "category", "label": "Configure Microsoft AD Federation Service (SAML)", "link": { "type": "doc", "id": "pages-for-subheaders/configure-microsoft-ad-federation-service-saml" }, "items": [ "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs" ] }, { "type": "category", "label": "Configure Shibboleth (SAML)", "link": { "type": "doc", "id": "pages-for-subheaders/configure-shibboleth-saml" }, "items": [ "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions" ] } ] }, { "type": "category", "label": "Manage Role-Based Access Control (RBAC)", "link": { "type": "doc", "id": "pages-for-subheaders/manage-role-based-access-control-rbac" }, "items": [ "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles" ] }, { "type": "category", "label": "About Provisioning Drivers", "link": { "type": "doc", "id": "pages-for-subheaders/about-provisioning-drivers" }, "items": [ "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers" ] }, { "type": "category", "label": "About RKE1 Templates", "link": { "type": "doc", "id": "pages-for-subheaders/about-rke1-templates" }, "items": [ "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases" ] }, "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies", "how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry" ] }, { "type": "category", "label": "Manage Clusters", "link": { "type": "doc", "id": "pages-for-subheaders/manage-clusters" }, "items": [ { "type": "category", "label": "Access Clusters", "link": { "type": "doc", "id": "pages-for-subheaders/access-clusters" }, "items": [ "how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig", "how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint", "how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters" ] }, "how-to-guides/advanced-user-guides/manage-clusters/backing-up-etcd", "how-to-guides/advanced-user-guides/manage-clusters/restoring-etcd", { "type": "category", "label": "Install Cluster Autoscaler", "link": { "type": "doc", "id": "pages-for-subheaders/install-cluster-autoscaler" }, "items": [ "how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups" ] }, { "type": "category", "label": "Create Kubernetes Persistent Storage", "link": { "type": "doc", "id": "pages-for-subheaders/create-kubernetes-persistent-storage" }, "items": [ { "type": "category", "label": "Manage Persistent Storage", "link": { "type": "doc", "id": "pages-for-subheaders/manage-persistent-storage" }, "items": [ "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage", "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage", "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage", "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes", "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes" ] }, { "type": "category", "label": "Provisioning Storage Examples", "link": { "type": "doc", "id": "pages-for-subheaders/provisioning-storage-examples" }, "items": [ "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs", "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage", "how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage" ] } ] }, "how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces", "how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration", "how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates", "how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools", "how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes", "how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy", "how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies" ] }, { "type": "category", "label": "Manage Projects", "link": { "type": "doc", "id": "pages-for-subheaders/manage-projects" }, "items": [ "how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects", "how-to-guides/advanced-user-guides/manage-projects/manage-namespaces", "how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines", "how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies", { "type": "category", "label": "Manage Project Resource Quotas", "link": { "type": "doc", "id": "pages-for-subheaders/manage-project-resource-quotas" }, "items": [ "how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas", "how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces", "how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/set-container-default-resource-limits", "how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types" ] } ] }, { "type": "category", "label": "Istio Setup Guide", "link": { "type": "doc", "id": "pages-for-subheaders/istio-setup-guide" }, "items": [ "how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster", "how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster-with-psp", "how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace", "how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors", "how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar", "how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway", "how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management", "how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic" ] }, { "type": "category", "label": "CIS Scan Guides", "link": { "type": "doc", "id": "pages-for-subheaders/cis-scan-guides" }, "items": [ "how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan", "how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule", "how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests", "how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule", "how-to-guides/advanced-user-guides/cis-scan-guides/delete-a-report", "how-to-guides/advanced-user-guides/cis-scan-guides/download-a-report" ] } ] } ] }, { "type": "category", "label": "Reference Guides", "link": { "type": "doc", "id": "reference-guides" }, "items": [ { "type": "category", "label": "Best Practices", "link": { "type": "doc", "id": "pages-for-subheaders/best-practices" }, "items": [ "reference-guides/best-practices/containers", "reference-guides/best-practices/deployment-strategies", "reference-guides/best-practices/deployment-types", "reference-guides/best-practices/management" ] }, { "type": "category", "label": "Rancher Architecture", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-manager-architecture" }, "items": [ "reference-guides/rancher-manager-architecture/rancher-server-and-components", "reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters", "reference-guides/rancher-manager-architecture/architecture-recommendations" ] }, { "type": "category", "label": "Cluster Configuration", "link": { "type": "doc", "id": "pages-for-subheaders/cluster-configuration" }, "items": [ { "type": "category", "label": "Rancher Server Configuration", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-server-configuration" }, "items": [ "reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration", { "type": "category", "label": "Use Existing Nodes", "link": { "type": "doc", "id": "pages-for-subheaders/use-existing-nodes" }, "items": [ "reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options" ] } ] }, { "type": "category", "label": "Downstream Cluster Configuration", "link": { "type": "doc", "id": "pages-for-subheaders/downstream-cluster-configuration" }, "items": [ { "type": "category", "label": "Node Template Configuration", "link": { "type": "doc", "id": "pages-for-subheaders/node-template-configuration" }, "items": [ "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure", { "type": "category", "label": "Creating a vSphere Cluster", "link": { "type": "doc", "id": "pages-for-subheaders/creating-a-vsphere-cluster" }, "items": [ "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.3", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.3.0", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.2.0", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/v2.0.4", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere/prior-to-v2.0.4" ] } ] } ] } ] }, { "type": "category", "label": "Single-Node Rancher in Docker", "link": { "type": "doc", "id": "pages-for-subheaders/single-node-rancher-in-docker" }, "items": [ "reference-guides/single-node-rancher-in-docker/http-proxy-configuration", "reference-guides/single-node-rancher-in-docker/advanced-options" ] }, { "type": "category", "label": "Installation References", "link": { "type": "doc", "id": "pages-for-subheaders/installation-references" }, "items": [ "reference-guides/installation-references/helm-chart-options", "reference-guides/installation-references/tls-settings", "reference-guides/installation-references/feature-flags" ] }, "reference-guides/installation-references/amazon-eks-permissions", { "type": "category", "label": "Configure OpenLDAP", "link": { "type": "doc", "id": "pages-for-subheaders/configure-openldap" }, "items": [ "reference-guides/configure-openldap/openldap-config-reference" ] }, "reference-guides/kubernetes-concepts", { "type": "category", "label": "User Settings", "link": { "type": "doc", "id": "pages-for-subheaders/user-settings" }, "items": [ "reference-guides/user-settings/api-keys", "reference-guides/user-settings/manage-node-templates", "reference-guides/user-settings/manage-cloud-credentials", "reference-guides/user-settings/user-preferences" ] }, { "type": "category", "label": "CLI with Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/cli-with-rancher" }, "items": [ "reference-guides/cli-with-rancher/rancher-cli", "reference-guides/cli-with-rancher/kubectl-utility" ] }, { "type": "category", "label": "About the API", "link": { "type": "doc", "id": "pages-for-subheaders/about-the-api" }, "items": [ "reference-guides/about-the-api/api-tokens" ] }, "reference-guides/rancher-cluster-tools", { "type": "category", "label": "Project Tools", "link": { "type": "doc", "id": "pages-for-subheaders/project-tools" }, "items": [ "reference-guides/rancher-project-tools/project-alerts", "reference-guides/rancher-project-tools/project-logging" ] }, "reference-guides/system-tools", "reference-guides/rke1-template-example-yaml", { "type": "category", "label": "Pipelines", "link": { "type": "doc", "id": "pages-for-subheaders/pipelines" }, "items": [ "reference-guides/pipelines/concepts", "reference-guides/pipelines/pipeline-configuration", "reference-guides/pipelines/configure-persistent-data", "reference-guides/pipelines/example-repositories", "reference-guides/pipelines/example-yaml", "reference-guides/pipelines/v2.0.x" ] }, { "type": "category", "label": "Rancher Security", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-security" }, "items": [ { "type": "category", "label": "Rancher v2.1 Hardening Guides", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-v2.1-hardening-guides" }, "items": [ "reference-guides/rancher-security/rancher-v2.1-hardening-guides/self-assessment-guide-with-cis-v1.3-benchmark", "reference-guides/rancher-security/rancher-v2.1-hardening-guides/hardening-guide-with-cis-v1.3-benchmark" ] }, { "type": "category", "label": "Rancher v2.2 Hardening Guides", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-v2.2-hardening-guides" }, "items": [ "reference-guides/rancher-security/rancher-v2.2-hardening-guides/self-assessment-guide-with-cis-v1.4-benchmark", "reference-guides/rancher-security/rancher-v2.2-hardening-guides/hardening-guide-with-cis-v1.4-benchmark" ] }, { "type": "category", "label": "Rancher v2.3 Hardening Guides", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-v2.3-hardening-guides" }, "items": [ "reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-self-assessment-guide-with-cis-v1.4.1-benchmark", "reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.0-hardening-guide-with-cis-v1.4.1-benchmark", "reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-self-assessment-guide-with-cis-v1.4.1-benchmark", "reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.3-hardening-guide-with-cis-v1.4.1-benchmark", "reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-self-assessment-guide-with-cis-v1.5-benchmark", "reference-guides/rancher-security/rancher-v2.3-hardening-guides/rancher-v2.3.5-hardening-guide-with-cis-v1.5-benchmark" ] }, { "type": "category", "label": "Rancher v2.4 Hardening Guides", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-v2.4-hardening-guides" }, "items": [ "reference-guides/rancher-security/rancher-v2.4-hardening-guides/self-assessment-guide-with-cis-v1.5-benchmark", "reference-guides/rancher-security/rancher-v2.4-hardening-guides/hardening-guide-with-cis-v1.5-benchmark" ] }, "reference-guides/rancher-security/security-advisories-and-cves" ] }, "reference-guides/v1.6-migration/migration-tools-cli-reference" ] }, { "type": "category", "label": "Explanations", "link": { "type": "doc", "id": "explanations" }, "items": [ { "type": "category", "label": "Integrations in Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/integrations-in-rancher" }, "items": [ { "type": "category", "label": "CIS Scans", "link": { "type": "doc", "id": "pages-for-subheaders/cis-scans" }, "items": [ "explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests" ] }, { "type": "category", "label": "Istio", "link": { "type": "doc", "id": "pages-for-subheaders/istio" }, "items": [ "explanations/integrations-in-rancher/istio/cpu-and-memory-allocations", "explanations/integrations-in-rancher/istio/rbac-for-istio", "explanations/integrations-in-rancher/istio/disable-istio", "explanations/integrations-in-rancher/istio/release-notes" ] }, { "type": "category", "label": "Logging", "link": { "type": "doc", "id": "pages-for-subheaders/cluster-logging" }, "items": [ "explanations/integrations-in-rancher/cluster-logging/elasticsearch", "explanations/integrations-in-rancher/cluster-logging/fluentd", "explanations/integrations-in-rancher/cluster-logging/kafka", "explanations/integrations-in-rancher/cluster-logging/splunk", "explanations/integrations-in-rancher/cluster-logging/syslog" ] }, { "type": "category", "label": "Alerting", "link": { "type": "doc", "id": "pages-for-subheaders/cluster-alerts" }, "items": [ "explanations/integrations-in-rancher/cluster-alerts/default-alerts" ] }, { "type": "category", "label": "Monitoring", "link": { "type": "doc", "id": "pages-for-subheaders/cluster-monitoring" }, "items": [ "explanations/integrations-in-rancher/cluster-monitoring/cluster-metrics", "explanations/integrations-in-rancher/cluster-monitoring/custom-metrics", "explanations/integrations-in-rancher/cluster-monitoring/expression", "explanations/integrations-in-rancher/cluster-monitoring/project-monitoring", "explanations/integrations-in-rancher/cluster-monitoring/prometheus", "explanations/integrations-in-rancher/cluster-monitoring/viewing-metrics" ] }, "explanations/integrations-in-rancher/opa-gatekeeper", "explanations/integrations-in-rancher/notifiers" ] } ] }, { "type": "category", "label": "FAQ", "link": { "type": "doc", "id": "faq" }, "items": [ "faq/install-and-configure-kubectl", "faq/technical-items", "faq/security", "faq/telemetry", "faq/upgrades-to-2x", "faq/networking", "faq/container-network-interface-providers", "faq/rancher-is-no-longer-needed" ] }, { "type": "category", "label": "Troubleshooting", "link": { "type": "doc", "id": "troubleshooting" }, "items": [ { "type": "category", "label": "Kubernetes Components", "link": { "type": "doc", "id": "pages-for-subheaders/kubernetes-components" }, "items": [ "troubleshooting/kubernetes-components/troubleshooting-etcd-nodes", "troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes", "troubleshooting/kubernetes-components/troubleshooting-nginx-proxy", "troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components" ] }, { "type": "category", "label": "Other Troubleshooting Tips", "link": { "type": "doc", "id": "pages-for-subheaders/other-troubleshooting-tips" }, "items": [ "troubleshooting/other-troubleshooting-tips/kubernetes-resources", "troubleshooting/other-troubleshooting-tips/networking", "troubleshooting/other-troubleshooting-tips/dns", "troubleshooting/other-troubleshooting-tips/rancher-ha", "troubleshooting/other-troubleshooting-tips/registered-clusters", "troubleshooting/other-troubleshooting-tips/logging" ] } ] }, "contribute-to-rancher" ] }