mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-15 21:44:24 +00:00
config options
This commit is contained in:
Denise Schannon
@@ -4,23 +4,46 @@ weight: 3000
|
||||
draft: true
|
||||
---
|
||||
|
||||
When setting up your cluster.yml for RKE, there are a lot of different options that can be configured to control RKE behavior.
|
||||
When setting up your `cluster.yml` for RKE, there are a lot of different options that can be configured to control the behavior of how RKE launches Kubernetes.
|
||||
|
||||
## Cluster options
|
||||
There are several options that can be configured in cluster configuration option. There are several [example yamls]({{< baseurl >}}/rke/v0.1.x/en/config-options/example-yamls/) that contain all the options.
|
||||
|
||||
#### Cluster Name
|
||||
### Configuring Nodes
|
||||
* [Nodes]({{< baseurl >}}/rke/v0.1.x/en/config-options/nodes/)
|
||||
* [Ignoring supported Docker versions](#supported-docker-versions)
|
||||
* [Private Registries]({{< baseurl >}}/rke/v0.1.x/en/config-options/private-registries/)
|
||||
* [Cluster Level SSH Key Path](#cluster-level-ssh-key-path)
|
||||
* [SSH Agent](#ssh-agent)
|
||||
* [Bastion Host]({{< baseurl >}}/rke/v0.1.x/en/config-options/bastion-host/)
|
||||
|
||||
`cluster_name` is an optional value that you can set to identify your cluster. The name will be set in your cluster's generated kubeconfig file.
|
||||
### Configuring Kubernetes Cluster
|
||||
* [Cluster Name](#cluster-name)
|
||||
* [Kubernetes Version](#kubernetes-version)
|
||||
* [System Images]({{< baseurl >}}/rke/v0.1.x/en/config-options/system-images/)
|
||||
* [Services]({{< baseurl >}}/rke/v0.1.x/en/config-options/services/)
|
||||
* [External Etcd]({{< baseurl >}}/rke/v0.1.x/en/config-options/services/external-etcd/)
|
||||
* [Extra Args and Binds]({{< baseurl >}}/rke/v0.1.x/en/config-options/services/extra-args-and-binds/)
|
||||
* [Add-ons]({{< baseurl >}}/rke/v0.1.x/en/config-options/add-ons/)
|
||||
* [Add-ons Jobs Timeout](#add-ons-jobs-timeout)
|
||||
* [Authentication]({{< baseurl >}}/rke/v0.1.x/en/config-options/authentication/)
|
||||
* [Authorization]({{< baseurl >}}/rke/v0.1.x/en/config-options/authorization/)
|
||||
* [Cloud Providers]({{< baseurl >}}/rke/v0.1.x/en/config-options/cloud-providers/)
|
||||
* [Network Plugins]({{< baseurl >}}/rke/v0.1.x/en/config-options/network-plugins/)
|
||||
* [Ingress Controller]({{< baseurl >}}/rke/v0.1.x/en/config-options/ingress-controller/)
|
||||
|
||||
The default value for this option is `local`.
|
||||
## Cluster Level Options
|
||||
|
||||
### Cluster Name
|
||||
|
||||
By default, the name of your cluster will be `local`. If you want a different name, you would use the `cluster_name` directive to change the name of your cluster. The name will be set in your cluster's generated kubeconfig file.
|
||||
|
||||
```yaml
|
||||
cluster_name: mycluster
|
||||
|
||||
```
|
||||
|
||||
#### Supported Docker Versions
|
||||
By default, RKE will check the installed Docker version on all hosts and fail with an error if the version is not supported by Kubernetes. To override this behavior, set this option to `true`.
|
||||
### Supported Docker Versions
|
||||
|
||||
By default, RKE will check the installed Docker version on all hosts and fail with an error if the version is not supported by Kubernetes. The list of [supported Docker versions](https://github.com/rancher/rke/blob/master/docker/docker.go#L29) are set specifically for each Kubernetes version. To override this behavior, set this option to `true`.
|
||||
|
||||
The default value is `false`.
|
||||
|
||||
@@ -28,25 +51,9 @@ The default value is `false`.
|
||||
ignore_docker_version: true
|
||||
```
|
||||
|
||||
#### 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.
|
||||
### Kubernetes Version
|
||||
|
||||
If both cluster-level and node-level ssh keys are defined, the node-level key will take precedence.
|
||||
```yaml
|
||||
ssh_key_path: ~/.ssh/test
|
||||
```
|
||||
|
||||
#### SSH Agent
|
||||
|
||||
RKE supports using ssh connection configuration from a local ssh agent. The default value for this option is `false`.
|
||||
|
||||
```yaml
|
||||
ssh_agent_auth: true
|
||||
```
|
||||
|
||||
#### Kubernetes Version
|
||||
|
||||
Use this option to choose Kubernetes version to install. Since this option was added mainly to be used by Rancher v2.0, it has a limited number of supported tags:
|
||||
You can select which version of Kubernetes to install for your cluster. These options are the Kubernetes versions made available in Rancher v2.x. The current default Kubernetes version used by RKE is `v1.10.3-rancher2-1`. If a version is defined in `kubernetes_version` and is not found in this list, the default is used.
|
||||
|
||||
|Kubernetes version|
|
||||
|-----------------|
|
||||
@@ -58,21 +65,39 @@ Use this option to choose Kubernetes version to install. Since this option was a
|
||||
|v1.8.11-rancher2-1|
|
||||
|v1.8.10-rancher1-1|
|
||||
|
||||
The current default Kubernetes version used by RKE is `v1.10.3-rancher2-1`. If a version is defined in `kubernetes_version` and is not found in this list, the default is used.
|
||||
|
||||
There are two ways to select a Kubernetes version:
|
||||
|
||||
- Using the kubernetes image defined in [System Images](#rke-system-images)
|
||||
- Using the configuration option `kubernetes_version`
|
||||
- Using the Kubernetes image defined in [system images](#rke-system-images)
|
||||
- Using the configuration option `kubernetes_version` in
|
||||
|
||||
```yaml
|
||||
kubernetes_version: "v1.10.3-rancher2-1"
|
||||
```
|
||||
|
||||
In case both are defined, the system images configuration will take precedence over `kubernetes_version`.
|
||||
|
||||
### 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/v0.1.x/en/config-options/nodes/).
|
||||
|
||||
#### Addons Job Timeout
|
||||
If ssh key paths are defined at the cluster level and at the node level, the node-level key will take precedence.
|
||||
|
||||
RKE kubernetes add-ons are deployed using kubernetes jobs. RKE will give up on trying to get the job status after this timeout in seconds. The default timeout value is `30` seconds.
|
||||
```yaml
|
||||
ssh_key_path: ~/.ssh/test
|
||||
```
|
||||
|
||||
### SSH Agent
|
||||
|
||||
RKE supports using ssh connection configuration from a local ssh agent. The default value for this option is `false`. If you want to set using a local ssh agent, you would set this to `true`.
|
||||
|
||||
```yaml
|
||||
ssh_agent_auth: true
|
||||
```
|
||||
|
||||
### Add-ons Job Timeout
|
||||
|
||||
You can define [add-ons]({{< baseurl >}}/rke/v0.1.x/en/config-options/add-ons/) to be deployed after the Kubernetes cluster comes up, which uses Kubernetes [jobs](https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/). RKE will stop attempting to retrieve the job status after the timeout, which is in seconds. The default timeout value is `30` seconds.
|
||||
|
||||
```yaml
|
||||
addon_job_timeout: 30
|
||||
```
|
||||
<!--add in sections for each option with high level description and link-->
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
---
|
||||
title: Kubernetes Services
|
||||
weight: 3000
|
||||
weight: 3025
|
||||
draft: true
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user