Why Rancher?
Why Rancher?
Why Kubernetes?
What Rancher Adds to Kubernetes
The Rancher Difference
Products
Overview
Rancher
k3s
Rio
Request a demo
Customers
Illumina
Sling TV
EOC
Deutsche Bahn
See All Customer Stories
Community
Overview
Learning Paths
Training
Tutorials
Events
Online Meetups
Rancher Rodeos
Kubernetes Master Classes
Getting Started Guide
Forums
Slack
Github
Resources
Docs
Analyst Reports
White Papers
Ebooks
Videos
Podcasts
Blog
Projects
RancherOS
k3OS
Submariner
Longhorn
Company
About us
Partners
Press
Events
Careers
Blog
Docs
Support
Request a demo
Contact
Pricing
Get started
Docs
Request a demo
Pricing
Support
Contact
Why RANCHER?
Why Rancher?
Why Kubernetes?
What Rancher Adds to Kubernetes
The Rancher Difference
Products
Overview
Rancher
RKE
K3s
Rio
Request a demo
Customers
Featured
Illumina
Illumina Innovates with Rancher and Kubernetes
More Customers
Sling TV
EOC
Deutsche Bahn
See All Customer Stories
RESOURCES
Community
Community Overview
Getting Started Guide
Learning Paths
Introductory Training
Tutorials
Online Meetups
Hands-on Workshops
Kubernetes Master Classes
Content Library
Docs
Analyst Reports
White Papers
Ebooks
Videos
Podcasts
Blog
Projects
RancherOS
k3OS
Submariner
Longhorn
Join the Community
Forums
|
Slack
|
Github
Company
About us
Partners
Press
Events
Careers
Blog
Get started
Rancher 2.x
K3s
RKE
Rancher 2.x
Rancher 1.6
RancherOS
Networking
Overview
Architecture
Architecture Recommendations
Kubernetes Concepts
Rancher Deployment Quick Start Guides
CLI with Rancher
Deploying Rancher Server
DigitalOcean Quick Start
Rancher AWS Quick Start Guide
Vagrant Quick Start
Manual Quick Start
Deploying Workloads
Workload with Ingress Quick Start
Workload with NodePort Quick Start
Installing Rancher
Installation Requirements
Installing Docker
Port Requirements
About High-availability Installations
How to Install Rancher on a High-availability Kubernetes Cluster
1. Create Nodes and Load Balancer
Setting up an NGINX Load Balancer
Setting up an Amazon NLB Load Balancer
2. Install Kubernetes with RKE
Troubleshooting
3. Installing Rancher Using the Helm Kubernetes Package Manager
Other Installation Methods
Installing Rancher on a Single Node Using Docker
FAQ and Troubleshooting
Advanced Options for Single-node Installs
HTTP Proxy Configuration
Single Node Install with External Load Balancer
Installing Rancher in an Air Gapped Environment
1. Prepare your Node(s)
2. Collect and Publish Images to your Private Registry
3. Install Kubernetes with RKE (HA Installs Only)
4. Install Rancher
Resources, References, and Advanced Options
HA 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
HA Install with External Load Balancer (TCP/Layer 4)
Amazon NLB Configuration
HA 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
Tuning etcd for Large Installations
Choosing a Rancher Version
Adding TLS Secrets
Helm Chart Options for HA Installations
RKE Add-On Install
HA Install with External Load Balancer (TCP/Layer 4)
Amazon NLB Configuration
HA 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
Troubleshooting
Helm Version Requirements
About Custom CA Root Certificates
Setting up Local System Charts for Air Gapped Installations
Upgrading Cert-Manager
Upgrading Cert-Manager with Helm 2
Running on ARM64 (Experimental)
Enabling Experimental Features
Allow Unsupported Storage Drivers
UI for Istio Virtual Services and Destination Rules
Enabling the API Audit Log to Record System Events
TLS settings
Opening Ports with firewalld
Upgrades and Rollbacks
Upgrades
Single Node Upgrade
High Availability (HA) Upgrade
Migrating from an HA RKE Add-on Install
Upgrading to v2.0.7+ — Namespace Migration
Rollbacks
Single Node Rollback
High Availability (HA) Rollback
Backups and Disaster Recovery
Backups
Creating Backups—Single Node Installs
Creating Backups—High Availability Installs
Restorations
Singe Node Installs
Restoring Backups—High Availability Installs
Best Practices Guide
Rancher Deployment Strategies
Tips for Running Rancher
Tips for Setting Up Containers
Tips for Scaling, Security and Reliability
Global Configuration
Configuring a Global Default Private Registry
Authentication
Users and Groups
Local Authentication
Configuring Active Directory (AD)
Configuring OpenLDAP
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 Google OAuth
Roles 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 User Clusters
Checklist for Production-Ready Clusters
Recommended Cluster Architecture
Roles for Nodes in Kubernetes
Setting up Clusters from Hosted Kubernetes Providers
Google Container 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
DigitalOcean
Azure
vSphere
Provisioning Kubernetes Clusters in vSphere
Creating Credentials in the vSphere Console
Enabling Disk UUIDs in Node Templates
vSphere Node Template Configuration Reference
Launching Kubernetes on Existing Custom Nodes
Rancher Agent Options
Launching Kubernetes on Windows Clusters
Networking Requirements for Host Gateway (L2bridge)
v2.1.x and v2.2.x Windows Documentation (Experimental)
Cluster Configuration Reference
Setting up Cloud Providers
Assigning Pod Security Policies
Rancher Agents
Importing Existing Clusters into Rancher
Cluster Administration
Cluster Access
Configuring Access to Kubernetes Using A Kubeconfig File
Access a Cluster with Kubectl Shell or Kubectl CLI
Adding Users to Clusters
Upgrading 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 Visibility
Notifiers
Alerts
Default Alerts for Cluster Monitoring
Rancher Integration with Logging Services
Elasticsearch
Splunk
Kafka
Syslog
Fluentd
Integrating Rancher and Prometheus for Cluster Monitoring
Prometheus Configuration
Viewing Metrics
Cluster Metrics
Expression
Istio
CPU and Memory Allocations
Setup Guide
1. Enable Istio in the Cluster
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
Cloning Clusters
Certificate Rotation
Backing up etcd
Restoring etcd
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 Visibility
Alerts
Logging
Monitoring
Istio
Rancher's CI/CD Pipelines
v2.0.x Pipeline Documentation
Pod Security Policies
Kubernetes Resources, Registries and Pipelines
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
Pipelines
Example Repositories
Example YAML File
Secure Sockets Layer Certificate
ConfigMaps
Secrets
Kubernetes Registry and Docker Registry
Catalogs, Helm Charts and Apps
Built-in Global Catalogs
Custom Catalogs
Creating Custom Catalogs Apps
Adding Custom Catalogs
Multi-Cluster Apps
Apps in a Project
Global DNS
Using the Rancher Command Line Interface
System Tools
User Settings
API Keys
Managing Node Templates
Managing Cloud Credentials
User Preferences
API
API Tokens
Removing Rancher Server
Security
Security Scans
Hardening Guide - Rancher v2.3.3+
Hardening Guide - Rancher v2.3.x
Hardening Guide - Rancher v2.2.x
Hardening Guide - Rancher v2.1.x
CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.0-v2.3.2
CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.3+
CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.2.x
CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.1.x
FAQ
Questions about Upgrading to Rancher v2.x
Installing and Configuring kubectl
Networking
Container Network Interface (CNI) Providers
Technical
Security
Telemetry
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
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
Networking
Networking FAQ’s
CNI Providers
Edit this page