RKE uses a cluster.yml file to install and configure your Kubernetes cluster.

    This template is 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.

    The following template can be used for the cluster.yml if you have a setup with:

    For more options, refer to RKE Documentation: Config Options.

    1. nodes:
    2.   - address: <IP> # hostname or IP to access nodes
    3.     user: <USER> # root user (usually 'root')
    4.     role: [controlplane,etcd,worker] # K8s roles for node
    5.     ssh_key_path: <PEM_FILE> # path to PEM file
    6.   - address: <IP>
    7.     user: <USER>
    8.     role: [controlplane,etcd,worker]
    9.     ssh_key_path: <PEM_FILE>
    10.   - address: <IP>
    11.     user: <USER>
    12.     role: [controlplane,etcd,worker]
    13.     ssh_key_path: <PEM_FILE>
    15. services:
    16.   etcd:
    17.     snapshot: true
    18.     creation: 6h
    19.     retention: 24h
    21. addons: |-
    22.   ---
    23.   kind: Namespace
    24.   apiVersion: v1
    25.   metadata:
    26.     name: cattle-system
    27.   ---
    28.   kind: ServiceAccount
    29.   apiVersion: v1
    30.   metadata:
    31.     name: cattle-admin
    32.     namespace: cattle-system
    33.   ---
    34.   kind: ClusterRoleBinding
    35.   apiVersion: rbac.authorization.k8s.io/v1
    36.   metadata:
    37.     name: cattle-crb
    38.     namespace: cattle-system
    39.   subjects:
    40.   - kind: ServiceAccount
    41.     name: cattle-admin
    42.     namespace: cattle-system
    43.   roleRef:
    44.     kind: ClusterRole
    45.     name: cluster-admin
    46.     apiGroup: rbac.authorization.k8s.io
    47.   ---
    48.   apiVersion: v1
    49.   kind: Secret
    50.   metadata:
    51.     name: cattle-keys-ingress
    52.     namespace: cattle-system
    53.   type: Opaque
    54.   data:
    55.     tls.crt: <BASE64_CRT>  # ssl cert for ingress. If self-signed, must be signed by same CA as cattle server
    56.     tls.key: <BASE64_KEY>  # ssl key for ingress. If self-signed, must be signed by same CA as cattle server
    57.   ---
    58.   apiVersion: v1
    59.   kind: Service
    60.   metadata:
    61.     namespace: cattle-system
    62.     name: cattle-service
    63.     labels:
    64.       app: cattle
    65.   spec:
    66.     ports:
    67.     - port: 80
    68.       targetPort: 80
    69.       protocol: TCP
    70.       name: http
    71.     - port: 443
    72.       targetPort: 443
    73.       protocol: TCP
    74.       name: https
    75.     selector:
    76.       app: cattle
    77.   ---
    78.   apiVersion: extensions/v1beta1
    79.   kind: Ingress
    80.   metadata:
    81.     namespace: cattle-system
    82.     name: cattle-ingress-http
    83.     annotations:
    84.       nginx.ingress.kubernetes.io/proxy-connect-timeout: "30"
    85.       nginx.ingress.kubernetes.io/proxy-read-timeout: "1800"   # Max time in seconds for ws to remain shell window open
    86.       nginx.ingress.kubernetes.io/proxy-send-timeout: "1800"   # Max time in seconds for ws to remain shell window open
    87.   spec:
    88.     rules:
    89.     - host: <FQDN>  # FQDN to access cattle server
    90.       http:
    91.         paths:
    92.         - backend:
    93.             serviceName: cattle-service
    94.             servicePort: 80
    95.     tls:
    96.     - secretName: cattle-keys-ingress
    97.       hosts:
    98.       - <FQDN>      # FQDN to access cattle server
    99.   ---
    100.   kind: Deployment
    101.   apiVersion: extensions/v1beta1
    102.   metadata:
    103.     namespace: cattle-system
    104.     name: cattle
    105.   spec:
    106.     replicas: 1
    107.     template:
    108.       metadata:
    109.         labels:
    110.           app: cattle
    111.       spec:
    112.         serviceAccountName: cattle-admin
    113.         containers:
    114.         # Rancher install via RKE addons is only supported up to v2.0.8
    115.         - image: rancher/rancher:v2.0.8
    116.           args:
    117.           - --no-cacerts
    118.           imagePullPolicy: Always
    119.           name: cattle-server
    120.   #       env:
    121.   #       - name: HTTP_PROXY
    122.   #         value: "http://your_proxy_address:port"
    123.   #       - name: HTTPS_PROXY
    124.   #         value: "http://your_proxy_address:port"
    125.   #       - name: NO_PROXY
    126.   #         value: "localhost,127.0.0.1,0.0.0.0,10.43.0.0/16,your_network_ranges_that_dont_need_proxy_to_access"
    127.           livenessProbe:
    128.             httpGet:
    129.               path: /ping
    130.               port: 80
    131.             initialDelaySeconds: 60
    132.             periodSeconds: 60
    133.           readinessProbe:
    134.             httpGet:
    135.               path: /ping
    136.               port: 80
    137.             initialDelaySeconds: 20
    138.             periodSeconds: 10
    139.           ports:
    140.           - containerPort: 80
    141.             protocol: TCP
    142.           - containerPort: 443
    143.             protocol: TCP