Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4b769ea
commit f759e87
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,30 @@ | ||
| # Providers Configurations | ||
|
|
||
| {{product}} bootstrap and control plane providers (CABPCK and CACPCK) | ||
| can be configured to aid the cluster admin in reaching the desired | ||
| state for the workload cluster. In this section we will go through | ||
| different configurations that each one of these providers expose. | ||
|
|
||
| ## Common Configurations | ||
|
|
||
| The following configurations are available for both bootstrap and control | ||
| plane providers. | ||
|
|
||
| ### `version` | ||
|
|
||
| **Type:** `string` | ||
|
|
||
| **Required:** yes | ||
|
|
||
| `version` is used to specify the {{product}} version installed on the nodes. | ||
|
|
||
| ```{note} | ||
| The {{product}} providers will install the latest patch in the `stable` risk | ||
| level by default, e.g. `1.30/stable`. Patch versions specified in this | ||
| configuration will be ignored. | ||
| To install a specific track or risk level, see | ||
| [Install custom {{product}} on machines] guide. | ||
| ``` | ||
|
|
||
| **Example Usage:** | ||
|
|
@@ -26,22 +34,24 @@ spec: | |
| ``` | ||
| ### `files` | ||
|
|
||
| **Type:** `struct` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `files` can be used to add new files to the machines or overwrite | ||
| existing files. | ||
|
|
||
| **Fields:** | ||
|
|
||
| | Name | Type | Description | Default | | ||
| |---------------|----------|-----------------------------------------------------------------------------------|---------| | ||
| | `path` | `string` | Where the file should be created | `""` | | ||
| | `content` | `string` | Content of the created file | `""` | | ||
| | `contentFrom` | `struct` | A reference to a secret containing the content of the file. Overwrites `content`. | `nil` | | ||
| | `permissions` | `string` | Permissions of the file to create, e.g. "0600" | `""` | | ||
| | `encoding` | `string` | Encoding of the file to create. One of `base64`, `gzip` and `gzip+base64` | `""` | | ||
| | `owner` | `string` | Owner of the file to create, e.g. "root:root" | `""` | | ||
|
|
||
| **Example Usage:** | ||
| - Using `content`: | ||
|
Check failure on line 57 in docs/src/capi/reference/configs.md
|
||
|
|
@@ -71,19 +81,21 @@ spec: | |
| ``` | ||
|
|
||
| ### `bootstrapConfig` | ||
|
|
||
| **Type:** `struct` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `bootstrapConfig` is configuration override to use upon bootstrapping | ||
| nodes. The structure of the `bootstrapConfig` is defined in the | ||
| [Bootstrap configuration file reference]. | ||
|
|
||
| **Fields:** | ||
|
|
||
| | Name | Type | Description | Default | | ||
| |---------------|----------|---------------------------------------------------------------|---------| | ||
| | `content` | `string` | Content of the file. If this is set, `contentFrom` is ignored | `""` | | ||
| | `contentFrom` | `struct` | A reference to a secret containing the content of the file | `nil` | | ||
|
|
||
| **Example Usage:** | ||
| - Using `content`: | ||
|
Check failure on line 101 in docs/src/capi/reference/configs.md
|
||
|
|
@@ -115,11 +127,13 @@ spec: | |
| ``` | ||
|
|
||
| ### `bootCommands` | ||
|
|
||
| **Type:** `[]string` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `bootCommands` specifies extra commands to run in cloud-init early in the | ||
| boot process. | ||
|
|
||
| **Example Usage:** | ||
| ```yaml | ||
|
|
@@ -131,14 +145,17 @@ spec: | |
|
|
||
| (preruncommands)= | ||
| ### `preRunCommands` | ||
|
|
||
| **Type:** `[]string` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `preRunCommands` specifies extra commands to run in cloud-init before | ||
| k8s-snap setup runs. | ||
|
|
||
| ```{note} | ||
| `preRunCommands` can also be used to install custom {{product}} versions | ||
| on machines. See [Install custom {{product}} on machines] guide for more info. | ||
| ``` | ||
|
|
||
| **Example Usage:** | ||
|
|
@@ -150,11 +167,13 @@ spec: | |
| ``` | ||
| ### `postRunCommands` | ||
|
|
||
| **Type:** `[]string` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `postRunCommands` specifies extra commands to run in cloud-init after | ||
| k8s-snap setup runs. | ||
|
|
||
| **Example Usage:** | ||
| ```yaml | ||
|
|
@@ -165,11 +184,16 @@ spec: | |
| ``` | ||
|
|
||
| ### `airGapped` | ||
|
|
||
| **Type:** `bool` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `airGapped` is used to signal that we are deploying to an air-gapped | ||
| environment. In this case, the provider will not attempt to install | ||
| k8s-snap on the machine. The user is expected to install k8s-snap | ||
| manually with [`preRunCommands`](#preruncommands), or provide an image | ||
| with k8s-snap pre-installed. | ||
|
|
||
| **Example Usage:** | ||
| ```yaml | ||
|
|
@@ -178,6 +202,7 @@ spec: | |
| ``` | ||
|
|
||
| ### `initConfig` | ||
|
|
||
| **Type:** `struct` | ||
|
|
||
| **Required:** no | ||
|
|
@@ -186,13 +211,13 @@ spec: | |
|
|
||
| **Fields:** | ||
|
|
||
| | Name | Type | Description | Default | | ||
| |------------------------------|---------------------|---------------------------------------------------------------|---------| | ||
| | `annotations` | `map[string]string` | Are used to configure the behaviour of the built-in features. | `nil` | | ||
| | `enableDefaultDNS` | `bool` | Specifies whether to enable the default DNS configuration. | `true` | | ||
| | `enableDefaultLocalStorage` | `bool` | Specifies whether to enable the default local storage. | `true` | | ||
| | `enableDefaultMetricsServer` | `bool` | Specifies whether to enable the default metrics server. | `true` | | ||
| | `enableDefaultNetwork` | `bool` | Specifies whether to enable the default CNI. | `true` | | ||
|
|
||
|
|
||
| **Example Usage:** | ||
|
|
@@ -208,11 +233,15 @@ spec: | |
| ``` | ||
|
|
||
| ### `nodeName` | ||
|
|
||
| **Type:** `string` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `nodeName` is the name to use for the kubelet of this node. It is needed | ||
| for clouds where the cloud-provider has specific pre-requisites about the | ||
| node names. It is typically set in Jinja template form, e.g. | ||
| `"{{ ds.meta_data.local_hostname }}"`. | ||
|
|
||
| **Example Usage:** | ||
| ```yaml | ||
|
|
@@ -222,14 +251,17 @@ spec: | |
|
|
||
| ## Control plane provider (CACPCK) | ||
|
|
||
| The following configurations are only available for the control plane | ||
| provider. | ||
|
|
||
| ### `replicas` | ||
|
|
||
| **Type:** `int32` | ||
|
|
||
| **Required:** no | ||
|
|
||
| `replicas` is the number of desired machines. Defaults to 1. When stacked | ||
| etcd is used only odd numbers are permitted, as per [etcd best practice]. | ||
|
|
||
| **Example Usage:** | ||
| ```yaml | ||
|
|
@@ -238,6 +270,7 @@ spec: | |
| ``` | ||
|
|
||
| ### `controlPlane` | ||
|
|
||
| **Type:** `struct` | ||
|
|
||
| **Required:** no | ||
|
|
@@ -246,17 +279,17 @@ spec: | |
|
|
||
| **Fields:** | ||
|
|
||
| | Name | Type | Description | Default | | ||
| |-----------------------------|-----------------------------|------------------------------------------------------------------------------------------------|-----------| | ||
| | `extraSANs` | `[]string` | A list of SANs to include in the server certificates. | `[]` | | ||
| | `cloudProvider` | `string` | The cloud-provider configuration option to set. | `""` | | ||
| | `nodeTaints` | `[]string` | Taints to add to the control plane kubelet nodes. | `[]` | | ||
| | `datastoreType` | `string` | The type of datastore to use for the control plane. | `""` | | ||
| | `datastoreServersSecretRef` | `struct{name:str, key:str}` | A reference to a secret containing the datastore servers. | `{}` | | ||
| | `k8sDqlitePort` | `int` | The port to use for k8s-dqlite. If unset, 2379 (etcd) will be used. | `2379` | | ||
| | `microclusterAddress` | `string` | The address (or CIDR) to use for MicroCluster. If unset, the default node interface is chosen. | `""` | | ||
| | `microclusterPort` | `int` | The port to use for MicroCluster. If unset, ":2380" (etcd peer) will be used. | `":2380"` | | ||
| | `extraKubeAPIServerArgs` | `map[string]string` | Extra arguments to add to kube-apiserver. | `map[]` | | ||
|
|
||
| **Example Usage:** | ||
| ```yaml | ||
|
|
||
