Skip to content

Add external Etcd options to docs #3937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jnummelin merged 1 commit into from
Jan 18, 2024
Merged

Add external Etcd options to docs #3937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down