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 selfsigned, must be signed by same CA as cattle server
    56.     tls.key: <BASE64_KEY>  # ssl key for ingress. If selfsigned, must be signed by same CA as cattle server
    57.   ---
    58.   apiVersion: v1
    59.   kind: Secret
    60.   metadata:
    61.     name: cattle-keys-server
    62.     namespace: cattle-system
    63.   type: Opaque
    64.   data:
    65.     cacerts.pem: <BASE64_CA>  # CA cert used to sign cattle server cert and key
    66.   ---
    67.   apiVersion: v1
    68.   kind: Service
    69.   metadata:
    70.     namespace: cattle-system
    71.     name: cattle-service
    72.     labels:
    73.       app: cattle
    74.   spec:
    75.     ports:
    76.     - port: 80
    77.       targetPort: 80
    78.       protocol: TCP
    79.       name: http
    80.     - port: 443
    81.       targetPort: 443
    82.       protocol: TCP
    83.       name: https
    84.     selector:
    85.       app: cattle
    86.   ---
    87.   apiVersion: extensions/v1beta1
    88.   kind: Ingress
    89.   metadata:
    90.     namespace: cattle-system
    91.     name: cattle-ingress-http
    92.     annotations:
    93.       nginx.ingress.kubernetes.io/proxy-connect-timeout: "30"
    94.       nginx.ingress.kubernetes.io/proxy-read-timeout: "1800"   # Max time in seconds for ws to remain shell window open
    95.       nginx.ingress.kubernetes.io/proxy-send-timeout: "1800"   # Max time in seconds for ws to remain shell window open
    96.   spec:
    97.     rules:
    98.     - host: <FQDN>  # FQDN to access cattle server
    99.       http:
    100.         paths:
    101.         - backend:
    102.             serviceName: cattle-service
    103.             servicePort: 80
    104.     tls:
    105.     - secretName: cattle-keys-ingress
    106.       hosts:
    107.       - <FQDN>      # FQDN to access cattle server
    108.   ---
    109.   kind: Deployment
    110.   apiVersion: extensions/v1beta1
    111.   metadata:
    112.     namespace: cattle-system
    113.     name: cattle
    114.   spec:
    115.     replicas: 1
    116.     template:
    117.       metadata:
    118.         labels:
    119.           app: cattle
    120.       spec:
    121.         serviceAccountName: cattle-admin
    122.         containers:
    123.         # Rancher install via RKE addons is only supported up to v2.0.8
    124.         - image: rancher/rancher:v2.0.8
    125.           imagePullPolicy: Always
    126.           name: cattle-server
    127.   #       env:
    128.   #       - name: HTTP_PROXY
    129.   #         value: "http://your_proxy_address:port"
    130.   #       - name: HTTPS_PROXY
    131.   #         value: "http://your_proxy_address:port"
    132.   #       - name: NO_PROXY
    133.   #         value: "localhost,127.0.0.1,0.0.0.0,10.43.0.0/16,your_network_ranges_that_dont_need_proxy_to_access"
    134.           livenessProbe:
    135.             httpGet:
    136.               path: /ping
    137.               port: 80
    138.             initialDelaySeconds: 60
    139.             periodSeconds: 60
    140.           readinessProbe:
    141.             httpGet:
    142.               path: /ping
    143.               port: 80
    144.             initialDelaySeconds: 20
    145.             periodSeconds: 10
    146.           ports:
    147.           - containerPort: 80
    148.             protocol: TCP
    149.           - containerPort: 443
    150.             protocol: TCP
    151.           volumeMounts:
    152.           - mountPath: /etc/rancher/ssl
    153.             name: cattle-keys-volume
    154.             readOnly: true
    155.         volumes:
    156.         - name: cattle-keys-volume
    157.           secret:
    158.             defaultMode: 420
    159.             secretName: cattle-keys-server