edits to etcd and heading updates

2026-09-24 20:18:18 +00:00 · 2018-06-19 22:36:31 -07:00
parent 5460d15e2e
commit 24553806be
3 changed files with 33 additions and 20 deletions
@@ -19,24 +19,24 @@ bastion_host:
  #   -----END RSA PRIVATE KEY-----
 ```

-### Bastion Host Options
+## Bastion Host Options

-#### Address
+### Address

 The `address` directive will be used to set the hostname or IP address of the bastion host. RKE must be able to connect to this address.

-#### SSH Port
+### SSH Port

 You specify which `port` to be used when connecting to the bastion host. The default port is `22`.

-#### SSH Users
+### SSH Users

 You specify the `user` to be used when connecting to this node.

-#### SSH Key Path
+### SSH Key Path

 You specify the path, i.e. `ssh_key_path`, for the SSH private key to be used when connecting to the bastion host.

-#### SSH Key
+### SSH Key

 Instead of setting the path to the SSH key, you can specify the actual key, i.e. `ssh_key`, to be used to connect to the bastion host.
@@ -34,43 +34,43 @@ nodes:
      app: ingress
 ```

-### Node Options
+## Node Options

 Within each node, there are multiple directives that can be used.

-#### Address
+### Address

 The `address` directive will be used to set the hostname or IP address of the node. RKE must be able to connect to this address.

-#### Internal Address
+### Internal Address

 The `internal_address` provides the ability to have nodes with multiple addresses set a specific address to use for inter-host communication on a private network. If the `internal_address` is not set, the `address` is used for inter-host communication.

-#### Overriding the Hostname
+### Overriding the Hostname

 The `hostname_override` is used to be able to provide a friendly name for RKE to use when registering the node in Kubernetes. This hostname doesn't need to be a routable address. If the `hostname_override` isn't set, then the `address` directive is used when registering the node in Kubernetes.

-> **Note:** When [cloud providers]({{< baseurl >}}/rke/v0.1.x/en/config-options/cloud-providers/) are configured, you may need to override the hostname in order to use the cloud provider correctly. 
+> **Note:** When [cloud providers]({{< baseurl >}}/rke/v0.1.x/en/config-options/cloud-providers/) are configured, you may need to override the hostname in order to use the cloud provider correctly.

-#### SSH Port
+### SSH Port

 In each node, you specify which `port` to be used when connecting to this node. The default port is `22`.

-#### SSH Users
+### SSH Users

 For each node, you specify the `user` to be used when connecting to this node. This user must be a member of the Docker group or allowed to write to the node's Docker socket.

-#### SSH Key Path
+### SSH Key Path

 For each node, you specify the path, i.e. `ssh_key_path`, for the SSH private key to be used when connecting to this node.

 > **Note:** If you have a private key that can be used across all nodes, you can set the [SSH key path at the cluster level]({{< baseurl >}}/rke/v0.1.x/en/config-options/#cluster-level-ssh-key-path). The SSH key path set in each node will always take precedence.

-#### SSH Key
+### SSH Key

 Instead of setting the path to the SSH key, you can alternatively specify the actual key, i.e. `ssh_key`, to be used to connect to the node.

-#### Kubernetes Roles
+### Kubernetes Roles

 You can specify the list of roles that you want the node to be as part of the Kubernetes cluster. Three roles are supported: `controlplane`, `etcd` and `worker`. Node roles are not mutually exclusive. It's possible to assign any combination of roles to any node. It's also possible to change a node's role using the upgrade process.

@@ -89,11 +89,11 @@ With this role, any workloads or pods that are deployed will land on these nodes

 > **Note:** Prior to v0.1.8, workloads/pods might have run on any nodes with `worker` or `controlplane` roles, but as of v0.1.8, they will only be deployed to any `worker` nodes.

-#### Docker Socket
+### Docker Socket

 If the Docker socket is different than the default, you can set the `docker_socket`. The default is `/var/run/docker.sock`

-#### Labels
+### Labels

 You have the ability to add an arbitrary map of labels for each node. It can be used when using the [ingress controller's]({{< baseurl >}}/rke/v0.1.x/en/config-options/ingress-controller/) `node_selector` option.

@@ -4,8 +4,9 @@ weight: 3000
 draft: true
 ---

+By default, RKE will launch etcd servers, but RKE also supports being able to use an external etcd. RKE only supports connecting to a TLS enabled etcd setup.

-RKE supports using external etcd instead of deploying etcd servers, to enable external etcd the following parameters should be populated:
+> **Note:** RKE will not accept having external etcd servers in conjunction with [nodes]({{< baseurl >}}/rke/v0.1.x/en/config-options/nodes/) with the `etcd` role.

 ```
 services:
@@ -27,4 +28,16 @@ services:
      -----END PRIVATE KEY-----
 ```

-Note that RKE only supports connecting to TLS enabled etcd setup, user can enable multiple endpoints in the `external_urls` field. RKE will not accept having external urls and nodes with `etcd` role at the same time, user should only specify either etcd role for servers or external etcd but not both.
+## External etcd options
+
+### Path
+
+The `path` defines the location of where the etcd cluster is on the endpoints.
+
+### External URLs
+
+The `external_urls` are the endpoints of where the etcd cluster is hosted. There can be multiple endpoints for the etcd cluster.
+
+### CA Cert/Cert/KEY
+
+The certificates and private keys used to authenticate and access the etcd service.