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

4980 lines
305 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": "2.0-2.4",
"label": "2.0-2.4",
"banner": "unmaintained",
"badge": true,
"className": "docs-version-2.0-2.4",
"isLast": false,
"docsSidebars": {
"tutorialSidebar": [
{
"type": "category",
"label": "v2.0-v2.4",
"collapsible": true,
"collapsed": true,
"items": [
{
"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": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/ad/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/ad/ad"
},
{
"type": "link",
"label": "Configuring Azure AD",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/azure-ad/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/azure-ad/azure-ad"
},
{
"type": "link",
"label": "Configuring FreeIPA",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/freeipa/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/freeipa/freeipa"
},
{
"type": "link",
"label": "Configuring GitHub",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/github/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/github/github"
},
{
"type": "link",
"label": "Configuring Google OAuth",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/google/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/google/google"
},
{
"type": "link",
"label": "Configuring Keycloak (SAML)",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/keycloak/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/keycloak/keycloak"
},
{
"type": "link",
"label": "Local Authentication",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/local/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup"
},
{
"type": "link",
"label": "2. Configuring Rancher for Microsoft AD FS",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/"
},
{
"type": "link",
"label": "Configuring Okta (SAML)",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/okta/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/okta/okta"
},
{
"type": "category",
"label": "Configuring OpenLDAP",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "OpenLDAP Configuration Reference",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/openldap/openldap-config/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/openldap/openldap-config/openldap-config"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/openldap/"
},
{
"type": "link",
"label": "Configuring PingIdentity (SAML)",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/ping-federate/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/shibboleth/about/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/shibboleth/about/about"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/shibboleth/"
},
{
"type": "link",
"label": "Users and Groups",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/user-groups/",
"docId": "v2.0-v2.4/en/admin-settings/authentication/user-groups/user-groups"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/authentication/"
},
{
"type": "link",
"label": "Configuring a Global Default Private Registry",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/config-private-registry/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/admin-settings/drivers/cluster-drivers/",
"docId": "v2.0-v2.4/en/admin-settings/drivers/cluster-drivers/cluster-drivers"
},
{
"type": "link",
"label": "Node Drivers",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/drivers/node-drivers/",
"docId": "v2.0-v2.4/en/admin-settings/drivers/node-drivers/node-drivers"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/drivers/"
},
{
"type": "link",
"label": "Upgrading Kubernetes without Upgrading Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/k8s-metadata/",
"docId": "v2.0-v2.4/en/admin-settings/k8s-metadata/k8s-metadata"
},
{
"type": "link",
"label": "Pod Security Policies",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/pod-security-policies/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rbac/cluster-project-roles/",
"docId": "v2.0-v2.4/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles"
},
{
"type": "link",
"label": "Custom Roles",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rbac/default-custom-roles/",
"docId": "v2.0-v2.4/en/admin-settings/rbac/default-custom-roles/default-custom-roles"
},
{
"type": "link",
"label": "Global Permissions",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rbac/global-permissions/",
"docId": "v2.0-v2.4/en/admin-settings/rbac/global-permissions/global-permissions"
},
{
"type": "link",
"label": "Locked Roles",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rbac/locked-roles/",
"docId": "v2.0-v2.4/en/admin-settings/rbac/locked-roles/locked-roles"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rbac/"
},
{
"type": "category",
"label": "RKE Templates",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Applying Templates",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/applying-templates/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/applying-templates/applying-templates"
},
{
"type": "link",
"label": "Creating and Revising Templates",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/creating-and-revising/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/creating-and-revising/creating-and-revising"
},
{
"type": "link",
"label": "Template Creator Permissions",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/creator-permissions/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/creator-permissions/creator-permissions"
},
{
"type": "link",
"label": "Template Enforcement",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/enforcement/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/enforcement/enforcement"
},
{
"type": "link",
"label": "Example Scenarios",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/example-scenarios/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/example-scenarios/example-scenarios"
},
{
"type": "link",
"label": "Example YAML",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/example-yaml/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/example-yaml/example-yaml"
},
{
"type": "link",
"label": "Overriding Template Settings",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/overrides/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/overrides/overrides"
},
{
"type": "link",
"label": "RKE Templates and Infrastructure",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/rke-templates-and-hardware/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware"
},
{
"type": "link",
"label": "Access and Sharing",
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/template-access-and-sharing/",
"docId": "v2.0-v2.4/en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/rke-templates/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/admin-settings/"
},
{
"type": "category",
"label": "API",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "API Tokens",
"href": "/2.0-2.4/v2.0-v2.4/en/api/api-tokens/",
"docId": "v2.0-v2.4/en/api/api-tokens/api-tokens"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/api/"
},
{
"type": "category",
"label": "Backups and Disaster Recovery",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Backup",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Backing up Rancher Installed with Docker",
"href": "/2.0-2.4/v2.0-v2.4/en/backups/backup/docker-backups/",
"docId": "v2.0-v2.4/en/backups/backup/docker-backups/docker-backups"
},
{
"type": "link",
"label": "Backing up Rancher Installed on a K3s Kubernetes Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/backups/backup/k3s-backups/",
"docId": "v2.0-v2.4/en/backups/backup/k3s-backups/k3s-backups"
},
{
"type": "link",
"label": "Backing up Rancher Installed on an RKE Kubernetes Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/backups/backup/rke-backups/",
"docId": "v2.0-v2.4/en/backups/backup/rke-backups/rke-backups"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/backups/backup/"
},
{
"type": "category",
"label": "Restore",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Restoring Backups—Docker Installs",
"href": "/2.0-2.4/v2.0-v2.4/en/backups/restore/docker-restores/",
"docId": "v2.0-v2.4/en/backups/restore/docker-restores/docker-restores"
},
{
"type": "link",
"label": "Restoring Rancher Installed on a K3s Kubernetes Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/backups/restore/k3s-restore/",
"docId": "v2.0-v2.4/en/backups/restore/k3s-restore/k3s-restore"
},
{
"type": "category",
"label": "Restoring Backups—Kubernetes installs",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rolling back to v2.0.0-v2.1.5",
"href": "/2.0-2.4/v2.0-v2.4/en/backups/restore/rke-restore/v2.0-v2.1/",
"docId": "v2.0-v2.4/en/backups/restore/rke-restore/v2.0-v2.1/v2.0-v2.1"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/backups/restore/rke-restore/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/backups/restore/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/backups/"
},
{
"type": "category",
"label": "Best Practices Guide",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Tips for Setting Up Containers",
"href": "/2.0-2.4/v2.0-v2.4/en/best-practices/containers/",
"docId": "v2.0-v2.4/en/best-practices/containers/containers"
},
{
"type": "link",
"label": "Rancher Deployment Strategies",
"href": "/2.0-2.4/v2.0-v2.4/en/best-practices/deployment-strategies/",
"docId": "v2.0-v2.4/en/best-practices/deployment-strategies/deployment-strategies"
},
{
"type": "link",
"label": "Tips for Running Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/best-practices/deployment-types/",
"docId": "v2.0-v2.4/en/best-practices/deployment-types/deployment-types"
},
{
"type": "link",
"label": "Tips for Scaling, Security and Reliability",
"href": "/2.0-2.4/v2.0-v2.4/en/best-practices/management/",
"docId": "v2.0-v2.4/en/best-practices/management/management"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/best-practices/"
},
{
"type": "link",
"label": "Using the Rancher Command Line Interface",
"href": "/2.0-2.4/v2.0-v2.4/en/cli/",
"docId": "v2.0-v2.4/en/cli/cli"
},
{
"type": "category",
"label": "Cluster Administration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Backing up a Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/backing-up-etcd/",
"docId": "v2.0-v2.4/en/cluster-admin/backing-up-etcd/backing-up-etcd"
},
{
"type": "link",
"label": "Certificate Rotation",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/certificate-rotation/",
"docId": "v2.0-v2.4/en/cluster-admin/certificate-rotation/certificate-rotation"
},
{
"type": "link",
"label": "Removing Kubernetes Components from Nodes",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/cleaning-cluster-nodes/",
"docId": "v2.0-v2.4/en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes"
},
{
"type": "link",
"label": "Cloning Clusters",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/cloning-clusters/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/cluster-access/ace/",
"docId": "v2.0-v2.4/en/cluster-admin/cluster-access/ace/ace"
},
{
"type": "link",
"label": "Adding Users to Clusters",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/cluster-access/cluster-members/",
"docId": "v2.0-v2.4/en/cluster-admin/cluster-access/cluster-members/cluster-members"
},
{
"type": "link",
"label": "Access a Cluster with Kubectl and kubeconfig",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/cluster-access/kubectl/",
"docId": "v2.0-v2.4/en/cluster-admin/cluster-access/kubectl/kubectl"
}
],
"href": "/2.0-2.4/v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/cluster-autoscaler/amazon/",
"docId": "v2.0-v2.4/en/cluster-admin/cluster-autoscaler/amazon/amazon"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/cluster-autoscaler/"
},
{
"type": "link",
"label": "Cluster Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/editing-clusters/",
"docId": "v2.0-v2.4/en/cluster-admin/editing-clusters/editing-clusters"
},
{
"type": "link",
"label": "Nodes and Node Pools",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/nodes/",
"docId": "v2.0-v2.4/en/cluster-admin/nodes/nodes"
},
{
"type": "link",
"label": "Adding a Pod Security Policy",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/pod-security-policy/",
"docId": "v2.0-v2.4/en/cluster-admin/pod-security-policy/pod-security-policy"
},
{
"type": "link",
"label": "Projects and Kubernetes Namespaces with Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/projects-and-namespaces/",
"docId": "v2.0-v2.4/en/cluster-admin/projects-and-namespaces/projects-and-namespaces"
},
{
"type": "link",
"label": "Restoring a Cluster from Backup",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/restoring-etcd/",
"docId": "v2.0-v2.4/en/cluster-admin/restoring-etcd/restoring-etcd"
},
{
"type": "category",
"label": "Tools for Logging, Monitoring, and More",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "CIS Scans",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Skipped and Not Applicable Tests",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cis-scans/skipped-tests/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cis-scans/skipped-tests/skipped-tests"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cis-scans/"
},
{
"type": "category",
"label": "Cluster Alerts",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Default Alerts for Cluster Monitoring",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-alerts/default-alerts/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-alerts/default-alerts/default-alerts"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-alerts/"
},
{
"type": "category",
"label": "Cluster Logging",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Elasticsearch",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-logging/elasticsearch/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/elasticsearch/elasticsearch"
},
{
"type": "link",
"label": "Fluentd",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-logging/fluentd/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/fluentd/fluentd"
},
{
"type": "link",
"label": "Kafka",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-logging/kafka/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/kafka/kafka"
},
{
"type": "link",
"label": "Splunk",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-logging/splunk/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/splunk/splunk"
},
{
"type": "link",
"label": "Syslog",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-logging/syslog/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/syslog/syslog"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-logging/"
},
{
"type": "category",
"label": "Integrating Rancher and Prometheus for Cluster Monitoring",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Cluster Metrics",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/cluster-metrics/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/cluster-metrics/cluster-metrics"
},
{
"type": "link",
"label": "Prometheus Custom Metrics Adapter",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/custom-metrics/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/custom-metrics/custom-metrics"
},
{
"type": "link",
"label": "Prometheus Expressions",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/expression/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/expression/expression"
},
{
"type": "link",
"label": "Project Monitoring",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/project-monitoring/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/project-monitoring/project-monitoring"
},
{
"type": "link",
"label": "Prometheus Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/prometheus/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/prometheus/prometheus"
},
{
"type": "link",
"label": "Viewing Metrics",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/viewing-metrics/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/viewing-metrics/viewing-metrics"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/"
},
{
"type": "category",
"label": "Istio",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Disabling Istio",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/disabling-istio/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/disabling-istio/disabling-istio"
},
{
"type": "link",
"label": "Role-based Access Control",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/rbac/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/rbac/rbac"
},
{
"type": "link",
"label": "Release Notes",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/release-notes/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/release-notes/release-notes"
},
{
"type": "link",
"label": "CPU and Memory Allocations",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/resources/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/resources/resources"
},
{
"type": "category",
"label": "Setup Guide",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "4. Add Deployments and Services with the Istio Sidecar",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/deploy-workloads/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/deploy-workloads/deploy-workloads"
},
{
"type": "category",
"label": "1. Enable Istio in the Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Enable Istio with Pod Security Policies",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-with-psp/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-with-psp/enable-istio-with-psp"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/"
},
{
"type": "link",
"label": "2. Enable Istio in a Namespace",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-namespace/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace"
},
{
"type": "link",
"label": "5. Set up the Istio Gateway",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/gateway/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/gateway/gateway"
},
{
"type": "link",
"label": "3. Select the Nodes Where Istio Components Will be Deployed",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/node-selectors/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/node-selectors/node-selectors"
},
{
"type": "link",
"label": "6. Set up Istio's Components for Traffic Management",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/set-up-traffic-management/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/set-up-traffic-management/set-up-traffic-management"
},
{
"type": "link",
"label": "7. Generate and View Traffic",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/view-traffic/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/view-traffic/view-traffic"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/setup/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/istio/"
},
{
"type": "link",
"label": "Notifiers",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/notifiers/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/notifiers/notifiers"
},
{
"type": "link",
"label": "OPA Gatekeeper",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/opa-gatekeeper/",
"docId": "v2.0-v2.4/en/cluster-admin/tools/opa-gatekeeper/opa-gatekeeper"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/tools/"
},
{
"type": "link",
"label": "Upgrading and Rolling Back Kubernetes",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/upgrading-kubernetes/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/attaching-existing-storage/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage"
},
{
"type": "category",
"label": "Provisioning Storage Examples",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating Persistent Storage in Amazon's EBS",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/ebs/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/ebs/ebs"
},
{
"type": "link",
"label": "NFS Storage",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/nfs/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/nfs/nfs"
},
{
"type": "link",
"label": "vSphere Storage",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/vsphere/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/"
},
{
"type": "link",
"label": "GlusterFS Volumes",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/glusterfs-volumes/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes"
},
{
"type": "link",
"label": "How Persistent Storage Works",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/how-storage-works/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works"
},
{
"type": "link",
"label": "iSCSI Volumes",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/iscsi-volumes/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes"
},
{
"type": "link",
"label": "Dynamically Provisioning New Storage in Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/provisioning-new-storage/",
"docId": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/volumes-and-storage/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-admin/"
},
{
"type": "category",
"label": "Setting up Kubernetes Clusters in Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "index",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/",
"docId": "v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/index"
},
{
"type": "category",
"label": "Setting up Clusters from Hosted Kubernetes Providers",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating an Aliyun ACK Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/ack/",
"docId": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack"
},
{
"type": "link",
"label": "Creating an AKS Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/aks/",
"docId": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks"
},
{
"type": "link",
"label": "Creating a Huawei CCE Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/cce/",
"docId": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce"
},
{
"type": "link",
"label": "Creating an EKS Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/eks/",
"docId": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/eks/eks"
},
{
"type": "link",
"label": "Creating a GKE Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/gke/",
"docId": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke"
},
{
"type": "link",
"label": "Creating a Tencent TKE Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/tke/",
"docId": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/"
},
{
"type": "link",
"label": "Importing Existing Clusters",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/imported-clusters/",
"docId": "v2.0-v2.4/en/cluster-provisioning/imported-clusters/imported-clusters"
},
{
"type": "link",
"label": "Node Requirements for Rancher Managed Clusters",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/node-requirements/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/production/nodes-and-roles/",
"docId": "v2.0-v2.4/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles"
},
{
"type": "link",
"label": "Recommended Cluster Architecture",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/production/recommended-architecture/",
"docId": "v2.0-v2.4/en/cluster-provisioning/production/recommended-architecture/recommended-architecture"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/production/"
},
{
"type": "category",
"label": "Launching Kubernetes with Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Setting up Cloud Providers",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Setting up the Amazon Cloud Provider",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon"
},
{
"type": "link",
"label": "Setting up the Azure Cloud Provider",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/azure/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/azure/azure"
},
{
"type": "link",
"label": "Setting up the Google Compute Engine Cloud Provider",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/gce/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce"
},
{
"type": "link",
"label": "Setting up the vSphere Cloud Provider",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/vsphere"
}
],
"href": "/2.0-2.4/v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options"
}
],
"href": "/2.0-2.4/v2.0-v2.4/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 Node Template Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/azure-node-template-config"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/azure/"
},
{
"type": "category",
"label": "Creating a DigitalOcean Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "DigitalOcean Node Template Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/do-node-template-config"
}
],
"href": "/2.0-2.4/v2.0-v2.4/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 Node Template Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/ec2/"
},
{
"type": "category",
"label": "Creating a vSphere Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating Credentials in the vSphere Console",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials"
},
{
"type": "link",
"label": "Provisioning Kubernetes Clusters in vSphere",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters"
},
{
"type": "category",
"label": "VSphere Node Template Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "vSphere Node Template Configuration in Rancher before v2.0.4",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/prior-to-2.0.4/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/prior-to-2.0.4/prior-to-2.0.4"
},
{
"type": "link",
"label": "vSphere Node Template Configuration in Rancher v2.0.4",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.0.4/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.0.4/v2.0.4"
},
{
"type": "link",
"label": "vSphere Node Template Configuration in Rancher v2.2.0",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.2.0/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.2.0/v2.2.0"
},
{
"type": "link",
"label": "vSphere Node Template Configuration in Rancher v2.3.0",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.0/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.0/v2.3.0"
},
{
"type": "link",
"label": "vSphere Node Template Configuration in Rancher v2.3.3",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.3/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.3/v2.3.3"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/"
},
{
"type": "category",
"label": "RKE Cluster Configuration Reference",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Assigning Pod Security Policies",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/options/pod-security-policies/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/options/pod-security-policies/pod-security-policies"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/options/"
},
{
"type": "link",
"label": "Rancher Agents",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/rancher-agents/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass"
},
{
"type": "link",
"label": "v2.1.x and v2.2.x Windows Documentation (Experimental)",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/docs-for-2.1-and-2.2/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/docs-for-2.1-and-2.2/docs-for-2.1-and-2.2"
},
{
"type": "link",
"label": "Networking Requirements for Host Gateway (L2bridge)",
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/",
"docId": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/host-gateway-requirements"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/rke-clusters/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/cluster-provisioning/"
},
{
"type": "link",
"label": "Contributing to Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/contributing/",
"docId": "v2.0-v2.4/en/contributing/contributing"
},
{
"type": "link",
"label": "Deploying Applications across Clusters",
"href": "/2.0-2.4/v2.0-v2.4/en/deploy-across-clusters/",
"docId": "v2.0-v2.4/en/deploy-across-clusters/deploy-across-clusters"
},
{
"type": "category",
"label": "FAQ",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Installing and Configuring kubectl",
"href": "/2.0-2.4/v2.0-v2.4/en/faq/kubectl/",
"docId": "v2.0-v2.4/en/faq/kubectl/kubectl"
},
{
"type": "category",
"label": "Networking",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Container Network Interface (CNI) Providers",
"href": "/2.0-2.4/v2.0-v2.4/en/faq/networking/cni-providers/",
"docId": "v2.0-v2.4/en/faq/networking/cni-providers/cni-providers"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/faq/networking/"
},
{
"type": "link",
"label": "Rancher is No Longer Needed",
"href": "/2.0-2.4/v2.0-v2.4/en/faq/removing-rancher/",
"docId": "v2.0-v2.4/en/faq/removing-rancher/removing-rancher"
},
{
"type": "link",
"label": "Security",
"href": "/2.0-2.4/v2.0-v2.4/en/faq/security/",
"docId": "v2.0-v2.4/en/faq/security/security"
},
{
"type": "link",
"label": "Technical",
"href": "/2.0-2.4/v2.0-v2.4/en/faq/technical/",
"docId": "v2.0-v2.4/en/faq/technical/technical"
},
{
"type": "link",
"label": "Telemetry",
"href": "/2.0-2.4/v2.0-v2.4/en/faq/telemetry/",
"docId": "v2.0-v2.4/en/faq/telemetry/telemetry"
},
{
"type": "link",
"label": "Questions about Upgrading to Rancher v2.x",
"href": "/2.0-2.4/v2.0-v2.4/en/faq/upgrades-to-2x/",
"docId": "v2.0-v2.4/en/faq/upgrades-to-2x/upgrades-to-2x"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/faq/"
},
{
"type": "category",
"label": "Helm Charts in Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Creating Custom Catalogs",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/adding-catalogs/",
"docId": "v2.0-v2.4/en/helm-charts/adding-catalogs/adding-catalogs"
},
{
"type": "link",
"label": "Enabling and Disabling Built-in Global Catalogs",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/built-in/",
"docId": "v2.0-v2.4/en/helm-charts/built-in/built-in"
},
{
"type": "link",
"label": "Custom Catalog Configuration Reference",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/catalog-config/",
"docId": "v2.0-v2.4/en/helm-charts/catalog-config/catalog-config"
},
{
"type": "link",
"label": "Creating Catalog Apps",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/creating-apps/",
"docId": "v2.0-v2.4/en/helm-charts/creating-apps/creating-apps"
},
{
"type": "link",
"label": "Global DNS",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/globaldns/",
"docId": "v2.0-v2.4/en/helm-charts/globaldns/globaldns"
},
{
"type": "link",
"label": "Launching Catalog Apps",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/launching-apps/",
"docId": "v2.0-v2.4/en/helm-charts/launching-apps/launching-apps"
},
{
"type": "link",
"label": "Managing Catalog Apps",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/managing-apps/",
"docId": "v2.0-v2.4/en/helm-charts/managing-apps/managing-apps"
},
{
"type": "link",
"label": "Multi-Cluster Apps",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/multi-cluster-apps/",
"docId": "v2.0-v2.4/en/helm-charts/multi-cluster-apps/multi-cluster-apps"
},
{
"type": "link",
"label": "Tutorial: Example Custom Chart Creation",
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/tutorial/",
"docId": "v2.0-v2.4/en/helm-charts/tutorial/tutorial"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/helm-charts/"
},
{
"type": "category",
"label": "Installing/Upgrading Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Install Rancher on a Kubernetes Cluster",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rancher Helm Chart Options",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/install-rancher-on-k8s/chart-options/",
"docId": "v2.0-v2.4/en/installation/install-rancher-on-k8s/chart-options/chart-options"
},
{
"type": "link",
"label": "Rollbacks",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/install-rancher-on-k8s/rollbacks/",
"docId": "v2.0-v2.4/en/installation/install-rancher-on-k8s/rollbacks/rollbacks"
},
{
"type": "category",
"label": "Upgrades",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Upgrading Rancher Installed on Kubernetes with Helm 2",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/helm2/",
"docId": "v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/helm2/helm2"
},
{
"type": "link",
"label": "Migrating from a Kubernetes Install with an RKE Add-on",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/migrating-from-rke-add-on/",
"docId": "v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/migrating-from-rke-add-on/migrating-from-rke-add-on"
},
{
"type": "link",
"label": "Upgrading to v2.0.7+ — Namespace Migration",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/namespace-migration/",
"docId": "v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/namespace-migration/namespace-migration"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/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": "link",
"label": "4. Install Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/air-gap/install-rancher/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/air-gap/install-rancher/install-rancher"
},
{
"type": "link",
"label": "3. Install Kubernetes (Skip for Docker Installs)",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/air-gap/launch-kubernetes/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes"
},
{
"type": "link",
"label": "2. Collect and Publish Images to your Private Registry",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/air-gap/populate-private-registry/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry"
},
{
"type": "link",
"label": "1. Set up Infrastructure and Private Registry",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/air-gap/prepare-nodes/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes"
}
],
"href": "/2.0-2.4/v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/install-rancher/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher"
},
{
"type": "link",
"label": "2. Install Kubernetes",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes"
},
{
"type": "link",
"label": "1. Set up Infrastructure",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/prepare-nodes/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes"
}
],
"href": "/2.0-2.4/v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/advanced/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/advanced/advanced"
},
{
"type": "link",
"label": "HTTP Proxy Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/proxy/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/proxy/proxy"
},
{
"type": "link",
"label": "Rolling Back Rancher Installed with Docker",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks"
},
{
"type": "link",
"label": "Upgrading Rancher Installed with Docker",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades"
},
{
"type": "link",
"label": "Certificate Troubleshooting",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/troubleshooting/",
"docId": "v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/troubleshooting/troubleshooting"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/other-installation-methods/"
},
{
"type": "category",
"label": "Installation Requirements",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Installing Docker",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/requirements/installing-docker/",
"docId": "v2.0-v2.4/en/installation/requirements/installing-docker/installing-docker"
},
{
"type": "category",
"label": "Port Requirements",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "index",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/requirements/ports/common-ports-table/",
"docId": "v2.0-v2.4/en/installation/requirements/ports/common-ports-table/index"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/requirements/ports/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/requirements/"
},
{
"type": "category",
"label": "Resources",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Advanced",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Installing Rancher in an Air Gapped Environment with Helm 2",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "4. Install Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/install-rancher"
},
{
"type": "link",
"label": "3. Install Kubernetes with RKE (Kubernetes Installs Only)",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/launch-kubernetes/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/launch-kubernetes/launch-kubernetes"
},
{
"type": "link",
"label": "2. Collect and Publish Images to your Private Registry",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/populate-private-registry/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/populate-private-registry/populate-private-registry"
},
{
"type": "link",
"label": "1. Prepare your Node(s)",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/prepare-nodes/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/prepare-nodes/prepare-nodes"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/"
},
{
"type": "link",
"label": "Enabling the API Audit Log to Record System Events",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/api-audit-log/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/api-audit-log/api-audit-log"
},
{
"type": "link",
"label": "Running on ARM64 (Experimental)",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/arm64-platform/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/arm64-platform/arm64-platform"
},
{
"type": "category",
"label": "cluster.yml Templates for RKE add-on installs",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Template for an RKE Cluster with a Self-signed Certificate and Layer 4 Load Balancer",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate/node-certificate"
},
{
"type": "link",
"label": "Template for an RKE Cluster with a Certificate Signed by Recognized CA and a Layer 4 Load Balancer",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate-recognizedca/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate-recognizedca/node-certificate-recognizedca"
},
{
"type": "link",
"label": "Template for an RKE Cluster with a Self-signed Certificate and SSL Termination on Layer 7 Load Balancer",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-certificate/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-certificate/node-externalssl-certificate"
},
{
"type": "link",
"label": "Template for an RKE Cluster with a Recognized CA Certificate and SSL Termination on Layer 7 Load Balancer",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-recognizedca/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-recognizedca/node-externalssl-recognizedca"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/"
},
{
"type": "link",
"label": "Tuning etcd for Large Installations",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/etcd/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/etcd/etcd"
},
{
"type": "link",
"label": "Opening Ports with firewalld",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/firewall/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/firewall/firewall"
},
{
"type": "category",
"label": "Kubernetes Installation Using Helm 2",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "1. Create Nodes and Load Balancer",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "NGINX",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nginx/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nginx/nginx"
},
{
"type": "link",
"label": "Amazon NLB",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nlb/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nlb/nlb"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/"
},
{
"type": "category",
"label": "Initialize Helm: Install the Tiller Service",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Troubleshooting",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/helm-init/troubleshooting/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-init/troubleshooting/troubleshooting"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/helm-init/"
},
{
"type": "category",
"label": "4. Install Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Chart Options",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/chart-options/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/chart-options/chart-options"
},
{
"type": "link",
"label": "Adding Kubernetes TLS Secrets",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/tls-secrets/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/tls-secrets/tls-secrets"
},
{
"type": "link",
"label": "Troubleshooting",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/troubleshooting/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/troubleshooting/troubleshooting"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/"
},
{
"type": "category",
"label": "2. Install Kubernetes with RKE",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Troubleshooting",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/kubernetes-rke/troubleshooting/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/kubernetes-rke/troubleshooting/troubleshooting"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/kubernetes-rke/"
},
{
"type": "category",
"label": "RKE Add-On Install",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Enable API Auditing",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/api-auditing/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/api-auditing/api-auditing"
},
{
"type": "category",
"label": "Kubernetes Install with External Load Balancer (TCP/Layer 4)",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Amazon NLB Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/nlb/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/nlb/nlb"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/"
},
{
"type": "category",
"label": "Kubernetes Install with External Load Balancer (HTTPS/Layer 7)",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Amazon ALB Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/alb/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/alb/alb"
},
{
"type": "link",
"label": "NGINX Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/nginx/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/nginx/nginx"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/"
},
{
"type": "link",
"label": "HTTP Proxy Configuration",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/proxy/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/proxy/proxy"
},
{
"type": "category",
"label": "Troubleshooting HA RKE Add-On Install",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "404 - default backend",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/default-backend/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/default-backend/default-backend"
},
{
"type": "link",
"label": "Generic troubleshooting",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/generic-troubleshooting/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/generic-troubleshooting/generic-troubleshooting"
},
{
"type": "link",
"label": "Failed to get job complete status",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/job-complete-status/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/job-complete-status/job-complete-status"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/helm2/"
},
{
"type": "category",
"label": "rke-add-on",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Kubernetes Install with External Load Balancer (TCP/Layer 4)",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-4-lb/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-4-lb/layer-4-lb"
},
{
"type": "link",
"label": "Kubernetes Install with External Load Balancer (HTTPS/Layer 7)",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-7-lb/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-7-lb/layer-7-lb"
}
]
},
{
"type": "link",
"label": "Docker Install with TLS Termination at Layer-7 NGINX Load Balancer",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/single-node-install-external-lb/",
"docId": "v2.0-v2.4/en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/advanced/"
},
{
"type": "link",
"label": "Rancher Helm Chart Options",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/chart-options/",
"docId": "v2.0-v2.4/en/installation/resources/chart-options/chart-options"
},
{
"type": "link",
"label": "Choosing a Rancher Version",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/choosing-version/",
"docId": "v2.0-v2.4/en/installation/resources/choosing-version/choosing-version"
},
{
"type": "link",
"label": "About Custom CA Root Certificates",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/custom-ca-root-certificate/",
"docId": "v2.0-v2.4/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": "Allow Unsupported Storage Drivers",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/feature-flags/enable-not-default-storage-drivers/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/installation/resources/feature-flags/istio-virtual-service-ui/",
"docId": "v2.0-v2.4/en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/feature-flags/"
},
{
"type": "link",
"label": "Helm Version Requirements",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/helm-version/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/ha-RKE/",
"docId": "v2.0-v2.4/en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE"
},
{
"type": "link",
"label": "Setting up a High-availability K3s Kubernetes Cluster for Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/ha-with-external-db/",
"docId": "v2.0-v2.4/en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db"
},
{
"type": "link",
"label": "About High-availability Installations",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/how-ha-works/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/",
"docId": "v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db"
},
{
"type": "link",
"label": "Setting up an NGINX Load Balancer",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/",
"docId": "v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/nginx"
},
{
"type": "link",
"label": "Setting up Amazon ELB Network Load Balancer",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/",
"docId": "v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb"
},
{
"type": "link",
"label": "Setting up a MySQL Database in Amazon RDS",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/",
"docId": "v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/k8s-tutorials/"
},
{
"type": "link",
"label": "Setting up Local System Charts for Air Gapped Installations",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/local-system-charts/",
"docId": "v2.0-v2.4/en/installation/resources/local-system-charts/local-system-charts"
},
{
"type": "link",
"label": "Adding TLS Secrets",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/tls-secrets/",
"docId": "v2.0-v2.4/en/installation/resources/tls-secrets/tls-secrets"
},
{
"type": "link",
"label": "TLS Settings",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/tls-settings/",
"docId": "v2.0-v2.4/en/installation/resources/tls-settings/tls-settings"
},
{
"type": "link",
"label": "Troubleshooting the Rancher Server Kubernetes Cluster",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/troubleshooting/",
"docId": "v2.0-v2.4/en/installation/resources/troubleshooting/troubleshooting"
},
{
"type": "link",
"label": "Updating the Rancher Certificate",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/update-rancher-cert/",
"docId": "v2.0-v2.4/en/installation/resources/update-rancher-cert/update-rancher-cert"
},
{
"type": "category",
"label": "Upgrading Cert-Manager",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Upgrading Cert-Manager with Helm 2",
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/upgrading-cert-manager/helm-2-instructions/",
"docId": "v2.0-v2.4/en/installation/resources/upgrading-cert-manager/helm-2-instructions/helm-2-instructions"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/upgrading-cert-manager/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/resources/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/installation/"
},
{
"type": "link",
"label": "Rancher 2.0-2.4",
"href": "/2.0-2.4/v2.0-v2.4/en/introduction",
"docId": "v2.0-v2.4/en/introduction"
},
{
"type": "category",
"label": "Kubernetes Resources",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Encrypting HTTP Communication",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/certificates/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/certificates/certificates"
},
{
"type": "link",
"label": "ConfigMaps",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/configmaps/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-background/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-background/hpa-background"
},
{
"type": "link",
"label": "Manual HPA Installation for Clusters Created Before Rancher v2.0.7",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-for-rancher-before-2_0_7/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-for-rancher-before-2_0_7/hpa-for-rancher-before-2_0_7"
},
{
"type": "link",
"label": "Managing HPAs with kubectl",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl"
},
{
"type": "link",
"label": "Managing HPAs with the Rancher UI",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui"
},
{
"type": "link",
"label": "Testing HPAs with kubectl",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/testing-hpa"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/"
},
{
"type": "category",
"label": "Set Up Load Balancer and Ingress Controller within Rancher",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Adding Ingresses to Your Project",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress"
},
{
"type": "link",
"label": "Layer 4 and Layer 7 Load Balancing",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/load-balancers"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/"
},
{
"type": "link",
"label": "Kubernetes Registry and Docker Registry",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/registries/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/registries/registries"
},
{
"type": "link",
"label": "Secrets",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/secrets/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/secrets/secrets"
},
{
"type": "link",
"label": "Service Discovery",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/service-discovery/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/workloads/add-a-sidecar/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar"
},
{
"type": "link",
"label": "Deploying Workloads",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/workloads/deploy-workloads/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads"
},
{
"type": "link",
"label": "Rolling Back Workloads",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/workloads/rollback-workloads/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/workloads/rollback-workloads/rollback-workloads"
},
{
"type": "link",
"label": "Upgrading Workloads",
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/workloads/upgrade-workloads/",
"docId": "v2.0-v2.4/en/k8s-in-rancher/workloads/upgrade-workloads/upgrade-workloads"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/workloads/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/k8s-in-rancher/"
},
{
"type": "category",
"label": "Overview",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Architecture",
"href": "/2.0-2.4/v2.0-v2.4/en/overview/architecture/",
"docId": "v2.0-v2.4/en/overview/architecture/architecture"
},
{
"type": "link",
"label": "Architecture Recommendations",
"href": "/2.0-2.4/v2.0-v2.4/en/overview/architecture-recommendations/",
"docId": "v2.0-v2.4/en/overview/architecture-recommendations/architecture-recommendations"
},
{
"type": "link",
"label": "Kubernetes Concepts",
"href": "/2.0-2.4/v2.0-v2.4/en/overview/concepts/",
"docId": "v2.0-v2.4/en/overview/concepts/concepts"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/overview/"
},
{
"type": "category",
"label": "Pipelines",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Concepts",
"href": "/2.0-2.4/v2.0-v2.4/en/pipelines/concepts/",
"docId": "v2.0-v2.4/en/pipelines/concepts/concepts"
},
{
"type": "link",
"label": "Pipeline Configuration Reference",
"href": "/2.0-2.4/v2.0-v2.4/en/pipelines/config/",
"docId": "v2.0-v2.4/en/pipelines/config/config"
},
{
"type": "link",
"label": "v2.0.x Pipeline Documentation",
"href": "/2.0-2.4/v2.0-v2.4/en/pipelines/docs-for-v2.0.x/",
"docId": "v2.0-v2.4/en/pipelines/docs-for-v2.0.x/docs-for-v2.0.x"
},
{
"type": "link",
"label": "Example YAML File",
"href": "/2.0-2.4/v2.0-v2.4/en/pipelines/example/",
"docId": "v2.0-v2.4/en/pipelines/example/example"
},
{
"type": "link",
"label": "Example Repositories",
"href": "/2.0-2.4/v2.0-v2.4/en/pipelines/example-repos/",
"docId": "v2.0-v2.4/en/pipelines/example-repos/example-repos"
},
{
"type": "link",
"label": "Configuring Persistent Data for Pipeline Components",
"href": "/2.0-2.4/v2.0-v2.4/en/pipelines/storage/",
"docId": "v2.0-v2.4/en/pipelines/storage/storage"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/pipelines/"
},
{
"type": "category",
"label": "Project Administration",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Namespaces",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/namespaces/",
"docId": "v2.0-v2.4/en/project-admin/namespaces/namespaces"
},
{
"type": "link",
"label": "Rancher's CI/CD Pipelines",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/pipelines/",
"docId": "v2.0-v2.4/en/project-admin/pipelines/pipelines"
},
{
"type": "link",
"label": "Pod Security Policies",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/pod-security-policies/",
"docId": "v2.0-v2.4/en/project-admin/pod-security-policies/pod-security-policies"
},
{
"type": "link",
"label": "Adding Users to Projects",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/project-members/",
"docId": "v2.0-v2.4/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": "/2.0-2.4/v2.0-v2.4/en/project-admin/resource-quotas/override-container-default/",
"docId": "v2.0-v2.4/en/project-admin/resource-quotas/override-container-default/override-container-default"
},
{
"type": "link",
"label": "Overriding the Default Limit for a Namespace",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/resource-quotas/override-namespace-default/",
"docId": "v2.0-v2.4/en/project-admin/resource-quotas/override-namespace-default/override-namespace-default"
},
{
"type": "link",
"label": "Resource Quota Type Reference",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/resource-quotas/quota-type-reference/",
"docId": "v2.0-v2.4/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference"
},
{
"type": "link",
"label": "How Resource Quotas Work in Rancher Projects",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/resource-quotas/quotas-for-projects/",
"docId": "v2.0-v2.4/en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/resource-quotas/"
},
{
"type": "category",
"label": "Tools for Logging, Monitoring, and More",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Project Alerts",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/tools/project-alerts/",
"docId": "v2.0-v2.4/en/project-admin/tools/project-alerts/project-alerts"
},
{
"type": "link",
"label": "Project Logging",
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/tools/project-logging/",
"docId": "v2.0-v2.4/en/project-admin/tools/project-logging/project-logging"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/tools/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/project-admin/"
},
{
"type": "category",
"label": "Rancher Deployment Quick Start Guides",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "CLI with Rancher",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/cli/",
"docId": "v2.0-v2.4/en/quick-start-guide/cli/cli"
},
{
"type": "category",
"label": "Deploying Rancher Server",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rancher AWS Quick Start Guide",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/deployment/amazon-aws-qs/",
"docId": "v2.0-v2.4/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs"
},
{
"type": "link",
"label": "Rancher DigitalOcean Quick Start Guide",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/deployment/digital-ocean-qs/",
"docId": "v2.0-v2.4/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs"
},
{
"type": "link",
"label": "Rancher GCP Quick Start Guide",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/deployment/google-gcp-qs/",
"docId": "v2.0-v2.4/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs"
},
{
"type": "link",
"label": "Rancher Azure Quick Start Guide",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/deployment/microsoft-azure-qs/",
"docId": "v2.0-v2.4/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs"
},
{
"type": "link",
"label": "Manual Quick Start",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/deployment/quickstart-manual-setup/",
"docId": "v2.0-v2.4/en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup"
},
{
"type": "link",
"label": "Vagrant Quick Start",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/deployment/quickstart-vagrant/",
"docId": "v2.0-v2.4/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/deployment/"
},
{
"type": "category",
"label": "Deploying Workloads",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Workload with Ingress Quick Start",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/",
"docId": "v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress"
},
{
"type": "link",
"label": "Workload with NodePort Quick Start",
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/",
"docId": "v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/workload/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/quick-start-guide/"
},
{
"type": "category",
"label": "Security",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Rancher CVEs and Resolutions",
"href": "/2.0-2.4/v2.0-v2.4/en/security/cve/",
"docId": "v2.0-v2.4/en/security/cve/cve"
},
{
"type": "category",
"label": "Rancher v2.1",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "CIS Benchmark Rancher Self-Assessment Guide v2.1",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.1/benchmark-2.1/",
"docId": "v2.0-v2.4/en/security/rancher-2.1/benchmark-2.1/benchmark-2.1"
},
{
"type": "link",
"label": "Hardening Guide v2.1",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.1/hardening-2.1/",
"docId": "v2.0-v2.4/en/security/rancher-2.1/hardening-2.1/hardening-2.1"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.1/"
},
{
"type": "category",
"label": "Rancher v2.2",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "CIS Benchmark Rancher Self-Assessment Guide v2.2",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.2/benchmark-2.2/",
"docId": "v2.0-v2.4/en/security/rancher-2.2/benchmark-2.2/benchmark-2.2"
},
{
"type": "link",
"label": "Hardening Guide v2.2",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.2/hardening-2.2/",
"docId": "v2.0-v2.4/en/security/rancher-2.2/hardening-2.2/hardening-2.2"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.2/"
},
{
"type": "category",
"label": "Rancher v2.3.x",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "category",
"label": "Rancher v2.3.0",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "CIS Benchmark Rancher Self-Assessment Guide v2.3",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/benchmark-2.3/",
"docId": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/benchmark-2.3/benchmark-2.3"
},
{
"type": "link",
"label": "Hardening Guide v2.3",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/hardening-2.3/",
"docId": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/hardening-2.3/hardening-2.3"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/"
},
{
"type": "category",
"label": "Rancher v2.3.3",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.3",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/benchmark-2.3.3/",
"docId": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/benchmark-2.3.3/benchmark-2.3.3"
},
{
"type": "link",
"label": "Hardening Guide v2.3.3",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/hardening-2.3.3/",
"docId": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/hardening-2.3.3/hardening-2.3.3"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/"
},
{
"type": "category",
"label": "Rancher v2.3.5",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "CIS Benchmark Rancher Self-Assessment Guide - v2.3.5",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/benchmark-2.3.5/",
"docId": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/benchmark-2.3.5/benchmark-2.3.5"
},
{
"type": "link",
"label": "Hardening Guide v2.3.5",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/hardening-2.3.5/",
"docId": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/hardening-2.3.5/hardening-2.3.5"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.3.x/"
},
{
"type": "category",
"label": "Rancher v2.4",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "CIS Benchmark Rancher Self-Assessment Guide - v2.4",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.4/benchmark-2.4/",
"docId": "v2.0-v2.4/en/security/rancher-2.4/benchmark-2.4/benchmark-2.4"
},
{
"type": "link",
"label": "Hardening Guide v2.4",
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.4/hardening-2.4/",
"docId": "v2.0-v2.4/en/security/rancher-2.4/hardening-2.4/hardening-2.4"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/rancher-2.4/"
},
{
"type": "link",
"label": "Security Scans",
"href": "/2.0-2.4/v2.0-v2.4/en/security/security-scan/",
"docId": "v2.0-v2.4/en/security/security-scan/security-scan"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/security/"
},
{
"type": "link",
"label": "System Tools",
"href": "/2.0-2.4/v2.0-v2.4/en/system-tools/",
"docId": "v2.0-v2.4/en/system-tools/system-tools"
},
{
"type": "category",
"label": "Troubleshooting",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "DNS",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/dns/",
"docId": "v2.0-v2.4/en/troubleshooting/dns/dns"
},
{
"type": "link",
"label": "Imported clusters",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/imported-clusters/",
"docId": "v2.0-v2.4/en/troubleshooting/imported-clusters/imported-clusters"
},
{
"type": "category",
"label": "Kubernetes Components",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Troubleshooting Controlplane Nodes",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/kubernetes-components/controlplane/",
"docId": "v2.0-v2.4/en/troubleshooting/kubernetes-components/controlplane/controlplane"
},
{
"type": "link",
"label": "Troubleshooting etcd Nodes",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/kubernetes-components/etcd/",
"docId": "v2.0-v2.4/en/troubleshooting/kubernetes-components/etcd/etcd"
},
{
"type": "link",
"label": "Troubleshooting nginx-proxy",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/kubernetes-components/nginx-proxy/",
"docId": "v2.0-v2.4/en/troubleshooting/kubernetes-components/nginx-proxy/nginx-proxy"
},
{
"type": "link",
"label": "Troubleshooting Worker Nodes and Generic Components",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/kubernetes-components/worker-and-generic/",
"docId": "v2.0-v2.4/en/troubleshooting/kubernetes-components/worker-and-generic/worker-and-generic"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/kubernetes-components/"
},
{
"type": "link",
"label": "Kubernetes resources",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/kubernetes-resources/",
"docId": "v2.0-v2.4/en/troubleshooting/kubernetes-resources/kubernetes-resources"
},
{
"type": "link",
"label": "Logging",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/logging/",
"docId": "v2.0-v2.4/en/troubleshooting/logging/logging"
},
{
"type": "link",
"label": "Networking",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/networking/",
"docId": "v2.0-v2.4/en/troubleshooting/networking/networking"
},
{
"type": "link",
"label": "Rancher HA",
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/rancherha/",
"docId": "v2.0-v2.4/en/troubleshooting/rancherha/rancherha"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/troubleshooting/"
},
{
"type": "category",
"label": "User Settings",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "API Keys",
"href": "/2.0-2.4/v2.0-v2.4/en/user-settings/api-keys/",
"docId": "v2.0-v2.4/en/user-settings/api-keys/api-keys"
},
{
"type": "link",
"label": "Managing Cloud Credentials",
"href": "/2.0-2.4/v2.0-v2.4/en/user-settings/cloud-credentials/",
"docId": "v2.0-v2.4/en/user-settings/cloud-credentials/cloud-credentials"
},
{
"type": "link",
"label": "Managing Node Templates",
"href": "/2.0-2.4/v2.0-v2.4/en/user-settings/node-templates/",
"docId": "v2.0-v2.4/en/user-settings/node-templates/node-templates"
},
{
"type": "link",
"label": "User Preferences",
"href": "/2.0-2.4/v2.0-v2.4/en/user-settings/preferences/",
"docId": "v2.0-v2.4/en/user-settings/preferences/preferences"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/user-settings/"
},
{
"type": "category",
"label": "Migrating from v1.6 to v2.x",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "6. Service Discovery",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/discover-services/",
"docId": "v2.0-v2.4/en/v1.6-migration/discover-services/discover-services"
},
{
"type": "link",
"label": "3. Expose Your Services",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/expose-services/",
"docId": "v2.0-v2.4/en/v1.6-migration/expose-services/expose-services"
},
{
"type": "link",
"label": "1. Get Started",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/get-started/",
"docId": "v2.0-v2.4/en/v1.6-migration/get-started/get-started"
},
{
"type": "link",
"label": "Kubernetes Introduction",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/kub-intro/",
"docId": "v2.0-v2.4/en/v1.6-migration/kub-intro/kub-intro"
},
{
"type": "link",
"label": "7. Load Balancing",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/load-balancing/",
"docId": "v2.0-v2.4/en/v1.6-migration/load-balancing/load-balancing"
},
{
"type": "link",
"label": "4. Configure Health Checks",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/monitor-apps/",
"docId": "v2.0-v2.4/en/v1.6-migration/monitor-apps/monitor-apps"
},
{
"type": "category",
"label": "2. Migrate Your Services",
"collapsible": true,
"collapsed": true,
"items": [
{
"type": "link",
"label": "Migration Tools CLI Reference",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/run-migration-tool/migration-tools-ref/",
"docId": "v2.0-v2.4/en/v1.6-migration/run-migration-tool/migration-tools-ref/migration-tools-ref"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/run-migration-tool/"
},
{
"type": "link",
"label": "5. Schedule Your Services",
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/schedule-workloads/",
"docId": "v2.0-v2.4/en/v1.6-migration/schedule-workloads/schedule-workloads"
}
],
"href": "/2.0-2.4/v2.0-v2.4/en/v1.6-migration/"
}
]
}
]
}
]
},
"docs": {
"v2.0-v2.4/en/admin-settings/admin-settings": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/authentication/ad/ad": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/authentication/authentication": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/authentication/azure-ad/azure-ad": {
"id": "v2.0-v2.4/en/admin-settings/authentication/azure-ad/azure-ad",
"title": "Configuring Azure AD",
"description": "Available as of v2.0.3",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/freeipa/freeipa": {
"id": "v2.0-v2.4/en/admin-settings/authentication/freeipa/freeipa",
"title": "Configuring FreeIPA",
"description": "Available as of v2.0.5",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/github/github": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/authentication/google/google": {
"id": "v2.0-v2.4/en/admin-settings/authentication/google/google",
"title": "Configuring Google OAuth",
"description": "Available as of v2.3.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/keycloak/keycloak": {
"id": "v2.0-v2.4/en/admin-settings/authentication/keycloak/keycloak",
"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"
},
"v2.0-v2.4/en/admin-settings/authentication/local/local": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs": {
"id": "v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs",
"title": "Configuring Microsoft Active Directory Federation Service (SAML)",
"description": "Available as of v2.0.7",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup": {
"id": "v2.0-v2.4/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup",
"title": "2. Configuring Rancher for Microsoft AD FS",
"description": "Available as of v2.0.7",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/okta/okta": {
"id": "v2.0-v2.4/en/admin-settings/authentication/okta/okta",
"title": "Configuring Okta (SAML)",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/openldap/openldap": {
"id": "v2.0-v2.4/en/admin-settings/authentication/openldap/openldap",
"title": "Configuring OpenLDAP",
"description": "Available as of v2.0.5",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/openldap/openldap-config/openldap-config": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/authentication/ping-federate/ping-federate": {
"id": "v2.0-v2.4/en/admin-settings/authentication/ping-federate/ping-federate",
"title": "Configuring PingIdentity (SAML)",
"description": "Available as of v2.0.7",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/shibboleth/about/about": {
"id": "v2.0-v2.4/en/admin-settings/authentication/shibboleth/about/about",
"title": "Group Permissions with Shibboleth and OpenLDAP",
"description": "Available as of Rancher v2.4",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/shibboleth/shibboleth": {
"id": "v2.0-v2.4/en/admin-settings/authentication/shibboleth/shibboleth",
"title": "Configuring Shibboleth (SAML)",
"description": "Available as of v2.4.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/authentication/user-groups/user-groups": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/config-private-registry/config-private-registry": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/drivers/cluster-drivers/cluster-drivers": {
"id": "v2.0-v2.4/en/admin-settings/drivers/cluster-drivers/cluster-drivers",
"title": "Cluster Drivers",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/drivers/drivers": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/drivers/node-drivers/node-drivers": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/k8s-metadata/k8s-metadata": {
"id": "v2.0-v2.4/en/admin-settings/k8s-metadata/k8s-metadata",
"title": "Upgrading Kubernetes without Upgrading Rancher",
"description": "Available as of v2.3.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/pod-security-policies/pod-security-policies": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles": {
"id": "v2.0-v2.4/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. You can manage these roles from the Global > Security > Roles page.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/rbac/default-custom-roles/default-custom-roles": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rbac/global-permissions/global-permissions": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rbac/locked-roles/locked-roles": {
"id": "v2.0-v2.4/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 users in the future.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/rbac/rbac": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/applying-templates/applying-templates": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/creating-and-revising/creating-and-revising": {
"id": "v2.0-v2.4/en/admin-settings/rke-templates/creating-and-revising/creating-and-revising",
"title": "Creating and Revising Templates",
"description": "This section describes how to manage RKE templates and revisions. You an create, share, update, and delete templates from the Global view under Tools > RKE Templates.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/rke-templates/creator-permissions/creator-permissions": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/enforcement/enforcement": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/example-scenarios/example-scenarios": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/example-yaml/example-yaml": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/overrides/overrides": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/rke-templates": {
"id": "v2.0-v2.4/en/admin-settings/rke-templates/rke-templates",
"title": "RKE Templates",
"description": "Available as of Rancher v2.3.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/api/api": {
"id": "v2.0-v2.4/en/api/api",
"title": "API",
"description": "How to use the API",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/api/api-tokens/api-tokens": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/backups/backup/backup": {
"id": "v2.0-v2.4/en/backups/backup/backup",
"title": "Backup",
"description": "This section contains information about how to create backups of your Rancher data and how to restore them in a disaster scenario.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/backups/backup/docker-backups/docker-backups": {
"id": "v2.0-v2.4/en/backups/backup/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"
},
"v2.0-v2.4/en/backups/backup/k3s-backups/k3s-backups": {
"id": "v2.0-v2.4/en/backups/backup/k3s-backups/k3s-backups",
"title": "Backing up Rancher Installed on a K3s Kubernetes Cluster",
"description": "When Rancher is installed on a high-availability Kubernetes cluster, we recommend using an external database to store the cluster data.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/backups/backup/rke-backups/rke-backups": {
"id": "v2.0-v2.4/en/backups/backup/rke-backups/rke-backups",
"title": "Backing up Rancher Installed on an RKE Kubernetes Cluster",
"description": "This section describes how to create backups of your high-availability Rancher install.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/backups/backups": {
"id": "v2.0-v2.4/en/backups/backups",
"title": "Backups and Disaster Recovery",
"description": "This section is devoted to protecting your data in a disaster scenario.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/backups/restore/docker-restores/docker-restores": {
"id": "v2.0-v2.4/en/backups/restore/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"
},
"v2.0-v2.4/en/backups/restore/k3s-restore/k3s-restore": {
"id": "v2.0-v2.4/en/backups/restore/k3s-restore/k3s-restore",
"title": "Restoring Rancher Installed on a K3s Kubernetes Cluster",
"description": "When Rancher is installed on a high-availability Kubernetes cluster, we recommend using an external database to store the cluster data.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/backups/restore/restore": {
"id": "v2.0-v2.4/en/backups/restore/restore",
"title": "Restore",
"description": "If you lose the data on your Rancher Server, you can restore it if you have backups stored in a safe location.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/backups/restore/rke-restore/rke-restore": {
"id": "v2.0-v2.4/en/backups/restore/rke-restore/rke-restore",
"title": "Restoring Backups—Kubernetes installs",
"description": "This procedure describes how to use RKE to restore a snapshot of the Rancher Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/backups/restore/rke-restore/v2.0-v2.1/v2.0-v2.1": {
"id": "v2.0-v2.4/en/backups/restore/rke-restore/v2.0-v2.1/v2.0-v2.1",
"title": "Rolling back to v2.0.0-v2.1.5",
"description": "Rolling back to Rancher v2.0-v2.1 is no longer supported. The instructions for rolling back to these versions are preserved here and are intended to be used only in cases where upgrading to Rancher v2.2+ is not feasible.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/best-practices/best-practices": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/best-practices/containers/containers": {
"id": "v2.0-v2.4/en/best-practices/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"
},
"v2.0-v2.4/en/best-practices/deployment-strategies/deployment-strategies": {
"id": "v2.0-v2.4/en/best-practices/deployment-strategies/deployment-strategies",
"title": "Rancher Deployment Strategies",
"description": "There are two recommended deployment strategies. Each one has its own pros and cons. Read more about which one would fit best for your use case:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/best-practices/deployment-types/deployment-types": {
"id": "v2.0-v2.4/en/best-practices/deployment-types/deployment-types",
"title": "Tips for Running Rancher",
"description": "A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed \"important.\" Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/best-practices/management/management": {
"id": "v2.0-v2.4/en/best-practices/management/management",
"title": "Tips for Scaling, Security and Reliability",
"description": "Rancher allows you to set up numerous combinations of configurations. Some configurations are more appropriate for development and testing, while there are other best practices for production environments for maximum availability and fault tolerance. The following best practices should be followed for production.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cli/cli": {
"id": "v2.0-v2.4/en/cli/cli",
"title": "Using the Rancher Command Line Interface",
"description": "The Rancher CLI is a unified tool that you can use to interact with Rancher. With it, you can operate Rancher using a command line interface rather than the GUI",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/backing-up-etcd/backing-up-etcd": {
"id": "v2.0-v2.4/en/cluster-admin/backing-up-etcd/backing-up-etcd",
"title": "Backing up a Cluster",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/certificate-rotation/certificate-rotation": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cloning-clusters/cloning-clusters": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cluster-access/ace/ace": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cluster-access/cluster-access": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cluster-access/cluster-members/cluster-members": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cluster-access/kubectl/kubectl": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cluster-admin": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cluster-autoscaler/amazon/amazon": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/cluster-autoscaler/cluster-autoscaler": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/editing-clusters/editing-clusters": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/nodes/nodes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/pod-security-policy/pod-security-policy": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/projects-and-namespaces/projects-and-namespaces": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/restoring-etcd/restoring-etcd": {
"id": "v2.0-v2.4/en/cluster-admin/restoring-etcd/restoring-etcd",
"title": "Restoring a Cluster from Backup",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cis-scans/cis-scans": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cis-scans/cis-scans",
"title": "CIS Scans",
"description": "Available as of v2.4.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cis-scans/skipped-tests/skipped-tests": {
"id": "v2.0-v2.4/en/cluster-admin/tools/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"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-alerts/cluster-alerts": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-alerts/cluster-alerts",
"title": "Cluster Alerts",
"description": "To keep your clusters and applications healthy and driving your organizational productivity forward, you need to stay informed of events occurring in your clusters and projects, both planned and unplanned. When an event occurs, your alert is triggered, and you are sent a notification. You can then, if necessary, follow up with corrective actions.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-alerts/default-alerts/default-alerts": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-alerts/default-alerts/default-alerts",
"title": "Default Alerts for Cluster Monitoring",
"description": "When you create a cluster, some alert rules are predefined. These alerts notify you about signs that the cluster could be unhealthy. You can receive these alerts if you configure a notifier for them.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-logging/cluster-logging": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/cluster-logging",
"title": "Cluster Logging",
"description": "Rancher integrates with popular logging services. Learn the requirements and benefits of integrating with logging services, and enable logging on your cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-logging/elasticsearch/elasticsearch": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/elasticsearch/elasticsearch",
"title": "Elasticsearch",
"description": "If your organization uses Elasticsearch, either on premise or in the cloud, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Elasticsearch deployment to view logs.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-logging/fluentd/fluentd": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/fluentd/fluentd",
"title": "Fluentd",
"description": "If your organization uses Fluentd, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Fluentd server to view logs.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-logging/kafka/kafka": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/kafka/kafka",
"title": "Kafka",
"description": "If your organization uses Kafka, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Kafka server to view logs.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-logging/splunk/splunk": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/splunk/splunk",
"title": "Splunk",
"description": "If your organization uses Splunk, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Splunk server to view logs.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-logging/syslog/syslog": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-logging/syslog/syslog",
"title": "Syslog",
"description": "If your organization uses Syslog, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Syslog server to view logs.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/cluster-metrics/cluster-metrics": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/cluster-metrics/cluster-metrics",
"title": "Cluster Metrics",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/cluster-monitoring": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/cluster-monitoring",
"title": "Integrating Rancher and Prometheus for Cluster Monitoring",
"description": "Prometheus lets you view metrics from your different Rancher and Kubernetes objects. Learn about the scope of monitoring and how to enable cluster monitoring",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/custom-metrics/custom-metrics": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/custom-metrics/custom-metrics",
"title": "Prometheus Custom Metrics Adapter",
"description": "After you've enabled cluster level monitoring, You can view the metrics data from Rancher. You can also deploy the Prometheus custom metrics adapter then you can use the HPA with metrics stored in cluster monitoring.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/expression/expression": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/expression/expression",
"title": "Prometheus Expressions",
"description": "The PromQL expressions in this doc can be used to configure alerts.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/project-monitoring/project-monitoring": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/project-monitoring/project-monitoring",
"title": "Project Monitoring",
"description": "Available as of v2.2.4",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/prometheus/prometheus": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/prometheus/prometheus",
"title": "Prometheus Configuration",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/viewing-metrics/viewing-metrics": {
"id": "v2.0-v2.4/en/cluster-admin/tools/cluster-monitoring/viewing-metrics/viewing-metrics",
"title": "Viewing Metrics",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/disabling-istio/disabling-istio": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/disabling-istio/disabling-istio",
"title": "Disabling Istio",
"description": "This section describes how to disable Istio in a cluster, namespace, or workload.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/istio": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/istio",
"title": "Istio",
"description": "Available as of v2.3.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/rbac/rbac": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/rbac/rbac",
"title": "Role-based Access Control",
"description": "This section describes the permissions required to access Istio features and how to configure access to the Kiali and Jaeger visualizations.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/release-notes/release-notes": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/release-notes/release-notes",
"title": "Release Notes",
"description": "Important note on 1.5.x versions",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/resources/resources": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/resources/resources",
"title": "CPU and Memory Allocations",
"description": "Available as of v2.3.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/deploy-workloads/deploy-workloads": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/deploy-workloads/deploy-workloads",
"title": "4. Add Deployments and Services with the Istio Sidecar",
"description": "Prerequisite: To enable Istio for a workload, the cluster and namespace must have Istio enabled.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster",
"title": "1. Enable Istio in the Cluster",
"description": "This cluster uses the default Nginx controller to allow traffic into the cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-with-psp/enable-istio-with-psp": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-with-psp/enable-istio-with-psp",
"title": "Enable Istio with Pod Security Policies",
"description": "Note: The following guide is only for RKE provisioned clusters.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace": {
"id": "v2.0-v2.4/en/cluster-admin/tools/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"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/gateway/gateway": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/gateway/gateway",
"title": "5. Set up the Istio Gateway",
"description": "The gateway to each cluster can have its own port or load balancer, which is unrelated to a service mesh. By default, each Rancher-provisioned cluster has one NGINX ingress controller allowing traffic into the cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/node-selectors/node-selectors": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/node-selectors/node-selectors",
"title": "3. Select the Nodes Where Istio Components Will be Deployed",
"description": "Prerequisite: Your cluster needs a worker node that can designated for Istio. The worker node should meet the resource requirements.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/set-up-traffic-management/set-up-traffic-management": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/set-up-traffic-management/set-up-traffic-management",
"title": "6. Set up Istio's Components for Traffic Management",
"description": "A central advantage of traffic management in Istio is that it allows dynamic request routing. Some common applications for dynamic request routing include canary deployments and blue/green deployments. The two key resources in Istio traffic management are virtual services and destination rules.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/setup": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/setup",
"title": "Setup Guide",
"description": "This section describes how to enable Istio and start using it in your projects.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/istio/setup/view-traffic/view-traffic": {
"id": "v2.0-v2.4/en/cluster-admin/tools/istio/setup/view-traffic/view-traffic",
"title": "7. Generate and View Traffic",
"description": "This section describes how to view the traffic that is being managed by Istio.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/notifiers/notifiers": {
"id": "v2.0-v2.4/en/cluster-admin/tools/notifiers/notifiers",
"title": "Notifiers",
"description": "Notifiers are services that inform you of alert events. You can configure notifiers to send alert notifications to staff best suited to take corrective action.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/opa-gatekeeper/opa-gatekeeper": {
"id": "v2.0-v2.4/en/cluster-admin/tools/opa-gatekeeper/opa-gatekeeper",
"title": "OPA Gatekeeper",
"description": "Available as of v2.4.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/tools/tools": {
"id": "v2.0-v2.4/en/cluster-admin/tools/tools",
"title": "Tools for Logging, Monitoring, and More",
"description": "Rancher contains a variety of tools that aren't included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently. Tools are divided into following categories:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/upgrading-kubernetes/upgrading-kubernetes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/ebs/ebs": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/examples": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/nfs/nfs": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere": {
"id": "v2.0-v2.4/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 persistent volume claim.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes": {
"id": "v2.0-v2.4/en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes",
"title": "GlusterFS Volumes",
"description": "This section only applies to RKE clusters.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-admin/volumes-and-storage/volumes-and-storage": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/index": {
"id": "v2.0-v2.4/en/cluster-provisioning/cluster-capabilities-table/index",
"title": "index",
"description": "| Action | Rancher launched Kubernetes Clusters | Hosted Kubernetes Clusters | Imported Clusters |",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/cluster-provisioning": {
"id": "v2.0-v2.4/en/cluster-provisioning/cluster-provisioning",
"title": "Setting up Kubernetes Clusters in Rancher",
"description": "Provisioning Kubernetes Clusters",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack": {
"id": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack",
"title": "Creating an Aliyun ACK Cluster",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce": {
"id": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce",
"title": "Creating a Huawei CCE Cluster",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/eks/eks": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke": {
"id": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke",
"title": "Creating a GKE Cluster",
"description": "Prerequisites in Google Kubernetes Engine",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/hosted-kubernetes-clusters": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke": {
"id": "v2.0-v2.4/en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke",
"title": "Creating a Tencent TKE Cluster",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/imported-clusters/imported-clusters": {
"id": "v2.0-v2.4/en/cluster-provisioning/imported-clusters/imported-clusters",
"title": "Importing Existing Clusters",
"description": "Learn how you can create a cluster in Rancher by importing an existing Kubernetes cluster. Then, you can manage it using Rancher",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/node-requirements/node-requirements": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/production/production": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/production/recommended-architecture/recommended-architecture": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/azure/azure": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/cloud-providers": {
"id": "v2.0-v2.4/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. For more information, refer to the official Kubernetes documentation on cloud providers.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/vsphere": {
"id": "v2.0-v2.4/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 the vSphere cloud provider for a Rancher managed RKE Kubernetes cluster in vSphere.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/azure/azure": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/azure-node-template-config": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/digital-ocean": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/do-node-template-config": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/node-pools": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/node-pools",
"title": "Launching Kubernetes on New Nodes in an Infrastructure Provider",
"description": "Using Rancher, you can create pools of nodes based on a node template. This node template defines the parameters you want to use to launch nodes in your infrastructure providers or cloud providers.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere",
"title": "Creating a vSphere Cluster",
"description": "Use Rancher to create a vSphere cluster. It may consist of groups of VMs with distinct properties which allow for fine-grained control over the sizing of nodes.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/prior-to-2.0.4/prior-to-2.0.4": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/prior-to-2.0.4/prior-to-2.0.4",
"title": "vSphere Node Template Configuration in Rancher before v2.0.4",
"description": "- Account access",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.0.4/v2.0.4": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.0.4/v2.0.4",
"title": "vSphere Node Template Configuration in Rancher v2.0.4",
"description": "- Account access",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.2.0/v2.2.0": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.2.0/v2.2.0",
"title": "vSphere Node Template Configuration in Rancher v2.2.0",
"description": "- Account Access",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.0/v2.3.0": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.0/v2.3.0",
"title": "vSphere Node Template Configuration in Rancher v2.3.0",
"description": "- Account Access",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.3/v2.3.3": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.3/v2.3.3",
"title": "vSphere Node Template Configuration in Rancher v2.3.3",
"description": "- Account Access",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config",
"title": "VSphere Node Template Configuration",
"description": "The vSphere node templates in Rancher were updated in the following Rancher versions. Refer to the newest configuration reference that is less than or equal to your Rancher version:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/options/options": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/options/options",
"title": "RKE Cluster Configuration Reference",
"description": "When Rancher installs Kubernetes, it uses RKE as the Kubernetes distribution.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/options/pod-security-policies/pod-security-policies": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/options/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/rancher-agents/rancher-agents": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/rke-clusters": {
"id": "v2.0-v2.4/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, it uses Rancher Kubernetes Engine (RKE), which is Rancher's own lightweight Kubernetes installer. It can launch Kubernetes on any computers, including:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/docs-for-2.1-and-2.2/docs-for-2.1-and-2.2": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/docs-for-2.1-and-2.2/docs-for-2.1-and-2.2",
"title": "v2.1.x and v2.2.x Windows Documentation (Experimental)",
"description": "Available from v2.1.0 to v2.1.9 and v2.2.0 to v2.2.3",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/host-gateway-requirements": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters": {
"id": "v2.0-v2.4/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters",
"title": "Launching Kubernetes on Windows Clusters",
"description": "Available as of v2.3.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/contributing/contributing": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/deploy-across-clusters/deploy-across-clusters": {
"id": "v2.0-v2.4/en/deploy-across-clusters/deploy-across-clusters",
"title": "Deploying Applications across Clusters",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/faq/faq": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/faq/kubectl/kubectl": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/faq/networking/cni-providers/cni-providers": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/faq/networking/networking": {
"id": "v2.0-v2.4/en/faq/networking/networking",
"title": "Networking",
"description": "Networking FAQ's",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/faq/removing-rancher/removing-rancher": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/faq/security/security": {
"id": "v2.0-v2.4/en/faq/security/security",
"title": "Security",
"description": "Is there a Hardening Guide?",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/faq/technical/technical": {
"id": "v2.0-v2.4/en/faq/technical/technical",
"title": "Technical",
"description": "How can I reset the administrator password?",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/faq/telemetry/telemetry": {
"id": "v2.0-v2.4/en/faq/telemetry/telemetry",
"title": "Telemetry",
"description": "What is Telemetry?",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/faq/upgrades-to-2x/upgrades-to-2x": {
"id": "v2.0-v2.4/en/faq/upgrades-to-2x/upgrades-to-2x",
"title": "Questions about Upgrading to Rancher v2.x",
"description": "This page contains frequently asked questions about the changes between Rancher v1.x and v2.x, and how to upgrade from Rancher v1.x to v2.x.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/adding-catalogs/adding-catalogs": {
"id": "v2.0-v2.4/en/helm-charts/adding-catalogs/adding-catalogs",
"title": "Creating Custom Catalogs",
"description": "Custom catalogs can be added into Rancher at a global scope, cluster scope, or project scope.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/built-in/built-in": {
"id": "v2.0-v2.4/en/helm-charts/built-in/built-in",
"title": "Enabling and Disabling Built-in Global Catalogs",
"description": "There are default global catalogs packaged as part of Rancher.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/catalog-config/catalog-config": {
"id": "v2.0-v2.4/en/helm-charts/catalog-config/catalog-config",
"title": "Custom Catalog Configuration Reference",
"description": "Any user can create custom catalogs to add into Rancher. Besides the content of the catalog, users must ensure their catalogs are able to be added into Rancher.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/creating-apps/creating-apps": {
"id": "v2.0-v2.4/en/helm-charts/creating-apps/creating-apps",
"title": "Creating Catalog Apps",
"description": "Rancher's catalog service requires any custom catalogs to be structured in a specific format for the catalog service to be able to leverage it in Rancher.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/globaldns/globaldns": {
"id": "v2.0-v2.4/en/helm-charts/globaldns/globaldns",
"title": "Global DNS",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/helm-charts": {
"id": "v2.0-v2.4/en/helm-charts/helm-charts",
"title": "Helm Charts in Rancher",
"description": "Rancher enables the use of catalogs to repeatedly deploy applications easily. Catalogs are GitHub or Helm Chart repositories filled with deployment-ready apps.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/launching-apps/launching-apps": {
"id": "v2.0-v2.4/en/helm-charts/launching-apps/launching-apps",
"title": "Launching Catalog Apps",
"description": "Within a project, when you want to deploy applications from catalogs, the applications available in your project will be based on the scope of the catalogs.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/managing-apps/managing-apps": {
"id": "v2.0-v2.4/en/helm-charts/managing-apps/managing-apps",
"title": "Managing Catalog Apps",
"description": "After deploying an application, one of the benefits of using an application versus individual workloads/resources is the ease of being able to manage many workloads/resources applications. Apps can be cloned, upgraded or rolled back.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/multi-cluster-apps/multi-cluster-apps": {
"id": "v2.0-v2.4/en/helm-charts/multi-cluster-apps/multi-cluster-apps",
"title": "Multi-Cluster Apps",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/helm-charts/tutorial/tutorial": {
"id": "v2.0-v2.4/en/helm-charts/tutorial/tutorial",
"title": "Tutorial: Example Custom Chart Creation",
"description": "In this tutorial, you'll learn how to create a Helm chart and deploy it to a repository. The repository can then be used as a source for a custom catalog in Rancher.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/install-rancher-on-k8s/chart-options/chart-options": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/install-rancher-on-k8s/install-rancher-on-k8s": {
"id": "v2.0-v2.4/en/installation/install-rancher-on-k8s/install-rancher-on-k8s",
"title": "Install Rancher on a Kubernetes Cluster",
"description": "Learn how to install Rancher in development and production environments. Read about single node and high availability installation",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/install-rancher-on-k8s/rollbacks/rollbacks": {
"id": "v2.0-v2.4/en/installation/install-rancher-on-k8s/rollbacks/rollbacks",
"title": "Rollbacks",
"description": "Rolling Back to Rancher v2.2-v2.4",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/helm2/helm2": {
"id": "v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/helm2/helm2",
"title": "Upgrading Rancher Installed on Kubernetes with Helm 2",
"description": "Helm 3 has been released. If you are using Helm 2, we recommend migrating to Helm 3 because it is simpler to use and more secure than Helm 2.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/migrating-from-rke-add-on/migrating-from-rke-add-on": {
"id": "v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/migrating-from-rke-add-on/migrating-from-rke-add-on",
"title": "Migrating from a Kubernetes Install with an RKE Add-on",
"description": "Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/namespace-migration/namespace-migration": {
"id": "v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/namespace-migration/namespace-migration",
"title": "Upgrading to v2.0.7+ — Namespace Migration",
"description": "This section applies only to Rancher upgrades from v2.0.6 or earlier to v2.0.7 or later. Upgrades from v2.0.7 to later version are unaffected.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/upgrades": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/installation": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/air-gap/air-gap": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/air-gap/install-rancher/install-rancher": {
"id": "v2.0-v2.4/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. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. There are tabs for either a high availability (recommended) or a Docker installation.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/behind-proxy": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/other-installation-methods": {
"id": "v2.0-v2.4/en/installation/other-installation-methods/other-installation-methods",
"title": "Other Installation Methods",
"description": "Air Gapped Installations",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/advanced/advanced": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/proxy/proxy": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-docker": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades": {
"id": "v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades",
"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"
},
"v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/troubleshooting/troubleshooting": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/requirements/installing-docker/installing-docker": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/requirements/ports/common-ports-table/index": {
"id": "v2.0-v2.4/en/installation/requirements/ports/common-ports-table/index",
"title": "index",
"description": "| Protocol \t| Port \t| Description \t |",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/requirements/ports/ports": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/requirements/requirements": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/advanced/advanced": {
"id": "v2.0-v2.4/en/installation/resources/advanced/advanced",
"title": "Advanced",
"description": "The documents in this section contain resources for less common use cases.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/air-gap-helm2": {
"id": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/air-gap-helm2",
"title": "Installing Rancher in an Air Gapped Environment with Helm 2",
"description": "After Helm 3 was released, the Rancher installation instructions were updated to use Helm 3.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/install-rancher": {
"id": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/install-rancher/install-rancher",
"title": "4. Install Rancher",
"description": "This section is about how to deploy Rancher for your air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. There are tabs for either a high availability (recommended) or a Docker installation.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/launch-kubernetes/launch-kubernetes": {
"id": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/launch-kubernetes/launch-kubernetes",
"title": "3. Install Kubernetes with RKE (Kubernetes Installs Only)",
"description": "This section is about how to prepare to launch a Kubernetes cluster which is used to deploy Rancher server for your air gapped environment.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/populate-private-registry/populate-private-registry": {
"id": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/populate-private-registry/populate-private-registry",
"title": "2. Collect and Publish Images to your Private Registry",
"description": "Prerequisites: You must have a private registry available to use.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/prepare-nodes/prepare-nodes": {
"id": "v2.0-v2.4/en/installation/resources/advanced/air-gap-helm2/prepare-nodes/prepare-nodes",
"title": "1. Prepare your Node(s)",
"description": "This section is about how to prepare your node(s) to install Rancher for your air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. There are tabs for either a high availability (recommended) or a Docker installation.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/api-audit-log/api-audit-log": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/advanced/arm64-platform/arm64-platform": {
"id": "v2.0-v2.4/en/installation/resources/advanced/arm64-platform/arm64-platform",
"title": "Running on ARM64 (Experimental)",
"description": "Important:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/cluster-yml-templates": {
"id": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/cluster-yml-templates",
"title": "cluster.yml Templates for RKE add-on installs",
"description": "These templates are intended to be used for RKE add-on installs, which are only supported up to Rancher v2.0.8. Please use the Rancher Helm chart if you are installing a newer Rancher version.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate-recognizedca/node-certificate-recognizedca": {
"id": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate-recognizedca/node-certificate-recognizedca",
"title": "Template for an RKE Cluster with a Certificate Signed by Recognized CA and a Layer 4 Load Balancer",
"description": "RKE uses a cluster.yml file to install and configure your Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate/node-certificate": {
"id": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-certificate/node-certificate",
"title": "Template for an RKE Cluster with a Self-signed Certificate and Layer 4 Load Balancer",
"description": "RKE uses a cluster.yml file to install and configure your Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-certificate/node-externalssl-certificate": {
"id": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-certificate/node-externalssl-certificate",
"title": "Template for an RKE Cluster with a Self-signed Certificate and SSL Termination on Layer 7 Load Balancer",
"description": "RKE uses a cluster.yml file to install and configure your Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-recognizedca/node-externalssl-recognizedca": {
"id": "v2.0-v2.4/en/installation/resources/advanced/cluster-yml-templates/node-externalssl-recognizedca/node-externalssl-recognizedca",
"title": "Template for an RKE Cluster with a Recognized CA Certificate and SSL Termination on Layer 7 Load Balancer",
"description": "RKE uses a cluster.yml file to install and configure your Kubernetes cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/etcd/etcd": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/advanced/firewall/firewall": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/create-nodes-lb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/create-nodes-lb",
"title": "1. Create Nodes and Load Balancer",
"description": "Use your provider of choice to provision 3 nodes and a Load Balancer endpoint for your RKE install.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nginx/nginx": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nginx/nginx",
"title": "NGINX",
"description": "NGINX will be configured as Layer 4 load balancer (TCP) that forwards connections to one of your Rancher nodes.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nlb/nlb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/create-nodes-lb/nlb/nlb",
"title": "Amazon NLB",
"description": "Objectives",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/helm-init/helm-init": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-init/helm-init",
"title": "Initialize Helm: Install the Tiller Service",
"description": "With Helm, you can create configurable deployments instead of using static files. In order to use Helm, the Tiller service needs to be installed on your cluster.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/helm-init/troubleshooting/troubleshooting": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-init/troubleshooting/troubleshooting",
"title": "Troubleshooting",
"description": "Helm commands show forbidden",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/chart-options/chart-options": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/chart-options/chart-options",
"title": "Chart Options",
"description": "Common Options",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/helm-rancher": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/helm-rancher",
"title": "4. Install Rancher",
"description": "Rancher installation is managed using the Helm package manager for Kubernetes. Use helm to install the prerequisite and charts to install Rancher.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/tls-secrets/tls-secrets": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/tls-secrets/tls-secrets",
"title": "Adding Kubernetes TLS Secrets",
"description": "Read about how to populate the Kubernetes TLS secret for a Rancher installation",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/troubleshooting/troubleshooting": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm-rancher/troubleshooting/troubleshooting",
"title": "Troubleshooting",
"description": "Where is everything",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/helm2": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/helm2",
"title": "Kubernetes Installation Using Helm 2",
"description": "After Helm 3 was released, the Rancher installation instructions were updated to use Helm 3.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/kubernetes-rke/kubernetes-rke": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/kubernetes-rke/kubernetes-rke",
"title": "2. Install Kubernetes with RKE",
"description": "Use RKE to install Kubernetes with a high availability etcd configuration.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/kubernetes-rke/troubleshooting/troubleshooting": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/kubernetes-rke/troubleshooting/troubleshooting",
"title": "Troubleshooting",
"description": "canal Pods show READY 2/3",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/api-auditing/api-auditing": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/api-auditing/api-auditing",
"title": "Enable API Auditing",
"description": "Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/layer-4-lb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/layer-4-lb",
"title": "Kubernetes Install with External Load Balancer (TCP/Layer 4)",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/nlb/nlb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/nlb/nlb",
"title": "Amazon NLB Configuration",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/alb/alb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/alb/alb",
"title": "Amazon ALB Configuration",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/layer-7-lb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/layer-7-lb",
"title": "Kubernetes Install with External Load Balancer (HTTPS/Layer 7)",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/nginx/nginx": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/nginx/nginx",
"title": "NGINX Configuration",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/proxy/proxy": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/proxy/proxy",
"title": "HTTP Proxy Configuration",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/rke-add-on": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/rke-add-on",
"title": "RKE Add-On Install",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/default-backend/default-backend": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/default-backend/default-backend",
"title": "404 - default backend",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/generic-troubleshooting/generic-troubleshooting": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/generic-troubleshooting/generic-troubleshooting",
"title": "Generic troubleshooting",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/job-complete-status/job-complete-status": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/job-complete-status/job-complete-status",
"title": "Failed to get job complete status",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/troubleshooting": {
"id": "v2.0-v2.4/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/troubleshooting",
"title": "Troubleshooting HA RKE Add-On Install",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-4-lb/layer-4-lb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-4-lb/layer-4-lb",
"title": "Kubernetes Install with External Load Balancer (TCP/Layer 4)",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-7-lb/layer-7-lb": {
"id": "v2.0-v2.4/en/installation/resources/advanced/rke-add-on/layer-7-lb/layer-7-lb",
"title": "Kubernetes Install with External Load Balancer (HTTPS/Layer 7)",
"description": "#### Important: RKE add-on install is only supported up to Rancher v2.0.8",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/chart-options/chart-options": {
"id": "v2.0-v2.4/en/installation/resources/chart-options/chart-options",
"title": "Rancher Helm Chart Options",
"description": "The Rancher Helm chart options reference moved to this page.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/choosing-version/choosing-version": {
"id": "v2.0-v2.4/en/installation/resources/choosing-version/choosing-version",
"title": "Choosing a Rancher Version",
"description": "This section describes how to choose a Rancher version.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/custom-ca-root-certificate/custom-ca-root-certificate": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/feature-flags/enable-not-default-storage-drivers/enable-not-default-storage-drivers": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/feature-flags/feature-flags": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/helm-version/helm-version": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/how-ha-works/how-ha-works": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/ec2-node": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/infra-for-ha": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infrastructure-tutorials": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/nginx": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/k8s-tutorials/k8s-tutorials": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/local-system-charts/local-system-charts": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/resources": {
"id": "v2.0-v2.4/en/installation/resources/resources",
"title": "Resources",
"description": "Docker Installations",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/tls-secrets/tls-secrets": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/tls-settings/tls-settings": {
"id": "v2.0-v2.4/en/installation/resources/tls-settings/tls-settings",
"title": "TLS Settings",
"description": "In Rancher v2.1.7, the default TLS configuration changed to only accept TLS 1.2 and secure TLS cipher suites. TLS 1.3 and TLS 1.3 exclusive cipher suites are not supported.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/troubleshooting/troubleshooting": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/update-rancher-cert/update-rancher-cert": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/installation/resources/upgrading-cert-manager/helm-2-instructions/helm-2-instructions": {
"id": "v2.0-v2.4/en/installation/resources/upgrading-cert-manager/helm-2-instructions/helm-2-instructions",
"title": "Upgrading Cert-Manager with Helm 2",
"description": "Rancher uses cert-manager to automatically generate and renew TLS certificates for HA deployments of Rancher. As of Fall 2019, three important changes to cert-manager are set to occur that you need to take action on if you have an HA deployment of Rancher:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/installation/resources/upgrading-cert-manager/upgrading-cert-manager": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/introduction": {
"id": "v2.0-v2.4/en/introduction",
"title": "Rancher 2.0-2.4",
"description": "Rancher adds significant value on top of Kubernetes: managing hundreds of clusters from one interface, centralizing RBAC, enabling monitoring and alerting. Read more.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/k8s-in-rancher/certificates/certificates": {
"id": "v2.0-v2.4/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 to either a project, a namespace, or both, so that you can add it to deployments",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/k8s-in-rancher/configmaps/configmaps": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/horitzontal-pod-autoscaler": {
"id": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/horitzontal-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"
},
"v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-background/hpa-background": {
"id": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-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"
},
"v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-for-rancher-before-2_0_7/hpa-for-rancher-before-2_0_7": {
"id": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-for-rancher-before-2_0_7/hpa-for-rancher-before-2_0_7",
"title": "Manual HPA Installation for Clusters Created Before Rancher v2.0.7",
"description": "This section describes how to manually install HPAs for clusters created with Rancher before v2.0.7. This section also describes how to configure your HPA to scale up or down, and how to assign roles to your HPA.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl": {
"id": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-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"
},
"v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui": {
"id": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui",
"title": "Managing HPAs with the Rancher UI",
"description": "Available as of v2.3.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/testing-hpa": {
"id": "v2.0-v2.4/en/k8s-in-rancher/horitzontal-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"
},
"v2.0-v2.4/en/k8s-in-rancher/k8s-in-rancher": {
"id": "v2.0-v2.4/en/k8s-in-rancher/k8s-in-rancher",
"title": "Kubernetes Resources",
"description": "Workloads",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress": {
"id": "v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress",
"title": "Adding Ingresses to Your Project",
"description": "Ingresses can be added for workloads to provide load balancing, SSL termination and host/path-based routing. Learn how to add Rancher ingress to your project",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers-and-ingress": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/load-balancers": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/registries/registries": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/secrets/secrets": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/service-discovery/service-discovery": {
"id": "v2.0-v2.4/en/k8s-in-rancher/service-discovery/service-discovery",
"title": "Service Discovery",
"description": "For every workload created, a complementing Service Discovery entry is created. This Service Discovery entry enables DNS resolution for the workload's pods using the following naming convention:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/workloads/rollback-workloads/rollback-workloads": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/workloads/upgrade-workloads/upgrade-workloads": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/k8s-in-rancher/workloads/workloads": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/overview/architecture-recommendations/architecture-recommendations": {
"id": "v2.0-v2.4/en/overview/architecture-recommendations/architecture-recommendations",
"title": "Architecture Recommendations",
"description": "Kubernetes cluster. If you are installing Rancher on a single node, the main architecture recommendation that applies to your installation is that the cluster running Rancher should be separate from downstream clusters.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/overview/architecture/architecture": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/overview/concepts/concepts": {
"id": "v2.0-v2.4/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 interview of Kubernetes components. For more details, refer to the official documentation on Kubernetes components.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/overview/overview": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/pipelines/concepts/concepts": {
"id": "v2.0-v2.4/en/pipelines/concepts/concepts",
"title": "Concepts",
"description": "The purpose of this page is to explain common concepts and terminology related to pipelines.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/pipelines/config/config": {
"id": "v2.0-v2.4/en/pipelines/config/config",
"title": "Pipeline Configuration Reference",
"description": "In this section, you'll learn how to configure pipelines.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/pipelines/docs-for-v2.0.x/docs-for-v2.0.x": {
"id": "v2.0-v2.4/en/pipelines/docs-for-v2.0.x/docs-for-v2.0.x",
"title": "v2.0.x Pipeline Documentation",
"description": "Note: This section describes the pipeline feature as implemented in Rancher v2.0.x. If you are using Rancher v2.1 or later, where pipelines have been significantly improved, please refer to the new documentation for v2.1 or later.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/pipelines/example-repos/example-repos": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/pipelines/example/example": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/pipelines/pipelines": {
"id": "v2.0-v2.4/en/pipelines/pipelines",
"title": "Pipelines",
"description": "Rancher's pipeline provides a simple CI/CD experience. Use it to automatically checkout code, run builds or scripts, publish Docker images or catalog applications, and deploy the updated software to users.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/pipelines/storage/storage": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/namespaces/namespaces": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/pipelines/pipelines": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/pod-security-policies/pod-security-policies": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/project-admin": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/project-members/project-members": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/resource-quotas/override-container-default/override-container-default": {
"id": "v2.0-v2.4/en/project-admin/resource-quotas/override-container-default/override-container-default",
"title": "Setting Container Default Resource Limits",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/project-admin/resource-quotas/override-namespace-default/override-namespace-default": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/project-admin/resource-quotas/resource-quotas": {
"id": "v2.0-v2.4/en/project-admin/resource-quotas/resource-quotas",
"title": "Project Resource Quotas",
"description": "Available as of v2.1.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/project-admin/tools/project-alerts/project-alerts": {
"id": "v2.0-v2.4/en/project-admin/tools/project-alerts/project-alerts",
"title": "Project Alerts",
"description": "To keep your clusters and applications healthy and driving your organizational productivity forward, you need to stay informed of events occurring in your clusters and projects, both planned and unplanned. When an event occurs, your alert is triggered, and you are sent a notification. You can then, if necessary, follow up with corrective actions.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/project-admin/tools/project-logging/project-logging": {
"id": "v2.0-v2.4/en/project-admin/tools/project-logging/project-logging",
"title": "Project Logging",
"description": "Rancher can integrate with a variety of popular logging services and tools that exist outside of your Kubernetes clusters.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/project-admin/tools/tools": {
"id": "v2.0-v2.4/en/project-admin/tools/tools",
"title": "Tools for Logging, Monitoring, and More",
"description": "Rancher contains a variety of tools that aren't included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently. Tools are divided into following categories:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/cli/cli": {
"id": "v2.0-v2.4/en/quick-start-guide/cli/cli",
"title": "CLI with Rancher",
"description": "Interact with Rancher using command line interface (CLI) tools from your workstation.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs": {
"id": "v2.0-v2.4/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 cluster attached.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/deployment/deployment": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs": {
"id": "v2.0-v2.4/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 cluster attached.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs": {
"id": "v2.0-v2.4/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 cluster attached.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs": {
"id": "v2.0-v2.4/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 cluster attached.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup": {
"id": "v2.0-v2.4/en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup",
"title": "Manual Quick Start",
"description": "Howdy Partner! This tutorial walks you through:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/quick-start-guide/quick-start-guide": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress": {
"id": "v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress",
"title": "Workload with Ingress Quick Start",
"description": "Prerequisite",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport": {
"id": "v2.0-v2.4/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport",
"title": "Workload with NodePort Quick Start",
"description": "Prerequisite",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/quick-start-guide/workload/workload": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/security/cve/cve": {
"id": "v2.0-v2.4/en/security/cve/cve",
"title": "Rancher CVEs and Resolutions",
"description": "Rancher is committed to informing the community of security issues in our products. Rancher will publish CVEs (Common Vulnerabilities and Exposures) for issues we have resolved.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.1/benchmark-2.1/benchmark-2.1": {
"id": "v2.0-v2.4/en/security/rancher-2.1/benchmark-2.1/benchmark-2.1",
"title": "CIS Benchmark Rancher Self-Assessment Guide v2.1",
"description": "This document is a companion to the Rancher v2.1 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.1/hardening-2.1/hardening-2.1": {
"id": "v2.0-v2.4/en/security/rancher-2.1/hardening-2.1/hardening-2.1",
"title": "Hardening Guide v2.1",
"description": "This document provides prescriptive guidance for hardening a production installation of Rancher v2.1.x. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.1/rancher-2.1": {
"id": "v2.0-v2.4/en/security/rancher-2.1/rancher-2.1",
"title": "Rancher v2.1",
"description": "Self Assessment Guide",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.2/benchmark-2.2/benchmark-2.2": {
"id": "v2.0-v2.4/en/security/rancher-2.2/benchmark-2.2/benchmark-2.2",
"title": "CIS Benchmark Rancher Self-Assessment Guide v2.2",
"description": "This document is a companion to the Rancher v2.2 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.2/hardening-2.2/hardening-2.2": {
"id": "v2.0-v2.4/en/security/rancher-2.2/hardening-2.2/hardening-2.2",
"title": "Hardening Guide v2.2",
"description": "This document provides prescriptive guidance for hardening a production installation of Rancher v2.2.x. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.2/rancher-2.2": {
"id": "v2.0-v2.4/en/security/rancher-2.2/rancher-2.2",
"title": "Rancher v2.2",
"description": "Self Assessment Guide",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-2.3.x": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-2.3.x",
"title": "Rancher v2.3.x",
"description": "The relevant Hardening Guide and Self Assessment guide depends on your Rancher version:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/benchmark-2.3/benchmark-2.3": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/benchmark-2.3/benchmark-2.3",
"title": "CIS Benchmark Rancher Self-Assessment Guide v2.3",
"description": "This document is a companion to the Rancher v2.3 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/hardening-2.3/hardening-2.3": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/hardening-2.3/hardening-2.3",
"title": "Hardening Guide v2.3",
"description": "This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.0-v2.3.2. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/rancher-v2.3.0": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.0/rancher-v2.3.0",
"title": "Rancher v2.3.0",
"description": "Self Assessment Guide",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/benchmark-2.3.3/benchmark-2.3.3": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/benchmark-2.3.3/benchmark-2.3.3",
"title": "CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.3",
"description": "This document is a companion to the Rancher v2.3.3 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/hardening-2.3.3/hardening-2.3.3": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/hardening-2.3.3/hardening-2.3.3",
"title": "Hardening Guide v2.3.3",
"description": "This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.3. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/rancher-v2.3.3": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.3/rancher-v2.3.3",
"title": "Rancher v2.3.3",
"description": "Self Assessment Guide",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/benchmark-2.3.5/benchmark-2.3.5": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/benchmark-2.3.5/benchmark-2.3.5",
"title": "CIS Benchmark Rancher Self-Assessment Guide - v2.3.5",
"description": "CIS Kubernetes Benchmark v1.5 - Rancher v2.3.5 with Kubernetes v1.15",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/hardening-2.3.5/hardening-2.3.5": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/hardening-2.3.5/hardening-2.3.5",
"title": "Hardening Guide v2.3.5",
"description": "This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.5. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/rancher-v2.3.5": {
"id": "v2.0-v2.4/en/security/rancher-2.3.x/rancher-v2.3.5/rancher-v2.3.5",
"title": "Rancher v2.3.5",
"description": "Self Assessment Guide",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.4/benchmark-2.4/benchmark-2.4": {
"id": "v2.0-v2.4/en/security/rancher-2.4/benchmark-2.4/benchmark-2.4",
"title": "CIS Benchmark Rancher Self-Assessment Guide - v2.4",
"description": "CIS Kubernetes Benchmark v1.5 - Rancher v2.4 with Kubernetes v1.15",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.4/hardening-2.4/hardening-2.4": {
"id": "v2.0-v2.4/en/security/rancher-2.4/hardening-2.4/hardening-2.4",
"title": "Hardening Guide v2.4",
"description": "This document provides prescriptive guidance for hardening a production installation of Rancher v2.4. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/rancher-2.4/rancher-2.4": {
"id": "v2.0-v2.4/en/security/rancher-2.4/rancher-2.4",
"title": "Rancher v2.4",
"description": "Self Assessment Guide",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/security": {
"id": "v2.0-v2.4/en/security/security",
"title": "Security",
"description": "Security policy",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/security/security-scan/security-scan": {
"id": "v2.0-v2.4/en/security/security-scan/security-scan",
"title": "Security Scans",
"description": "The documentation about CIS security scans has moved here.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/system-tools/system-tools": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/dns/dns": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/imported-clusters/imported-clusters": {
"id": "v2.0-v2.4/en/troubleshooting/imported-clusters/imported-clusters",
"title": "Imported clusters",
"description": "The commands/steps listed on this page can be used to check clusters that you are importing or that are imported in Rancher.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/troubleshooting/kubernetes-components/controlplane/controlplane": {
"id": "v2.0-v2.4/en/troubleshooting/kubernetes-components/controlplane/controlplane",
"title": "Troubleshooting Controlplane Nodes",
"description": "This section applies to nodes with the controlplane role.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/troubleshooting/kubernetes-components/etcd/etcd": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/kubernetes-components/kubernetes-components": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/kubernetes-components/nginx-proxy/nginx-proxy": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/kubernetes-components/worker-and-generic/worker-and-generic": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/kubernetes-resources/kubernetes-resources": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/logging/logging": {
"id": "v2.0-v2.4/en/troubleshooting/logging/logging",
"title": "Logging",
"description": "The following log levels are used in Rancher:",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/troubleshooting/networking/networking": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/rancherha/rancherha": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/troubleshooting/troubleshooting": {
"id": "v2.0-v2.4/en/troubleshooting/troubleshooting",
"title": "Troubleshooting",
"description": "This section contains information to help you troubleshoot issues when using Rancher.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/user-settings/api-keys/api-keys": {
"id": "v2.0-v2.4/en/user-settings/api-keys/api-keys",
"title": "API Keys",
"description": "API Keys and User Authentication",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/user-settings/cloud-credentials/cloud-credentials": {
"id": "v2.0-v2.4/en/user-settings/cloud-credentials/cloud-credentials",
"title": "Managing Cloud Credentials",
"description": "Available as of v2.2.0",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/user-settings/node-templates/node-templates": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/user-settings/preferences/preferences": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/user-settings/user-settings": {
"id": "v2.0-v2.4/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"
},
"v2.0-v2.4/en/v1.6-migration/discover-services/discover-services": {
"id": "v2.0-v2.4/en/v1.6-migration/discover-services/discover-services",
"title": "6. Service Discovery",
"description": "Service discovery is one of the core functionalities of any container-based environment. Once you have packaged and launched your application, the next step is making it discoverable to other containers in your environment or the external world. This document will describe how to use the service discovery support provided by Rancher v2.x so that you can find them by name.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/expose-services/expose-services": {
"id": "v2.0-v2.4/en/v1.6-migration/expose-services/expose-services",
"title": "3. Expose Your Services",
"description": "In testing environments, you usually need to route external traffic to your cluster containers by using an unadvertised IP and port number, providing users access to their apps. You can accomplish this goal using port mapping, which exposes a workload (i.e., service) publicly over a specific port, provided you know your node IP address(es). You can either map a port using HostPorts (which exposes a service on a specified port on a single node) or NodePorts (which exposes a service on all nodes on a single port).",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/get-started/get-started": {
"id": "v2.0-v2.4/en/v1.6-migration/get-started/get-started",
"title": "1. Get Started",
"description": "Get started with your migration to Rancher v2.x by installing Rancher and configuring your new Rancher environment.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/kub-intro/kub-intro": {
"id": "v2.0-v2.4/en/v1.6-migration/kub-intro/kub-intro",
"title": "Kubernetes Introduction",
"description": "Rancher v2.x is built on the Kubernetes container orchestrator. This shift in underlying technology for v2.x is a large departure from v1.6, which supported several popular container orchestrators. Since Rancher is now based entirely on Kubernetes, it's helpful to learn the Kubernetes basics.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/load-balancing/load-balancing": {
"id": "v2.0-v2.4/en/v1.6-migration/load-balancing/load-balancing",
"title": "7. Load Balancing",
"description": "If your applications are public-facing and consume significant traffic, you should place a load balancer in front of your cluster so that users can always access their apps without service interruption. Typically, you can fulfill a high volume of service requests by horizontally scaling your deployment, which spins up additional application containers as traffic ramps up. However, this technique requires routing that distributes traffic across your nodes efficiently. In cases where you need to accommodate public traffic that scales up and down, you'll need a load balancer.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/monitor-apps/monitor-apps": {
"id": "v2.0-v2.4/en/v1.6-migration/monitor-apps/monitor-apps",
"title": "4. Configure Health Checks",
"description": "Rancher v1.6 provided TCP and HTTP health checks on your nodes and services using its own health check microservice. These health checks monitored your containers to confirm they're operating as intended. If a container failed a health check, Rancher would destroy the unhealthy container and then replicates a healthy one to replace it.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/run-migration-tool/migration-tools-ref/migration-tools-ref": {
"id": "v2.0-v2.4/en/v1.6-migration/run-migration-tool/migration-tools-ref/migration-tools-ref",
"title": "Migration Tools CLI Reference",
"description": "The migration-tools CLI includes multiple commands and options to assist your migration from Rancher v1.6 to Rancher v2.x.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/run-migration-tool/run-migration-tool": {
"id": "v2.0-v2.4/en/v1.6-migration/run-migration-tool/run-migration-tool",
"title": "2. Migrate Your Services",
"description": "Although your services from v1.6 won't work in Rancher v2.x by default, that doesn't mean you have to start again from square one, manually rebuilding your applications in v2.x. To help with migration from v1.6 to v2.x, Rancher has developed a migration tool. The migration-tools CLI is a utility that helps you recreate your applications in Rancher v2.x. This tool exports your Rancher v1.6 services as Compose files and converts them to a Kubernetes manifest that Rancher v2.x can consume.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/schedule-workloads/schedule-workloads": {
"id": "v2.0-v2.4/en/v1.6-migration/schedule-workloads/schedule-workloads",
"title": "5. Schedule Your Services",
"description": "In v1.6, objects called services were used to schedule containers to your cluster hosts. Services included the Docker image for an application, along with configuration settings for a desired state.",
"sidebar": "tutorialSidebar"
},
"v2.0-v2.4/en/v1.6-migration/v1.6-migration": {
"id": "v2.0-v2.4/en/v1.6-migration/v1.6-migration",
"title": "Migrating from v1.6 to v2.x",
"description": "Rancher v2.x has been rearchitected and rewritten with the goal of providing a complete management solution for Kubernetes and Docker. Due to these extensive changes, there is no direct upgrade path from v1.6 to v2.x, but rather a migration of your v1.6 services into v2.x as Kubernetes workloads. In v1.6, the most common orchestration used was Rancher's own engine called Cattle. The following guide explains and educates our Cattle users on running workloads in a Kubernetes environment.",
"sidebar": "tutorialSidebar"
}
}
}
Reference in New Issue View Git Blame Copy Permalink