From 0bbb2efb19d0da737a03948aef3bda2a7566b549 Mon Sep 17 00:00:00 2001 From: galal-hussein Date: Sat, 27 Apr 2019 00:00:57 +0200 Subject: [PATCH] Add Prefix Path documentation --- .../rke/latest/en/config-options/_index.md | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/content/rke/latest/en/config-options/_index.md b/content/rke/latest/en/config-options/_index.md index 0df26d39165..b1ad9fa6f07 100644 --- a/content/rke/latest/en/config-options/_index.md +++ b/content/rke/latest/en/config-options/_index.md @@ -18,6 +18,7 @@ There are several options that can be configured in cluster configuration option ### Configuring Kubernetes Cluster * [Cluster Name](#cluster-name) * [Kubernetes Version](#kubernetes-version) +* [Prefix Path](#prefix-path) * [System Images]({{< baseurl >}}/rke/latest/en/config-options/system-images/) * [Services]({{< baseurl >}}/rke/latest/en/config-options/services/) * [Extra Args and Binds and Environment Variables]({{< baseurl >}}/rke/latest/en/config-options/services/services-extras/) @@ -68,7 +69,7 @@ In case both `kubernetes_version` and [system images]({{< baseurl >}}/rke/latest Please refer to the [release notes](https://github.com/rancher/rke/releases) of the RKE version that you are running, to find the list of supported Kubernetes versions as well as the default Kubernetes version. -You can also list the supported versions and system images of specific version of RKE release with a quick command. +You can also list the supported versions and system images of specific version of RKE release with a quick command. ``` $ rke config --system-images --all @@ -81,14 +82,27 @@ INFO[0000] Generating images list for version [v1.12.6-rancher1-2]: ....... ``` -#### Using an unsupported Kubernetes version +#### Using an unsupported Kubernetes version -As of v0.2.0, if a version is defined in `kubernetes_version` and is not found in the specific list of supported Kubernetes versions, then RKE will error out. +As of v0.2.0, if a version is defined in `kubernetes_version` and is not found in the specific list of supported Kubernetes versions, then RKE will error out. -Prior to v0.2.0, if a version is defined in `kubernetes_version` and is not found in the specific list of supported Kubernetes versions, the default version from the supported list is used. +Prior to v0.2.0, if a version is defined in `kubernetes_version` and is not found in the specific list of supported Kubernetes versions, the default version from the supported list is used. If you want to use a different version from the supported list, please use the [system images]({{< baseurl >}}/rke/latest/en/config-options/system-images/) option. +### Prefix Path + +For some operating systems including ROS, and CoreOS, RKE stores its resources to a different prefix path, this prefix path is by default for these operating systems is: +``` +/opt/rke +``` +So `/etc/kubernetes` will be stored in `/opt/rke/etc/kubernetes` and `/var/lib/etcd` will be stored in `/opt/rke/var/lib/etcd` etc. + +To change the default prefix path for any cluster, you can use the following option in the cluster configuration file `cluster.yml`: +``` +prefix_path: /opt/custom_path +``` + ### Cluster Level SSH Key Path RKE connects to host(s) using `ssh`. Typically, each node will have an independent path for each ssh key, i.e. `ssh_key_path`, in the `nodes` section, but if you have a SSH key that is able to access **all** hosts in your cluster configuration file, you can set the path to that ssh key at the top level. Otherwise, you would set the ssh key path in the [nodes]({{< baseurl >}}/rke/latest/en/config-options/nodes/).