public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-05-14 09:03:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea9d79eee4cb7dadf2fc610389e6dad30e9e7c8a
rancher-docs/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json
T
Divya Mohan 45c96d98be Adding content from docusaurus
2022-06-23 10:58:07 +05:30

5028 lines
280 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"pluginId": "default",
"version": "current",
"label": "v2.6",
"banner": null,
"badge": true,
"className": "docs-version-current",
"isLast": true,
"docsSidebars": {
"tutorialSidebar": [
{
"type": "category",
"label": "en",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Authentication, Permissions and Global Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Authentication",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Configuring Active Directory (AD)",
"href": "/en/en/admin-settings/authentication/ad/",
"docId": "en/admin-settings/authentication/ad/ad"
},
{
"type": "link",
"label": "Configuring Azure AD",
"href": "/en/en/admin-settings/authentication/azure-ad/",
"docId": "en/admin-settings/authentication/azure-ad/azure-ad"
},
{
"type": "link",
"label": "Configuring FreeIPA",
"href": "/en/en/admin-settings/authentication/freeipa/",
"docId": "en/admin-settings/authentication/freeipa/freeipa"
},
{
"type": "link",
"label": "Configuring GitHub",
"href": "/en/en/admin-settings/authentication/github/",
"docId": "en/admin-settings/authentication/github/github"
},
{
"type": "link",
"label": "Configuring Google OAuth",
"href": "/en/en/admin-settings/authentication/google/",
"docId": "en/admin-settings/authentication/google/google"
},
{
"type": "link",
"label": "Configuring Keycloak (OIDC)",
"href": "/en/en/admin-settings/authentication/keycloak-oidc/",
"docId": "en/admin-settings/authentication/keycloak-oidc/keycloak-oidc"
},
{
"type": "link",
"label": "Configuring Keycloak (SAML)",
"href": "/en/en/admin-settings/authentication/keycloak-saml/",
"docId": "en/admin-settings/authentication/keycloak-saml/keycloak-saml"
},
{
"type": "link",
"label": "Local Authentication",
"href": "/en/en/admin-settings/authentication/local/",
"docId": "en/admin-settings/authentication/local/local"
},
{
"type": "category",
"label": "Configuring Microsoft Active Directory Federation Service (SAML)",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "1. Configuring Microsoft AD FS for Rancher",
"href": "/en/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/",
"docId": "en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup"
},
{
"type": "link",
"label": "2. Configuring Rancher for Microsoft AD FS",
"href": "/en/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/",
"docId": "en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup"
}
],
"href": "/en/en/admin-settings/authentication/microsoft-adfs/"
},
{
"type": "link",
"label": "Configuring Okta (SAML)",
"href": "/en/en/admin-settings/authentication/okta/",
"docId": "en/admin-settings/authentication/okta/okta"
},
{
"type": "category",
"label": "Configuring OpenLDAP",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "OpenLDAP Configuration Reference",
"href": "/en/en/admin-settings/authentication/openldap/openldap-config/",
"docId": "en/admin-settings/authentication/openldap/openldap-config/openldap-config"
}
],
"href": "/en/en/admin-settings/authentication/openldap/"
},
{
"type": "link",
"label": "Configuring PingIdentity (SAML)",
"href": "/en/en/admin-settings/authentication/ping-federate/",
"docId": "en/admin-settings/authentication/ping-federate/ping-federate"
},
{
"type": "category",
"label": "Configuring Shibboleth (SAML)",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Group Permissions with Shibboleth and OpenLDAP",
"href": "/en/en/admin-settings/authentication/shibboleth/about/",
"docId": "en/admin-settings/authentication/shibboleth/about/about"
}
],
"href": "/en/en/admin-settings/authentication/shibboleth/"
},
{
"type": "link",
"label": "Users and Groups",
"href": "/en/en/admin-settings/authentication/user-groups/",
"docId": "en/admin-settings/authentication/user-groups/user-groups"
}
],
"href": "/en/en/admin-settings/authentication/"
},
{
"type": "link",
"label": "Custom Branding",
"href": "/en/en/admin-settings/branding/",
"docId": "en/admin-settings/branding/branding"
},
{
"type": "link",
"label": "Cluster Templates",
"href": "/en/en/admin-settings/cluster-templates/",
"docId": "en/admin-settings/cluster-templates/cluster-templates"
},
{
"type": "link",
"label": "Configuring a Global Default Private Registry",
"href": "/en/en/admin-settings/config-private-registry/",
"docId": "en/admin-settings/config-private-registry/config-private-registry"
},
{
"type": "category",
"label": "Provisioning Drivers",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Cluster Drivers",
"href": "/en/en/admin-settings/drivers/cluster-drivers/",
"docId": "en/admin-settings/drivers/cluster-drivers/cluster-drivers"
},
{
"type": "link",
"label": "Node Drivers",
"href": "/en/en/admin-settings/drivers/node-drivers/",
"docId": "en/admin-settings/drivers/node-drivers/node-drivers"
}
],
"href": "/en/en/admin-settings/drivers/"
},
{
"type": "link",
"label": "Upgrading Kubernetes without Upgrading Rancher",
"href": "/en/en/admin-settings/k8s-metadata/",
"docId": "en/admin-settings/k8s-metadata/k8s-metadata"
},
{
"type": "link",
"label": "Pod Security Policies",
"href": "/en/en/admin-settings/pod-security-policies/",
"docId": "en/admin-settings/pod-security-policies/pod-security-policies"
},
{
"type": "category",
"label": "Role-Based Access Control (RBAC)",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Cluster and Project Roles",
"href": "/en/en/admin-settings/rbac/cluster-project-roles/",
"docId": "en/admin-settings/rbac/cluster-project-roles/cluster-project-roles"
},
{
"type": "link",
"label": "Custom Roles",
"href": "/en/en/admin-settings/rbac/default-custom-roles/",
"docId": "en/admin-settings/rbac/default-custom-roles/default-custom-roles"
},
{
"type": "link",
"label": "Global Permissions",
"href": "/en/en/admin-settings/rbac/global-permissions/",
"docId": "en/admin-settings/rbac/global-permissions/global-permissions"
},
{
"type": "link",
"label": "Locked Roles",
"href": "/en/en/admin-settings/rbac/locked-roles/",
"docId": "en/admin-settings/rbac/locked-roles/locked-roles"
}
],
"href": "/en/en/admin-settings/rbac/"
},
{
"type": "category",
"label": "RKE Templates",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Applying Templates",
"href": "/en/en/admin-settings/rke-templates/applying-templates/",
"docId": "en/admin-settings/rke-templates/applying-templates/applying-templates"
},
{
"type": "link",
"label": "Creating and Revising RKE Templates",
"href": "/en/en/admin-settings/rke-templates/creating-and-revising/",
"docId": "en/admin-settings/rke-templates/creating-and-revising/creating-and-revising"
},
{
"type": "link",
"label": "Template Creator Permissions",
"href": "/en/en/admin-settings/rke-templates/creator-permissions/",
"docId": "en/admin-settings/rke-templates/creator-permissions/creator-permissions"
},
{
"type": "link",
"label": "Template Enforcement",
"href": "/en/en/admin-settings/rke-templates/enforcement/",
"docId": "en/admin-settings/rke-templates/enforcement/enforcement"
},
{
"type": "link",
"label": "Example Scenarios",
"href": "/en/en/admin-settings/rke-templates/example-scenarios/",
"docId": "en/admin-settings/rke-templates/example-scenarios/example-scenarios"
},
{
"type": "link",
"label": "Example YAML",
"href": "/en/en/admin-settings/rke-templates/example-yaml/",
"docId": "en/admin-settings/rke-templates/example-yaml/example-yaml"
},
{
"type": "link",
"label": "Overriding Template Settings",
"href": "/en/en/admin-settings/rke-templates/overrides/",
"docId": "en/admin-settings/rke-templates/overrides/overrides"
},
{
"type": "link",
"label": "RKE Templates and Infrastructure",
"href": "/en/en/admin-settings/rke-templates/rke-templates-and-hardware/",
"docId": "en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware"
},
{
"type": "link",
"label": "Access and Sharing",
"href": "/en/en/admin-settings/rke-templates/template-access-and-sharing/",
"docId": "en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing"
}
],
"href": "/en/en/admin-settings/rke-templates/"
}
],
"href": "/en/en/admin-settings/"
},
{
"type": "category",
"label": "API",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "API Tokens",
"href": "/en/en/api/api-tokens/",
"docId": "en/api/api-tokens/api-tokens"
}
],
"href": "/en/en/api/"
},
{
"type": "category",
"label": "Backups and Disaster Recovery",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Backing up Rancher",
"href": "/en/en/backups/back-up-rancher/",
"docId": "en/backups/back-up-rancher/back-up-rancher"
},
{
"type": "category",
"label": "Rancher Backup Configuration Reference",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Backup Configuration",
"href": "/en/en/backups/configuration/backup-config/",
"docId": "en/backups/configuration/backup-config/backup-config"
},
{
"type": "link",
"label": "Restore Configuration",
"href": "/en/en/backups/configuration/restore-config/",
"docId": "en/backups/configuration/restore-config/restore-config"
},
{
"type": "link",
"label": "Backup Storage Location Configuration",
"href": "/en/en/backups/configuration/storage-config/",
"docId": "en/backups/configuration/storage-config/storage-config"
}
],
"href": "/en/en/backups/configuration/"
},
{
"type": "category",
"label": "Backup and Restore for Rancher Installed with Docker",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Backing up Rancher Installed with Docker",
"href": "/en/en/backups/docker-installs/docker-backups/",
"docId": "en/backups/docker-installs/docker-backups/docker-backups"
},
{
"type": "link",
"label": "Restoring Backups—Docker Installs",
"href": "/en/en/backups/docker-installs/docker-restores/",
"docId": "en/backups/docker-installs/docker-restores/docker-restores"
}
],
"href": "/en/en/backups/docker-installs/"
},
{
"type": "link",
"label": "Examples",
"href": "/en/en/backups/examples/",
"docId": "en/backups/examples/examples"
},
{
"type": "link",
"label": "Migrating Rancher to a New Cluster",
"href": "/en/en/backups/migrating-rancher/",
"docId": "en/backups/migrating-rancher/migrating-rancher"
},
{
"type": "link",
"label": "Restoring Rancher",
"href": "/en/en/backups/restoring-rancher/",
"docId": "en/backups/restoring-rancher/restoring-rancher"
}
],
"href": "/en/en/backups/"
},
{
"type": "category",
"label": "Best Practices Guide",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Best Practices for Rancher Managed Clusters",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Tips for Setting Up Containers",
"href": "/en/en/best-practices/rancher-managed/containers/",
"docId": "en/best-practices/rancher-managed/containers/containers"
},
{
"type": "link",
"label": "Logging Best Practices",
"href": "/en/en/best-practices/rancher-managed/logging/",
"docId": "en/best-practices/rancher-managed/logging/logging"
},
{
"type": "link",
"label": "Best Practices for Rancher Managed vSphere Clusters",
"href": "/en/en/best-practices/rancher-managed/managed-vsphere/",
"docId": "en/best-practices/rancher-managed/managed-vsphere/managed-vsphere"
},
{
"type": "link",
"label": "Monitoring Best Practices",
"href": "/en/en/best-practices/rancher-managed/monitoring/",
"docId": "en/best-practices/rancher-managed/monitoring/monitoring"
}
],
"href": "/en/en/best-practices/rancher-managed/"
},
{
"type": "category",
"label": "Best Practices for the Rancher Server",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rancher Deployment Strategy",
"href": "/en/en/best-practices/rancher-server/deployment-strategies/",
"docId": "en/best-practices/rancher-server/deployment-strategies/deployment-strategies"
},
{
"type": "link",
"label": "Tips for Running Rancher",
"href": "/en/en/best-practices/rancher-server/deployment-types/",
"docId": "en/best-practices/rancher-server/deployment-types/deployment-types"
},
{
"type": "link",
"label": "Installing Rancher in a vSphere Environment",
"href": "/en/en/best-practices/rancher-server/rancher-in-vsphere/",
"docId": "en/best-practices/rancher-server/rancher-in-vsphere/rancher-in-vsphere"
}
],
"href": "/en/en/best-practices/rancher-server/"
}
],
"href": "/en/en/best-practices/"
},
{
"type": "category",
"label": "CIS Scans",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Configuration",
"href": "/en/en/cis-scans/configuration/",
"docId": "en/cis-scans/configuration/configuration"
},
{
"type": "link",
"label": "Creating a Custom Benchmark Version for Running a Cluster Scan",
"href": "/en/en/cis-scans/custom-benchmark/",
"docId": "en/cis-scans/custom-benchmark/custom-benchmark"
},
{
"type": "link",
"label": "Roles-based Access Control",
"href": "/en/en/cis-scans/rbac/",
"docId": "en/cis-scans/rbac/rbac"
},
{
"type": "link",
"label": "Skipped and Not Applicable Tests",
"href": "/en/en/cis-scans/skipped-tests/",
"docId": "en/cis-scans/skipped-tests/skipped-tests"
}
],
"href": "/en/en/cis-scans/"
},
{
"type": "link",
"label": "CLI with Rancher",
"href": "/en/en/cli/",
"docId": "en/cli/cli"
},
{
"type": "category",
"label": "Cluster Administration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Backing up a Cluster",
"href": "/en/en/cluster-admin/backing-up-etcd/",
"docId": "en/cluster-admin/backing-up-etcd/backing-up-etcd"
},
{
"type": "link",
"label": "Certificate Rotation",
"href": "/en/en/cluster-admin/certificate-rotation/",
"docId": "en/cluster-admin/certificate-rotation/certificate-rotation"
},
{
"type": "link",
"label": "Removing Kubernetes Components from Nodes",
"href": "/en/en/cluster-admin/cleaning-cluster-nodes/",
"docId": "en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes"
},
{
"type": "link",
"label": "Cloning Clusters",
"href": "/en/en/cluster-admin/cloning-clusters/",
"docId": "en/cluster-admin/cloning-clusters/cloning-clusters"
},
{
"type": "category",
"label": "Cluster Access",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "How the Authorized Cluster Endpoint Works",
"href": "/en/en/cluster-admin/cluster-access/ace/",
"docId": "en/cluster-admin/cluster-access/ace/ace"
},
{
"type": "link",
"label": "Adding Users to Clusters",
"href": "/en/en/cluster-admin/cluster-access/cluster-members/",
"docId": "en/cluster-admin/cluster-access/cluster-members/cluster-members"
},
{
"type": "link",
"label": "Access a Cluster with Kubectl and kubeconfig",
"href": "/en/en/cluster-admin/cluster-access/kubectl/",
"docId": "en/cluster-admin/cluster-access/kubectl/kubectl"
}
],
"href": "/en/en/cluster-admin/cluster-access/"
},
{
"type": "category",
"label": "Cluster Autoscaler",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Cluster Autoscaler with AWS EC2 Auto Scaling Groups",
"href": "/en/en/cluster-admin/cluster-autoscaler/amazon/",
"docId": "en/cluster-admin/cluster-autoscaler/amazon/amazon"
}
],
"href": "/en/en/cluster-admin/cluster-autoscaler/"
},
{
"type": "category",
"label": "Cluster Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "AKS Cluster Configuration Reference",
"href": "/en/en/cluster-admin/editing-clusters/aks-config-reference/",
"docId": "en/cluster-admin/editing-clusters/aks-config-reference/aks-config-reference"
},
{
"type": "link",
"label": "EKS Cluster Configuration Reference",
"href": "/en/en/cluster-admin/editing-clusters/eks-config-reference/",
"docId": "en/cluster-admin/editing-clusters/eks-config-reference/eks-config-reference"
},
{
"type": "category",
"label": "GKE Cluster Configuration Reference",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Private Clusters",
"href": "/en/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/",
"docId": "en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters"
}
],
"href": "/en/en/cluster-admin/editing-clusters/gke-config-reference/"
},
{
"type": "link",
"label": "K3s Cluster Configuration Reference",
"href": "/en/en/cluster-admin/editing-clusters/k3s-config-reference/",
"docId": "en/cluster-admin/editing-clusters/k3s-config-reference/k3s-config-reference"
},
{
"type": "category",
"label": "rke-config-reference",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "RKE Cluster Configuration Reference",
"href": "/en/en/cluster-admin/editing-clusters/rke-config-reference/rke-config-references",
"docId": "en/cluster-admin/editing-clusters/rke-config-reference/rke-config-references"
}
]
},
{
"type": "link",
"label": "RKE2 Cluster Configuration Reference",
"href": "/en/en/cluster-admin/editing-clusters/rke2-config-reference/",
"docId": "en/cluster-admin/editing-clusters/rke2-config-reference/rke2-config-reference"
},
{
"type": "link",
"label": "Syncing",
"href": "/en/en/cluster-admin/editing-clusters/syncing/",
"docId": "en/cluster-admin/editing-clusters/syncing/syncing"
}
],
"href": "/en/en/cluster-admin/editing-clusters/"
},
{
"type": "link",
"label": "Nodes and Node Pools",
"href": "/en/en/cluster-admin/nodes/",
"docId": "en/cluster-admin/nodes/nodes"
},
{
"type": "link",
"label": "Assigning Pod Security Policies",
"href": "/en/en/cluster-admin/pod-security-policies/",
"docId": "en/cluster-admin/pod-security-policies/pod-security-policies"
},
{
"type": "link",
"label": "Adding a Pod Security Policy",
"href": "/en/en/cluster-admin/pod-security-policy/",
"docId": "en/cluster-admin/pod-security-policy/pod-security-policy"
},
{
"type": "link",
"label": "Projects and Kubernetes Namespaces with Rancher",
"href": "/en/en/cluster-admin/projects-and-namespaces/",
"docId": "en/cluster-admin/projects-and-namespaces/projects-and-namespaces"
},
{
"type": "link",
"label": "Restoring a Cluster from Backup",
"href": "/en/en/cluster-admin/restoring-etcd/",
"docId": "en/cluster-admin/restoring-etcd/restoring-etcd"
},
{
"type": "link",
"label": "Tools for Logging, Monitoring, and Visibility",
"href": "/en/en/cluster-admin/tools/",
"docId": "en/cluster-admin/tools/tools"
},
{
"type": "link",
"label": "Upgrading and Rolling Back Kubernetes",
"href": "/en/en/cluster-admin/upgrading-kubernetes/",
"docId": "en/cluster-admin/upgrading-kubernetes/upgrading-kubernetes"
},
{
"type": "category",
"label": "Kubernetes Persistent Storage: Volumes and Storage Classes",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Setting up Existing Storage",
"href": "/en/en/cluster-admin/volumes-and-storage/attaching-existing-storage/",
"docId": "en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage"
},
{
"type": "link",
"label": "Using an External Ceph Driver",
"href": "/en/en/cluster-admin/volumes-and-storage/ceph/",
"docId": "en/cluster-admin/volumes-and-storage/ceph/ceph"
},
{
"type": "category",
"label": "Provisioning Storage Examples",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating Persistent Storage in Amazon's EBS",
"href": "/en/en/cluster-admin/volumes-and-storage/examples/ebs/",
"docId": "en/cluster-admin/volumes-and-storage/examples/ebs/ebs"
},
{
"type": "link",
"label": "NFS Storage",
"href": "/en/en/cluster-admin/volumes-and-storage/examples/nfs/",
"docId": "en/cluster-admin/volumes-and-storage/examples/nfs/nfs"
},
{
"type": "link",
"label": "vSphere Storage",
"href": "/en/en/cluster-admin/volumes-and-storage/examples/vsphere/",
"docId": "en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere"
}
],
"href": "/en/en/cluster-admin/volumes-and-storage/examples/"
},
{
"type": "link",
"label": "GlusterFS Volumes",
"href": "/en/en/cluster-admin/volumes-and-storage/glusterfs-volumes/",
"docId": "en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes"
},
{
"type": "link",
"label": "How Persistent Storage Works",
"href": "/en/en/cluster-admin/volumes-and-storage/how-storage-works/",
"docId": "en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works"
},
{
"type": "link",
"label": "iSCSI Volumes",
"href": "/en/en/cluster-admin/volumes-and-storage/iscsi-volumes/",
"docId": "en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes"
},
{
"type": "link",
"label": "Dynamically Provisioning New Storage in Rancher",
"href": "/en/en/cluster-admin/volumes-and-storage/provisioning-new-storage/",
"docId": "en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage"
}
],
"href": "/en/en/cluster-admin/volumes-and-storage/"
}
],
"href": "/en/en/cluster-admin/"
},
{
"type": "category",
"label": "Setting up Kubernetes Clusters in Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "cluster-capabilities-table",
"href": "/en/en/cluster-provisioning/cluster-capabilities-table/",
"docId": "en/cluster-provisioning/cluster-capabilities-table/cluster-capabilities-table"
},
{
"type": "category",
"label": "Setting up Clusters from Hosted Kubernetes Providers",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating an Aliyun ACK Cluster",
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/ack/",
"docId": "en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack"
},
{
"type": "link",
"label": "Creating an AKS Cluster",
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/aks/",
"docId": "en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks"
},
{
"type": "link",
"label": "Creating a Huawei CCE Cluster",
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/cce/",
"docId": "en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce"
},
{
"type": "category",
"label": "Creating an EKS Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Minimum EKS Permissions",
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/",
"docId": "en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/permissions"
}
],
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/eks/"
},
{
"type": "link",
"label": "Managing GKE Clusters",
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/gke/",
"docId": "en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke"
},
{
"type": "link",
"label": "Creating a Tencent TKE Cluster",
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/tke/",
"docId": "en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke"
}
],
"href": "/en/en/cluster-provisioning/hosted-kubernetes-clusters/"
},
{
"type": "link",
"label": "Node Requirements for Rancher Managed Clusters",
"href": "/en/en/cluster-provisioning/node-requirements/",
"docId": "en/cluster-provisioning/node-requirements/node-requirements"
},
{
"type": "category",
"label": "Checklist for Production-Ready Clusters",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Roles for Nodes in Kubernetes",
"href": "/en/en/cluster-provisioning/production/nodes-and-roles/",
"docId": "en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles"
},
{
"type": "link",
"label": "Recommended Cluster Architecture",
"href": "/en/en/cluster-provisioning/production/recommended-architecture/",
"docId": "en/cluster-provisioning/production/recommended-architecture/recommended-architecture"
}
],
"href": "/en/en/cluster-provisioning/production/"
},
{
"type": "link",
"label": "Registering Existing Clusters",
"href": "/en/en/cluster-provisioning/registered-clusters/",
"docId": "en/cluster-provisioning/registered-clusters/registered-clusters"
},
{
"type": "category",
"label": "Launching Kubernetes with Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Behavior Differences Between RKE1 and RKE2",
"href": "/en/en/cluster-provisioning/rke-clusters/behavior-differences-between-rke1-and-rke2/",
"docId": "en/cluster-provisioning/rke-clusters/behavior-differences-between-rke1-and-rke2/behavior-differences-between-rke1-and-rke2"
},
{
"type": "category",
"label": "Setting up Cloud Providers",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Setting up the Amazon Cloud Provider",
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/",
"docId": "en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon"
},
{
"type": "link",
"label": "Setting up the Azure Cloud Provider",
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/azure/",
"docId": "en/cluster-provisioning/rke-clusters/cloud-providers/azure/azure"
},
{
"type": "link",
"label": "Setting up the Google Compute Engine Cloud Provider",
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/gce/",
"docId": "en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce"
},
{
"type": "category",
"label": "Setting up the vSphere Cloud Provider",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "How to Configure In-tree vSphere Cloud Provider",
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/",
"docId": "en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/in-tree"
},
{
"type": "category",
"label": "How to Configure Out-of-tree vSphere Cloud Provider",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Migrating vSphere In-tree Volumes to CSI",
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/",
"docId": "en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/vsphere-volume-migration"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/cloud-providers/"
},
{
"type": "category",
"label": "Launching Kubernetes on Existing Custom Nodes",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rancher Agent Options",
"href": "/en/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/",
"docId": "en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/custom-nodes/"
},
{
"type": "category",
"label": "Launching Kubernetes on New Nodes in an Infrastructure Provider",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Creating an Azure Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Azure Machine Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-machine-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/azure/azure-machine-config/azure-machine-config"
},
{
"type": "link",
"label": "Azure Node Template Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/azure-node-template-config"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/azure/"
},
{
"type": "category",
"label": "Creating a DigitalOcean Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "DigitalOcean Machine Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-machine-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-machine-config/do-machine-config"
},
{
"type": "link",
"label": "DigitalOcean Node Template Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/do-node-template-config"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/"
},
{
"type": "category",
"label": "Creating an Amazon EC2 Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "EC2 Machine Configuration Reference",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/ec2-machine-config"
},
{
"type": "link",
"label": "EC2 Node Template Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/ec2/"
},
{
"type": "category",
"label": "Creating a Nutanix AOS Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Nutanix Node Template Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/nutanix-node-template-config"
},
{
"type": "category",
"label": "provisioning-nutanix-clusters",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Provisioning Kubernetes Clusters in Nutanix AOS",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/providing-nutanix-clusters",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/providing-nutanix-clusters"
}
]
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/nutanix/"
},
{
"type": "category",
"label": "vsphere",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating a vSphere Virtual Machine Template",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-a-vm-template/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-a-vm-template/creating-a-vm-template"
},
{
"type": "link",
"label": "Creating Credentials in the vSphere Console",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials"
},
{
"type": "link",
"label": "Provisioning Kubernetes Clusters in vSphere",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters"
},
{
"type": "link",
"label": "Creating a vSphere Cluster",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vpshere",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/vpshere"
},
{
"type": "link",
"label": "VSphere Node Template Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/",
"docId": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config"
}
]
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/node-pools/"
},
{
"type": "link",
"label": "RKE Cluster Configuration",
"href": "/en/en/cluster-provisioning/rke-clusters/options/",
"docId": "en/cluster-provisioning/rke-clusters/options/options"
},
{
"type": "link",
"label": "Rancher Agents",
"href": "/en/en/cluster-provisioning/rke-clusters/rancher-agents/",
"docId": "en/cluster-provisioning/rke-clusters/rancher-agents/rancher-agents"
},
{
"type": "category",
"label": "Launching Kubernetes on Windows Clusters",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Configuration for Storage Classes in Azure",
"href": "/en/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/",
"docId": "en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass"
},
{
"type": "link",
"label": "Networking Requirements for Host Gateway (L2bridge)",
"href": "/en/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/",
"docId": "en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/host-gateway-requirements"
},
{
"type": "link",
"label": "Windows and Linux Cluster Feature Parity",
"href": "/en/en/cluster-provisioning/rke-clusters/windows-clusters/windows-parity/",
"docId": "en/cluster-provisioning/rke-clusters/windows-clusters/windows-parity/windows-parity"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/windows-clusters/"
}
],
"href": "/en/en/cluster-provisioning/rke-clusters/"
}
],
"href": "/en/en/cluster-provisioning/"
},
{
"type": "link",
"label": "Contributing to Rancher",
"href": "/en/en/contributing/",
"docId": "en/contributing/contributing"
},
{
"type": "category",
"label": "Deploying Applications across Clusters",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Fleet - GitOps at Scale",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Architecture",
"href": "/en/en/deploy-across-clusters/fleet/architecture/",
"docId": "en/deploy-across-clusters/fleet/architecture/architecture"
},
{
"type": "link",
"label": "Using Fleet Behind a Proxy",
"href": "/en/en/deploy-across-clusters/fleet/proxy/",
"docId": "en/deploy-across-clusters/fleet/proxy/proxy"
},
{
"type": "link",
"label": "Windows Support",
"href": "/en/en/deploy-across-clusters/fleet/windows/",
"docId": "en/deploy-across-clusters/fleet/windows/windows"
}
],
"href": "/en/en/deploy-across-clusters/fleet/"
},
{
"type": "link",
"label": "Multi-cluster Apps",
"href": "/en/en/deploy-across-clusters/multi-cluster-apps/",
"docId": "en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps"
}
],
"href": "/en/en/deploy-across-clusters/"
},
{
"type": "category",
"label": "FAQ",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Deprecated Features in Rancher",
"href": "/en/en/faq/deprecated-features/",
"docId": "en/faq/deprecated-features/deprecated-features"
},
{
"type": "link",
"label": "Dockershim",
"href": "/en/en/faq/dockershim/",
"docId": "en/faq/dockershim/dockershim"
},
{
"type": "link",
"label": "Installing and Configuring kubectl",
"href": "/en/en/faq/kubectl/",
"docId": "en/faq/kubectl/kubectl"
},
{
"type": "category",
"label": "Networking",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Container Network Interface (CNI) Providers",
"href": "/en/en/faq/networking/cni-providers/",
"docId": "en/faq/networking/cni-providers/cni-providers"
}
],
"href": "/en/en/faq/networking/"
},
{
"type": "link",
"label": "Rancher is No Longer Needed",
"href": "/en/en/faq/removing-rancher/",
"docId": "en/faq/removing-rancher/removing-rancher"
},
{
"type": "link",
"label": "Security",
"href": "/en/en/faq/security/",
"docId": "en/faq/security/security"
},
{
"type": "link",
"label": "Technical",
"href": "/en/en/faq/technical/",
"docId": "en/faq/technical/technical"
},
{
"type": "link",
"label": "Telemetry",
"href": "/en/en/faq/telemetry/",
"docId": "en/faq/telemetry/telemetry"
}
],
"href": "/en/en/faq/"
},
{
"type": "category",
"label": "helm-charts",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating Apps",
"href": "/en/en/helm-charts/creating-apps/",
"docId": "en/helm-charts/creating-apps/creating-apps"
},
{
"type": "link",
"label": "Helm Charts in Rancher",
"href": "/en/en/helm-charts/helm",
"docId": "en/helm-charts/helm"
}
]
},
{
"type": "category",
"label": "Installing/Upgrading Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Install/Upgrade Rancher on a Kubernetes Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Installing Rancher on Azure Kubernetes Service",
"href": "/en/en/installation/install-rancher-on-k8s/aks/",
"docId": "en/installation/install-rancher-on-k8s/aks/aks"
},
{
"type": "link",
"label": "Installing Rancher on Amazon EKS",
"href": "/en/en/installation/install-rancher-on-k8s/amazon-eks/",
"docId": "en/installation/install-rancher-on-k8s/amazon-eks/amazon-eks"
},
{
"type": "link",
"label": "Rancher Helm Chart Options",
"href": "/en/en/installation/install-rancher-on-k8s/chart-options/",
"docId": "en/installation/install-rancher-on-k8s/chart-options/chart-options"
},
{
"type": "link",
"label": "Installing Rancher on a Google Kubernetes Engine Cluster",
"href": "/en/en/installation/install-rancher-on-k8s/gke/",
"docId": "en/installation/install-rancher-on-k8s/gke/gke"
},
{
"type": "link",
"label": "Rollbacks",
"href": "/en/en/installation/install-rancher-on-k8s/rollbacks/",
"docId": "en/installation/install-rancher-on-k8s/rollbacks/rollbacks"
},
{
"type": "category",
"label": "Upgrades",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rendering the Helm Template in an Air Gapped Environment",
"href": "/en/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/",
"docId": "en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/air-gap-upgrade"
}
],
"href": "/en/en/installation/install-rancher-on-k8s/upgrades/"
}
],
"href": "/en/en/installation/install-rancher-on-k8s/"
},
{
"type": "category",
"label": "Other Installation Methods",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Air Gapped Helm CLI Install",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "4. Install Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Docker Install Commands",
"href": "/en/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/",
"docId": "en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands"
}
],
"href": "/en/en/installation/other-installation-methods/air-gap/install-rancher/"
},
{
"type": "link",
"label": "3. Install Kubernetes (Skip for Docker Installs)",
"href": "/en/en/installation/other-installation-methods/air-gap/launch-kubernetes/",
"docId": "en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes"
},
{
"type": "link",
"label": "2. Collect and Publish Images to your Private Registry",
"href": "/en/en/installation/other-installation-methods/air-gap/populate-private-registry/",
"docId": "en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry"
},
{
"type": "link",
"label": "1. Set up Infrastructure and Private Registry",
"href": "/en/en/installation/other-installation-methods/air-gap/prepare-nodes/",
"docId": "en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes"
}
],
"href": "/en/en/installation/other-installation-methods/air-gap/"
},
{
"type": "category",
"label": "Installing Rancher behind an HTTP Proxy",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "3. Install Rancher",
"href": "/en/en/installation/other-installation-methods/behind-proxy/install-rancher/",
"docId": "en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher"
},
{
"type": "link",
"label": "2. Install Kubernetes",
"href": "/en/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/",
"docId": "en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes"
},
{
"type": "link",
"label": "1. Set up Infrastructure",
"href": "/en/en/installation/other-installation-methods/behind-proxy/prepare-nodes/",
"docId": "en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes"
}
],
"href": "/en/en/installation/other-installation-methods/behind-proxy/"
},
{
"type": "category",
"label": "Installing Rancher on a Single Node Using Docker",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Advanced Options for Docker Installs",
"href": "/en/en/installation/other-installation-methods/single-node-docker/advanced/",
"docId": "en/installation/other-installation-methods/single-node-docker/advanced/advanced"
},
{
"type": "link",
"label": "HTTP Proxy Configuration",
"href": "/en/en/installation/other-installation-methods/single-node-docker/proxy/",
"docId": "en/installation/other-installation-methods/single-node-docker/proxy/proxy"
},
{
"type": "link",
"label": "Rolling Back Rancher Installed with Docker",
"href": "/en/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/",
"docId": "en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks"
},
{
"type": "category",
"label": "single-node-upgrades",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Upgrading Rancher Installed with Docker",
"href": "/en/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-updates",
"docId": "en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-updates"
}
]
},
{
"type": "link",
"label": "Certificate Troubleshooting",
"href": "/en/en/installation/other-installation-methods/single-node-docker/troubleshooting/",
"docId": "en/installation/other-installation-methods/single-node-docker/troubleshooting/troubleshooting"
}
],
"href": "/en/en/installation/other-installation-methods/single-node-docker/"
}
],
"href": "/en/en/installation/other-installation-methods/"
},
{
"type": "category",
"label": "Installation Requirements",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Dockershim",
"href": "/en/en/installation/requirements/dockershim/",
"docId": "en/installation/requirements/dockershim/dockershim"
},
{
"type": "link",
"label": "Installing Docker",
"href": "/en/en/installation/requirements/installing-docker/",
"docId": "en/installation/requirements/installing-docker/installing-docker"
},
{
"type": "category",
"label": "Port Requirements",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "common-ports-table",
"href": "/en/en/installation/requirements/ports/common-ports-table/",
"docId": "en/installation/requirements/ports/common-ports-table/common-ports-table"
}
],
"href": "/en/en/installation/requirements/ports/"
}
],
"href": "/en/en/installation/requirements/"
},
{
"type": "category",
"label": "Resources",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Advanced",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Enabling the API Audit Log to Record System Events",
"href": "/en/en/installation/resources/advanced/api-audit-log/",
"docId": "en/installation/resources/advanced/api-audit-log/api-audit-log"
},
{
"type": "link",
"label": "Running on ARM64 (Experimental)",
"href": "/en/en/installation/resources/advanced/arm64-platform/",
"docId": "en/installation/resources/advanced/arm64-platform/arm64-platform"
},
{
"type": "link",
"label": "Tuning etcd for Large Installations",
"href": "/en/en/installation/resources/advanced/etcd/",
"docId": "en/installation/resources/advanced/etcd/etcd"
},
{
"type": "link",
"label": "Opening Ports with firewalld",
"href": "/en/en/installation/resources/advanced/firewall/",
"docId": "en/installation/resources/advanced/firewall/firewall"
},
{
"type": "link",
"label": "Docker Install with TLS Termination at Layer-7 NGINX Load Balancer",
"href": "/en/en/installation/resources/advanced/single-node-install-external-lb/",
"docId": "en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb"
}
],
"href": "/en/en/installation/resources/advanced/"
},
{
"type": "link",
"label": "Bootstrap Password",
"href": "/en/en/installation/resources/bootstrap-password/",
"docId": "en/installation/resources/bootstrap-password/bootstrap-password"
},
{
"type": "link",
"label": "Choosing a Rancher Version",
"href": "/en/en/installation/resources/choosing-version/",
"docId": "en/installation/resources/choosing-version/choosing-version"
},
{
"type": "link",
"label": "About Custom CA Root Certificates",
"href": "/en/en/installation/resources/custom-ca-root-certificate/",
"docId": "en/installation/resources/custom-ca-root-certificate/custom-ca-root-certificate"
},
{
"type": "category",
"label": "Enabling Experimental Features",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Continuous Delivery",
"href": "/en/en/installation/resources/feature-flags/continuous-delivery/",
"docId": "en/installation/resources/feature-flags/continuous-delivery/continuous-delivery"
},
{
"type": "link",
"label": "Allow Unsupported Storage Drivers",
"href": "/en/en/installation/resources/feature-flags/enable-not-default-storage-drivers/",
"docId": "en/installation/resources/feature-flags/enable-not-default-storage-drivers/enable-not-default-storage-drivers"
},
{
"type": "link",
"label": "UI for Istio Virtual Services and Destination Rules",
"href": "/en/en/installation/resources/feature-flags/istio-virtual-service-ui/",
"docId": "en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui"
}
],
"href": "/en/en/installation/resources/feature-flags/"
},
{
"type": "link",
"label": "Helm Version Requirements",
"href": "/en/en/installation/resources/helm-version/",
"docId": "en/installation/resources/helm-version/helm-version"
},
{
"type": "category",
"label": "Don't have a Kubernetes cluster? Try one of these tutorials.",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Setting up a High-availability RKE Kubernetes Cluster",
"href": "/en/en/installation/resources/k8s-tutorials/ha-RKE/",
"docId": "en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE"
},
{
"type": "link",
"label": "Setting up a High-availability RKE2 Kubernetes Cluster for Rancher",
"href": "/en/en/installation/resources/k8s-tutorials/ha-rke2/",
"docId": "en/installation/resources/k8s-tutorials/ha-rke2/ha-rke2"
},
{
"type": "link",
"label": "Setting up a High-availability K3s Kubernetes Cluster for Rancher",
"href": "/en/en/installation/resources/k8s-tutorials/ha-with-external-db/",
"docId": "en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db"
},
{
"type": "link",
"label": "About High-availability Installations",
"href": "/en/en/installation/resources/k8s-tutorials/how-ha-works/",
"docId": "en/installation/resources/k8s-tutorials/how-ha-works/how-ha-works"
},
{
"type": "category",
"label": "Don't have infrastructure for your Kubernetes cluster? Try one of these tutorials.",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Setting up Nodes in Amazon EC2",
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/",
"docId": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/ec2-node"
},
{
"type": "link",
"label": "Set up Infrastructure for a High Availability RKE Kubernetes Cluster",
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/",
"docId": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/infra-for-ha"
},
{
"type": "link",
"label": "Set up Infrastructure for a High Availability K3s Kubernetes Cluster",
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/",
"docId": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db"
},
{
"type": "link",
"label": "Set up Infrastructure for a High Availability RKE2 Kubernetes Cluster",
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha/",
"docId": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha/infra-for-rke2-ha"
},
{
"type": "link",
"label": "Setting up an NGINX Load Balancer",
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/",
"docId": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/nginx"
},
{
"type": "link",
"label": "Setting up Amazon ELB Network Load Balancer",
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/",
"docId": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb"
},
{
"type": "link",
"label": "Setting up a MySQL Database in Amazon RDS",
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/",
"docId": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds"
}
],
"href": "/en/en/installation/resources/k8s-tutorials/infrastructure-tutorials/"
}
],
"href": "/en/en/installation/resources/k8s-tutorials/"
},
{
"type": "link",
"label": "Setting up Local System Charts for Air Gapped Installations",
"href": "/en/en/installation/resources/local-system-charts/",
"docId": "en/installation/resources/local-system-charts/local-system-charts"
},
{
"type": "link",
"label": "Adding TLS Secrets",
"href": "/en/en/installation/resources/tls-secrets/",
"docId": "en/installation/resources/tls-secrets/tls-secrets"
},
{
"type": "link",
"label": "TLS Settings",
"href": "/en/en/installation/resources/tls-settings/",
"docId": "en/installation/resources/tls-settings/tls-settings"
},
{
"type": "link",
"label": "Troubleshooting the Rancher Server Kubernetes Cluster",
"href": "/en/en/installation/resources/troubleshooting/",
"docId": "en/installation/resources/troubleshooting/troubleshooting"
},
{
"type": "link",
"label": "Updating the Rancher Certificate",
"href": "/en/en/installation/resources/update-rancher-cert/",
"docId": "en/installation/resources/update-rancher-cert/update-rancher-cert"
},
{
"type": "link",
"label": "Upgrading Cert-Manager",
"href": "/en/en/installation/resources/upgrading-cert-manager/",
"docId": "en/installation/resources/upgrading-cert-manager/upgrading-cert-manager"
}
],
"href": "/en/en/installation/resources/"
}
],
"href": "/en/en/installation/"
},
{
"type": "link",
"label": "Rancher 2.6",
"href": "/en/",
"docId": "en/introduction"
},
{
"type": "category",
"label": "Istio",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Configuration Options",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Additional Steps for Project Network Isolation",
"href": "/en/en/istio/configuration-reference/canal-and-project-network/",
"docId": "en/istio/configuration-reference/canal-and-project-network/canal-and-project-network"
},
{
"type": "link",
"label": "Enable Istio with Pod Security Policies",
"href": "/en/en/istio/configuration-reference/enable-istio-with-psp/",
"docId": "en/istio/configuration-reference/enable-istio-with-psp/enable-istio-with-psp"
},
{
"type": "link",
"label": "Additional Steps for Installing Istio on an RKE2 Cluster",
"href": "/en/en/istio/configuration-reference/rke2/",
"docId": "en/istio/configuration-reference/rke2/rke2"
},
{
"type": "link",
"label": "Selectors and Scrape Configs",
"href": "/en/en/istio/configuration-reference/selectors-and-scrape/",
"docId": "en/istio/configuration-reference/selectors-and-scrape/selectors-and-scrape"
}
],
"href": "/en/en/istio/configuration-reference/"
},
{
"type": "link",
"label": "Disabling Istio",
"href": "/en/en/istio/disabling-istio/",
"docId": "en/istio/disabling-istio/disabling-istio"
},
{
"type": "link",
"label": "Role-based Access Control",
"href": "/en/en/istio/rbac/",
"docId": "en/istio/rbac/rbac"
},
{
"type": "link",
"label": "CPU and Memory Allocations",
"href": "/en/en/istio/resources/",
"docId": "en/istio/resources/resources"
},
{
"type": "category",
"label": "Setup Guide",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "3. Add Deployments and Services with the Istio Sidecar",
"href": "/en/en/istio/setup/deploy-workloads/",
"docId": "en/istio/setup/deploy-workloads/deploy-workloads"
},
{
"type": "link",
"label": "1. Enable Istio in the Cluster",
"href": "/en/en/istio/setup/enable-istio-in-cluster/",
"docId": "en/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster"
},
{
"type": "link",
"label": "2. Enable Istio in a Namespace",
"href": "/en/en/istio/setup/enable-istio-in-namespace/",
"docId": "en/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace"
},
{
"type": "link",
"label": "4. Set up the Istio Gateway",
"href": "/en/en/istio/setup/gateway/",
"docId": "en/istio/setup/gateway/gateway"
},
{
"type": "link",
"label": "5. Set up Istio's Components for Traffic Management",
"href": "/en/en/istio/setup/set-up-traffic-management/",
"docId": "en/istio/setup/set-up-traffic-management/set-up-traffic-management"
},
{
"type": "link",
"label": "6. Generate and View Traffic",
"href": "/en/en/istio/setup/view-traffic/",
"docId": "en/istio/setup/view-traffic/view-traffic"
}
],
"href": "/en/en/istio/setup/"
}
],
"href": "/en/en/istio/"
},
{
"type": "category",
"label": "Kubernetes Resources",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Encrypting HTTP Communication",
"href": "/en/en/k8s-in-rancher/certificates/",
"docId": "en/k8s-in-rancher/certificates/certificates"
},
{
"type": "link",
"label": "ConfigMaps",
"href": "/en/en/k8s-in-rancher/configmaps/",
"docId": "en/k8s-in-rancher/configmaps/configmaps"
},
{
"type": "category",
"label": "The Horizontal Pod Autoscaler",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Background Information on HPAs",
"href": "/en/en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/",
"docId": "en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/hpa-background"
},
{
"type": "link",
"label": "Managing HPAs with kubectl",
"href": "/en/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/",
"docId": "en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl"
},
{
"type": "link",
"label": "Managing HPAs with the Rancher UI",
"href": "/en/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/",
"docId": "en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui"
},
{
"type": "link",
"label": "Testing HPAs with kubectl",
"href": "/en/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/",
"docId": "en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/testing-hpa"
}
],
"href": "/en/en/k8s-in-rancher/horizontal-pod-autoscaler/"
},
{
"type": "category",
"label": "Set Up Load Balancer and Ingress Controller within Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Adding Ingresses",
"href": "/en/en/k8s-in-rancher/load-balancers-and-ingress/ingress/",
"docId": "en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress"
},
{
"type": "link",
"label": "Ingress Configuration",
"href": "/en/en/k8s-in-rancher/load-balancers-and-ingress/ingress-config/",
"docId": "en/k8s-in-rancher/load-balancers-and-ingress/ingress-config/ingress-config"
},
{
"type": "link",
"label": "Layer 4 and Layer 7 Load Balancing",
"href": "/en/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/",
"docId": "en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/load-balancers"
}
],
"href": "/en/en/k8s-in-rancher/load-balancers-and-ingress/"
},
{
"type": "link",
"label": "Kubernetes Registry and Docker Registry",
"href": "/en/en/k8s-in-rancher/registries/",
"docId": "en/k8s-in-rancher/registries/registries"
},
{
"type": "link",
"label": "Secrets",
"href": "/en/en/k8s-in-rancher/secrets/",
"docId": "en/k8s-in-rancher/secrets/secrets"
},
{
"type": "link",
"label": "Services",
"href": "/en/en/k8s-in-rancher/service-discovery/",
"docId": "en/k8s-in-rancher/service-discovery/service-discovery"
},
{
"type": "category",
"label": "Kubernetes Workloads and Pods",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Adding a Sidecar",
"href": "/en/en/k8s-in-rancher/workloads/add-a-sidecar/",
"docId": "en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar"
},
{
"type": "link",
"label": "Deploying Workloads",
"href": "/en/en/k8s-in-rancher/workloads/deploy-workloads/",
"docId": "en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads"
},
{
"type": "link",
"label": "Rolling Back Workloads",
"href": "/en/en/k8s-in-rancher/workloads/rollback-workloads/",
"docId": "en/k8s-in-rancher/workloads/rollback-workloads/rollback-workloads"
},
{
"type": "link",
"label": "Upgrading Workloads",
"href": "/en/en/k8s-in-rancher/workloads/upgrade-workloads/",
"docId": "en/k8s-in-rancher/workloads/upgrade-workloads/upgrade-workloads"
}
],
"href": "/en/en/k8s-in-rancher/workloads/"
}
],
"href": "/en/en/k8s-in-rancher/"
},
{
"type": "category",
"label": "Rancher Integration with Logging Services",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Architecture",
"href": "/en/en/logging/architecture/",
"docId": "en/logging/architecture/architecture"
},
{
"type": "category",
"label": "Custom Resource Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Flows and ClusterFlows",
"href": "/en/en/logging/custom-resource-config/flows/",
"docId": "en/logging/custom-resource-config/flows/flows"
},
{
"type": "link",
"label": "Outputs and ClusterOutputs",
"href": "/en/en/logging/custom-resource-config/outputs/",
"docId": "en/logging/custom-resource-config/outputs/outputs"
}
],
"href": "/en/en/logging/custom-resource-config/"
},
{
"type": "link",
"label": "rancher-logging Helm Chart Options",
"href": "/en/en/logging/helm-chart-options/",
"docId": "en/logging/helm-chart-options/helm-chart-options"
},
{
"type": "link",
"label": "Migrating to Rancher v2.5 Logging",
"href": "/en/en/logging/migrating/",
"docId": "en/logging/migrating/migrating"
},
{
"type": "link",
"label": "Role-based Access Control for Logging",
"href": "/en/en/logging/rbac/",
"docId": "en/logging/rbac/rbac"
},
{
"type": "link",
"label": "Working with Taints and Tolerations",
"href": "/en/en/logging/taints-tolerations/",
"docId": "en/logging/taints-tolerations/taints-tolerations"
}
],
"href": "/en/en/logging/"
},
{
"type": "link",
"label": "Longhorn - Cloud native distributed block storage for Kubernetes",
"href": "/en/en/longhorn/",
"docId": "en/longhorn/longhorn"
},
{
"type": "category",
"label": "Monitoring and Alerting",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Advanced Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Alertmanager Configuration",
"href": "/en/en/monitoring-alerting/configuration/advanced/alertmanager/",
"docId": "en/monitoring-alerting/configuration/advanced/alertmanager/alertmanager"
},
{
"type": "link",
"label": "Prometheus Configuration",
"href": "/en/en/monitoring-alerting/configuration/advanced/prometheus/",
"docId": "en/monitoring-alerting/configuration/advanced/prometheus/prometheus"
},
{
"type": "link",
"label": "Configuring PrometheusRules",
"href": "/en/en/monitoring-alerting/configuration/advanced/prometheusrules/",
"docId": "en/monitoring-alerting/configuration/advanced/prometheusrules/prometheusrules"
}
],
"href": "/en/en/monitoring-alerting/configuration/advanced/"
},
{
"type": "link",
"label": "Examples",
"href": "/en/en/monitoring-alerting/configuration/examples/",
"docId": "en/monitoring-alerting/configuration/examples/examples"
},
{
"type": "link",
"label": "Helm Chart Options",
"href": "/en/en/monitoring-alerting/configuration/helm-chart-options/",
"docId": "en/monitoring-alerting/configuration/helm-chart-options/helm-chart-options"
},
{
"type": "link",
"label": "Receiver Configuration",
"href": "/en/en/monitoring-alerting/configuration/receiver/",
"docId": "en/monitoring-alerting/configuration/receiver/receiver"
},
{
"type": "link",
"label": "Route Configuration",
"href": "/en/en/monitoring-alerting/configuration/route/",
"docId": "en/monitoring-alerting/configuration/route/route"
},
{
"type": "link",
"label": "ServiceMonitor and PodMonitor Configuration",
"href": "/en/en/monitoring-alerting/configuration/servicemonitor-podmonitor/",
"docId": "en/monitoring-alerting/configuration/servicemonitor-podmonitor/servicemonitor-podmonitor"
}
],
"href": "/en/en/monitoring-alerting/configuration/"
},
{
"type": "link",
"label": "Built-in Dashboards",
"href": "/en/en/monitoring-alerting/dashboards/",
"docId": "en/monitoring-alerting/dashboards/dashboards"
},
{
"type": "link",
"label": "PromQL Expression Reference",
"href": "/en/en/monitoring-alerting/expression/",
"docId": "en/monitoring-alerting/expression/expression"
},
{
"type": "category",
"label": "Monitoring Guides",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Customizing Grafana Dashboards",
"href": "/en/en/monitoring-alerting/guides/customize-grafana/",
"docId": "en/monitoring-alerting/guides/customize-grafana/customize-grafana"
},
{
"type": "link",
"label": "Enable Monitoring",
"href": "/en/en/monitoring-alerting/guides/enable-monitoring/",
"docId": "en/monitoring-alerting/guides/enable-monitoring/enable-monitoring"
},
{
"type": "link",
"label": "Debugging High Memory Usage",
"href": "/en/en/monitoring-alerting/guides/memory-usage/",
"docId": "en/monitoring-alerting/guides/memory-usage/memory-usage"
},
{
"type": "link",
"label": "Migrating to Rancher v2.5+ Monitoring",
"href": "/en/en/monitoring-alerting/guides/migrating/",
"docId": "en/monitoring-alerting/guides/migrating/migrating"
},
{
"type": "link",
"label": "Setting up Monitoring for a Workload",
"href": "/en/en/monitoring-alerting/guides/monitoring-workloads/",
"docId": "en/monitoring-alerting/guides/monitoring-workloads/monitoring-workloads"
},
{
"type": "link",
"label": "Persistent Grafana Dashboards",
"href": "/en/en/monitoring-alerting/guides/persist-grafana/",
"docId": "en/monitoring-alerting/guides/persist-grafana/persist-grafana"
},
{
"type": "link",
"label": "Uninstall Monitoring",
"href": "/en/en/monitoring-alerting/guides/uninstall/",
"docId": "en/monitoring-alerting/guides/uninstall/uninstall"
}
],
"href": "/en/en/monitoring-alerting/guides/"
},
{
"type": "link",
"label": "How Monitoring Works",
"href": "/en/en/monitoring-alerting/how-monitoring-works/",
"docId": "en/monitoring-alerting/how-monitoring-works/how-monitoring-works"
},
{
"type": "category",
"label": "Prometheus Federator",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "guides",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Customizing Grafana Dashboards",
"href": "/en/en/monitoring-alerting/prometheus-federator/guides/customizing-grafana/",
"docId": "en/monitoring-alerting/prometheus-federator/guides/customizing-grafana/customizing-grafana"
},
{
"type": "link",
"label": "Enable Prometheus Federator",
"href": "/en/en/monitoring-alerting/prometheus-federator/guides/enable-prom-fed/",
"docId": "en/monitoring-alerting/prometheus-federator/guides/enable-prom-fed/enable-prom-fed"
},
{
"type": "link",
"label": "Setting up Prometheus Federator for a Workload",
"href": "/en/en/monitoring-alerting/prometheus-federator/guides/prom-fed-workloads/",
"docId": "en/monitoring-alerting/prometheus-federator/guides/prom-fed-workloads/prom-fed-workloads"
},
{
"type": "link",
"label": "Uninstall Prometheus Federator",
"href": "/en/en/monitoring-alerting/prometheus-federator/guides/uninstall-prom-fed/",
"docId": "en/monitoring-alerting/prometheus-federator/guides/uninstall-prom-fed/uninstall-prom-fed"
}
]
},
{
"type": "link",
"label": "Role-Based Access Control",
"href": "/en/en/monitoring-alerting/prometheus-federator/rbac/",
"docId": "en/monitoring-alerting/prometheus-federator/rbac/rbac"
}
],
"href": "/en/en/monitoring-alerting/prometheus-federator/"
},
{
"type": "link",
"label": "Role-based Access Control",
"href": "/en/en/monitoring-alerting/rbac/",
"docId": "en/monitoring-alerting/rbac/rbac"
},
{
"type": "link",
"label": "Windows Cluster Support for Monitoring V2",
"href": "/en/en/monitoring-alerting/windows-clusters/",
"docId": "en/monitoring-alerting/windows-clusters/windows-clusters"
}
],
"href": "/en/en/monitoring-alerting/"
},
{
"type": "link",
"label": "NeuVector Integration",
"href": "/en/en/neuvector-integration/",
"docId": "en/neuvector-integration/neuvector-integration"
},
{
"type": "category",
"label": "opa-gatekeper",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "OPA Gatekeeper",
"href": "/en/en/opa-gatekeper/opa-gatekeeper",
"docId": "en/opa-gatekeper/opa-gatekeeper"
}
]
},
{
"type": "category",
"label": "Overview",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Architecture",
"href": "/en/en/overview/architecture/",
"docId": "en/overview/architecture/architecture"
},
{
"type": "link",
"label": "Architecture Recommendations",
"href": "/en/en/overview/architecture-recommendations/",
"docId": "en/overview/architecture-recommendations/architecture-recommendations"
},
{
"type": "link",
"label": "Kubernetes Concepts",
"href": "/en/en/overview/concepts/",
"docId": "en/overview/concepts/concepts"
}
],
"href": "/en/en/overview/"
},
{
"type": "category",
"label": "Pipelines",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Concepts",
"href": "/en/en/pipelines/concepts/",
"docId": "en/pipelines/concepts/concepts"
},
{
"type": "link",
"label": "Pipeline Configuration Reference",
"href": "/en/en/pipelines/config/",
"docId": "en/pipelines/config/config"
},
{
"type": "link",
"label": "Example YAML File",
"href": "/en/en/pipelines/example/",
"docId": "en/pipelines/example/example"
},
{
"type": "link",
"label": "Example Repositories",
"href": "/en/en/pipelines/example-repos/",
"docId": "en/pipelines/example-repos/example-repos"
},
{
"type": "link",
"label": "Configuring Persistent Data for Pipeline Components",
"href": "/en/en/pipelines/storage/",
"docId": "en/pipelines/storage/storage"
}
],
"href": "/en/en/pipelines/"
},
{
"type": "category",
"label": "Project Administration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Namespaces",
"href": "/en/en/project-admin/namespaces/",
"docId": "en/project-admin/namespaces/namespaces"
},
{
"type": "link",
"label": "Rancher's CI/CD Pipelines",
"href": "/en/en/project-admin/pipelines/",
"docId": "en/project-admin/pipelines/pipelines"
},
{
"type": "link",
"label": "Pod Security Policies",
"href": "/en/en/project-admin/pod-security-policies/",
"docId": "en/project-admin/pod-security-policies/pod-security-policies"
},
{
"type": "link",
"label": "Adding Users to Projects",
"href": "/en/en/project-admin/project-members/",
"docId": "en/project-admin/project-members/project-members"
},
{
"type": "category",
"label": "Project Resource Quotas",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Setting Container Default Resource Limits",
"href": "/en/en/project-admin/resource-quotas/override-container-default/",
"docId": "en/project-admin/resource-quotas/override-container-default/override-container-default"
},
{
"type": "link",
"label": "Overriding the Default Limit for a Namespace",
"href": "/en/en/project-admin/resource-quotas/override-namespace-default/",
"docId": "en/project-admin/resource-quotas/override-namespace-default/override-namespace-default"
},
{
"type": "link",
"label": "Resource Quota Type Reference",
"href": "/en/en/project-admin/resource-quotas/quota-type-reference/",
"docId": "en/project-admin/resource-quotas/quota-type-reference/quota-type-reference"
},
{
"type": "link",
"label": "How Resource Quotas Work in Rancher Projects",
"href": "/en/en/project-admin/resource-quotas/quotas-for-projects/",
"docId": "en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects"
}
],
"href": "/en/en/project-admin/resource-quotas/"
},
{
"type": "link",
"label": "Tools for Logging, Monitoring, and Visibility",
"href": "/en/en/project-admin/tools/",
"docId": "en/project-admin/tools/tools"
}
],
"href": "/en/en/project-admin/"
},
{
"type": "category",
"label": "Rancher Deployment Quick Start Guides",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Deploying Rancher Server",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rancher AWS Marketplace Quick Start",
"href": "/en/en/quick-start-guide/deployment/amazon-aws-marketplace-qs/",
"docId": "en/quick-start-guide/deployment/amazon-aws-marketplace-qs/amazon-aws-marketplace-qs"
},
{
"type": "link",
"label": "Rancher AWS Quick Start Guide",
"href": "/en/en/quick-start-guide/deployment/amazon-aws-qs/",
"docId": "en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs"
},
{
"type": "link",
"label": "Rancher DigitalOcean Quick Start Guide",
"href": "/en/en/quick-start-guide/deployment/digital-ocean-qs/",
"docId": "en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs"
},
{
"type": "link",
"label": "Rancher Equinix Metal Quick Start",
"href": "/en/en/quick-start-guide/deployment/equinix-metal-qs/",
"docId": "en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs"
},
{
"type": "link",
"label": "Rancher GCP Quick Start Guide",
"href": "/en/en/quick-start-guide/deployment/google-gcp-qs/",
"docId": "en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs"
},
{
"type": "link",
"label": "Rancher Hetzner Cloud Quick Start Guide",
"href": "/en/en/quick-start-guide/deployment/hetzner-cloud-qs/",
"docId": "en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs"
},
{
"type": "link",
"label": "Rancher Azure Quick Start Guide",
"href": "/en/en/quick-start-guide/deployment/microsoft-azure-qs/",
"docId": "en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs"
},
{
"type": "link",
"label": "Helm CLI Quick Start",
"href": "/en/en/quick-start-guide/deployment/quickstart-manual-setup/",
"docId": "en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup"
},
{
"type": "link",
"label": "Vagrant Quick Start",
"href": "/en/en/quick-start-guide/deployment/quickstart-vagrant/",
"docId": "en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant"
}
],
"href": "/en/en/quick-start-guide/deployment/"
},
{
"type": "category",
"label": "Deploying Workloads",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Workload with Ingress Quick Start",
"href": "/en/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/",
"docId": "en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress"
},
{
"type": "link",
"label": "Workload with NodePort Quick Start",
"href": "/en/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/",
"docId": "en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport"
}
],
"href": "/en/en/quick-start-guide/workload/"
}
],
"href": "/en/en/quick-start-guide/"
},
{
"type": "category",
"label": "Security",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Kubernetes Security Best Practices",
"href": "/en/en/security/best-practices/",
"docId": "en/security/best-practices/best-practices"
},
{
"type": "link",
"label": "Security Advisories and CVEs",
"href": "/en/en/security/cve/",
"docId": "en/security/cve/cve"
},
{
"type": "category",
"label": "Self-Assessment and Hardening Guides for Rancher v2.6",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "RKE CIS v1.6 Benchmark - Self-Assessment Guide - Rancher v2.6",
"href": "/en/en/security/hardening-guides/rke-1.6-benchmark-2.6/",
"docId": "en/security/hardening-guides/rke-1.6-benchmark-2.6/rke-1.6-benchmark-2.6"
},
{
"type": "link",
"label": "RKE Hardening Guide with CIS v1.6 Benchmark",
"href": "/en/en/security/hardening-guides/rke-1.6-hardening-2.6/",
"docId": "en/security/hardening-guides/rke-1.6-hardening-2.6/rke-1.6-hardening-2.6"
},
{
"type": "link",
"label": "RKE2 CIS v1.6 Benchmark - Self-Assessment Guide - Rancher v2.6",
"href": "/en/en/security/hardening-guides/rke2-1.6-benchmark-2.6/",
"docId": "en/security/hardening-guides/rke2-1.6-benchmark-2.6/rke2-1.6-benchmark-2.6"
},
{
"type": "link",
"label": "RKE2 Hardening Guide with CIS v1.6 Benchmark",
"href": "/en/en/security/hardening-guides/rke2-1.6-hardening-2.6/",
"docId": "en/security/hardening-guides/rke2-1.6-hardening-2.6/rke2-1.6-hardening-2.6"
}
],
"href": "/en/en/security/hardening-guides/"
},
{
"type": "link",
"label": "Security Scans",
"href": "/en/en/security/security-scan/",
"docId": "en/security/security-scan/security-scan"
},
{
"type": "link",
"label": "SELinux RPM",
"href": "/en/en/security/selinux/",
"docId": "en/security/selinux/selinux"
}
],
"href": "/en/en/security/"
},
{
"type": "link",
"label": "System Tools",
"href": "/en/en/system-tools/",
"docId": "en/system-tools/system-tools"
},
{
"type": "category",
"label": "Troubleshooting",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "DNS",
"href": "/en/en/troubleshooting/dns/",
"docId": "en/troubleshooting/dns/dns"
},
{
"type": "link",
"label": "Rotation of Expired Webhook Certificates",
"href": "/en/en/troubleshooting/expired-webhook-certificates/",
"docId": "en/troubleshooting/expired-webhook-certificates/expired-webhook-certificates"
},
{
"type": "link",
"label": "Registered clusters",
"href": "/en/en/troubleshooting/imported-clusters/",
"docId": "en/troubleshooting/imported-clusters/imported-clusters"
},
{
"type": "category",
"label": "Kubernetes Components",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "controlplane",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Troubleshooting Controlplane Nodes",
"href": "/en/en/troubleshooting/kubernetes-components/controlplane/etcd",
"docId": "en/troubleshooting/kubernetes-components/controlplane/etcd"
}
]
},
{
"type": "link",
"label": "Troubleshooting etcd Nodes",
"href": "/en/en/troubleshooting/kubernetes-components/etcd/",
"docId": "en/troubleshooting/kubernetes-components/etcd/etcd"
},
{
"type": "link",
"label": "Troubleshooting nginx-proxy",
"href": "/en/en/troubleshooting/kubernetes-components/nginx-proxy/",
"docId": "en/troubleshooting/kubernetes-components/nginx-proxy/nginx-proxy"
},
{
"type": "link",
"label": "Troubleshooting Worker Nodes and Generic Components",
"href": "/en/en/troubleshooting/kubernetes-components/worker-and-generic/",
"docId": "en/troubleshooting/kubernetes-components/worker-and-generic/worker-and-generic"
}
],
"href": "/en/en/troubleshooting/kubernetes-components/"
},
{
"type": "link",
"label": "Kubernetes resources",
"href": "/en/en/troubleshooting/kubernetes-resources/",
"docId": "en/troubleshooting/kubernetes-resources/kubernetes-resources"
},
{
"type": "link",
"label": "Logging",
"href": "/en/en/troubleshooting/logging/",
"docId": "en/troubleshooting/logging/logging"
},
{
"type": "link",
"label": "Networking",
"href": "/en/en/troubleshooting/networking/",
"docId": "en/troubleshooting/networking/networking"
},
{
"type": "link",
"label": "Rancher HA",
"href": "/en/en/troubleshooting/rancherha/",
"docId": "en/troubleshooting/rancherha/rancherha"
},
{
"type": "link",
"label": "User ID Tracking in Audit Logs",
"href": "/en/en/troubleshooting/userid-tracking-in-audit-logs/",
"docId": "en/troubleshooting/userid-tracking-in-audit-logs/userid-tracking-in-audit-logs"
}
],
"href": "/en/en/troubleshooting/"
},
{
"type": "category",
"label": "User Settings",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "API Keys",
"href": "/en/en/user-settings/api-keys/",
"docId": "en/user-settings/api-keys/api-keys"
},
{
"type": "link",
"label": "Managing Cloud Credentials",
"href": "/en/en/user-settings/cloud-credentials/",
"docId": "en/user-settings/cloud-credentials/cloud-credentials"
},
{
"type": "link",
"label": "Managing Node Templates",
"href": "/en/en/user-settings/node-templates/",
"docId": "en/user-settings/node-templates/node-templates"
},
{
"type": "link",
"label": "User Preferences",
"href": "/en/en/user-settings/preferences/",
"docId": "en/user-settings/preferences/preferences"
}
],
"href": "/en/en/user-settings/"
},
{
"type": "link",
"label": "Harvester Integration",
"href": "/en/en/virtualization-admin/",
"docId": "en/virtualization-admin/virtualization-admin"
}
]
}
]
},
"docs": {
"en/admin-settings/admin-settings": {
"id": "en/admin-settings/admin-settings",
"title": "Authentication, Permissions and Global Configuration",
"description": "After installation, the system administrator should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/ad/ad": {
"id": "en/admin-settings/authentication/ad/ad",
"title": "Configuring Active Directory (AD)",
"description": "If your organization uses Microsoft Active Directory as central user repository, you can configure Rancher to communicate with an Active Directory server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the Active Directory, while allowing end-users to authenticate with their AD credentials when logging in to the Rancher UI.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/authentication": {
"id": "en/admin-settings/authentication/authentication",
"title": "Authentication",
"description": "One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows your users to use one set of credentials to authenticate with any of your Kubernetes clusters.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/azure-ad/azure-ad": {
"id": "en/admin-settings/authentication/azure-ad/azure-ad",
"title": "Configuring Azure AD",
"description": "If you have an instance of Active Directory (AD) hosted in Azure, you can configure Rancher to allow your users to log in using their AD accounts. Configuration of Azure AD external authentication requires you to make configurations in both Azure and Rancher.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/freeipa/freeipa": {
"id": "en/admin-settings/authentication/freeipa/freeipa",
"title": "Configuring FreeIPA",
"description": "If your organization uses FreeIPA for user authentication, you can configure Rancher to allow your users to login using their FreeIPA credentials.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/github/github": {
"id": "en/admin-settings/authentication/github/github",
"title": "Configuring GitHub",
"description": "In environments using GitHub, you can configure Rancher to allow sign on using GitHub credentials.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/google/google": {
"id": "en/admin-settings/authentication/google/google",
"title": "Configuring Google OAuth",
"description": "If your organization uses G Suite for user authentication, you can configure Rancher to allow your users to log in using their G Suite credentials.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/keycloak-oidc/keycloak-oidc": {
"id": "en/admin-settings/authentication/keycloak-oidc/keycloak-oidc",
"title": "Configuring Keycloak (OIDC)",
"description": "Create a Keycloak OpenID Connect (OIDC) client and configure Rancher to work with Keycloak. By the end your users will be able to sign into Rancher using their Keycloak logins",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/keycloak-saml/keycloak-saml": {
"id": "en/admin-settings/authentication/keycloak-saml/keycloak-saml",
"title": "Configuring Keycloak (SAML)",
"description": "Create a Keycloak SAML client and configure Rancher to work with Keycloak. By the end your users will be able to sign into Rancher using their Keycloak logins",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/local/local": {
"id": "en/admin-settings/authentication/local/local",
"title": "Local Authentication",
"description": "Local authentication is the default until you configure an external authentication provider. Local authentication is where Rancher stores the user information, i.e. names and passwords, of who can log in to Rancher. By default, the admin user that logs in to Rancher for the first time is a local user.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/microsoft-adfs/microsoft-adfs": {
"id": "en/admin-settings/authentication/microsoft-adfs/microsoft-adfs",
"title": "Configuring Microsoft Active Directory Federation Service (SAML)",
"description": "If your organization uses Microsoft Active Directory Federation Services (AD FS) for user authentication, you can configure Rancher to allow your users to log in using their AD FS credentials.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup": {
"id": "en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup",
"title": "1. Configuring Microsoft AD FS for Rancher",
"description": "Before configuring Rancher to support AD FS users, you must add Rancher as a relying party trust in AD FS.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup": {
"id": "en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup",
"title": "2. Configuring Rancher for Microsoft AD FS",
"description": "After you complete Configuring Microsoft AD FS for Rancher, enter your AD FS information into Rancher to allow AD FS users to authenticate with Rancher.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/okta/okta": {
"id": "en/admin-settings/authentication/okta/okta",
"title": "Configuring Okta (SAML)",
"description": "If your organization uses Okta Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/openldap/openldap": {
"id": "en/admin-settings/authentication/openldap/openldap",
"title": "Configuring OpenLDAP",
"description": "If your organization uses LDAP for user authentication, you can configure Rancher to communicate with an OpenLDAP server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the organisation's central user repository, while allowing end-users to authenticate with their LDAP credentials when logging in to the Rancher UI.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/openldap/openldap-config/openldap-config": {
"id": "en/admin-settings/authentication/openldap/openldap-config/openldap-config",
"title": "OpenLDAP Configuration Reference",
"description": "This section is intended to be used as a reference when setting up an OpenLDAP authentication provider in Rancher.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/ping-federate/ping-federate": {
"id": "en/admin-settings/authentication/ping-federate/ping-federate",
"title": "Configuring PingIdentity (SAML)",
"description": "If your organization uses Ping Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/shibboleth/about/about": {
"id": "en/admin-settings/authentication/shibboleth/about/about",
"title": "Group Permissions with Shibboleth and OpenLDAP",
"description": "This page provides background information and context for Rancher users who intend to set up the Shibboleth authentication provider in Rancher.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/shibboleth/shibboleth": {
"id": "en/admin-settings/authentication/shibboleth/shibboleth",
"title": "Configuring Shibboleth (SAML)",
"description": "If your organization uses Shibboleth Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in to Rancher using their Shibboleth credentials.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/authentication/user-groups/user-groups": {
"id": "en/admin-settings/authentication/user-groups/user-groups",
"title": "Users and Groups",
"description": "Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When you configure an external authentication provider, users from that provider will be able to log in to your Rancher server. When a user logs in, the authentication provider will supply your Rancher server with a list of groups to which the user belongs.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/branding/branding": {
"id": "en/admin-settings/branding/branding",
"title": "Custom Branding",
"description": "Rancher v2.6 introduced the ability to customize Rancher’s branding and navigation links.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/cluster-templates/cluster-templates": {
"id": "en/admin-settings/cluster-templates/cluster-templates",
"title": "Cluster Templates",
"description": "Cluster templates encompass both Kubernetes configuration and node pool configuration, allowing a single template to contain all the information Rancher needs to provision new nodes in a cloud provider and install Kubernetes on those nodes.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/config-private-registry/config-private-registry": {
"id": "en/admin-settings/config-private-registry/config-private-registry",
"title": "Configuring a Global Default Private Registry",
"description": "You might want to use a private container registry to share your custom base images within your organization. With a private registry, you can keep a private, consistent, and centralized source of truth for the container images that are used in your clusters.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/drivers/cluster-drivers/cluster-drivers": {
"id": "en/admin-settings/drivers/cluster-drivers/cluster-drivers",
"title": "Cluster Drivers",
"description": "Cluster drivers are used to create clusters in a hosted Kubernetes provider, such as Google GKE. The availability of which cluster driver to display when creating clusters is defined by the cluster driver's status. Only active cluster drivers will be displayed as an option for creating clusters. By default, Rancher is packaged with several existing cloud provider cluster drivers, but you can also add custom cluster drivers to Rancher.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/drivers/drivers": {
"id": "en/admin-settings/drivers/drivers",
"title": "Provisioning Drivers",
"description": "Drivers in Rancher allow you to manage which providers can be used to deploy hosted Kubernetes clusters or nodes in an infrastructure provider to allow Rancher to deploy and manage Kubernetes.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/drivers/node-drivers/node-drivers": {
"id": "en/admin-settings/drivers/node-drivers/node-drivers",
"title": "Node Drivers",
"description": "Node drivers are used to provision hosts, which Rancher uses to launch and manage Kubernetes clusters. A node driver is the same as a Docker Machine driver. The availability of which node driver to display when creating node templates is defined based on the node driver's status. Only active node drivers will be displayed as an option for creating node templates. By default, Rancher is packaged with many existing Docker Machine drivers, but you can also create custom node drivers to add to Rancher.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/k8s-metadata/k8s-metadata": {
"id": "en/admin-settings/k8s-metadata/k8s-metadata",
"title": "Upgrading Kubernetes without Upgrading Rancher",
"description": "The RKE metadata feature allows you to provision clusters with new versions of Kubernetes as soon as they are released, without upgrading Rancher. This feature is useful for taking advantage of patch versions of Kubernetes, for example, if you want to upgrade to Kubernetes v1.14.7 when your Rancher server originally supported v1.14.6.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/pod-security-policies/pod-security-policies": {
"id": "en/admin-settings/pod-security-policies/pod-security-policies",
"title": "Pod Security Policies",
"description": "Pod Security Policies (or PSPs) are objects that control security-sensitive aspects of pod specification (like root privileges).",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rbac/cluster-project-roles/cluster-project-roles": {
"id": "en/admin-settings/rbac/cluster-project-roles/cluster-project-roles",
"title": "Cluster and Project Roles",
"description": "Cluster and project roles define user authorization inside a cluster or project.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rbac/default-custom-roles/default-custom-roles": {
"id": "en/admin-settings/rbac/default-custom-roles/default-custom-roles",
"title": "Custom Roles",
"description": "Within Rancher, roles determine what actions a user can make within a cluster or project.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rbac/global-permissions/global-permissions": {
"id": "en/admin-settings/rbac/global-permissions/global-permissions",
"title": "Global Permissions",
"description": "Permissions are individual access rights that you can assign when selecting a custom permission for a user.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rbac/locked-roles/locked-roles": {
"id": "en/admin-settings/rbac/locked-roles/locked-roles",
"title": "Locked Roles",
"description": "You can set roles to a status of locked. Locking roles prevent them from being assigned to users in the future.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rbac/rbac": {
"id": "en/admin-settings/rbac/rbac",
"title": "Role-Based Access Control (RBAC)",
"description": "Within Rancher, each person authenticates as a user, which is a login that grants you access to Rancher. As mentioned in Authentication, users can either be local or external.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/applying-templates/applying-templates": {
"id": "en/admin-settings/rke-templates/applying-templates/applying-templates",
"title": "Applying Templates",
"description": "You can create a cluster from an RKE template that you created, or from a template that has been shared with you.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/creating-and-revising/creating-and-revising": {
"id": "en/admin-settings/rke-templates/creating-and-revising/creating-and-revising",
"title": "Creating and Revising RKE Templates",
"description": "This section describes how to manage RKE templates and revisions. You an create, share, update, and delete templates from the Cluster Management view under RKE1 Configuration > RKE Templates.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/creator-permissions/creator-permissions": {
"id": "en/admin-settings/rke-templates/creator-permissions/creator-permissions",
"title": "Template Creator Permissions",
"description": "Administrators have the permission to create RKE templates, and only administrators can give that permission to other users.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/enforcement/enforcement": {
"id": "en/admin-settings/rke-templates/enforcement/enforcement",
"title": "Template Enforcement",
"description": "This section describes how template administrators can enforce templates in Rancher, restricting the ability of users to create clusters without a template.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/example-scenarios/example-scenarios": {
"id": "en/admin-settings/rke-templates/example-scenarios/example-scenarios",
"title": "Example Scenarios",
"description": "These example scenarios describe how an organization could use templates to standardize cluster creation.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/example-yaml/example-yaml": {
"id": "en/admin-settings/rke-templates/example-yaml/example-yaml",
"title": "Example YAML",
"description": "Below is an example RKE template configuration file for reference.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/overrides/overrides": {
"id": "en/admin-settings/rke-templates/overrides/overrides",
"title": "Overriding Template Settings",
"description": "When a user creates an RKE template, each setting in the template has a switch in the Rancher UI that indicates if users can override the setting. This switch marks those settings as Allow User Override.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/rke-templates": {
"id": "en/admin-settings/rke-templates/rke-templates",
"title": "RKE Templates",
"description": "RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware": {
"id": "en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware",
"title": "RKE Templates and Infrastructure",
"description": "In Rancher, RKE templates are used to provision Kubernetes and define Rancher settings, while node templates are used to provision nodes.",
"sidebar": "tutorialSidebar"
},
"en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing": {
"id": "en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing",
"title": "Access and Sharing",
"description": "If you are an RKE template owner, you can share it with users or groups of users, who can then use the template to create clusters.",
"sidebar": "tutorialSidebar"
},
"en/api/api": {
"id": "en/api/api",
"title": "API",
"description": "How to use the API",
"sidebar": "tutorialSidebar"
},
"en/api/api-tokens/api-tokens": {
"id": "en/api/api-tokens/api-tokens",
"title": "API Tokens",
"description": "By default, some cluster-level API tokens are generated with infinite time-to-live (ttl=0). In other words, API tokens with ttl=0 never expire unless you invalidate them. Tokens are not invalidated by changing a password.",
"sidebar": "tutorialSidebar"
},
"en/backups/back-up-rancher/back-up-rancher": {
"id": "en/backups/back-up-rancher/back-up-rancher",
"title": "Backing up Rancher",
"description": "In this section, you'll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer the instructions for single node backups",
"sidebar": "tutorialSidebar"
},
"en/backups/backups": {
"id": "en/backups/backups",
"title": "Backups and Disaster Recovery",
"description": "In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"en/backups/configuration/backup-config/backup-config": {
"id": "en/backups/configuration/backup-config/backup-config",
"title": "Backup Configuration",
"description": "The Backup Create page lets you configure a schedule, enable encryption and specify the storage location for your backups.",
"sidebar": "tutorialSidebar"
},
"en/backups/configuration/configuration": {
"id": "en/backups/configuration/configuration",
"title": "Rancher Backup Configuration Reference",
"description": "- Backup configuration",
"sidebar": "tutorialSidebar"
},
"en/backups/configuration/restore-config/restore-config": {
"id": "en/backups/configuration/restore-config/restore-config",
"title": "Restore Configuration",
"description": "The Restore Create page lets you provide details of the backup to restore from",
"sidebar": "tutorialSidebar"
},
"en/backups/configuration/storage-config/storage-config": {
"id": "en/backups/configuration/storage-config/storage-config",
"title": "Backup Storage Location Configuration",
"description": "Configure a storage location where all backups are saved by default. You will have the option to override this with each backup, but will be limited to using an S3-compatible object store.",
"sidebar": "tutorialSidebar"
},
"en/backups/docker-installs/docker-backups/docker-backups": {
"id": "en/backups/docker-installs/docker-backups/docker-backups",
"title": "Backing up Rancher Installed with Docker",
"description": "After completing your Docker installation of Rancher, we recommend creating backups of it on a regular basis. Having a recent backup will let you recover quickly from an unexpected disaster.",
"sidebar": "tutorialSidebar"
},
"en/backups/docker-installs/docker-installs": {
"id": "en/backups/docker-installs/docker-installs",
"title": "Backup and Restore for Rancher Installed with Docker",
"description": "- Backups",
"sidebar": "tutorialSidebar"
},
"en/backups/docker-installs/docker-restores/docker-restores": {
"id": "en/backups/docker-installs/docker-restores/docker-restores",
"title": "Restoring Backups—Docker Installs",
"description": "If you encounter a disaster scenario, you can restore your Rancher Server to your most recent backup.",
"sidebar": "tutorialSidebar"
},
"en/backups/examples/examples": {
"id": "en/backups/examples/examples",
"title": "Examples",
"description": "This section contains examples of Backup and Restore custom resources.",
"sidebar": "tutorialSidebar"
},
"en/backups/migrating-rancher/migrating-rancher": {
"id": "en/backups/migrating-rancher/migrating-rancher",
"title": "Migrating Rancher to a New Cluster",
"description": "If you are migrating Rancher to a new Kubernetes cluster, you don't need to install Rancher on the new cluster first. If Rancher is restored to a new cluster with Rancher already installed, it can cause problems.",
"sidebar": "tutorialSidebar"
},
"en/backups/restoring-rancher/restoring-rancher": {
"id": "en/backups/restoring-rancher/restoring-rancher",
"title": "Restoring Rancher",
"description": "This page outlines how to perform a restore with Rancher.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/best-practices": {
"id": "en/best-practices/best-practices",
"title": "Best Practices Guide",
"description": "The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-managed/containers/containers": {
"id": "en/best-practices/rancher-managed/containers/containers",
"title": "Tips for Setting Up Containers",
"description": "Running well-built containers can greatly impact the overall performance and security of your environment.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-managed/logging/logging": {
"id": "en/best-practices/rancher-managed/logging/logging",
"title": "Logging Best Practices",
"description": "In this guide, we recommend best practices for cluster-level logging and application logging.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-managed/managed-vsphere/managed-vsphere": {
"id": "en/best-practices/rancher-managed/managed-vsphere/managed-vsphere",
"title": "Best Practices for Rancher Managed vSphere Clusters",
"description": "This guide outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-managed/monitoring/monitoring": {
"id": "en/best-practices/rancher-managed/monitoring/monitoring",
"title": "Monitoring Best Practices",
"description": "Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-managed/rancher-managed": {
"id": "en/best-practices/rancher-managed/rancher-managed",
"title": "Best Practices for Rancher Managed Clusters",
"description": "Logging",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-server/deployment-strategies/deployment-strategies": {
"id": "en/best-practices/rancher-server/deployment-strategies/deployment-strategies",
"title": "Rancher Deployment Strategy",
"description": "There are two recommended deployment strategies for a Rancher server that manages downstream Kubernetes clusters. Each one has its own pros and cons. Read more about which one would fit best for your use case:",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-server/deployment-types/deployment-types": {
"id": "en/best-practices/rancher-server/deployment-types/deployment-types",
"title": "Tips for Running Rancher",
"description": "This guide is geared toward use cases where Rancher is used to manage downstream Kubernetes clusters. The high-availability setup is intended to prevent losing access to downstream clusters if the Rancher server is not available.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-server/rancher-in-vsphere/rancher-in-vsphere": {
"id": "en/best-practices/rancher-server/rancher-in-vsphere/rancher-in-vsphere",
"title": "Installing Rancher in a vSphere Environment",
"description": "This guide outlines a reference architecture for installing Rancher on an RKE Kubernetes cluster in a vSphere environment, in addition to standard vSphere best practices as documented by VMware.",
"sidebar": "tutorialSidebar"
},
"en/best-practices/rancher-server/rancher-server": {
"id": "en/best-practices/rancher-server/rancher-server",
"title": "Best Practices for the Rancher Server",
"description": "This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters.",
"sidebar": "tutorialSidebar"
},
"en/cis-scans/cis-scans": {
"id": "en/cis-scans/cis-scans",
"title": "CIS Scans",
"description": "Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. The CIS scans can run on any Kubernetes cluster, including hosted Kubernetes providers such as EKS, AKS, and GKE.",
"sidebar": "tutorialSidebar"
},
"en/cis-scans/configuration/configuration": {
"id": "en/cis-scans/configuration/configuration",
"title": "Configuration",
"description": "This configuration reference is intended to help you manage the custom resources created by the rancher-cis-benchmark application. These resources are used for performing CIS scans on a cluster, skipping tests, setting the test profile that will be used during a scan, and other customization.",
"sidebar": "tutorialSidebar"
},
"en/cis-scans/custom-benchmark/custom-benchmark": {
"id": "en/cis-scans/custom-benchmark/custom-benchmark",
"title": "Creating a Custom Benchmark Version for Running a Cluster Scan",
"description": "Each Benchmark Version defines a set of test configuration files that define the CIS tests to be run by the kube-bench tool.",
"sidebar": "tutorialSidebar"
},
"en/cis-scans/rbac/rbac": {
"id": "en/cis-scans/rbac/rbac",
"title": "Roles-based Access Control",
"description": "This section describes the permissions required to use the rancher-cis-benchmark App.",
"sidebar": "tutorialSidebar"
},
"en/cis-scans/skipped-tests/skipped-tests": {
"id": "en/cis-scans/skipped-tests/skipped-tests",
"title": "Skipped and Not Applicable Tests",
"description": "This section lists the tests that are skipped in the permissive test profile for RKE.",
"sidebar": "tutorialSidebar"
},
"en/cli/cli": {
"id": "en/cli/cli",
"title": "CLI with Rancher",
"description": "Interact with Rancher using command line interface (CLI) tools from your workstation.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/backing-up-etcd/backing-up-etcd": {
"id": "en/cluster-admin/backing-up-etcd/backing-up-etcd",
"title": "Backing up a Cluster",
"description": "In the Rancher UI, etcd backup and recovery for Rancher launched Kubernetes clusters can be easily performed.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/certificate-rotation/certificate-rotation": {
"id": "en/cluster-admin/certificate-rotation/certificate-rotation",
"title": "Certificate Rotation",
"description": "Warning: Rotating Kubernetes certificates may result in your cluster being temporarily unavailable as components are restarted. For production environments, it's recommended to perform this action during a maintenance window.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes": {
"id": "en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes",
"title": "Removing Kubernetes Components from Nodes",
"description": "Learn about cluster cleanup when removing nodes from your Rancher-launched Kubernetes cluster. What is removed, how to do it manually",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cloning-clusters/cloning-clusters": {
"id": "en/cluster-admin/cloning-clusters/cloning-clusters",
"title": "Cloning Clusters",
"description": "If you have a cluster in Rancher that you want to use as a template for creating similar clusters, you can use Rancher CLI to clone the cluster's configuration, edit it, and then use it to quickly launch the cloned cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cluster-access/ace/ace": {
"id": "en/cluster-admin/cluster-access/ace/ace",
"title": "How the Authorized Cluster Endpoint Works",
"description": "This section describes how the kubectl CLI, the kubeconfig file, and the authorized cluster endpoint work together to allow you to access a downstream Kubernetes cluster directly, without authenticating through the Rancher server. It is intended to provide background information and context to the instructions for how to set up kubectl to directly access a cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cluster-access/cluster-access": {
"id": "en/cluster-admin/cluster-access/cluster-access",
"title": "Cluster Access",
"description": "This section is about what tools can be used to access clusters managed by Rancher.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cluster-access/cluster-members/cluster-members": {
"id": "en/cluster-admin/cluster-access/cluster-members/cluster-members",
"title": "Adding Users to Clusters",
"description": "If you want to provide a user with access and permissions to all projects, nodes, and resources within a cluster, assign the user a cluster membership.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cluster-access/kubectl/kubectl": {
"id": "en/cluster-admin/cluster-access/kubectl/kubectl",
"title": "Access a Cluster with Kubectl and kubeconfig",
"description": "Learn how you can access and manage your Kubernetes clusters using kubectl with kubectl Shell or with kubectl CLI and kubeconfig file. A kubeconfig file is used to configure access to Kubernetes. When you create a cluster with Rancher, it automatically creates a kubeconfig for your cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cluster-admin": {
"id": "en/cluster-admin/cluster-admin",
"title": "Cluster Administration",
"description": "After you provision a cluster in Rancher, you can begin using powerful Kubernetes features to deploy and scale your containerized applications in development, testing, or production environments.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cluster-autoscaler/amazon/amazon": {
"id": "en/cluster-admin/cluster-autoscaler/amazon/amazon",
"title": "Cluster Autoscaler with AWS EC2 Auto Scaling Groups",
"description": "This guide will show you how to install and use Kubernetes cluster-autoscaler on Rancher custom clusters using AWS EC2 Auto Scaling Groups.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/cluster-autoscaler/cluster-autoscaler": {
"id": "en/cluster-admin/cluster-autoscaler/cluster-autoscaler",
"title": "Cluster Autoscaler",
"description": "In this section, you'll learn how to install and use the Kubernetes cluster-autoscaler on Rancher custom clusters using AWS EC2 Auto Scaling Groups.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/aks-config-reference/aks-config-reference": {
"id": "en/cluster-admin/editing-clusters/aks-config-reference/aks-config-reference",
"title": "AKS Cluster Configuration Reference",
"description": "- Support for adding more than one node pool",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/editing-clusters": {
"id": "en/cluster-admin/editing-clusters/editing-clusters",
"title": "Cluster Configuration",
"description": "After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/eks-config-reference/eks-config-reference": {
"id": "en/cluster-admin/editing-clusters/eks-config-reference/eks-config-reference",
"title": "EKS Cluster Configuration Reference",
"description": "Account Access",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/gke-config-reference/gke-config-reference": {
"id": "en/cluster-admin/editing-clusters/gke-config-reference/gke-config-reference",
"title": "GKE Cluster Configuration Reference",
"description": "- Support for additional configuration options:",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters": {
"id": "en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters",
"title": "Private Clusters",
"description": "In GKE, private clusters are clusters whose nodes are isolated from inbound and outbound traffic by assigning them internal IP addresses only. Private clusters in GKE have the option of exposing the control plane endpoint as a publicly accessible address or as a private address. This is different from other Kubernetes providers, which may refer to clusters with private control plane endpoints as \"private clusters\" but still allow traffic to and from nodes. You may want to create a cluster with private nodes, with or without a public control plane endpoint, depending on your organization's networking and security requirements. A GKE cluster provisioned from Rancher can use isolated nodes by selecting \"Private Cluster\" in the Cluster Options (under \"Show advanced options\"). The control plane endpoint can optionally be made private by selecting \"Enable Private Endpoint\".",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/k3s-config-reference/k3s-config-reference": {
"id": "en/cluster-admin/editing-clusters/k3s-config-reference/k3s-config-reference",
"title": "K3s Cluster Configuration Reference",
"description": "This section covers the configuration options that are available in Rancher for a new or existing K3s Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/rke-config-reference/rke-config-references": {
"id": "en/cluster-admin/editing-clusters/rke-config-reference/rke-config-references",
"title": "RKE Cluster Configuration Reference",
"description": "When Rancher installs Kubernetes, it uses RKE or RKE2 as the Kubernetes distribution.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/rke2-config-reference/rke2-config-reference": {
"id": "en/cluster-admin/editing-clusters/rke2-config-reference/rke2-config-reference",
"title": "RKE2 Cluster Configuration Reference",
"description": "This section covers the configuration options that are available in Rancher for a new or existing RKE2 Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/editing-clusters/syncing/syncing": {
"id": "en/cluster-admin/editing-clusters/syncing/syncing",
"title": "Syncing",
"description": "Syncing is the feature for EKS and GKE clusters that causes Rancher to update the clusters' values so they are up to date with their corresponding cluster object in the hosted Kubernetes provider. This enables Rancher to not be the sole owner of a hosted cluster’s state. Its largest limitation is that processing an update from Rancher and another source at the same time or within 5 minutes of one finishing may cause the state from one source to completely overwrite the other.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/nodes/nodes": {
"id": "en/cluster-admin/nodes/nodes",
"title": "Nodes and Node Pools",
"description": "After you launch a Kubernetes cluster in Rancher, you can manage individual nodes from the cluster's Node tab. Depending on the option used to provision the cluster, there are different node options available.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/pod-security-policies/pod-security-policies": {
"id": "en/cluster-admin/pod-security-policies/pod-security-policies",
"title": "Assigning Pod Security Policies",
"description": "Pod Security Policies are objects that control security-sensitive aspects of pod specification (like root privileges).",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/pod-security-policy/pod-security-policy": {
"id": "en/cluster-admin/pod-security-policy/pod-security-policy",
"title": "Adding a Pod Security Policy",
"description": "Prerequisite: The options below are available only for clusters that are launched using RKE.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/projects-and-namespaces/projects-and-namespaces": {
"id": "en/cluster-admin/projects-and-namespaces/projects-and-namespaces",
"title": "Projects and Kubernetes Namespaces with Rancher",
"description": "Rancher Projects ease the administrative burden of your cluster and support multi-tenancy. Learn to create projects and divide projects into Kubernetes namespaces",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/restoring-etcd/restoring-etcd": {
"id": "en/cluster-admin/restoring-etcd/restoring-etcd",
"title": "Restoring a Cluster from Backup",
"description": "etcd backup and recovery for Rancher launched Kubernetes clusters can be easily performed. Snapshots of the etcd database are taken and saved either locally onto the etcd nodes or to a S3 compatible target. The advantages of configuring S3 is that if all etcd nodes are lost, your snapshot is saved remotely and can be used to restore the cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/tools/tools": {
"id": "en/cluster-admin/tools/tools",
"title": "Tools for Logging, Monitoring, and Visibility",
"description": "Rancher contains a variety of tools that aren't included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently. Tools are divided into following categories:",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/upgrading-kubernetes/upgrading-kubernetes": {
"id": "en/cluster-admin/upgrading-kubernetes/upgrading-kubernetes",
"title": "Upgrading and Rolling Back Kubernetes",
"description": "Following an upgrade to the latest version of Rancher, downstream Kubernetes clusters can be upgraded to use the latest supported version of Kubernetes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage": {
"id": "en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage",
"title": "Setting up Existing Storage",
"description": "This section describes how to set up existing persistent storage for workloads in Rancher.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/ceph/ceph": {
"id": "en/cluster-admin/volumes-and-storage/ceph/ceph",
"title": "Using an External Ceph Driver",
"description": "These instructions are about using the external Ceph driver in an RKE2 cluster. If you are using RKE, additional steps are required. For details, refer to this section.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/examples/ebs/ebs": {
"id": "en/cluster-admin/volumes-and-storage/examples/ebs/ebs",
"title": "Creating Persistent Storage in Amazon's EBS",
"description": "This section describes how to set up Amazon's Elastic Block Store in EC2.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/examples/examples": {
"id": "en/cluster-admin/volumes-and-storage/examples/examples",
"title": "Provisioning Storage Examples",
"description": "Rancher supports persistent storage with a variety of volume plugins. However, before you use any of these plugins to bind persistent storage to your workloads, you have to configure the storage itself, whether its a cloud-based solution from a service-provider or an on-prem solution that you manage yourself.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/examples/nfs/nfs": {
"id": "en/cluster-admin/volumes-and-storage/examples/nfs/nfs",
"title": "NFS Storage",
"description": "Before you can use the NFS storage volume plug-in with Rancher deployments, you need to provision an NFS server.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere": {
"id": "en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere",
"title": "vSphere Storage",
"description": "To provide stateful workloads with vSphere storage, we recommend creating a vSphereVolume StorageClass. This practice dynamically provisions vSphere storage when workloads request volumes through a PersistentVolumeClaim.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes": {
"id": "en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes",
"title": "GlusterFS Volumes",
"description": "This section only applies to RKE clusters.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works": {
"id": "en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works",
"title": "How Persistent Storage Works",
"description": "A persistent volume (PV) is a piece of storage in the Kubernetes cluster, while a persistent volume claim (PVC) is a request for storage.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes": {
"id": "en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes",
"title": "iSCSI Volumes",
"description": "In Rancher Launched Kubernetes clusters that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. This failure is likely due to an incompatibility issue involving the iSCSI initiator tool. You can resolve this issue by installing the iSCSI initiator tool on each of your cluster nodes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage": {
"id": "en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage",
"title": "Dynamically Provisioning New Storage in Rancher",
"description": "This section describes how to provision new persistent storage for workloads in Rancher.",
"sidebar": "tutorialSidebar"
},
"en/cluster-admin/volumes-and-storage/volumes-and-storage": {
"id": "en/cluster-admin/volumes-and-storage/volumes-and-storage",
"title": "Kubernetes Persistent Storage: Volumes and Storage Classes",
"description": "Learn about the two ways with which you can create persistent storage in Kubernetes: persistent volumes and storage classes",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/cluster-capabilities-table/cluster-capabilities-table": {
"id": "en/cluster-provisioning/cluster-capabilities-table/cluster-capabilities-table",
"title": "cluster-capabilities-table",
"description": "| Action | Rancher Launched Kubernetes Clusters | EKS, GKE and AKS Clusters1 | Other Hosted Kubernetes Clusters | Non-EKS or GKE Registered Clusters |",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/cluster-provisioning": {
"id": "en/cluster-provisioning/cluster-provisioning",
"title": "Setting up Kubernetes Clusters in Rancher",
"description": "Provisioning Kubernetes Clusters",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack",
"title": "Creating an Aliyun ACK Cluster",
"description": "You can use Rancher to create a cluster hosted in Alibaba Cloud Kubernetes (ACK). Rancher has already implemented and packaged the cluster driver for ACK, but by default, this cluster driver is inactive. In order to launch ACK clusters, you will need to enable the ACK cluster driver. After enabling the cluster driver, you can start provisioning ACK clusters.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks",
"title": "Creating an AKS Cluster",
"description": "You can use Rancher to create a cluster hosted in Microsoft Azure Kubernetes Service (AKS).",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce",
"title": "Creating a Huawei CCE Cluster",
"description": "You can use Rancher to create a cluster hosted in Huawei Cloud Container Engine (CCE). Rancher has already implemented and packaged the cluster driver for CCE, but by default, this cluster driver is inactive. In order to launch CCE clusters, you will need to enable the CCE cluster driver. After enabling the cluster driver, you can start provisioning CCE clusters.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/eks/eks": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/eks/eks",
"title": "Creating an EKS Cluster",
"description": "Amazon EKS provides a managed control plane for your Kubernetes cluster. Amazon EKS runs the Kubernetes control plane instances across multiple Availability Zones to ensure high availability. Rancher provides an intuitive user interface for managing and deploying the Kubernetes clusters you run in Amazon EKS. With this guide, you will use Rancher to quickly and easily launch an Amazon EKS Kubernetes cluster in your AWS account. For more information on Amazon EKS, see this documentation.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/permissions": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/permissions",
"title": "Minimum EKS Permissions",
"description": "Documented here is a minimum set of permissions necessary to use all functionality of the EKS driver in Rancher. Additional permissions are required for Rancher to provision the Service Role and VPC resources. Optionally these resources can be created before the cluster creation and will be selectable when defining the cluster configuration.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke",
"title": "Managing GKE Clusters",
"description": "- Prerequisites",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/hosted-kubernetes-clusters": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/hosted-kubernetes-clusters",
"title": "Setting up Clusters from Hosted Kubernetes Providers",
"description": "In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke": {
"id": "en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke",
"title": "Creating a Tencent TKE Cluster",
"description": "You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE). Rancher has already implemented and packaged the cluster driver for TKE, but by default, this cluster driver is inactive. In order to launch TKE clusters, you will need to enable the TKE cluster driver. After enabling the cluster driver, you can start provisioning TKE clusters.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/node-requirements/node-requirements": {
"id": "en/cluster-provisioning/node-requirements/node-requirements",
"title": "Node Requirements for Rancher Managed Clusters",
"description": "This page describes the requirements for the Rancher managed Kubernetes clusters where your apps and services will be installed. These downstream clusters should be separate from the three-node cluster running Rancher.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles": {
"id": "en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles",
"title": "Roles for Nodes in Kubernetes",
"description": "This section describes the roles for etcd nodes, controlplane nodes, and worker nodes in Kubernetes, and how the roles work together in a cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/production/production": {
"id": "en/cluster-provisioning/production/production",
"title": "Checklist for Production-Ready Clusters",
"description": "In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/production/recommended-architecture/recommended-architecture": {
"id": "en/cluster-provisioning/production/recommended-architecture/recommended-architecture",
"title": "Recommended Cluster Architecture",
"description": "There are three roles that can be assigned to nodes: etcd, controlplane and worker.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/registered-clusters/registered-clusters": {
"id": "en/cluster-provisioning/registered-clusters/registered-clusters",
"title": "Registering Existing Clusters",
"description": "The cluster registration feature replaced the feature to import clusters.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/behavior-differences-between-rke1-and-rke2/behavior-differences-between-rke1-and-rke2": {
"id": "en/cluster-provisioning/rke-clusters/behavior-differences-between-rke1-and-rke2/behavior-differences-between-rke1-and-rke2",
"title": "Behavior Differences Between RKE1 and RKE2",
"description": "RKE2, also known as RKE Government, is a Kubernetes distribution that focuses on security and compliance for U.S. Federal Government entities. It is considered the next iteration of the Rancher Kubernetes Engine, now known as RKE1.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon",
"title": "Setting up the Amazon Cloud Provider",
"description": "When using the Amazon cloud provider, you can leverage the following capabilities:",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/azure/azure": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/azure/azure",
"title": "Setting up the Azure Cloud Provider",
"description": "When using the Azure cloud provider, you can leverage the following capabilities:",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/cloud-providers": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/cloud-providers",
"title": "Setting up Cloud Providers",
"description": "A cloud provider is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce",
"title": "Setting up the Google Compute Engine Cloud Provider",
"description": "In this section, you'll learn how to enable the Google Compute Engine (GCE) cloud provider for custom clusters in Rancher. A custom cluster is one in which Rancher installs Kubernetes on existing nodes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/in-tree": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/in-tree",
"title": "How to Configure In-tree vSphere Cloud Provider",
"description": "To set up the in-tree vSphere cloud provider, follow these steps while creating the vSphere cluster in Rancher:",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/out-of-tree": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/out-of-tree",
"title": "How to Configure Out-of-tree vSphere Cloud Provider",
"description": "Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/vsphere-volume-migration": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/vsphere-volume-migration",
"title": "Migrating vSphere In-tree Volumes to CSI",
"description": "Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/vsphere": {
"id": "en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/vsphere",
"title": "Setting up the vSphere Cloud Provider",
"description": "In this section, you'll learn how to set up a vSphere cloud provider for a Rancher managed RKE Kubernetes cluster in vSphere.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options": {
"id": "en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options",
"title": "Rancher Agent Options",
"description": "Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to create a cluster with custom nodes and add the options to the generated docker run command when adding a node.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes": {
"id": "en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes",
"title": "Launching Kubernetes on Existing Custom Nodes",
"description": "To create a cluster with custom nodes, you’ll need to access servers in your cluster and provision them according to Rancher requirements",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/azure/azure": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/azure/azure",
"title": "Creating an Azure Cluster",
"description": "In this section, you'll learn how to install an RKE Kubernetes cluster in Azure through Rancher.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/azure/azure-machine-config/azure-machine-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/azure/azure-machine-config/azure-machine-config",
"title": "Azure Machine Configuration",
"description": "For more information about Azure, refer to the official Azure documentation.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/azure-node-template-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/azure-node-template-config",
"title": "Azure Node Template Configuration",
"description": "For more information about Azure, refer to the official Azure documentation.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/digital-ocean": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/digital-ocean",
"title": "Creating a DigitalOcean Cluster",
"description": "In this section, you'll learn how to use Rancher to install an RKE Kubernetes cluster in DigitalOcean.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-machine-config/do-machine-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-machine-config/do-machine-config",
"title": "DigitalOcean Machine Configuration",
"description": "For more details about DigitalOcean, Droplets, refer to the official documentation.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/do-node-template-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/do-node-template-config",
"title": "DigitalOcean Node Template Configuration",
"description": "-",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2",
"title": "Creating an Amazon EC2 Cluster",
"description": "Learn the prerequisites and steps required in order for you to create an Amazon EC2 cluster using Rancher",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/ec2-machine-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/ec2-machine-config",
"title": "EC2 Machine Configuration Reference",
"description": "For more details about EC2 nodes, refer to the official documentation for the EC2 Management Console.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config",
"title": "EC2 Node Template Configuration",
"description": "For more details about EC2, nodes, refer to the official documentation for the EC2 Management Console.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/node-pools": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/node-pools",
"title": "Launching Kubernetes on New Nodes in an Infrastructure Provider",
"description": "This section covers the following topics:",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix",
"title": "Creating a Nutanix AOS Cluster",
"description": "Use Rancher to create a Nutanix AOS (AHV) cluster. It may consist of groups of VMs with distinct properties which allow for fine-grained control over the sizing of nodes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/nutanix-node-template-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/nutanix-node-template-config",
"title": "Nutanix Node Template Configuration",
"description": "- Account Access",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/providing-nutanix-clusters": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/providing-nutanix-clusters",
"title": "Provisioning Kubernetes Clusters in Nutanix AOS",
"description": "To use Rancher to install an RKE Kubernetes cluster in Nutanix AOS (AHV):",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-a-vm-template/creating-a-vm-template": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-a-vm-template/creating-a-vm-template",
"title": "Creating a vSphere Virtual Machine Template",
"description": "Creating virtual machines in a repeatable and reliable fashion can often be difficult. VMware vSphere offers the ability to build one VM that can then be converted to a template. The template can then be used to create identically configured VMs. Rancher leverages this capability within node pools to create identical RKE1 and RKE2 nodes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials",
"title": "Creating Credentials in the vSphere Console",
"description": "This section describes how to create a vSphere username and password. You will need to provide these vSphere credentials to Rancher, which allows Rancher to provision resources in vSphere.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters",
"title": "Provisioning Kubernetes Clusters in vSphere",
"description": "In this section, you'll learn how to use Rancher to install an RKE Kubernetes cluster in vSphere.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/vsphere/vpshere": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/vpshere",
"title": "Creating a vSphere Cluster",
"description": "Use Rancher to create a vSphere cluster. It may consist of groups of VMs with distinct properties which allow for fine-grained control over the sizing of nodes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config": {
"id": "en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config",
"title": "VSphere Node Template Configuration",
"description": "- Account Access",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/options/options": {
"id": "en/cluster-provisioning/rke-clusters/options/options",
"title": "RKE Cluster Configuration",
"description": "This page has moved here.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/rancher-agents/rancher-agents": {
"id": "en/cluster-provisioning/rke-clusters/rancher-agents/rancher-agents",
"title": "Rancher Agents",
"description": "There are two different agent resources deployed on Rancher managed clusters:",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/rke-clusters": {
"id": "en/cluster-provisioning/rke-clusters/rke-clusters",
"title": "Launching Kubernetes with Rancher",
"description": "You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, you can choose between Rancher Kubernetes Engine (RKE) or RKE2 distributions. Rancher can launch Kubernetes on any computers, including:",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass": {
"id": "en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass",
"title": "Configuration for Storage Classes in Azure",
"description": "If you are using Azure VMs for your nodes, you can use Azure files as a StorageClass for the cluster.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/host-gateway-requirements": {
"id": "en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/host-gateway-requirements",
"title": "Networking Requirements for Host Gateway (L2bridge)",
"description": "This section describes how to configure custom Windows clusters that are using Host Gateway (L2bridge) mode.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters": {
"id": "en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters",
"title": "Launching Kubernetes on Windows Clusters",
"description": "When provisioning a custom cluster using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes.",
"sidebar": "tutorialSidebar"
},
"en/cluster-provisioning/rke-clusters/windows-clusters/windows-parity/windows-parity": {
"id": "en/cluster-provisioning/rke-clusters/windows-clusters/windows-parity/windows-parity",
"title": "Windows and Linux Cluster Feature Parity",
"description": "Windows clusters do not share the same feature support as Linux clusters.",
"sidebar": "tutorialSidebar"
},
"en/contributing/contributing": {
"id": "en/contributing/contributing",
"title": "Contributing to Rancher",
"description": "This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue.",
"sidebar": "tutorialSidebar"
},
"en/deploy-across-clusters/deploy-across-clusters": {
"id": "en/deploy-across-clusters/deploy-across-clusters",
"title": "Deploying Applications across Clusters",
"description": "Fleet",
"sidebar": "tutorialSidebar"
},
"en/deploy-across-clusters/fleet/architecture/architecture": {
"id": "en/deploy-across-clusters/fleet/architecture/architecture",
"title": "Architecture",
"description": "Fleet can manage deployments from git of raw Kubernetes YAML, Helm charts, or Kustomize or any combination of the three. Regardless of the source, all resources are dynamically turned into Helm charts, and Helm is used as the engine to deploy everything in the cluster. This gives you a high degree of control, consistency, and auditability. Fleet focuses not only on the ability to scale, but to give one a high degree of control and visibility to exactly what is installed on the cluster.",
"sidebar": "tutorialSidebar"
},
"en/deploy-across-clusters/fleet/fleet": {
"id": "en/deploy-across-clusters/fleet/fleet",
"title": "Fleet - GitOps at Scale",
"description": "Fleet is GitOps at scale. Fleet is designed to manage up to a million clusters. It's also lightweight enough that it works great for a single cluster too, but it really shines when you get to a large scale. By large scale we mean either a lot of clusters, a lot of deployments, or a lot of teams in a single organization.",
"sidebar": "tutorialSidebar"
},
"en/deploy-across-clusters/fleet/proxy/proxy": {
"id": "en/deploy-across-clusters/fleet/proxy/proxy",
"title": "Using Fleet Behind a Proxy",
"description": "In this section, you'll learn how to enable Fleet in a setup that has a Rancher server with a public IP a Kubernetes cluster that has no public IP, but is configured to use a proxy.",
"sidebar": "tutorialSidebar"
},
"en/deploy-across-clusters/fleet/windows/windows": {
"id": "en/deploy-across-clusters/fleet/windows/windows",
"title": "Windows Support",
"description": "Prior to Rancher v2.5.6, the agent did not have native Windows manifests on downstream clusters with Windows nodes. This would result in a failing agent pod for the cluster.",
"sidebar": "tutorialSidebar"
},
"en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps": {
"id": "en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps",
"title": "Multi-cluster Apps",
"description": "As of Rancher v2.5, multi-cluster apps are deprecated. We now recommend using Fleet for deploying apps across clusters.",
"sidebar": "tutorialSidebar"
},
"en/faq/deprecated-features/deprecated-features": {
"id": "en/faq/deprecated-features/deprecated-features",
"title": "Deprecated Features in Rancher",
"description": "What is Rancher's Deprecation policy?",
"sidebar": "tutorialSidebar"
},
"en/faq/dockershim/dockershim": {
"id": "en/faq/dockershim/dockershim",
"title": "Dockershim",
"description": "The Dockershim is the CRI compliant layer between the Kubelet and the Docker daemon. As part of the Kubernetes 1.20 release, the deprecation of the in-tree Dockershim was announced. Removal is currently scheduled for Kubernetes 1.24. For more information on the deprecation and its timelines, see the Kubernetes Dockershim Deprecation FAQ.",
"sidebar": "tutorialSidebar"
},
"en/faq/faq": {
"id": "en/faq/faq",
"title": "FAQ",
"description": "This FAQ is a work in progress designed to answers the questions our users most frequently ask about Rancher v2.x.",
"sidebar": "tutorialSidebar"
},
"en/faq/kubectl/kubectl": {
"id": "en/faq/kubectl/kubectl",
"title": "Installing and Configuring kubectl",
"description": "kubectl is a CLI utility for running commands against Kubernetes clusters. It's required for many maintenance and administrative tasks in Rancher 2.x.",
"sidebar": "tutorialSidebar"
},
"en/faq/networking/cni-providers/cni-providers": {
"id": "en/faq/networking/cni-providers/cni-providers",
"title": "Container Network Interface (CNI) Providers",
"description": "Learn about Container Network Interface (CNI), the CNI providers Rancher provides, the features they offer, and how to choose a provider for you",
"sidebar": "tutorialSidebar"
},
"en/faq/networking/networking": {
"id": "en/faq/networking/networking",
"title": "Networking",
"description": "Networking FAQ's",
"sidebar": "tutorialSidebar"
},
"en/faq/removing-rancher/removing-rancher": {
"id": "en/faq/removing-rancher/removing-rancher",
"title": "Rancher is No Longer Needed",
"description": "This page is intended to answer questions about what happens if you don't want Rancher anymore, if you don't want a cluster to be managed by Rancher anymore, or if the Rancher server is deleted.",
"sidebar": "tutorialSidebar"
},
"en/faq/security/security": {
"id": "en/faq/security/security",
"title": "Security",
"description": "Is there a Hardening Guide?",
"sidebar": "tutorialSidebar"
},
"en/faq/technical/technical": {
"id": "en/faq/technical/technical",
"title": "Technical",
"description": "How can I reset the administrator password?",
"sidebar": "tutorialSidebar"
},
"en/faq/telemetry/telemetry": {
"id": "en/faq/telemetry/telemetry",
"title": "Telemetry",
"description": "What is Telemetry?",
"sidebar": "tutorialSidebar"
},
"en/helm-charts/creating-apps/creating-apps": {
"id": "en/helm-charts/creating-apps/creating-apps",
"title": "Creating Apps",
"description": "Rancher's App Marketplace is based on Helm Repositories and Helm Charts. You can add HTTP based standard Helm Repositories as well as any Git Repository which contains charts.",
"sidebar": "tutorialSidebar"
},
"en/helm-charts/helm": {
"id": "en/helm-charts/helm",
"title": "Helm Charts in Rancher",
"description": "In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using Apps & Marketplace. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/aks/aks": {
"id": "en/installation/install-rancher-on-k8s/aks/aks",
"title": "Installing Rancher on Azure Kubernetes Service",
"description": "This page covers how to install Rancher on Microsoft's Azure Kubernetes Service (AKS).",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/amazon-eks/amazon-eks": {
"id": "en/installation/install-rancher-on-k8s/amazon-eks/amazon-eks",
"title": "Installing Rancher on Amazon EKS",
"description": "This page covers two ways to install Rancher on EKS.",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/chart-options/chart-options": {
"id": "en/installation/install-rancher-on-k8s/chart-options/chart-options",
"title": "Rancher Helm Chart Options",
"description": "This page is a configuration reference for the Rancher Helm chart.",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/gke/gke": {
"id": "en/installation/install-rancher-on-k8s/gke/gke",
"title": "Installing Rancher on a Google Kubernetes Engine Cluster",
"description": "In this section, you'll learn how to install Rancher using Google Kubernetes Engine.",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/install-rancher-on-k8s": {
"id": "en/installation/install-rancher-on-k8s/install-rancher-on-k8s",
"title": "Install/Upgrade Rancher on a Kubernetes Cluster",
"description": "Learn how to install Rancher in development and production environments. Read about single node and high availability installation",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/rollbacks/rollbacks": {
"id": "en/installation/install-rancher-on-k8s/rollbacks/rollbacks",
"title": "Rollbacks",
"description": "- Rolling Back to Rancher v2.5.0+",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/air-gap-upgrade": {
"id": "en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/air-gap-upgrade",
"title": "Rendering the Helm Template in an Air Gapped Environment",
"description": "These instructions assume you have already followed the instructions for a Kubernetes upgrade on this page, including the prerequisites, up until step 3. Upgrade Rancher.",
"sidebar": "tutorialSidebar"
},
"en/installation/install-rancher-on-k8s/upgrades/upgrades": {
"id": "en/installation/install-rancher-on-k8s/upgrades/upgrades",
"title": "Upgrades",
"description": "The following instructions will guide you through upgrading a Rancher server that was installed on a Kubernetes cluster with Helm. These steps also apply to air gap installs with Helm.",
"sidebar": "tutorialSidebar"
},
"en/installation/installation": {
"id": "en/installation/installation",
"title": "Installing/Upgrading Rancher",
"description": "Learn how to install Rancher in development and production environments. Read about single node and high availability installation",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/air-gap/air-gap": {
"id": "en/installation/other-installation-methods/air-gap/air-gap",
"title": "Air Gapped Helm CLI Install",
"description": "This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands": {
"id": "en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands",
"title": "Docker Install Commands",
"description": "The Docker installation is for Rancher users who want to test out Rancher.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/air-gap/install-rancher/install-rancher": {
"id": "en/installation/other-installation-methods/air-gap/install-rancher/install-rancher",
"title": "4. Install Rancher",
"description": "This section is about how to deploy Rancher for your air gapped environment in a high-availability Kubernetes installation. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes": {
"id": "en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes",
"title": "3. Install Kubernetes (Skip for Docker Installs)",
"description": "Skip this section if you are installing Rancher on a single node with Docker.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry": {
"id": "en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry",
"title": "2. Collect and Publish Images to your Private Registry",
"description": "This section describes how to set up your private registry so that when you install Rancher, Rancher will pull all the required images from this registry.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes": {
"id": "en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes",
"title": "1. Set up Infrastructure and Private Registry",
"description": "In this section, you will provision the underlying infrastructure for your Rancher management server in an air gapped environment. You will also set up the private Docker registry that must be available to your Rancher node(s).",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/behind-proxy/behind-proxy": {
"id": "en/installation/other-installation-methods/behind-proxy/behind-proxy",
"title": "Installing Rancher behind an HTTP Proxy",
"description": "In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher": {
"id": "en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher",
"title": "3. Install Rancher",
"description": "Now that you have a running RKE cluster, you can install Rancher in it. For security reasons all traffic to Rancher must be encrypted with TLS. For this tutorial you are going to automatically issue a self-signed certificate through cert-manager. In a real-world use-case you will likely use Let's Encrypt or provide your own certificate.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes": {
"id": "en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes",
"title": "2. Install Kubernetes",
"description": "Once the infrastructure is ready, you can continue with setting up an RKE cluster to install Rancher in.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes": {
"id": "en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes",
"title": "1. Set up Infrastructure",
"description": "In this section, you will provision the underlying infrastructure for your Rancher management server with internete access through a HTTP proxy.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/other-installation-methods": {
"id": "en/installation/other-installation-methods/other-installation-methods",
"title": "Other Installation Methods",
"description": "Air Gapped Installations",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/single-node-docker/advanced/advanced": {
"id": "en/installation/other-installation-methods/single-node-docker/advanced/advanced",
"title": "Advanced Options for Docker Installs",
"description": "When installing Rancher, there are several advanced options that can be enabled:",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/single-node-docker/proxy/proxy": {
"id": "en/installation/other-installation-methods/single-node-docker/proxy/proxy",
"title": "HTTP Proxy Configuration",
"description": "If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/single-node-docker/single-node-docker": {
"id": "en/installation/other-installation-methods/single-node-docker/single-node-docker",
"title": "Installing Rancher on a Single Node Using Docker",
"description": "For development and testing environments only, use a Docker install. Install Docker on a single Linux host, and deploy Rancher with a single Docker container.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks": {
"id": "en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks",
"title": "Rolling Back Rancher Installed with Docker",
"description": "If a Rancher upgrade does not complete successfully, you'll have to roll back to your Rancher setup that you were using before Docker Upgrade. Rolling back restores:",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-updates": {
"id": "en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-updates",
"title": "Upgrading Rancher Installed with Docker",
"description": "The following instructions will guide you through upgrading a Rancher server that was installed with Docker.",
"sidebar": "tutorialSidebar"
},
"en/installation/other-installation-methods/single-node-docker/troubleshooting/troubleshooting": {
"id": "en/installation/other-installation-methods/single-node-docker/troubleshooting/troubleshooting",
"title": "Certificate Troubleshooting",
"description": "How Do I Know if My Certificates are in PEM Format?",
"sidebar": "tutorialSidebar"
},
"en/installation/requirements/dockershim/dockershim": {
"id": "en/installation/requirements/dockershim/dockershim",
"title": "Dockershim",
"description": "The Dockershim is the CRI compliant layer between the Kubelet and the Docker daemon. As part of the Kubernetes 1.20 release, the deprecation of the in-tree Dockershim was announced. For more information on the deprecation and its timelines, see the Kubernetes Dockershim Deprecation FAQ.",
"sidebar": "tutorialSidebar"
},
"en/installation/requirements/installing-docker/installing-docker": {
"id": "en/installation/requirements/installing-docker/installing-docker",
"title": "Installing Docker",
"description": "Docker is required to be installed on nodes where the Rancher server will be installed with Helm or Docker.",
"sidebar": "tutorialSidebar"
},
"en/installation/requirements/ports/common-ports-table/common-ports-table": {
"id": "en/installation/requirements/ports/common-ports-table/common-ports-table",
"title": "common-ports-table",
"description": "| Protocol \t| Port \t| Description \t |",
"sidebar": "tutorialSidebar"
},
"en/installation/requirements/ports/ports": {
"id": "en/installation/requirements/ports/ports",
"title": "Port Requirements",
"description": "Read about port requirements needed in order for Rancher to operate properly, both for Rancher nodes and downstream Kubernetes cluster nodes",
"sidebar": "tutorialSidebar"
},
"en/installation/requirements/requirements": {
"id": "en/installation/requirements/requirements",
"title": "Installation Requirements",
"description": "Learn the node requirements for each node running Rancher server when you’re configuring Rancher to run either in a Docker or Kubernetes setup",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/advanced/advanced": {
"id": "en/installation/resources/advanced/advanced",
"title": "Advanced",
"description": "The documents in this section contain resources for less common use cases.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/advanced/api-audit-log/api-audit-log": {
"id": "en/installation/resources/advanced/api-audit-log/api-audit-log",
"title": "Enabling the API Audit Log to Record System Events",
"description": "You can enable the API audit log to record the sequence of system events initiated by individual users. You can know what happened, when it happened, who initiated it, and what cluster it affected. When you enable this feature, all requests to the Rancher API and all responses from it are written to a log.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/advanced/arm64-platform/arm64-platform": {
"id": "en/installation/resources/advanced/arm64-platform/arm64-platform",
"title": "Running on ARM64 (Experimental)",
"description": "Important:",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/advanced/etcd/etcd": {
"id": "en/installation/resources/advanced/etcd/etcd",
"title": "Tuning etcd for Large Installations",
"description": "When running larger Rancher installations with 15 or more clusters it is recommended to increase the default keyspace for etcd from the default 2GB. The maximum setting is 8GB and the host should have enough RAM to keep the entire dataset in memory. When increasing this value you should also increase the size of the host. The keyspace size can also be adjusted in smaller installations if you anticipate a high rate of change of pods during the garbage collection interval.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/advanced/firewall/firewall": {
"id": "en/installation/resources/advanced/firewall/firewall",
"title": "Opening Ports with firewalld",
"description": "We recommend disabling firewalld. For Kubernetes 1.19.x and higher, firewalld must be turned off.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb": {
"id": "en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb",
"title": "Docker Install with TLS Termination at Layer-7 NGINX Load Balancer",
"description": "For development and testing environments that have a special requirement to terminate TLS/SSL at a load balancer instead of your Rancher Server container, deploy Rancher and configure a load balancer to work with it conjunction.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/bootstrap-password/bootstrap-password": {
"id": "en/installation/resources/bootstrap-password/bootstrap-password",
"title": "Bootstrap Password",
"description": "When Rancher starts for the first time, a password is randomly generated for the first admin user. When the admin first logs in to Rancher, the UI shows commands that can be used to retrieve the bootstrap password. The admin needs to run those commands and log in with the bootstrap password. Then Rancher gives the admin an opportunity to reset the password.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/choosing-version/choosing-version": {
"id": "en/installation/resources/choosing-version/choosing-version",
"title": "Choosing a Rancher Version",
"description": "This section describes how to choose a Rancher version.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/custom-ca-root-certificate/custom-ca-root-certificate": {
"id": "en/installation/resources/custom-ca-root-certificate/custom-ca-root-certificate",
"title": "About Custom CA Root Certificates",
"description": "If you're using Rancher in an internal production environment where you aren't exposing apps publicly, use a certificate from a private certificate authority (CA).",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/feature-flags/continuous-delivery/continuous-delivery": {
"id": "en/installation/resources/feature-flags/continuous-delivery/continuous-delivery",
"title": "Continuous Delivery",
"description": "As of Rancher v2.5, Fleet comes preinstalled in Rancher, and as of Rancher v2.6, Fleet can no longer be fully disabled. However, the Fleet feature for GitOps continuous delivery may be disabled using the continuous-delivery feature flag.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/feature-flags/enable-not-default-storage-drivers/enable-not-default-storage-drivers": {
"id": "en/installation/resources/feature-flags/enable-not-default-storage-drivers/enable-not-default-storage-drivers",
"title": "Allow Unsupported Storage Drivers",
"description": "This feature allows you to use types for storage providers and provisioners that are not enabled by default.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/feature-flags/feature-flags": {
"id": "en/installation/resources/feature-flags/feature-flags",
"title": "Enabling Experimental Features",
"description": "Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an unsupported storage type outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui": {
"id": "en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui",
"title": "UI for Istio Virtual Services and Destination Rules",
"description": "This feature enables a UI that lets you create, read, update and delete virtual services and destination rules, which are traffic management features of Istio.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/helm-version/helm-version": {
"id": "en/installation/resources/helm-version/helm-version",
"title": "Helm Version Requirements",
"description": "This section contains the requirements for Helm, which is the tool used to install Rancher on a high-availability Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE": {
"id": "en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE",
"title": "Setting up a High-availability RKE Kubernetes Cluster",
"description": "This section describes how to install a Kubernetes cluster. This cluster should be dedicated to run only the Rancher server.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/ha-rke2/ha-rke2": {
"id": "en/installation/resources/k8s-tutorials/ha-rke2/ha-rke2",
"title": "Setting up a High-availability RKE2 Kubernetes Cluster for Rancher",
"description": "Tested on v2.5.6",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db": {
"id": "en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db",
"title": "Setting up a High-availability K3s Kubernetes Cluster for Rancher",
"description": "This section describes how to install a Kubernetes cluster according to the best practices for the Rancher server environment.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/how-ha-works/how-ha-works": {
"id": "en/installation/resources/k8s-tutorials/how-ha-works/how-ha-works",
"title": "About High-availability Installations",
"description": "We recommend using Helm, a Kubernetes package manager, to install Rancher on a dedicated Kubernetes cluster. This is called a high-availability Kubernetes installation because increased availability is achieved by running Rancher on multiple nodes.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/ec2-node": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/ec2-node",
"title": "Setting up Nodes in Amazon EC2",
"description": "In this tutorial, you will learn one way to set up Linux nodes for the Rancher management server. These nodes will fulfill the node requirements for OS, Docker, hardware, and networking.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db",
"title": "Set up Infrastructure for a High Availability K3s Kubernetes Cluster",
"description": "This tutorial is intended to help you provision the underlying infrastructure for a Rancher management server.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/infra-for-ha": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/infra-for-ha",
"title": "Set up Infrastructure for a High Availability RKE Kubernetes Cluster",
"description": "This tutorial is intended to help you create a high-availability RKE cluster that can be used to install a Rancher server.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha/infra-for-rke2-ha": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha/infra-for-rke2-ha",
"title": "Set up Infrastructure for a High Availability RKE2 Kubernetes Cluster",
"description": "This tutorial is intended to help you provision the underlying infrastructure for a Rancher management server.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/infrastructure-tutorials": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/infrastructure-tutorials",
"title": "Don't have infrastructure for your Kubernetes cluster? Try one of these tutorials.",
"description": "To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to this page.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/nginx": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/nginx",
"title": "Setting up an NGINX Load Balancer",
"description": "NGINX will be configured as Layer 4 load balancer (TCP) that forwards connections to one of your Rancher nodes.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb",
"title": "Setting up Amazon ELB Network Load Balancer",
"description": "This how-to guide describes how to set up a Network Load Balancer (NLB) in Amazon's EC2 service that will direct traffic to multiple instances on EC2.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds": {
"id": "en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds",
"title": "Setting up a MySQL Database in Amazon RDS",
"description": "This tutorial describes how to set up a MySQL database in Amazon's RDS.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/k8s-tutorials/k8s-tutorials": {
"id": "en/installation/resources/k8s-tutorials/k8s-tutorials",
"title": "Don't have a Kubernetes cluster? Try one of these tutorials.",
"description": "This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/local-system-charts/local-system-charts": {
"id": "en/installation/resources/local-system-charts/local-system-charts",
"title": "Setting up Local System Charts for Air Gapped Installations",
"description": "The System Charts repository contains all the catalog items required for features such as monitoring, logging, alerting and global DNS.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/resources": {
"id": "en/installation/resources/resources",
"title": "Resources",
"description": "Docker Installations",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/tls-secrets/tls-secrets": {
"id": "en/installation/resources/tls-secrets/tls-secrets",
"title": "Adding TLS Secrets",
"description": "Kubernetes will create all the objects and services for Rancher, but it will not become available until we populate the tls-rancher-ingress secret in the cattle-system namespace with the certificate and key.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/tls-settings/tls-settings": {
"id": "en/installation/resources/tls-settings/tls-settings",
"title": "TLS Settings",
"description": "Changing the default TLS settings depends on the chosen installation method.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/troubleshooting/troubleshooting": {
"id": "en/installation/resources/troubleshooting/troubleshooting",
"title": "Troubleshooting the Rancher Server Kubernetes Cluster",
"description": "This section describes how to troubleshoot an installation of Rancher on a Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/update-rancher-cert/update-rancher-cert": {
"id": "en/installation/resources/update-rancher-cert/update-rancher-cert",
"title": "Updating the Rancher Certificate",
"description": "Follow these steps to update the SSL certificate of the ingress in a Rancher high availability Kubernetes installation or to switch from the default self-signed certificate to a custom certificate.",
"sidebar": "tutorialSidebar"
},
"en/installation/resources/upgrading-cert-manager/upgrading-cert-manager": {
"id": "en/installation/resources/upgrading-cert-manager/upgrading-cert-manager",
"title": "Upgrading Cert-Manager",
"description": "Rancher uses cert-manager to automatically generate and renew TLS certificates for HA deployments of Rancher. As of Fall 2019, three important changes to cert-manager are set to occur that you need to take action on if you have an HA deployment of Rancher:",
"sidebar": "tutorialSidebar"
},
"en/introduction": {
"id": "en/introduction",
"title": "Rancher 2.6",
"description": "Rancher adds significant value on top of Kubernetes: managing hundreds of clusters from one interface, centralizing RBAC, enabling monitoring and alerting. Read more.",
"sidebar": "tutorialSidebar"
},
"en/istio/configuration-reference/canal-and-project-network/canal-and-project-network": {
"id": "en/istio/configuration-reference/canal-and-project-network/canal-and-project-network",
"title": "Additional Steps for Project Network Isolation",
"description": "In clusters where:",
"sidebar": "tutorialSidebar"
},
"en/istio/configuration-reference/configuration-reference": {
"id": "en/istio/configuration-reference/configuration-reference",
"title": "Configuration Options",
"description": "- Egress Support",
"sidebar": "tutorialSidebar"
},
"en/istio/configuration-reference/enable-istio-with-psp/enable-istio-with-psp": {
"id": "en/istio/configuration-reference/enable-istio-with-psp/enable-istio-with-psp",
"title": "Enable Istio with Pod Security Policies",
"description": "If you have restrictive Pod Security Policies enabled, then Istio may not be able to function correctly, because it needs certain permissions in order to install itself and manage pod infrastructure. In this section, we will configure a cluster with PSPs enabled for an Istio install, and also set up the Istio CNI plugin.",
"sidebar": "tutorialSidebar"
},
"en/istio/configuration-reference/rke2/rke2": {
"id": "en/istio/configuration-reference/rke2/rke2",
"title": "Additional Steps for Installing Istio on an RKE2 Cluster",
"description": "When installing or upgrading the Istio Helm chart through Apps & Marketplace,",
"sidebar": "tutorialSidebar"
},
"en/istio/configuration-reference/selectors-and-scrape/selectors-and-scrape": {
"id": "en/istio/configuration-reference/selectors-and-scrape/selectors-and-scrape",
"title": "Selectors and Scrape Configs",
"description": "The Monitoring app sets prometheus.prometheusSpec.ignoreNamespaceSelectors=false, which enables monitoring across all namespaces by default.",
"sidebar": "tutorialSidebar"
},
"en/istio/disabling-istio/disabling-istio": {
"id": "en/istio/disabling-istio/disabling-istio",
"title": "Disabling Istio",
"description": "This section describes how to uninstall Istio in a cluster or disable a namespace, or workload.",
"sidebar": "tutorialSidebar"
},
"en/istio/istio": {
"id": "en/istio/istio",
"title": "Istio",
"description": "Istio is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices.",
"sidebar": "tutorialSidebar"
},
"en/istio/rbac/rbac": {
"id": "en/istio/rbac/rbac",
"title": "Role-based Access Control",
"description": "This section describes the permissions required to access Istio features.",
"sidebar": "tutorialSidebar"
},
"en/istio/resources/resources": {
"id": "en/istio/resources/resources",
"title": "CPU and Memory Allocations",
"description": "This section describes the minimum recommended computing resources for the Istio components in a cluster.",
"sidebar": "tutorialSidebar"
},
"en/istio/setup/deploy-workloads/deploy-workloads": {
"id": "en/istio/setup/deploy-workloads/deploy-workloads",
"title": "3. Add Deployments and Services with the Istio Sidecar",
"description": "Prerequisite: To enable Istio for a workload, the cluster and namespace must have the Istio app installed.",
"sidebar": "tutorialSidebar"
},
"en/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster": {
"id": "en/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster",
"title": "1. Enable Istio in the Cluster",
"description": "Prerequisites:",
"sidebar": "tutorialSidebar"
},
"en/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace": {
"id": "en/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace",
"title": "2. Enable Istio in a Namespace",
"description": "You will need to manually enable Istio in each namespace that you want to be tracked or controlled by Istio. When Istio is enabled in a namespace, the Envoy sidecar proxy will be automatically injected into all new workloads that are deployed in the namespace.",
"sidebar": "tutorialSidebar"
},
"en/istio/setup/gateway/gateway": {
"id": "en/istio/setup/gateway/gateway",
"title": "4. Set up the Istio Gateway",
"description": "The gateway to each cluster can have its own port or load balancer, which is unrelated to a service mesh. By default, each Rancher-provisioned cluster has one NGINX ingress controller allowing traffic into the cluster.",
"sidebar": "tutorialSidebar"
},
"en/istio/setup/set-up-traffic-management/set-up-traffic-management": {
"id": "en/istio/setup/set-up-traffic-management/set-up-traffic-management",
"title": "5. Set up Istio's Components for Traffic Management",
"description": "A central advantage of traffic management in Istio is that it allows dynamic request routing. Some common applications for dynamic request routing include canary deployments and blue/green deployments. The two key resources in Istio traffic management are virtual services and destination rules.",
"sidebar": "tutorialSidebar"
},
"en/istio/setup/setup": {
"id": "en/istio/setup/setup",
"title": "Setup Guide",
"description": "This section describes how to enable Istio and start using it in your projects.",
"sidebar": "tutorialSidebar"
},
"en/istio/setup/view-traffic/view-traffic": {
"id": "en/istio/setup/view-traffic/view-traffic",
"title": "6. Generate and View Traffic",
"description": "This section describes how to view the traffic that is being managed by Istio.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/certificates/certificates": {
"id": "en/k8s-in-rancher/certificates/certificates",
"title": "Encrypting HTTP Communication",
"description": "Learn how to add an SSL (Secure Sockets Layer) certificate or TLS (Transport Layer Security) certificate",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/configmaps/configmaps": {
"id": "en/k8s-in-rancher/configmaps/configmaps",
"title": "ConfigMaps",
"description": "While most types of Kubernetes secrets store sensitive information, ConfigMaps store general configuration information, such as a group of config files. Because ConfigMaps don't store sensitive information, they can be updated automatically, and therefore don't require their containers to be restarted following update (unlike most secret types, which require manual updates and a container restart to take effect).",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/horizontal-pod-autoscaler/horizontal-pod-autoscaler": {
"id": "en/k8s-in-rancher/horizontal-pod-autoscaler/horizontal-pod-autoscaler",
"title": "The Horizontal Pod Autoscaler",
"description": "Learn about the horizontal pod autoscaler (HPA). How to manage HPAs and how to test them with a service deployment",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/hpa-background": {
"id": "en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/hpa-background",
"title": "Background Information on HPAs",
"description": "The Horizontal Pod Autoscaler (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. This section provides explanation on how HPA works with Kubernetes.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl": {
"id": "en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl",
"title": "Managing HPAs with kubectl",
"description": "This section describes HPA management with kubectl. This document has instructions for how to:",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui": {
"id": "en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui",
"title": "Managing HPAs with the Rancher UI",
"description": "The Rancher UI supports creating, managing, and deleting HPAs. You can configure CPU or memory usage as the metric that the HPA uses to scale.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/testing-hpa": {
"id": "en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/testing-hpa",
"title": "Testing HPAs with kubectl",
"description": "This document describes how to check the status of your HPAs after scaling them up or down with your load testing tool. For information on how to check the status from the Rancher UI (at least version 2.3.x), refer to Managing HPAs with the Rancher UI.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/k8s-in-rancher": {
"id": "en/k8s-in-rancher/k8s-in-rancher",
"title": "Kubernetes Resources",
"description": "You can view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/load-balancers-and-ingress/ingress-config/ingress-config": {
"id": "en/k8s-in-rancher/load-balancers-and-ingress/ingress-config/ingress-config",
"title": "Ingress Configuration",
"description": "Ingress configuration",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress": {
"id": "en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress",
"title": "Adding Ingresses",
"description": "Ingresses can be added for workloads to provide load balancing, SSL termination and host/path-based routing. Learn how to add Rancher ingress",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/load-balancers-and-ingress/load-balancers-and-ingress": {
"id": "en/k8s-in-rancher/load-balancers-and-ingress/load-balancers-and-ingress",
"title": "Set Up Load Balancer and Ingress Controller within Rancher",
"description": "Learn how you can set up load balancers and ingress controllers to redirect service requests within Rancher, and learn about the limitations of load balancers",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/load-balancers": {
"id": "en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/load-balancers",
"title": "Layer 4 and Layer 7 Load Balancing",
"description": "Kubernetes supports load balancing in two ways: Layer-4 Load Balancing and Layer-7 Load Balancing. Learn about the support for each way in different deployments",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/registries/registries": {
"id": "en/k8s-in-rancher/registries/registries",
"title": "Kubernetes Registry and Docker Registry",
"description": "Learn about the Docker registry and Kubernetes registry, their use cases and how to use a private registry with the Rancher UI",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/secrets/secrets": {
"id": "en/k8s-in-rancher/secrets/secrets",
"title": "Secrets",
"description": "Secrets store sensitive data like passwords, tokens, or keys. They may contain one or more key value pairs.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/service-discovery/service-discovery": {
"id": "en/k8s-in-rancher/service-discovery/service-discovery",
"title": "Services",
"description": "Pod configuration is managed by Deployments, StatefulSets and Daemonsets, whereas services direct traffic to pods using selectors.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar": {
"id": "en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar",
"title": "Adding a Sidecar",
"description": "A sidecar is a container that extends or enhances the main container in a pod. The main container and the sidecar share a pod, and therefore share the same network space and storage. You can add sidecars to existing workloads by using the Add a Sidecar option.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads": {
"id": "en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads",
"title": "Deploying Workloads",
"description": "Read this step by step guide for deploying workloads. Deploy a workload to run an application in one or more containers.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/workloads/rollback-workloads/rollback-workloads": {
"id": "en/k8s-in-rancher/workloads/rollback-workloads/rollback-workloads",
"title": "Rolling Back Workloads",
"description": "Sometimes there is a need to rollback to the previous version of the application, either for debugging purposes or because an upgrade did not go as planned.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/workloads/upgrade-workloads/upgrade-workloads": {
"id": "en/k8s-in-rancher/workloads/upgrade-workloads/upgrade-workloads",
"title": "Upgrading Workloads",
"description": "When a new version of an application image is released on Docker Hub, you can upgrade any workloads running a previous version of the application to the new one.",
"sidebar": "tutorialSidebar"
},
"en/k8s-in-rancher/workloads/workloads": {
"id": "en/k8s-in-rancher/workloads/workloads",
"title": "Kubernetes Workloads and Pods",
"description": "Learn about the two constructs with which you can build any complex containerized application in Kubernetes: Kubernetes workloads and pods",
"sidebar": "tutorialSidebar"
},
"en/logging/architecture/architecture": {
"id": "en/logging/architecture/architecture",
"title": "Architecture",
"description": "This section summarizes the architecture of the Rancher logging application.",
"sidebar": "tutorialSidebar"
},
"en/logging/custom-resource-config/custom-resource-config": {
"id": "en/logging/custom-resource-config/custom-resource-config",
"title": "Custom Resource Configuration",
"description": "The following Custom Resource Definitions are used to configure logging:",
"sidebar": "tutorialSidebar"
},
"en/logging/custom-resource-config/flows/flows": {
"id": "en/logging/custom-resource-config/flows/flows",
"title": "Flows and ClusterFlows",
"description": "For the full details on configuring Flows and ClusterFlows, see the Banzai Cloud Logging operator documentation.",
"sidebar": "tutorialSidebar"
},
"en/logging/custom-resource-config/outputs/outputs": {
"id": "en/logging/custom-resource-config/outputs/outputs",
"title": "Outputs and ClusterOutputs",
"description": "For the full details on configuring Outputs and ClusterOutputs, see the Banzai Cloud Logging operator documentation.",
"sidebar": "tutorialSidebar"
},
"en/logging/helm-chart-options/helm-chart-options": {
"id": "en/logging/helm-chart-options/helm-chart-options",
"title": "rancher-logging Helm Chart Options",
"description": "- Enable/Disable Windows Node Logging",
"sidebar": "tutorialSidebar"
},
"en/logging/logging": {
"id": "en/logging/logging",
"title": "Rancher Integration with Logging Services",
"description": "Rancher integrates with popular logging services. Learn the requirements and benefits of integrating with logging services, and enable logging on your cluster.",
"sidebar": "tutorialSidebar"
},
"en/logging/migrating/migrating": {
"id": "en/logging/migrating/migrating",
"title": "Migrating to Rancher v2.5 Logging",
"description": "Starting in v2.5, the logging feature available within Rancher has been completely overhauled. The logging operator from Banzai Cloud has been adopted; Rancher configures this tooling for use when deploying logging.",
"sidebar": "tutorialSidebar"
},
"en/logging/rbac/rbac": {
"id": "en/logging/rbac/rbac",
"title": "Role-based Access Control for Logging",
"description": "Rancher logging has two roles, logging-admin and logging-view.",
"sidebar": "tutorialSidebar"
},
"en/logging/taints-tolerations/taints-tolerations": {
"id": "en/logging/taints-tolerations/taints-tolerations",
"title": "Working with Taints and Tolerations",
"description": "\"Tainting\" a Kubernetes node causes pods to repel running on that node.",
"sidebar": "tutorialSidebar"
},
"en/longhorn/longhorn": {
"id": "en/longhorn/longhorn",
"title": "Longhorn - Cloud native distributed block storage for Kubernetes",
"description": "Longhorn is a lightweight, reliable and easy-to-use distributed block storage system for Kubernetes.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/advanced/advanced": {
"id": "en/monitoring-alerting/configuration/advanced/advanced",
"title": "Advanced Configuration",
"description": "Alertmanager",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/advanced/alertmanager/alertmanager": {
"id": "en/monitoring-alerting/configuration/advanced/alertmanager/alertmanager",
"title": "Alertmanager Configuration",
"description": "It is usually not necessary to directly edit the Alertmanager custom resource. For most use cases, you will only need to edit the Receivers and Routes to configure notifications.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/advanced/prometheus/prometheus": {
"id": "en/monitoring-alerting/configuration/advanced/prometheus/prometheus",
"title": "Prometheus Configuration",
"description": "It is usually not necessary to directly edit the Prometheus custom resource because the monitoring application automatically updates it based on changes to ServiceMonitors and PodMonitors.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/advanced/prometheusrules/prometheusrules": {
"id": "en/monitoring-alerting/configuration/advanced/prometheusrules/prometheusrules",
"title": "Configuring PrometheusRules",
"description": "A PrometheusRule defines a group of Prometheus alerting and/or recording rules.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/configuration": {
"id": "en/monitoring-alerting/configuration/configuration",
"title": "Configuration",
"description": "This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/examples/examples": {
"id": "en/monitoring-alerting/configuration/examples/examples",
"title": "Examples",
"description": "ServiceMonitor",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/helm-chart-options/helm-chart-options": {
"id": "en/monitoring-alerting/configuration/helm-chart-options/helm-chart-options",
"title": "Helm Chart Options",
"description": "- Configuring Resource Limits and Requests",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/receiver/receiver": {
"id": "en/monitoring-alerting/configuration/receiver/receiver",
"title": "Receiver Configuration",
"description": "The Alertmanager Config Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/route/route": {
"id": "en/monitoring-alerting/configuration/route/route",
"title": "Route Configuration",
"description": "The route configuration is the section of the Alertmanager custom resource that controls how the alerts fired by Prometheus are grouped and filtered before they reach the receiver.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/configuration/servicemonitor-podmonitor/servicemonitor-podmonitor": {
"id": "en/monitoring-alerting/configuration/servicemonitor-podmonitor/servicemonitor-podmonitor",
"title": "ServiceMonitor and PodMonitor Configuration",
"description": "ServiceMonitors and PodMonitors are both pseudo-CRDs that map the scrape configuration of the Prometheus custom resource.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/dashboards/dashboards": {
"id": "en/monitoring-alerting/dashboards/dashboards",
"title": "Built-in Dashboards",
"description": "- Grafana UI",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/expression/expression": {
"id": "en/monitoring-alerting/expression/expression",
"title": "PromQL Expression Reference",
"description": "The PromQL expressions in this doc can be used to configure alerts.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/customize-grafana/customize-grafana": {
"id": "en/monitoring-alerting/guides/customize-grafana/customize-grafana",
"title": "Customizing Grafana Dashboards",
"description": "In this section, you'll learn how to customize the Grafana dashboard to show metrics that apply to a certain container.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/enable-monitoring/enable-monitoring": {
"id": "en/monitoring-alerting/guides/enable-monitoring/enable-monitoring",
"title": "Enable Monitoring",
"description": "As an administrator or cluster owner, you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/guides": {
"id": "en/monitoring-alerting/guides/guides",
"title": "Monitoring Guides",
"description": "- Enable monitoring",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/memory-usage/memory-usage": {
"id": "en/monitoring-alerting/guides/memory-usage/memory-usage",
"title": "Debugging High Memory Usage",
"description": "Every time series in Prometheus is uniquely identified by its metric name and optional key-value pairs called labels.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/migrating/migrating": {
"id": "en/monitoring-alerting/guides/migrating/migrating",
"title": "Migrating to Rancher v2.5+ Monitoring",
"description": "If you previously enabled Monitoring, Alerting, or Notifiers in Rancher before v2.5, there is no automatic upgrade path for switching to the new monitoring/alerting solution. Before deploying the new monitoring solution via Cluster Explore, you will need to disable and remove all existing custom alerts, notifiers and monitoring installations for the whole cluster and in all projects.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/monitoring-workloads/monitoring-workloads": {
"id": "en/monitoring-alerting/guides/monitoring-workloads/monitoring-workloads",
"title": "Setting up Monitoring for a Workload",
"description": "- Display CPU and Memory Metrics for a Workload",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/persist-grafana/persist-grafana": {
"id": "en/monitoring-alerting/guides/persist-grafana/persist-grafana",
"title": "Persistent Grafana Dashboards",
"description": "To allow the Grafana dashboard to persist after the Grafana instance restarts, add the dashboard configuration JSON into a ConfigMap. ConfigMaps also allow the dashboards to be deployed with a GitOps or CD based approach. This allows the dashboard to be put under version control.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/guides/uninstall/uninstall": {
"id": "en/monitoring-alerting/guides/uninstall/uninstall",
"title": "Uninstall Monitoring",
"description": "1. Click ☰ > Cluster Management.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/how-monitoring-works/how-monitoring-works": {
"id": "en/monitoring-alerting/how-monitoring-works/how-monitoring-works",
"title": "How Monitoring Works",
"description": "1. Architecture Overview",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/monitoring-alerting": {
"id": "en/monitoring-alerting/monitoring-alerting",
"title": "Monitoring and Alerting",
"description": "Prometheus lets you view metrics from your different Rancher and Kubernetes objects. Learn about the scope of monitoring and how to enable cluster monitoring",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/prometheus-federator/guides/customizing-grafana/customizing-grafana": {
"id": "en/monitoring-alerting/prometheus-federator/guides/customizing-grafana/customizing-grafana",
"title": "Customizing Grafana Dashboards",
"description": "Grafana dashboards are customized the same way whether it's for rancher-monitoring or for Prometheus Federator.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/prometheus-federator/guides/enable-prom-fed/enable-prom-fed": {
"id": "en/monitoring-alerting/prometheus-federator/guides/enable-prom-fed/enable-prom-fed",
"title": "Enable Prometheus Federator",
"description": "- Requirements",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/prometheus-federator/guides/prom-fed-workloads/prom-fed-workloads": {
"id": "en/monitoring-alerting/prometheus-federator/guides/prom-fed-workloads/prom-fed-workloads",
"title": "Setting up Prometheus Federator for a Workload",
"description": "- Display CPU and Memory Metrics for a Workload",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/prometheus-federator/guides/uninstall-prom-fed/uninstall-prom-fed": {
"id": "en/monitoring-alerting/prometheus-federator/guides/uninstall-prom-fed/uninstall-prom-fed",
"title": "Uninstall Prometheus Federator",
"description": "1. Click ☰ > Cluster Management.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/prometheus-federator/prometheus-federator": {
"id": "en/monitoring-alerting/prometheus-federator/prometheus-federator",
"title": "Prometheus Federator",
"description": "Prometheus Federator, also referred to as Project Monitoring v2, deploys a Helm Project Operator (based on the rancher/helm-project-operator), an operator that manages deploying Helm charts each containing a Project Monitoring Stack, where each stack contains:",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/prometheus-federator/rbac/rbac": {
"id": "en/monitoring-alerting/prometheus-federator/rbac/rbac",
"title": "Role-Based Access Control",
"description": "This section describes the expectations for Role-Based Access Control (RBAC) for Prometheus Federator.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/rbac/rbac": {
"id": "en/monitoring-alerting/rbac/rbac",
"title": "Role-based Access Control",
"description": "This section describes the expectations for RBAC for Rancher Monitoring.",
"sidebar": "tutorialSidebar"
},
"en/monitoring-alerting/windows-clusters/windows-clusters": {
"id": "en/monitoring-alerting/windows-clusters/windows-clusters",
"title": "Windows Cluster Support for Monitoring V2",
"description": "Available as of v2.5.8",
"sidebar": "tutorialSidebar"
},
"en/neuvector-integration/neuvector-integration": {
"id": "en/neuvector-integration/neuvector-integration",
"title": "NeuVector Integration",
"description": "NeuVector Integration in Rancher",
"sidebar": "tutorialSidebar"
},
"en/opa-gatekeper/opa-gatekeeper": {
"id": "en/opa-gatekeper/opa-gatekeeper",
"title": "OPA Gatekeeper",
"description": "To ensure consistency and compliance, every organization needs the ability to define and enforce policies in its environment in an automated way. OPA (Open Policy Agent) is a policy engine that facilitates policy-based control for cloud native environments. Rancher provides the ability to enable OPA Gatekeeper in Kubernetes clusters, and also installs a couple of built-in policy definitions, which are also called constraint templates.",
"sidebar": "tutorialSidebar"
},
"en/overview/architecture-recommendations/architecture-recommendations": {
"id": "en/overview/architecture-recommendations/architecture-recommendations",
"title": "Architecture Recommendations",
"description": "If you are installing Rancher on a single node, the main architecture recommendation that applies to your installation is that the node running Rancher should be separate from downstream clusters.",
"sidebar": "tutorialSidebar"
},
"en/overview/architecture/architecture": {
"id": "en/overview/architecture/architecture",
"title": "Architecture",
"description": "This section focuses on the Rancher server, its components, and how Rancher communicates with downstream Kubernetes clusters.",
"sidebar": "tutorialSidebar"
},
"en/overview/concepts/concepts": {
"id": "en/overview/concepts/concepts",
"title": "Kubernetes Concepts",
"description": "This page explains concepts related to Kubernetes that are important for understanding how Rancher works. The descriptions below provide a simplified overview of Kubernetes components. For more details, refer to the official documentation on Kubernetes components.",
"sidebar": "tutorialSidebar"
},
"en/overview/overview": {
"id": "en/overview/overview",
"title": "Overview",
"description": "Rancher is a container management platform built for organizations that deploy containers in production. Rancher makes it easy to run Kubernetes everywhere, meet IT requirements, and empower DevOps teams.",
"sidebar": "tutorialSidebar"
},
"en/pipelines/concepts/concepts": {
"id": "en/pipelines/concepts/concepts",
"title": "Concepts",
"description": "The purpose of this page is to explain common concepts and terminology related to pipelines.",
"sidebar": "tutorialSidebar"
},
"en/pipelines/config/config": {
"id": "en/pipelines/config/config",
"title": "Pipeline Configuration Reference",
"description": "In this section, you'll learn how to configure pipelines.",
"sidebar": "tutorialSidebar"
},
"en/pipelines/example-repos/example-repos": {
"id": "en/pipelines/example-repos/example-repos",
"title": "Example Repositories",
"description": "Rancher ships with several example repositories that you can use to familiarize yourself with pipelines. We recommend configuring and testing the example repository that most resembles your environment before using pipelines with your own repositories in a production environment. Use this example repository as a sandbox for repo configuration, build demonstration, etc. Rancher includes example repositories for:",
"sidebar": "tutorialSidebar"
},
"en/pipelines/example/example": {
"id": "en/pipelines/example/example",
"title": "Example YAML File",
"description": "Pipelines can be configured either through the UI or using a yaml file in the repository, i.e. .rancher-pipeline.yml or .rancher-pipeline.yaml.",
"sidebar": "tutorialSidebar"
},
"en/pipelines/pipelines": {
"id": "en/pipelines/pipelines",
"title": "Pipelines",
"description": "As of Rancher v2.5, Git-based deployment pipelines are now deprecated. We recommend handling pipelines with Rancher Continuous Delivery powered by Fleet. To get to Fleet in Rancher, click ☰ > Continuous Delivery.",
"sidebar": "tutorialSidebar"
},
"en/pipelines/storage/storage": {
"id": "en/pipelines/storage/storage",
"title": "Configuring Persistent Data for Pipeline Components",
"description": "The pipelines' internal Docker registry and the Minio workloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/namespaces/namespaces": {
"id": "en/project-admin/namespaces/namespaces",
"title": "Namespaces",
"description": "Within Rancher, you can further divide projects into different namespaces, which are virtual clusters within a project backed by a physical cluster. Should you require another level of organization beyond projects and the default namespace, you can use multiple namespaces to isolate applications and resources.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/pipelines/pipelines": {
"id": "en/project-admin/pipelines/pipelines",
"title": "Rancher's CI/CD Pipelines",
"description": "Use Rancher’s CI/CD pipeline to automatically checkout code, run builds or scripts, publish Docker images, and deploy software to users",
"sidebar": "tutorialSidebar"
},
"en/project-admin/pod-security-policies/pod-security-policies": {
"id": "en/project-admin/pod-security-policies/pod-security-policies",
"title": "Pod Security Policies",
"description": "These cluster options are only available for clusters in which Rancher has launched Kubernetes.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/project-admin": {
"id": "en/project-admin/project-admin",
"title": "Project Administration",
"description": "Projects are objects introduced in Rancher that help organize namespaces in your Kubernetes cluster. You can use projects to create multi-tenant clusters, which allows a group of users to share the same underlying resources without interacting with each other's applications.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/project-members/project-members": {
"id": "en/project-admin/project-members/project-members",
"title": "Adding Users to Projects",
"description": "If you want to provide a user with access and permissions to specific projects and resources within a cluster, assign the user a project membership.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/resource-quotas/override-container-default/override-container-default": {
"id": "en/project-admin/resource-quotas/override-container-default/override-container-default",
"title": "Setting Container Default Resource Limits",
"description": "When setting resource quotas, if you set anything related to CPU or Memory (i.e. limits or reservations) on a project / namespace, all containers will require a respective CPU or Memory field set during creation. See the Kubernetes documentation for more details on why this is required.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/resource-quotas/override-namespace-default/override-namespace-default": {
"id": "en/project-admin/resource-quotas/override-namespace-default/override-namespace-default",
"title": "Overriding the Default Limit for a Namespace",
"description": "Although the Namespace Default Limit propagates from the project to each namespace when created, in some cases, you may need to increase (or decrease) the quotas for a specific namespace. In this situation, you can override the default limits by editing the namespace.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/resource-quotas/quota-type-reference/quota-type-reference": {
"id": "en/project-admin/resource-quotas/quota-type-reference/quota-type-reference",
"title": "Resource Quota Type Reference",
"description": "When you create a resource quota, you are configuring the pool of resources available to the project. You can set the following resource limits for the following resource types.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects": {
"id": "en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects",
"title": "How Resource Quotas Work in Rancher Projects",
"description": "Resource quotas in Rancher include the same functionality as the native version of Kubernetes. However, in Rancher, resource quotas have been extended so that you can apply them to projects.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/resource-quotas/resource-quotas": {
"id": "en/project-admin/resource-quotas/resource-quotas",
"title": "Project Resource Quotas",
"description": "In situations where several teams share a cluster, one team may overconsume the resources available: CPU, memory, storage, services, Kubernetes objects like pods or secrets, and so on. To prevent this overconsumption, you can apply a resource quota, which is a Rancher feature that limits the resources available to a project or namespace.",
"sidebar": "tutorialSidebar"
},
"en/project-admin/tools/tools": {
"id": "en/project-admin/tools/tools",
"title": "Tools for Logging, Monitoring, and Visibility",
"description": "Rancher contains a variety of tools that aren't included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently. Tools are divided into following categories:",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/amazon-aws-marketplace-qs/amazon-aws-marketplace-qs": {
"id": "en/quick-start-guide/deployment/amazon-aws-marketplace-qs/amazon-aws-marketplace-qs",
"title": "Rancher AWS Marketplace Quick Start",
"description": "Use Amazon EKS to deploy Rancher server.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs": {
"id": "en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs",
"title": "Rancher AWS Quick Start Guide",
"description": "Read this step by step Rancher AWS guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/deployment": {
"id": "en/quick-start-guide/deployment/deployment",
"title": "Deploying Rancher Server",
"description": "Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs": {
"id": "en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs",
"title": "Rancher DigitalOcean Quick Start Guide",
"description": "Read this step by step Rancher DigitalOcean guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs": {
"id": "en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs",
"title": "Rancher Equinix Metal Quick Start",
"description": "This tutorial walks you through the following:",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs": {
"id": "en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs",
"title": "Rancher GCP Quick Start Guide",
"description": "Read this step by step Rancher GCP guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs": {
"id": "en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs",
"title": "Rancher Hetzner Cloud Quick Start Guide",
"description": "Read this step by step Rancher Hetzner Cloud guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs": {
"id": "en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs",
"title": "Rancher Azure Quick Start Guide",
"description": "Read this step by step Rancher Azure guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup": {
"id": "en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup",
"title": "Helm CLI Quick Start",
"description": "These instructions capture a quick way to set up a proof-of-concept Rancher installation.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant": {
"id": "en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant",
"title": "Vagrant Quick Start",
"description": "The following steps quickly deploy a Rancher Server with a single node cluster attached.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/quick-start-guide": {
"id": "en/quick-start-guide/quick-start-guide",
"title": "Rancher Deployment Quick Start Guides",
"description": "Note: The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see Installation.",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress": {
"id": "en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress",
"title": "Workload with Ingress Quick Start",
"description": "Prerequisite",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport": {
"id": "en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport",
"title": "Workload with NodePort Quick Start",
"description": "Prerequisite",
"sidebar": "tutorialSidebar"
},
"en/quick-start-guide/workload/workload": {
"id": "en/quick-start-guide/workload/workload",
"title": "Deploying Workloads",
"description": "These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster.",
"sidebar": "tutorialSidebar"
},
"en/security/best-practices/best-practices": {
"id": "en/security/best-practices/best-practices",
"title": "Kubernetes Security Best Practices",
"description": "Restricting cloud metadata API access",
"sidebar": "tutorialSidebar"
},
"en/security/cve/cve": {
"id": "en/security/cve/cve",
"title": "Security Advisories and CVEs",
"description": "Rancher is committed to informing the community of security issues in our products. Rancher will publish security advisories and CVEs (Common Vulnerabilities and Exposures) for issues we have resolved. New security advisories are also published in Rancher's GitHub security page.",
"sidebar": "tutorialSidebar"
},
"en/security/hardening-guides/hardening-guides": {
"id": "en/security/hardening-guides/hardening-guides",
"title": "Self-Assessment and Hardening Guides for Rancher v2.6",
"description": "Rancher provides specific security hardening guides for each supported Rancher's Kubernetes distributions.",
"sidebar": "tutorialSidebar"
},
"en/security/hardening-guides/rke-1.6-benchmark-2.6/rke-1.6-benchmark-2.6": {
"id": "en/security/hardening-guides/rke-1.6-benchmark-2.6/rke-1.6-benchmark-2.6",
"title": "RKE CIS v1.6 Benchmark - Self-Assessment Guide - Rancher v2.6",
"description": "RKE CIS v1.6 Kubernetes Benchmark - Rancher v2.6 with Kubernetes v1.18 to v1.23",
"sidebar": "tutorialSidebar"
},
"en/security/hardening-guides/rke-1.6-hardening-2.6/rke-1.6-hardening-2.6": {
"id": "en/security/hardening-guides/rke-1.6-hardening-2.6/rke-1.6-hardening-2.6",
"title": "RKE Hardening Guide with CIS v1.6 Benchmark",
"description": "This document provides prescriptive guidance for hardening a production installation of a RKE cluster to be used with Rancher v2.6. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"en/security/hardening-guides/rke2-1.6-benchmark-2.6/rke2-1.6-benchmark-2.6": {
"id": "en/security/hardening-guides/rke2-1.6-benchmark-2.6/rke2-1.6-benchmark-2.6",
"title": "RKE2 CIS v1.6 Benchmark - Self-Assessment Guide - Rancher v2.6",
"description": "CIS v1.6 Kubernetes Benchmark - Rancher v2.6 RKE2 with Kubernetes v1.21 up to v1.23",
"sidebar": "tutorialSidebar"
},
"en/security/hardening-guides/rke2-1.6-hardening-2.6/rke2-1.6-hardening-2.6": {
"id": "en/security/hardening-guides/rke2-1.6-hardening-2.6/rke2-1.6-hardening-2.6",
"title": "RKE2 Hardening Guide with CIS v1.6 Benchmark",
"description": "This document provides prescriptive guidance for hardening a production installation of a RKE2 cluster to be provisioned with Rancher v2.6.5. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"en/security/security": {
"id": "en/security/security",
"title": "Security",
"description": "Security policy",
"sidebar": "tutorialSidebar"
},
"en/security/security-scan/security-scan": {
"id": "en/security/security-scan/security-scan",
"title": "Security Scans",
"description": "The documentation about CIS security scans has moved here.",
"sidebar": "tutorialSidebar"
},
"en/security/selinux/selinux": {
"id": "en/security/selinux/selinux",
"title": "SELinux RPM",
"description": "Security-Enhanced Linux (SELinux) is a security enhancement to Linux.",
"sidebar": "tutorialSidebar"
},
"en/system-tools/system-tools": {
"id": "en/system-tools/system-tools",
"title": "System Tools",
"description": "System Tools is a tool to perform operational tasks on Rancher Launched Kubernetes clusters or installations of Rancher on an RKE cluster. The tasks include:",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/dns/dns": {
"id": "en/troubleshooting/dns/dns",
"title": "DNS",
"description": "The commands/steps listed on this page can be used to check name resolution issues in your cluster.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/expired-webhook-certificates/expired-webhook-certificates": {
"id": "en/troubleshooting/expired-webhook-certificates/expired-webhook-certificates",
"title": "Rotation of Expired Webhook Certificates",
"description": "For Rancher versions that have rancher-webhook installed, these certificates will expire after one year. It will be necessary for you to rotate your webhook certificate when this occurs.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/imported-clusters/imported-clusters": {
"id": "en/troubleshooting/imported-clusters/imported-clusters",
"title": "Registered clusters",
"description": "The commands/steps listed on this page can be used to check clusters that you are registering or that are registered in Rancher.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/kubernetes-components/controlplane/etcd": {
"id": "en/troubleshooting/kubernetes-components/controlplane/etcd",
"title": "Troubleshooting Controlplane Nodes",
"description": "This section applies to nodes with the controlplane role.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/kubernetes-components/etcd/etcd": {
"id": "en/troubleshooting/kubernetes-components/etcd/etcd",
"title": "Troubleshooting etcd Nodes",
"description": "This section contains commands and tips for troubleshooting nodes with the etcd role.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/kubernetes-components/kubernetes-components": {
"id": "en/troubleshooting/kubernetes-components/kubernetes-components",
"title": "Kubernetes Components",
"description": "The commands and steps listed in this section apply to the core Kubernetes components on Rancher Launched Kubernetes clusters.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/kubernetes-components/nginx-proxy/nginx-proxy": {
"id": "en/troubleshooting/kubernetes-components/nginx-proxy/nginx-proxy",
"title": "Troubleshooting nginx-proxy",
"description": "The nginx-proxy container is deployed on every node that does not have the controlplane role. It provides access to all the nodes with the controlplane role by dynamically generating the NGINX configuration based on available nodes with the controlplane role.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/kubernetes-components/worker-and-generic/worker-and-generic": {
"id": "en/troubleshooting/kubernetes-components/worker-and-generic/worker-and-generic",
"title": "Troubleshooting Worker Nodes and Generic Components",
"description": "This section applies to every node as it includes components that run on nodes with any role.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/kubernetes-resources/kubernetes-resources": {
"id": "en/troubleshooting/kubernetes-resources/kubernetes-resources",
"title": "Kubernetes resources",
"description": "The commands/steps listed on this page can be used to check the most important Kubernetes resources and apply to Rancher Launched Kubernetes clusters.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/logging/logging": {
"id": "en/troubleshooting/logging/logging",
"title": "Logging",
"description": "The following log levels are used in Rancher:",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/networking/networking": {
"id": "en/troubleshooting/networking/networking",
"title": "Networking",
"description": "The commands/steps listed on this page can be used to check networking related issues in your cluster.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/rancherha/rancherha": {
"id": "en/troubleshooting/rancherha/rancherha",
"title": "Rancher HA",
"description": "The commands/steps listed on this page can be used to check your Rancher Kubernetes Installation.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/troubleshooting": {
"id": "en/troubleshooting/troubleshooting",
"title": "Troubleshooting",
"description": "This section contains information to help you troubleshoot issues when using Rancher.",
"sidebar": "tutorialSidebar"
},
"en/troubleshooting/userid-tracking-in-audit-logs/userid-tracking-in-audit-logs": {
"id": "en/troubleshooting/userid-tracking-in-audit-logs/userid-tracking-in-audit-logs",
"title": "User ID Tracking in Audit Logs",
"description": "The following audit logs are used in Rancher to track events occuring on the local and downstream clusters:",
"sidebar": "tutorialSidebar"
},
"en/user-settings/api-keys/api-keys": {
"id": "en/user-settings/api-keys/api-keys",
"title": "API Keys",
"description": "API Keys and User Authentication",
"sidebar": "tutorialSidebar"
},
"en/user-settings/cloud-credentials/cloud-credentials": {
"id": "en/user-settings/cloud-credentials/cloud-credentials",
"title": "Managing Cloud Credentials",
"description": "When you create a cluster hosted by an infrastructure provider, node templates are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node.",
"sidebar": "tutorialSidebar"
},
"en/user-settings/node-templates/node-templates": {
"id": "en/user-settings/node-templates/node-templates",
"title": "Managing Node Templates",
"description": "When you provision a cluster hosted by an infrastructure provider, node templates are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts:",
"sidebar": "tutorialSidebar"
},
"en/user-settings/preferences/preferences": {
"id": "en/user-settings/preferences/preferences",
"title": "User Preferences",
"description": "Each user can choose preferences to personalize their Rancher experience. To change preference settings, open the User Settings menu and then select Preferences.",
"sidebar": "tutorialSidebar"
},
"en/user-settings/user-settings": {
"id": "en/user-settings/user-settings",
"title": "User Settings",
"description": "Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the User Settings menu. You can open this menu by clicking your avatar, located within the main menu.",
"sidebar": "tutorialSidebar"
},
"en/virtualization-admin/virtualization-admin": {
"id": "en/virtualization-admin/virtualization-admin",
"title": "Harvester Integration",
"description": "Tech Preview",
"sidebar": "tutorialSidebar"
}
}
}
Reference in New Issue View Git Blame Copy Permalink