The Logo of Rancher: an Open Source Kubernetes Multi Cluster Management Platform
Gray Search Icon
  • Why Rancher?
    • Why Rancher?
    • Why Kubernetes?
    • How Rancher Strengthens Kubernetes
    • The Rancher Difference
  • Products
    • Overview
    • Rancher
    • Hosted Rancher
    • k3s
    • Longhorn
    • Request a demo
  • Customers
    • Continental
    • Ubisoft
    • Schneider Electric
    • MPAC
    • See All Customer Stories
  • Community
    • Overview
    • Learning Paths
    • Training
    • Tutorials
    • Events
    • Online Meetups
    • Rancher Rodeos
    • Kubernetes Master Classes
    • Get Certified!
    • Getting Started Guide
    • Forums
    • Slack
    • Github
  • Resources
    • Docs
    • Analyst Reports
    • White Papers
    • Ebooks
    • Videos
    • Podcasts
    • Blog
  • Projects
    • k3OS
    • Rio
    • Submariner
    • Longhorn
  • Company
    • About us
    • Partners
    • Press
    • Events
    • Careers
    • Blog
  • Docs
  • Request a demo
  • Contact
  • Pricing
  • Get started
  • Docs
  • Request a demo
  • Pricing
  • Contact
Rancher Logo
  • Why RANCHER?
    • Why Rancher? Why Kubernetes? How We strengthen Kubernetes​ Our Difference​
  • Software
      • All Products Rancher Hosted Rancher RKE Longhorn K3s
  • Learn
      • Learn the Basics Grow Your Skills Get Certified Access Documentation Read the Blogs Content Library
  • Community
      • About Us Join the Community Forums Slack Events & Webinars
  • Get started
  • Rancher 2.0-2.4
    • K3s
    • RKE
    • Rancher 2.6 (Latest)
    • Rancher 2.5
    • Rancher 2.0-2.4
    • Rancher 1.6
    • RancherOS
