From f1eb13e30a28fc975de5a519c4f590351ae28421 Mon Sep 17 00:00:00 2001 From: Jussi Nummelin Date: Tue, 16 Jan 2024 20:24:08 +0200 Subject: [PATCH] Add external Etcd options to docs Signed-off-by: Jussi Nummelin --- docs/configuration.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 214e3572d373..782aa03a4412 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -137,12 +137,25 @@ spec: ### `spec.storage` -| Element | Description | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | Type of the data store (valid values:`etcd` or `kine`). **Note**: Type `etcd` will cause k0s to create and manage an elastic etcd cluster within the controller nodes. | -| `etcd.peerAddress` | Node address used for etcd cluster peering. | -| `etcd.extraArgs` | Map of key-values (strings) for any extra arguments to pass down to etcd process. | -| `kine.dataSource` | [kine](https://github.com/k3s-io/kine) datasource URL. | +| Element | Description | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `type` | Type of the data store (valid values:`etcd` or `kine`). **Note**: Type `etcd` will cause k0s to create and manage an elastic etcd cluster within the controller nodes. | +| `etcd.peerAddress` | Node address used for etcd cluster peering. | +| `etcd.extraArgs` | Map of key-values (strings) for any extra arguments to pass down to etcd process. | +| `kine.dataSource` | [kine](https://github.com/k3s-io/kine) datasource URL. | +| `etcd.externalCluster` | Configuration when etcd is externally managed, i.e. running on dedicated nodes. See [`spec.storage.etcd.externalCluster`](#specstorageetcdexternalcluster) | + +#### `spec.storage.etcd.externalCluster` + +k0s can also work with externally managed Etcd cluster. If this is configured, k0s will NOT set up etcd, it has to be managed manually. + +| Element | Description | +|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `endpoints` | Array of Etcd endpoints to use. | +| `etcdPrefix` | Prefix to use for this cluster. The same external Etcd cluster can be used for several k0s clusters, each prefixed with unique prefix to store data with. | +| `caFile` | CaFile is the host path to a file with Etcd cluster CA certificate. | +| `clientCertFile` | ClientCertFile is the host path to a file with TLS certificate for etcd client. | +| `clientKeyFile` | ClientKeyFile is the host path to a file with TLS key for etcd client. | ### `spec.network`