Prerequisites
Before installing Rancher, ensure your environment meets the following requirements:Supported Kubernetes Distributions
For installations covered under Rancher Support SLA, the target cluster must be one of:- RKE1 - Rancher Kubernetes Engine 1
- RKE2 - Rancher Kubernetes Engine 2
- K3s - Lightweight Kubernetes
- AKS - Azure Kubernetes Service
- EKS - Amazon Elastic Kubernetes Service
- GKE - Google Kubernetes Engine
Required Tools
- kubectl - Kubernetes command-line tool
- helm - Package management for Kubernetes (refer to Helm version requirements)
System Requirements
- Operating system and container runtime requirements
- Hardware requirements:
- CPU and Memory
- Ingress controller
- Disk storage
- Networking requirements:
- Node IP addresses
- Port requirements
Installation Steps
Choose the repository based on your version requirements:
rancher-latest- Latest stable releasesrancher-stable- Stable releases with extended testingrancher-alpha- Alpha/preview releases
helm install rancher rancher-latest/rancher \
--namespace cattle-system \
--set hostname=rancher.my.org
helm install rancher rancher-latest/rancher \
--namespace cattle-system \
--set hostname=rancher.my.org \
--set ingress.tls.source=letsEncrypt \
--set [email protected]
The production environment only allows registering a name 5 times per week. Use
letsEncrypt.environment=staging for testing.helm install rancher rancher-latest/rancher \
--namespace cattle-system \
--set hostname=rancher.my.org \
--set ingress.tls.source=secret
helm install rancher rancher-latest/rancher \
--namespace cattle-system \
--set hostname=rancher.my.org \
--set ingress.tls.source=secret \
--set privateCA=true
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.0/cert-manager.yaml
Waiting for deployment "rancher" rollout to finish: 0 of 3 updated replicas are available...
deployment "rancher" successfully rolled out
Common Configuration Options
Basic Options
| Parameter | Default | Description |
|---|---|---|
hostname | ” “ | Fully Qualified Domain Name for your Rancher Server |
ingress.tls.source | ”rancher” | Certificate source: rancher, letsEncrypt, or secret |
letsEncrypt.email | ” “ | Email address for Let’s Encrypt |
letsEncrypt.environment | ”production” | Let’s Encrypt environment: staging or production |
privateCA | false | Set to true if using a private CA-signed certificate |
replicas | 3 | Number of Rancher pod replicas |
bootstrapPassword | "" | Set a bootstrap password (random if empty) |
Advanced Options
| Parameter | Default | Description |
|---|---|---|
antiAffinity | ”preferred” | AntiAffinity rule for Rancher pods: preferred or required |
auditLog.enabled | false | Enable the Rancher audit logging system |
auditLog.level | 0 | API audit log level (0-3, with 3 most verbose) |
proxy | ” “ | HTTP[S] proxy server for Rancher |
noProxy | ”127.0.0.0/8,…” | Comma-separated list of addresses not to proxy |
resources | Pod resource requests and limits | |
systemDefaultRegistry | "" | Private registry for all system Docker images |
useBundledSystemChart | false | Use system-charts packaged with Rancher (air-gapped) |
ingress.ingressClassName | ” “ | Ingress class name if not using defaults |
Example: Custom Resource Limits
Example: Air-Gapped Installation
Saving Installation Options
Troubleshooting
If deployment exceeds the progress deadline:Gateway API Configuration
Rancher supports the Gateway API as an alternative to traditional Ingress controllers. This is useful for environments that use Gateway API for routing.Gateway API support requires the Gateway API CRDs to be installed in your cluster and a compatible Gateway controller (e.g., Istio, Envoy Gateway).
Resource Requirements
For production deployments, it’s recommended to set resource requests and limits to ensure stable performance:Host Network Mode
In some scenarios, Rancher needs to run with host networking enabled. This is particularly common in EKS clusters using non-VPC CNI plugins like Calico.Next Steps
- Configure high availability for production deployments
- Set up authentication providers
- Configure backup and disaster recovery
- Review best practices for running Rancher in production