Rke-add-on
  • Overview
    • Architecture
    • Architecture Recommendations
    • Kubernetes Concepts
  • Rancher Deployment Quick Start Guides
    • CLI with Rancher
    • Deploying Rancher Server
      • Rancher AWS Quick Start Guide
      • Rancher Azure Quick Start Guide
      • Rancher DigitalOcean Quick Start Guide
      • Rancher GCP Quick Start Guide
      • Vagrant Quick Start
      • Manual Quick Start
    • Deploying Workloads
      • Workload with Ingress Quick Start
      • Workload with NodePort Quick Start
  • Installing/Upgrading Rancher
    • Installation Requirements
      • Installing Docker
      • Port Requirements
    • Install Rancher on a Kubernetes Cluster
      • Rancher Helm Chart Options
      • Upgrades
        • Migrating from a Kubernetes Install with an RKE Add-on
        • Upgrading to v2.0.7+ — Namespace Migration
        • Upgrading Rancher Installed on Kubernetes with Helm 2
      • Rollbacks
    • Other Installation Methods
      • Air Gapped Helm CLI Install
        • 1. Set up Infrastructure and Private Registry
        • 2. Collect and Publish Images to your Private Registry
        • 3. Install Kubernetes (Skip for Docker Installs)
        • 4. Install Rancher
      • Installing Rancher on a Single Node Using Docker
        • Certificate Troubleshooting
        • Advanced Options for Docker Installs
        • HTTP Proxy Configuration
        • Upgrading Rancher Installed with Docker
        • Rolling Back Rancher Installed with Docker
      • Installing Rancher behind an HTTP Proxy
        • 1. Set up Infrastructure
        • 2. Install Kubernetes
        • 3. Install Rancher
    • Resources
      • About Custom CA Root Certificates
      • Choosing a Rancher Version
      • Adding TLS Secrets
      • Helm Version Requirements
      • TLS Settings
      • Don't have a Kubernetes cluster? Try one of these tutorials.
        • About High-availability Installations
        • Set up K3s for Rancher
        • Set up RKE Kubernetes
        • Infrastructure Tutorials
          • Set up Infrastructure for a High Availability K3s Kubernetes Cluster
          • Set up Infrastructure for a High Availability RKE Kubernetes Cluster
          • Setting up Nodes in Amazon EC2
          • Setting up a MySQL Database in Amazon RDS
          • Setting up an NGINX Load Balancer
          • Setting up Amazon ELB Network Load Balancer
      • Upgrading Cert-Manager
        • Upgrading Cert-Manager with Helm 2
      • Updating the Rancher Certificate
      • Enabling Experimental Features
        • Allow Unsupported Storage Drivers
        • UI for Istio Virtual Services and Destination Rules
      • Rancher Helm Chart Options
      • Setting up Local System Charts for Air Gapped Installations
      • Troubleshooting the Rancher Server Kubernetes Cluster
      • Advanced
        • Kubernetes Installation Using Helm 2
          • 1. Create Nodes and Load Balancer
            • NGINX
            • Amazon NLB
          • 2. Install Kubernetes with RKE
            • Troubleshooting
          • Initialize Helm: Install the Tiller Service
            • Troubleshooting
          • 4. Install Rancher
            • Adding Kubernetes TLS Secrets
            • Chart Options
            • Troubleshooting
          • RKE Add-On Install
            • Kubernetes Install with External Load Balancer (TCP/Layer 4)
              • Amazon NLB Configuration
            • Kubernetes Install with External Load Balancer (HTTPS/Layer 7)
              • Amazon ALB Configuration
              • NGINX Configuration
            • HTTP Proxy Configuration
            • Enable API Auditing
            • Troubleshooting HA RKE Add-On Install
              • Generic troubleshooting
              • Failed to get job complete status
              • 404 - default backend
        • Opening Ports with firewalld
        • Installing Rancher in an Air Gapped Environment with Helm 2
          • 1. Prepare your Node(s)
          • 2. Collect and Publish Images to your Private Registry
          • 3. Install Kubernetes with RKE (Kubernetes Installs Only)
          • 4. Install Rancher
        • Tuning etcd for Large Installations
        • Running on ARM64 (Experimental)
        • Enabling the API Audit Log to Record System Events
        • cluster.yml Templates for RKE add-on installs
          • Template for an RKE Cluster with a Self-signed Certificate and Layer 4 Load Balancer
          • Template for an RKE Cluster with a Certificate Signed by Recognized CA and a Layer 4 Load Balancer
          • Template for an RKE Cluster with a Self-signed Certificate and SSL Termination on Layer 7 Load Balancer
          • Template for an RKE Cluster with a Recognized CA Certificate and SSL Termination on Layer 7 Load Balancer
        • Docker Install with TLS Termination at Layer-7 NGINX Load Balancer
        • Rke-add-on
          • Kubernetes Install with External Load Balancer (TCP/Layer 4)
          • Kubernetes Install with External Load Balancer (HTTPS/Layer 7)
  • Best Practices Guide
    • Rancher Deployment Strategies
    • Tips for Running Rancher
    • Tips for Setting Up Containers
    • Tips for Scaling, Security and Reliability
  • Backups and Disaster Recovery
    • Backup
      • K3s Installs
      • RKE Installs
      • Docker Installs
    • Restore
      • K3s Installs
      • RKE Installs
        • Rolling back to v2.0.0-v2.1.5
      • Docker Installs
  • Authentication, Permissions and Global Configuration
    • Configuring a Global Default Private Registry
    • Authentication
      • Users and Groups
      • Local Authentication
      • Configuring Active Directory (AD)
      • Configuring OpenLDAP
        • OpenLDAP Configuration Reference
      • Configuring FreeIPA
      • Configuring Azure AD
      • Configuring GitHub
      • Configuring Keycloak (SAML)
      • Configuring PingIdentity (SAML)
      • Configuring Microsoft Active Directory Federation Service (SAML)
        • 1. Configuring Microsoft AD FS for Rancher
        • 2. Configuring Rancher for Microsoft AD FS
      • Configuring Okta (SAML)
      • Configuring Shibboleth (SAML)
        • Group Permissions with Shibboleth and OpenLDAP
      • Configuring Google OAuth
    • Role-Based Access Control (RBAC)
      • Global Permissions
      • Cluster and Project Roles
      • Custom Roles
      • Locked Roles
    • Upgrading Kubernetes without Upgrading Rancher
    • Pod Security Policies
    • Provisioning Drivers
      • Cluster Drivers
      • Node Drivers
    • RKE Templates
      • Example Scenarios
      • Template Creator Permissions
      • Access and Sharing
      • Creating and Revising Templates
      • Template Enforcement
      • Overriding Template Settings
      • Applying Templates
      • Example YAML
      • RKE Templates and Infrastructure
  • Setting up Kubernetes Clusters in Rancher
    • Node Requirements for Rancher Managed Clusters
    • Checklist for Production-Ready Clusters
      • Recommended Cluster Architecture
      • Roles for Nodes in Kubernetes
    • Setting up Clusters from Hosted Kubernetes Providers
      • Google Kubernetes Engine
      • Amazon EKS
      • Azure Kubernetes Service
      • Alibaba Cloud Container Service for Kubernetes
      • Tencent Kubernetes Engine
      • Huawei Cloud Kubernetes Service
    • Launching Kubernetes with Rancher
      • Launching Kubernetes on New Nodes in an Infrastructure Provider
        • Amazon EC2
          • EC2 Node Template Configuration
        • DigitalOcean
          • DigitalOcean Node Template Configuration
        • Azure
          • Azure Node Template Configuration
        • vSphere
          • Provisioning Kubernetes Clusters in vSphere
          • VSphere Node Template Configuration
            • v2.3.3
            • v2.3.0
            • v2.2.0
            • v2.0.4
            • Before v2.0.4
          • Creating Credentials in the vSphere Console
      • Launching Kubernetes on Existing Custom Nodes
        • Rancher Agent Options
      • Launching Kubernetes on Windows Clusters
        • Configuration for Storage Classes in Azure
        • Networking Requirements for Host Gateway (L2bridge)
        • v2.1.x and v2.2.x Windows Documentation (Experimental)
      • RKE Cluster Configuration Reference
        • Assigning Pod Security Policies
      • Setting up Cloud Providers
        • Setting up the Amazon Cloud Provider
        • Setting up the Azure Cloud Provider
        • Setting up the Google Compute Engine Cloud Provider
        • Setting up the vSphere Cloud Provider
      • Rancher Agents
    • Importing Existing Clusters
  • Cluster Administration
    • Cluster Access
      • Access a Cluster with Kubectl and kubeconfig
      • How the Authorized Cluster Endpoint Works
      • Adding Users to Clusters
    • Cluster Autoscaler
      • Cluster Autoscaler with AWS EC2 Auto Scaling Groups
    • Upgrading and Rolling Back Kubernetes
    • Adding a Pod Security Policy
    • Cluster Configuration
    • Nodes and Node Pools
    • Kubernetes Persistent Storage: Volumes and Storage Classes
      • How Persistent Storage Works
      • Setting up Existing Storage
      • Dynamically Provisioning New Storage in Rancher
      • Provisioning Storage Examples
        • Creating Persistent Storage in Amazon's EBS
        • NFS Storage
        • vSphere Storage
      • GlusterFS Volumes
      • iSCSI Volumes
    • Projects and Kubernetes Namespaces with Rancher
    • Tools for Logging, Monitoring, and More
      • Monitoring
        • Prometheus Configuration
        • Project Monitoring
        • Viewing Metrics
        • Cluster Metrics
        • Prometheus Expressions
        • Prometheus Custom Metrics Adapter
      • Alerts
        • Default Alerts for Cluster Monitoring
      • Logging
        • Elasticsearch
        • Splunk
        • Kafka
        • Syslog
        • Fluentd
      • Notifiers
      • Istio
        • CPU and Memory Allocations
        • Setup Guide
          • 1. Enable Istio in the Cluster
            • Enable Istio with Pod Security Policies
          • 2. Enable Istio in a Namespace
          • 3. Select the Nodes Where Istio Components Will be Deployed
          • 4. Add Deployments and Services with the Istio Sidecar
          • 5. Set up the Istio Gateway
          • 6. Set up Istio's Components for Traffic Management
          • 7. Generate and View Traffic
        • Role-based Access Control
        • Disabling Istio
        • Release Notes
      • OPA Gatekeeper
      • CIS Scans
        • Skipped and Not Applicable Tests
    • Cloning Clusters
    • Certificate Rotation
    • Backing up a Cluster
    • Restoring a Cluster from Backup
    • Removing Kubernetes Components from Nodes
  • Project Administration
    • Adding Users to Projects
    • Project Resource Quotas
      • How Resource Quotas Work in Rancher Projects
      • Overriding the Default Limit for a Namespace
      • Setting Container Default Resource Limits
      • Resource Quota Type Reference
    • Namespaces
    • Tools for Logging, Monitoring, and More
      • Project Alerts
      • Project Logging
    • Rancher's CI/CD Pipelines
    • Pod Security Policies
  • Pipelines
    • Concepts
    • Pipeline Configuration Reference
    • Example Repositories
    • Example YAML File
    • Configuring Persistent Data for Pipeline Components
    • v2.0.x Pipeline Documentation
  • Helm Charts in Rancher
    • Enabling and Disabling Built-in Global Catalogs
    • Creating Custom Catalogs
    • Custom Catalog Configuration Reference
    • Creating Catalog Apps
    • Managing Catalog Apps
    • Multi-Cluster Apps
    • Launching Catalog Apps
    • Tutorial: Example Custom Chart Creation
    • Global DNS
  • Deploying Applications across Clusters
  • Kubernetes Resources
    • Kubernetes Workloads and Pods
      • Deploying Workloads
      • Rolling Back Workloads
      • Upgrading Workloads
      • Adding a Sidecar
    • The Horizontal Pod Autoscaler
      • Background Information on HPAs
      • Managing HPAs with the Rancher UI
      • Managing HPAs with kubectl
      • Testing HPAs with kubectl
      • Manual HPA Installation for Clusters Created Before Rancher v2.0.7
    • Set Up Load Balancer and Ingress Controller within Rancher
      • Layer 4 and Layer 7 Load Balancing
      • Adding Ingresses to Your Project
    • Service Discovery
    • Encrypting HTTP Communication
    • ConfigMaps
    • Secrets
    • Kubernetes Registry and Docker Registry
  • Security
    • Rancher v2.4
      • Hardening Guide v2.4
      • CIS Benchmark Rancher Self-Assessment Guide - v2.4
    • Rancher v2.3.x
      • Rancher v2.3.5
        • Hardening Guide v2.3.5
        • CIS Benchmark Rancher Self-Assessment Guide - v2.3.5
      • Rancher v2.3.3
        • Hardening Guide v2.3.3
        • CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.3
      • Rancher v2.3.0
        • Hardening Guide v2.3
        • CIS Benchmark Rancher Self-Assessment Guide v2.3
    • Rancher v2.2
      • Hardening Guide v2.2
      • CIS Benchmark Rancher Self-Assessment Guide v2.2
    • Rancher v2.1
      • Hardening Guide v2.1
      • CIS Benchmark Rancher Self-Assessment Guide v2.1
    • Security Scans
    • Rancher CVEs and Resolutions
  • Using the Rancher Command Line Interface
  • System Tools
  • User Settings
    • API Keys
    • Managing Node Templates
    • Managing Cloud Credentials
    • User Preferences
  • API
    • API Tokens
  • FAQ
    • Questions about Upgrading to Rancher v2.x
    • Installing and Configuring kubectl
    • Networking
      • Container Network Interface (CNI) Providers
    • Technical
    • Security
    • Telemetry
    • Rancher is No Longer Needed
  • Troubleshooting
    • Kubernetes Components
      • Troubleshooting etcd Nodes
      • Troubleshooting Controlplane Nodes
      • Troubleshooting nginx-proxy
      • Troubleshooting Worker Nodes and Generic Components
    • Kubernetes resources
    • Networking
    • DNS
    • Rancher HA
    • Imported clusters
    • Logging
  • Contributing to Rancher
  • Migrating from v1.6 to v2.x
    • Kubernetes Introduction
    • 1. Get Started
    • 2. Migrate Your Services
      • Migration Tools CLI Reference
    • 3. Expose Your Services
    • 4. Configure Health Checks
    • 5. Schedule Your Services
    • 6. Service Discovery
    • 7. Load Balancing
? Need Help?  Get free intro and advanced online training ×
Get the Latest News
Connect with us
  • Twitter Link
  • Linkedin Link
  • Facebook Link
  • Youtube Link
  • Github Link
  • Slack Link
  • Products
  • Rancher
  • Hosted Rancher
  • RKE
  • K3s
  • Longhorn
  • Experience
  • Online Meetups
  • Hands-on Workshops​
  • Kubernetes Master Classes
  • Forums
  • Slack
  • GitHub
  • Resources
  • Rancher 2.x Docs
  • RKE Docs
  • K3s Docs
  • Getting Started Guide
  • Why Kubernetes
  • Reporting Bugs in Rancher Documentation
  • © Copyright 2021 Rancher. All Rights Reserved.
  • Privacy Policy