/** * Creating a sidebar enables you to: - create an ordered group of docs - render a sidebar for each doc of that group - provide next/previous navigation The sidebars can be generated from the filesystem, or explicitly defined here. Create as many sidebars as you want. */ // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], // But you can create a sidebar manually tutorialSidebar: [ "rancher-manager", { type: "category", label: "Getting Started", items: [ "getting-started/overview", { type: "category", label: "Quick Start Guides", link: { type: "doc", id: "getting-started/quick-start-guides/quick-start-guides", }, items: [ { type: "category", label: "Deploying Rancher Server", link: { type: "doc", id: "getting-started/quick-start-guides/deploy-rancher-manager/deploy-rancher-manager", }, items: [ "getting-started/quick-start-guides/deploy-rancher-manager/aws", "getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace", "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/hetzner-cloud", "getting-started/quick-start-guides/deploy-rancher-manager/linode", "getting-started/quick-start-guides/deploy-rancher-manager/vagrant", "getting-started/quick-start-guides/deploy-rancher-manager/equinix-metal", "getting-started/quick-start-guides/deploy-rancher-manager/outscale-qs", "getting-started/quick-start-guides/deploy-rancher-manager/helm-cli", ], }, "getting-started/quick-start-guides/deploy-rancher-manager/prime", { type: "category", label: "Deploying Workloads", link: { type: "doc", id: "getting-started/quick-start-guides/deploy-workloads/deploy-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: "getting-started/installation-and-upgrade/installation-and-upgrade", }, items: [ { type: "category", label: "Installation Requirements", link: { type: "doc", id: "getting-started/installation-and-upgrade/installation-requirements/installation-requirements", }, items: [ "getting-started/installation-and-upgrade/installation-requirements/port-requirements", ], }, { type: "category", label: "Installation References", link: { type: "doc", id: "getting-started/installation-and-upgrade/installation-references/installation-references", }, items: [ "getting-started/installation-and-upgrade/installation-references/helm-chart-options", "getting-started/installation-and-upgrade/installation-references/tls-settings", "getting-started/installation-and-upgrade/installation-references/feature-flags", ], }, { type: "category", label: "Install/Upgrade on a Kubernetes Cluster", link: { type: "doc", id: "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/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/upgrades", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke", "getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting", ], }, { type: "category", label: "Other Installation Methods", link: { type: "doc", id: "getting-started/installation-and-upgrade/other-installation-methods/other-installation-methods", }, items: [ { type: "category", label: "Air-Gapped Helm CLI Install", link: { type: "doc", id: "getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/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", "getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands", ], }, { type: "category", label: "Rancher on a Single Node with Docker", link: { type: "doc", id: "getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/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: "getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/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: "getting-started/installation-and-upgrade/resources/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/update-rancher-certificate", "getting-started/installation-and-upgrade/resources/bootstrap-password", "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: "How-to Guides", items: [ { type: "category", label: "New User Guides", link: { type: "doc", id: "how-to-guides/new-user-guides/new-user-guides", }, items: [ { type: "category", label: "Authentication, Permissions, and Global Configuration", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-permissions-and-global-configuration", }, items: [ { type: "category", label: "Configuring Authentication", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/authentication-config", }, items: [ "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/manage-users-and-groups", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/create-local-users", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-google-oauth", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-active-directory", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-freeipa", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-azure-ad", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-github", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-github-app", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-pingidentity", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-okta-saml", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-generic-oidc", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-amazon-cognito", ], }, { type: "category", label: "Configuring OpenLDAP", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap", }, items: [ "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/openldap-config-reference", ], }, { type: "category", label: "Configuring Microsoft AD Federation Service (SAML)", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-microsoft-ad-federation-service-saml", }, items: [ "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs", ], }, { type: "category", label: "Configuring Shibboleth (SAML)", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml", }, items: [ "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/about-group-permissions", ], }, { type: "category", label: "Managing Role-Based Access Control (RBAC)", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/manage-role-based-access-control-rbac", }, items: [ "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-resources", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles", ], }, "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/jwt-authentication", { type: "category", label: "About Provisioning Drivers", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers", }, items: [ "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers", ], }, { type: "category", label: "About RKE1 Templates", link: { type: "doc", id: "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/about-rke1-templates", }, items: [ "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases", ], }, "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/pod-security-standards", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/custom-branding", "how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/notification-center" ], }, { type: "category", label: "Cluster Administration", link: { type: "doc", id: "how-to-guides/new-user-guides/manage-clusters/manage-clusters", }, items: [ { type: "category", label: "Access Clusters", link: { type: "doc", id: "how-to-guides/new-user-guides/manage-clusters/access-clusters/access-clusters", }, items: [ "how-to-guides/new-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig", "how-to-guides/new-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint", "how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters", ], }, { type: "category", label: "Create Kubernetes Persistent Storage", link: { type: "doc", id: "how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/create-kubernetes-persistent-storage", }, items: [ "how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage", "how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage", "how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage", "how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver", "how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes", "how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes", ], }, { type: "category", label: "Provisioning Storage Examples", link: { type: "doc", id: "how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/provisioning-storage-examples", }, items: [ "how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/persistent-storage-in-amazon-ebs", "how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/nfs-storage", "how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/vsphere-storage", ], }, "how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces", "how-to-guides/new-user-guides/manage-clusters/rotate-certificates", "how-to-guides/new-user-guides/manage-clusters/rotate-encryption-key", "how-to-guides/new-user-guides/manage-clusters/manage-cluster-templates", "how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools", "how-to-guides/new-user-guides/manage-clusters/clean-cluster-nodes", ], }, { type: "category", label: "Setting up a Kubernetes Cluster for Rancher Server", link: { type: "doc", id: "how-to-guides/new-user-guides/kubernetes-cluster-setup/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/rke2-for-rancher", ], }, { type: "category", label: "Infrastructure Setup", link: { type: "doc", id: "how-to-guides/new-user-guides/infrastructure-setup/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/ha-rke2-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: "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/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: "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/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: "Setting up Clusters from Hosted Kubernetes Providers", link: { type: "doc", id: "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers", }, items: [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/eks", "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", ], }, { type: "category", label: "Launching Kubernetes on Windows Clusters", link: { type: "doc", id: "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/use-windows-clusters", }, items: [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/azure-storageclass-configuration", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/windows-linux-cluster-feature-parity", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/network-requirements-for-host-gateway", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/workload-migration-guidance", ], }, { type: "category", label: "Setting up Cloud Providers", link: { type: "doc", id: "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/set-up-cloud-providers", }, items: [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/azure", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/google-compute-engine", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-in-tree-vsphere", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-out-of-tree-vsphere", ], }, { type: "category", label: "Migrate to an Out-of-tree Cloud Provider", items: [ "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere", "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-azure", ], }, "how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters", ], }, { type: "category", label: "Launching Kubernetes with Rancher", link: { type: "doc", id: "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher", }, items: [ { type: "category", label: "Launching New Nodes in an Infra Provider", link: { type: "doc", id: "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider", }, items: [ "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster", "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster", "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster", "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-google-compute-engine-cluster", { type: "category", label: "Creating a VMware vSphere Cluster", link: { type: "doc", id: "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/vsphere", }, items: [ "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere", "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials", "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template", "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/shutdown-vm", ], }, { type: "category", label: "Creating a Nutanix AOS Cluster", link: { type: "doc", id: "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix", }, items: [ "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos", ], }, ], }, "how-to-guides/new-user-guides/launch-kubernetes-with-rancher/about-rancher-agents", ], }, { type: "category", label: "Kubernetes Resources Setup", link: { type: "doc", id: "how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup", }, items: [ { type: "category", label: "Workloads and Pods", link: { type: "doc", id: "how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/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: "how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/horizontal-pod-autoscaler", }, items: [ "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: "how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/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/load-balancer-and-ingress-controller/ingress-configuration", ], }, "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 and Apps", link: { type: "doc", id: "how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher", }, items: [ "how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps", "how-to-guides/new-user-guides/helm-charts-in-rancher/oci-repositories", ], }, { type: "category", label: "Backup, Restore, and Disaster Recovery", link: { type: "doc", id: "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery", }, items: [ "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher", "how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster", "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-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/add-users-to-projects", "how-to-guides/new-user-guides/manage-namespaces", ], }, { type: "category", label: "Advanced User Guides", link: { type: "doc", id: "how-to-guides/advanced-user-guides/advanced-user-guides", }, items: [ { type: "category", label: "Project Administration", link: { type: "doc", id: "how-to-guides/advanced-user-guides/manage-projects/manage-projects", }, items: [ { type: "category", label: "Project Resource Quotas", link: { type: "doc", id: "how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/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: "Monitoring/Alerting Guides", link: { type: "doc", id: "how-to-guides/advanced-user-guides/monitoring-alerting-guides/monitoring-alerting-guides", }, items: [ "how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage", { type: "category", label: "Prometheus Federator Guides", link: { type: "doc", id: "how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/prometheus-federator-guides", }, items: [ "how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/enable-prometheus-federator", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/uninstall-prometheus-federator", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/customize-grafana-dashboards", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/set-up-workloads", "how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/project-monitors", ], }, ], }, { type: "category", label: "Monitoring Configuration Guides", link: { type: "doc", id: "how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/monitoring-v2-configuration-guides", }, items: [ { type: "category", label: "Advanced Configuration", link: { type: "doc", id: "how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/advanced-configuration", }, items: [ "how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager", "how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus", "how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules", ], }, ], }, { type: "category", label: "Istio Setup Guides", link: { type: "doc", id: "how-to-guides/advanced-user-guides/istio-setup-guide/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-namespace", "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: "Compliance Scan Guides", link: { type: "doc", id: "how-to-guides/advanced-user-guides/compliance-scan-guides/compliance-scan-guides", }, items: [ "how-to-guides/advanced-user-guides/compliance-scan-guides/install-rancher-compliance", "how-to-guides/advanced-user-guides/compliance-scan-guides/uninstall-rancher-compliance", "how-to-guides/advanced-user-guides/compliance-scan-guides/run-a-scan", "how-to-guides/advanced-user-guides/compliance-scan-guides/run-a-scan-periodically-on-a-schedule", "how-to-guides/advanced-user-guides/compliance-scan-guides/view-reports", "how-to-guides/advanced-user-guides/compliance-scan-guides/enable-alerting-for-rancher-compliance", "how-to-guides/advanced-user-guides/compliance-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule", "how-to-guides/advanced-user-guides/compliance-scan-guides/create-a-custom-compliance-version-to-run", ], }, { type: "category", label: "Enabling Experimental Features", link: { type: "doc", id: "how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features", }, items: [ "how-to-guides/advanced-user-guides/enable-experimental-features/rancher-on-arm64", "how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers", "how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features", "how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery", "how-to-guides/advanced-user-guides/enable-experimental-features/role-template-aggregation", ], }, "how-to-guides/advanced-user-guides/open-ports-with-firewalld", "how-to-guides/advanced-user-guides/tune-etcd-for-large-installs", "how-to-guides/advanced-user-guides/enable-api-audit-log", "how-to-guides/advanced-user-guides/enable-api-audit-log-in-downstream-clusters", "how-to-guides/advanced-user-guides/enable-user-retention", "how-to-guides/advanced-user-guides/enable-cluster-agent-scheduling-customization", "how-to-guides/advanced-user-guides/configure-layer-7-nginx-load-balancer", "how-to-guides/advanced-user-guides/configure-oidc-provider", "how-to-guides/advanced-user-guides/ui-server-side-pagination" ], }, ], }, { type: "category", label: "Reference Guides", items: [ { type: "category", label: "Best Practice Guides", link: { type: "doc", id: "reference-guides/best-practices/best-practices", }, items: [ { type: "category", label: "Rancher Server", link: { type: "doc", id: "reference-guides/best-practices/rancher-server/rancher-server", }, items: [ "reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere", "reference-guides/best-practices/rancher-server/rancher-deployment-strategy", "reference-guides/best-practices/rancher-server/tips-for-running-rancher", "reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale", ], }, { type: "category", label: "Rancher-Managed Clusters", link: { type: "doc", id: "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters", }, items: [ "reference-guides/best-practices/rancher-managed-clusters/logging-best-practices", "reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices", "reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers", "reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere", "reference-guides/best-practices/rancher-managed-clusters/disconnected-clusters", ], }, ], }, { type: "category", label: "Rancher Architecture", link: { type: "doc", id: "reference-guides/rancher-manager-architecture/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: "reference-guides/cluster-configuration/cluster-configuration", }, items: [ { type: "category", label: "Rancher Server Configuration", link: { type: "doc", id: "reference-guides/cluster-configuration/rancher-server-configuration/rancher-server-configuration", }, items: [ "reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration", "reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration", "reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration", "reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration", "reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration", { type: "category", label: "GKE Cluster Configuration Reference", link: { type: "doc", id: "reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-cluster-configuration", }, items: [ "reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters", ], }, { type: "category", label: "Use Existing Nodes", link: { type: "doc", id: "reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes", }, items: [], }, "reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters", ], }, { type: "category", label: "Downstream Cluster Configuration", link: { type: "doc", id: "reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration", }, items: [ { type: "category", label: "Node Template Configuration", link: { type: "doc", id: "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/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", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere", "reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/nutanix", ], }, { type: "category", label: "Machine Configuration", link: { type: "doc", id: "reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/machine-configuration", }, items: [ "reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/amazon-ec2", "reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/digitalocean", "reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/azure", "reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/google-gce" ] } ] } ] }, { type: "category", label: "Single-Node Rancher in Docker", link: { type: "doc", id: "reference-guides/single-node-rancher-in-docker/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: "Backup & Restore Configuration", link: { type: "doc", id: "reference-guides/backup-restore-configuration/backup-restore-configuration", }, items: [ "reference-guides/backup-restore-configuration/backup-configuration", "reference-guides/backup-restore-configuration/restore-configuration", "reference-guides/backup-restore-configuration/storage-configuration", "reference-guides/backup-restore-configuration/examples", ], }, "reference-guides/kubernetes-concepts", { type: "category", label: "Monitoring Configuration Reference", link: { type: "doc", id: "reference-guides/monitoring-v2-configuration/monitoring-v2-configuration", }, items: [ "reference-guides/monitoring-v2-configuration/receivers", "reference-guides/monitoring-v2-configuration/routes", "reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors", "reference-guides/monitoring-v2-configuration/helm-chart-options", "reference-guides/monitoring-v2-configuration/examples", ], }, { type: "category", label: "Prometheus Federator", link: { type: "doc", id: "reference-guides/prometheus-federator/prometheus-federator", }, items: ["reference-guides/prometheus-federator/rbac"], }, { type: "category", label: "User Settings", link: { type: "doc", id: "reference-guides/user-settings/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: "reference-guides/cli-with-rancher/cli-with-rancher", }, items: [ "reference-guides/cli-with-rancher/rancher-cli", "reference-guides/cli-with-rancher/kubectl-utility", ], }, "reference-guides/rancher-cluster-tools", "reference-guides/rancher-project-tools", "reference-guides/system-tools", "reference-guides/dual-stack", "reference-guides/rke1-template-example-yaml", "reference-guides/rancher-webhook", { type: "category", label: "Rancher Security Guides", link: { type: "doc", id: "reference-guides/rancher-security/rancher-security", }, items: [ { type: "category", label: "SELinux RPM", link: { type: "doc", id: "reference-guides/rancher-security/selinux-rpm/selinux-rpm", }, items: [ "reference-guides/rancher-security/selinux-rpm/about-rancher-selinux", "reference-guides/rancher-security/selinux-rpm/about-rke2-selinux", "reference-guides/rancher-security/selinux-rpm/about-k3s-selinux", ], }, "reference-guides/rancher-security/rancher-security-best-practices", "reference-guides/rancher-security/security-advisories-and-cves", "reference-guides/rancher-security/psa-restricted-exemptions", "reference-guides/rancher-security/rancher-webhook-hardening", ], }, ], }, { type: "category", label: "Integrations in Rancher", link: { type: "doc", id: "integrations-in-rancher/integrations-in-rancher", }, items: [ "integrations-in-rancher/kubernetes-distributions/kubernetes-distributions", { type: "category", label: "Virtualization on Kubernetes with Harvester", link: { type: "doc", id: "integrations-in-rancher/harvester/harvester", }, items: ["integrations-in-rancher/harvester/overview"], }, { type: "category", label: "Cloud Native Storage with Longhorn", link: { type: "doc", id: "integrations-in-rancher/longhorn/longhorn", }, items: ["integrations-in-rancher/longhorn/overview"], }, { type: "category", label: "Container Security with Neuvector", link: { type: "doc", id: "integrations-in-rancher/neuvector/neuvector", }, items: ["integrations-in-rancher/neuvector/overview"], }, "integrations-in-rancher/suse-observability/suse-observability", "integrations-in-rancher/kubewarden/kubewarden", "integrations-in-rancher/elemental/elemental", { type: "category", label: "Continuous Delivery with Fleet", link: { type: "doc", id: "integrations-in-rancher/fleet/fleet", }, items: [ "integrations-in-rancher/fleet/overview", "integrations-in-rancher/fleet/architecture", "integrations-in-rancher/fleet/windows-support", "integrations-in-rancher/fleet/use-fleet-behind-a-proxy", ], }, { type: "category", label: "Cluster API (CAPI) with Rancher Turtles", link: { type: "doc", id: "integrations-in-rancher/cluster-api/cluster-api", }, items: ["integrations-in-rancher/cluster-api/overview"], }, "integrations-in-rancher/rancher-desktop", { type: "category", label: "Cloud Marketplace Integration", link: { type: "doc", id: "integrations-in-rancher/cloud-marketplace/cloud-marketplace", }, items: [ { type: "category", label: "AWS Marketplace Integration", link: { type: "doc", id: "integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/aws-cloud-marketplace", }, items: [ "integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/adapter-requirements", "integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter", "integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/uninstall-adapter", "integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/common-issues", ], }, "integrations-in-rancher/cloud-marketplace/supportconfig", ], }, { type: "category", label: "Compliance Scans", link: { type: "doc", id: "integrations-in-rancher/compliance-scans/compliance-scans", }, items: [ "integrations-in-rancher/compliance-scans/configuration-reference", "integrations-in-rancher/compliance-scans/rbac-for-compliance-scans", "integrations-in-rancher/compliance-scans/custom-benchmark", ], }, { type: "category", label: "Istio", link: { type: "doc", id: "integrations-in-rancher/istio/istio", }, items: [ "integrations-in-rancher/istio/cpu-and-memory-allocations", "integrations-in-rancher/istio/rbac-for-istio", "integrations-in-rancher/istio/disable-istio", { type: "category", label: "Configuration Options", link: { type: "doc", id: "integrations-in-rancher/istio/configuration-options/configuration-options", }, items: [ "integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations", "integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster", "integrations-in-rancher/istio/configuration-options/project-network-isolation", ], }, ], }, { type: "category", label: "Logging", link: { type: "doc", id: "integrations-in-rancher/logging/logging", }, items: [ "integrations-in-rancher/logging/logging-architecture", "integrations-in-rancher/logging/rbac-for-logging", "integrations-in-rancher/logging/logging-helm-chart-options", "integrations-in-rancher/logging/taints-and-tolerations", { type: "category", label: "Custom Resource Configuration", link: { type: "doc", id: "integrations-in-rancher/logging/custom-resource-configuration/custom-resource-configuration", }, items: [ "integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows", "integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs", ], }, ], }, { type: "category", label: "Monitoring and Alerting", link: { type: "doc", id: "integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting", }, items: [ "integrations-in-rancher/monitoring-and-alerting/how-monitoring-works", "integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring", "integrations-in-rancher/monitoring-and-alerting/built-in-dashboards", "integrations-in-rancher/monitoring-and-alerting/windows-support", "integrations-in-rancher/monitoring-and-alerting/promql-expressions", ], }, "integrations-in-rancher/rancher-extensions", ], }, { type: "category", label: "FAQ", items: [ "faq/general-faq", "faq/deprecated-features", "faq/install-and-configure-kubectl", "faq/technical-items", "faq/security", "faq/container-network-interface-providers", "faq/rancher-is-no-longer-needed", ], }, { type: "category", label: "Troubleshooting", items: [ "troubleshooting/general-troubleshooting", { type: "category", label: "Kubernetes Components", link: { type: "doc", id: "troubleshooting/kubernetes-components/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", 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", "troubleshooting/other-troubleshooting-tips/user-id-tracking-in-audit-logs", "troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation", ], }, ], }, { type: "category", label: "Rancher Kubernetes API", items: [ "api/quickstart", { type: "category", label: "Example Workflows", items: ["api/workflows/projects", "api/workflows/kubeconfigs", "api/workflows/tokens", "api/workflows/users"], }, "api/api-reference", "api/api-tokens", "api/extension-apiserver", "api/v3-rancher-api-guide", ], }, "contribute-to-rancher", "glossary", ], }; module.exports = sidebars;