Skip to content

Commit d8debe4

Browse files
committed
Cleanup compatibility docs and add RKE2 to K3S section
Signed-off-by: Philip Laine <philip.laine@gmail.com>
1 parent e9ab8a1 commit d8debe4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/COMPATIBILITY.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Spegel has been tested on the following Kubernetes distributions for compatibili
2222
| :green_circle: | AKS |
2323
| :green_circle: | Minikube |
2424
| :yellow_circle: | EKS |
25-
| :yellow_circle: | K3S |
25+
| :yellow_circle: | K3S and RKE2 |
2626
| :yellow_circle: | Kind |
2727
| :yellow_circle: | Talos |
2828
| :red_circle: | GKE |
@@ -36,7 +36,7 @@ This needs to be disabled as otherwise all of the required layers of an image wo
3636
### Amazon Linux 2
3737

3838
If your EKS AMI is based on AL2, the included containerd config [imports overrides](https://github.com/awslabs/amazon-eks-ami/blob/main/templates/al2/runtime/containerd-config.toml)
39-
from `/etc/containerd/config.d/*.toml` by default, so the best way to change containerd settings is to add a file to the import directory using a custom node bootstrap script in your launch template:
39+
from `/etc/containerd/config.d/*.toml` by default. The best way to change containerd settings is to add a file to the import directory using a custom node bootstrap script in your launch template.
4040

4141
```shell
4242
#!/bin/bash
@@ -56,7 +56,7 @@ EOL
5656
### Amazon Linux 2023
5757

5858
If you are using an AL2023-based EKS AMI, bootstrap involves [nodeadm configuration](https://awslabs.github.io/amazon-eks-ami/nodeadm/). To change containerd settings, you should add a
59-
nodeadm configuration section like the following:
59+
nodeadm configuration section.
6060

6161
```yaml
6262
...
@@ -102,9 +102,9 @@ containerdConfigPatches:
102102
103103
For a full example, see the end-to-end tests' [Kind configuration](../test/e2e/kind-config-iptables.yaml) for a full example.
104104
105-
## K3S
105+
## K3S and RKE2
106106
107-
K3S embeds Spegel, refer to their [documentation](https://docs.k3s.io/installation/registry-mirror?_highlight=spegel) for deployment information.
107+
K3S and RKE2 embeds Spegel, refer to their [documentation](https://docs.k3s.io/installation/registry-mirror?_highlight=spegel) for deployment information.
108108
109109
## Talos
110110

0 commit comments

Comments
 (0)