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