Merge pull request #3937 from jnummelin/docs/external-etcd

Add external Etcd options to docs
k0sproject · Jan 18, 2024 · 9cee4a9 · 9cee4a9
2 parents a189bf9 + f1eb13e
commit 9cee4a9
Showing 1 changed file with 19 additions and 6 deletions.
diff --git 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`