Skip to content

Commit

Permalink
Prettify tables and fix lint
Browse files Browse the repository at this point in the history
  • Loading branch information
@HomayoonAlimohammadi
HomayoonAlimohammadi committed Jan 9, 2025
1 parent 4b769ea commit a633605
Showing 1 changed file with 95 additions and 46 deletions.
141 changes: 95 additions & 46 deletions docs/src/capi/reference/configs.md
View file
Original file line number Diff line number Diff line change
@@ -1,50 +1,63 @@
# 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.
{{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.
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.
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.
To install a specific track or risk level, see
[Install custom {{product}} on machines] guide.
```

**Example Usage:**

```yaml
spec:
version: 1.30
```
### `files`

**Type:** `struct`

**Required:** no

`files` can be used to add new files to the machines or overwrite existing files.
`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" | `""` |
| 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`:

```yaml
spec:
files:
Expand All @@ -55,7 +68,9 @@ spec:
permissions: "0500"
owner: root:root
```

- Using `contentFrom`:

```yaml
spec:
files:
Expand All @@ -71,22 +86,26 @@ 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].
`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` |
| 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`:

```yaml
spec:
bootstrapConfig:
Expand All @@ -102,7 +121,9 @@ spec:
load-balancer:
enabled: true
```

- Using `contentFrom`:

```yaml
spec:
bootstrapConfig:
Expand All @@ -115,33 +136,39 @@ spec:
```

### `bootCommands`

**Type:** `[]string`

**Required:** no

`bootCommands` specifies extra commands to run in cloud-init early in the boot process.
`bootCommands` specifies extra commands to run in cloud-init early in the
boot process.

**Example Usage:**

```yaml
spec:
bootCommands:
- echo "first-command"
- echo "second-command"
```

(preruncommands)=
### `preRunCommands`

**Type:** `[]string`

**Required:** no

`preRunCommands` specifies extra commands to run in cloud-init before k8s-snap setup runs.
`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.
`preRunCommands` can also be used to install custom {{product}} versions
on machines. See [Install custom {{product}} on machines] guide for more info.
```

**Example Usage:**

```yaml
spec:
preRunCommands:
Expand All @@ -150,13 +177,16 @@ spec:
```
### `postRunCommands`

**Type:** `[]string`

**Required:** no

`postRunCommands` specifies extra commands to run in cloud-init after k8s-snap setup runs.
`postRunCommands` specifies extra commands to run in cloud-init after
k8s-snap setup runs.

**Example Usage:**

```yaml
spec:
postRunCommands:
Expand All @@ -165,19 +195,26 @@ 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.
`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
spec:
airGapped: true
```

### `initConfig`

**Type:** `struct`

**Required:** no
Expand All @@ -186,16 +223,17 @@ 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` |
| 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:**

```yaml
spec:
initConfig:
Expand All @@ -208,36 +246,46 @@ 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 }}"`.
`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
spec:
nodeName: "{{ ds.meta_data.local_hostname }}"
```

## Control plane provider (CACPCK)

The following configurations are only available for the control plane provider.
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].
`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
spec:
replicas: 2
```

### `controlPlane`

**Type:** `struct`

**Required:** no
Expand All @@ -246,19 +294,20 @@ 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[]` |
| 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
spec:
controlPlane:
Expand Down

0 comments on commit a633605

Please sign in to comment.