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