Skip to content

Commit

Permalink
Docs refresh 1.31 (#811)
Browse files Browse the repository at this point in the history
* update content for 1.31

* bump install command
  • Loading branch information
evilnick authored Nov 18, 2024
1 parent 5cc306c commit 5556d56
Show file tree
Hide file tree
Showing 87 changed files with 4,898 additions and 752 deletions.
485 changes: 485 additions & 0 deletions docs/src/_parts/bootstrap_config.md

Large diffs are not rendered by default.

152 changes: 152 additions & 0 deletions docs/src/_parts/control_plane_join_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
### extra-sans
**Type:** `[]string`<br>

List of extra SANs to be added to certificates.

### front-proxy-client-crt
**Type:** `string`<br>

The client certificate to be used for the front proxy.
If omitted defaults to an auto generated certificate.

### front-proxy-client-key
**Type:** `string`<br>

The client key to be used for the front proxy.
If omitted defaults to an auto generated key.

### kube-proxy-client-crt
**Type:** `string`<br>

The client certificate to be used by kubelet for communicating with the kube-apiserver.
If omitted defaults to an auto generated certificate.

### kube-proxy-client-key
**Type:** `string`<br>

The client key to be used by kubelet for communicating with the kube-apiserver.
If omitted defaults to an auto generated key.

### kube-scheduler-client-crt
**Type:** `string`<br>

The client certificate to be used for the kube-scheduler.
If omitted defaults to an auto generated certificate.

### kube-scheduler-client-key
**Type:** `string`<br>

The client key to be used for the kube-scheduler.
If omitted defaults to an auto generated key.

### kube-controller-manager-client-crt
**Type:** `string`<br>

The client certificate to be used for the Kubernetes controller manager.
If omitted defaults to an auto generated certificate.

### kube-controller-manager-client-key
**Type:** `string`<br>

The client key to be used for the Kubernetes controller manager.
If omitted defaults to an auto generated key.

### apiserver-crt
**Type:** `string`<br>

The certificate to be used for the kube-apiserver.
If omitted defaults to an auto generated certificate.

### apiserver-key
**Type:** `string`<br>

The key to be used for the kube-apiserver.
If omitted defaults to an auto generated key.

### kubelet-crt
**Type:** `string`<br>

The certificate to be used for the kubelet.
If omitted defaults to an auto generated certificate.

### kubelet-key
**Type:** `string`<br>

The key to be used for the kubelet.
If omitted defaults to an auto generated key.

### kubelet-client-crt
**Type:** `string`<br>

The client certificate to be used for the kubelet.
If omitted defaults to an auto generated certificate.

### kubelet-client-key
**Type:** `string`<br>

The client key to be used for the kubelet.
If omitted defaults to an auto generated key.

### extra-node-config-files
**Type:** `map[string]string`<br>

Additional files that are uploaded `/var/snap/k8s/common/args/conf.d/<filename>`
to a node on bootstrap. These files can then be referenced by Kubernetes
service arguments.

The format is `map[<filename>]<filecontent>`.

### extra-node-kube-apiserver-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to the `kube-apiserver` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-kube-controller-manager-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to the `kube-controller-manager` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-kube-scheduler-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to the `kube-scheduler` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-kube-proxy-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to the `kube-proxy` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-kubelet-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to the `kubelet` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-containerd-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to `containerd` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-k8s-dqlite-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to `k8s-dqlite` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-containerd-config
**Type:** `apiv1.MapStringAny`<br>

Extra configuration for the containerd config.toml

3 changes: 3 additions & 0 deletions docs/src/_parts/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```
sudo snap install k8s --classic --channel=1.31/stable
```
5 changes: 0 additions & 5 deletions docs/src/_parts/template-explanation
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,6 @@ The documentation also supports various diagrams-as-code options. We
prefer to use UML-style diagrams, but you can also use Mermaid or many
other types.

Diagrams like this are processed using the 'kroki' directive:

```{kroki} ../../assets/ck-cluster.puml
```

## Links

Explanations frequently include links to other documents. In particular, please
Expand Down
2 changes: 1 addition & 1 deletion docs/src/_parts/template-tutorial
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ workload and remove everything again!

## Next Steps

- Keep mastering Canonical Kubernetes with kubectl: [How to use kubectl]
- How to control {{product}} with `kubectl`: [How to use kubectl]
- Explore Kubernetes commands with our [Command Reference Guide]
- Learn how to set up a multi-node environment [Setting up a K8s cluster]
- Configure storage options [Storage]
Expand Down
78 changes: 78 additions & 0 deletions docs/src/_parts/worker_join_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
### kubelet-crt
**Type:** `string`<br>

The certificate to be used for the kubelet.
If omitted defaults to an auto generated certificate.

### kubelet-key
**Type:** `string`<br>

The key to be used for the kubelet.
If omitted defaults to an auto generated key.

### kubelet-client-crt
**Type:** `string`<br>

The client certificate to be used for the kubelet.
If omitted defaults to an auto generated certificate.

### kubelet-client-key
**Type:** `string`<br>

The client key to be used for the kubelet.
If omitted defaults to an auto generated key.

### kube-proxy-client-crt
**Type:** `string`<br>

The client certificate to be used for the kube-proxy.
If omitted defaults to an auto generated certificate.

### kube-proxy-client-key
**Type:** `string`<br>

The client key to be used for the kube-proxy.
If omitted defaults to an auto generated key.

### extra-node-config-files
**Type:** `map[string]string`<br>

Additional files that are uploaded `/var/snap/k8s/common/args/conf.d/<filename>`
to a node on bootstrap. These files can then be referenced by Kubernetes
service arguments.

The format is `map[<filename>]<filecontent>`.

### extra-node-kube-proxy-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to the `kube-proxy` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-kubelet-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to the `kubelet` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-containerd-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to `containerd` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-k8s-apiserver-proxy-args
**Type:** `map[string]string`<br>

Additional arguments that are passed to `k8s-api-server-proxy` only for that specific node.
A parameter that is explicitly set to `null` is deleted.
The format is `map[<--flag-name>]<value>`.

### extra-node-containerd-config
**Type:** `apiv1.MapStringAny`<br>

Extra configuration for the containerd config.toml

4 changes: 4 additions & 0 deletions docs/src/assets/capi-ck8s.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5556d56

Please sign in to comment.