From e5ae1ac3556e0cb52ff5ee5a56d4122030753014 Mon Sep 17 00:00:00 2001 From: Niamh Hennigan Date: Thu, 28 Nov 2024 13:05:05 -0800 Subject: [PATCH] Add download links to long files (#853) providing a file for longer examples that are in the docs --- docs/src/assets/configuration.yaml | 11 ++ .../src/assets/how-to-dualstack-manifest.yaml | 37 +++++ docs/src/assets/how-to-epa-maas-cloud-init | 99 ++++++++++++++ .../src/assets/how-to-ipv6-only-manifest.yaml | 35 +++++ .../assets/reference-bootstrap-config.yaml | 49 +++++++ docs/src/snap/howto/epa.md | 126 +----------------- docs/src/snap/howto/networking/dualstack.md | 43 +----- docs/src/snap/howto/networking/ipv6.md | 45 +------ .../reference/bootstrap-config-reference.md | 55 +------- 9 files changed, 248 insertions(+), 252 deletions(-) create mode 100644 docs/src/assets/configuration.yaml create mode 100644 docs/src/assets/how-to-dualstack-manifest.yaml create mode 100644 docs/src/assets/how-to-epa-maas-cloud-init create mode 100644 docs/src/assets/how-to-ipv6-only-manifest.yaml create mode 100644 docs/src/assets/reference-bootstrap-config.yaml diff --git a/docs/src/assets/configuration.yaml b/docs/src/assets/configuration.yaml new file mode 100644 index 000000000..9564a18ad --- /dev/null +++ b/docs/src/assets/configuration.yaml @@ -0,0 +1,11 @@ +cluster-config: + network: + enabled: true + dns: + enabled: true + local-storage: + enabled: true + extra-node-kubelet-args: + --reserved-cpus: "0-31" + --cpu-manager-policy: "static" + --topology-manager-policy: "best-effort" diff --git a/docs/src/assets/how-to-dualstack-manifest.yaml b/docs/src/assets/how-to-dualstack-manifest.yaml new file mode 100644 index 000000000..f0e369784 --- /dev/null +++ b/docs/src/assets/how-to-dualstack-manifest.yaml @@ -0,0 +1,37 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: +name: nginxdualstack +spec: +selector: + matchLabels: + run: nginxdualstack +replicas: 1 +template: + metadata: + labels: + run: nginxdualstack + spec: + containers: + - name: nginxdualstack + image: rocks.canonical.com/cdk/diverdane/nginxdualstack:1.0.0 + ports: + - containerPort: 80 +--- +apiVersion: v1 +kind: Service +metadata: +name: nginx-dualstack +labels: + run: nginxdualstack +spec: +type: NodePort +ipFamilies: +- IPv4 +- IPv6 +ipFamilyPolicy: RequireDualStack +ports: +- port: 80 + protocol: TCP +selector: + run: nginxdualstack diff --git a/docs/src/assets/how-to-epa-maas-cloud-init b/docs/src/assets/how-to-epa-maas-cloud-init new file mode 100644 index 000000000..5850e7caa --- /dev/null +++ b/docs/src/assets/how-to-epa-maas-cloud-init @@ -0,0 +1,99 @@ +#cloud-config + +apt: + sources: + rtk.list: + source: "deb https://:@private-ppa.launchpadcontent.net/canonical-kernel-rt/ppa/ubuntu jammy main" + +write_files: + # set kernel option with hugepages and cpu isolation + - path: /etc/default/grub.d/100-telco_kernel_options.cfg + content: | + GRUB_CMDLINE_LINUX_DEFAULT="${GRUB_CMDLINE_LINUX_DEFAULT} intel_iommu=on iommu=pt usbcore.autosuspend=-1 selinux=0 enforcing=0 nmi_watchdog=0 crashkernel=auto softlockup_panic=0 audit=0 tsc=nowatchdog intel_pstate=disable mce=off hugepagesz=1G hugepages=1000 hugepagesz=2M hugepages=0 default_hugepagesz=1G kthread_cpus=0-31 irqaffinity=0-31 nohz=on nosoftlockup nohz_full=32-127 rcu_nocbs=32-127 rcu_nocb_poll skew_tick=1 isolcpus=managed_irq,32-127 console=tty0 console=ttyS0,115200n8" + permissions: "0644" + + # create sriov VFs + - path: /etc/netplan/99-sriov_vfs.yaml + content: | + network: + ethernets: + enp152s0f1: + virtual-function-count: 128 + permissions: "0600" + + # ensure VFs are bound to vfio-pci driver (so they can be consumed by pods) + - path: /var/lib/cloud/scripts/per-boot/dpdk_bind.sh + content: | + #!/bin/bash + if [ -d /home/ubuntu/dpdk ]; then + modprobe vfio-pci + vfs=$(python3 /home/ubuntu/dpdk/usertools/dpdk-devbind.py -s | grep drv=iavf | awk '{print $1}' | tail -n +11) + python3 /home/ubuntu/dpdk/usertools/dpdk-devbind.py --bind=vfio-pci $vfs + fi + permissions: "0755" + + # set proxy variables + - path: /etc/environment + content: | + HTTPS_PROXY=http://10.18.2.1:3128 + HTTP_PROXY=http://10.18.2.1:3128 + NO_PROXY=10.0.0.0/8,192.168.0.0/16,127.0.0.1,172.16.0.0/16,.svc,localhost + https_proxy=http://10.18.2.1:3128 + http_proxy=http://10.18.2.1:3128 + no_proxy=10.0.0.0/8,192.168.0.0/16,127.0.0.1,172.16.0.0/16,.svc,localhost + append: true + + # add rtk ppa key + - path: /etc/apt/trusted.gpg.d/rtk.asc + content: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + Comment: Hostname: + Version: Hockeypuck 2.2 + + xsFNBGAervwBEADHCeEuR7WKRiEII+uFOu8J+W47MZOcVhfNpu4rdcveL4qe4gj4 + nsROMHaINeUPCmv7/4EXdXtTm1VksXeh4xTeqH6ZaQre8YZ9Hf4OYNRcnFOn0KR+ + aCk0OWe9xkoDbrSYd3wmx8NG/Eau2C7URzYzYWwdHgZv6elUKk6RDbDh6XzIaChm + kLsErCP1SiYhKQvD3Q0qfXdRG908lycCxgejcJIdYxgxOYFFPcyC+kJy2OynnvQr + 4Yw6LJ2LhwsA7bJ5hhQDCYZ4foKCXX9I59G71dO1fFit5O/0/oq0xe7yUYCejf7Z + OqD+TzEK4lxLr1u8j8lXoQyUXzkKIL0SWEFT4tzOFpWQ2IBs/sT4X2oVA18dPDoZ + H2SGxCUcABfne5zrEDgkUkbnQRihBtTyR7QRiE3GpU19RNVs6yAu+wA/hti8Pg9O + U/5hqifQrhJXiuEoSmmgNb9QfbR3tc0ZhKevz4y+J3vcnka6qlrP1lAirOVm2HA7 + STGRnaEJcTama85MSIzJ6aCx4omCgUIfDmsi9nAZRkmeomERVlIAvcUYxtqprLfu + 6plDs+aeff/MAmHbak7yF+Txj8+8F4k6FcfNBT51oVSZuqFwyLswjGVzWol6aEY7 + akVIrn3OdN2u6VWlU4ZO5+sjP4QYsf5K2oVnzFVIpYvqtO2fGbxq/8dRJQARAQAB + zSVMYXVuY2hwYWQgUFBBIGZvciBDYW5vbmljYWwgS2VybmVsIFJUwsGOBBMBCgA4 + FiEEc4Tsv+pcopCX6lNfLz1Vl/FsjCEFAmAervwCGwMFCwkIBwIGFQoJCAsCBBYC + AwECHgECF4AACgkQLz1Vl/FsjCF9WhAAnwfx9njs1M3rfsMMuhvPxx0WS65HDlq8 + SRgl9K2EHtZIcS7lHmcjiTR5RD1w+4rlKZuE5J3EuMnNX1PdCYLSyMQed+7UAtX6 + TNyuiuVZVxuzJ5iS7L2ZoX05ASgyoh/Loipc+an6HzHqQnNC16ZdrBL4AkkGhDgP + ZbYjM3FbBQkL2T/08NcwTrKuVz8DIxgH7yPAOpBzm91n/pV248eK0a46sKauR2DB + zPKjcc180qmaVWyv9C60roSslvnkZsqe/jYyDFuSsRWqGgE5jNyIb8EY7K7KraPv + 3AkusgCh4fqlBxOvF6FJkiYeZZs5YXvGQ296HTfVhPLOqctSFX2kuUKGIq2Z+H/9 + qfJFGS1iaUsoDEUOaU27lQg5wsYa8EsCm9otroH2P3g7435JYRbeiwlwfHMS9EfK + dwD38d8UzZj7TnxGG4T1aLb3Lj5tNG6DSko69+zqHhuknjkRuAxRAZfHeuRbACgE + nIa7Chit8EGhC2GB12pr5XFWzTvNFdxFhbG+ed7EiGn/v0pVQc0ZfE73FXltg7et + bkoC26o5Ksk1wK2SEs/f8aDZFtG01Ys0ASFICDGW2tusFvDs6LpPUUggMjf41s7j + 4tKotEE1Hzr38EdY+8faRaAS9teQdH5yob5a5Bp5F5wgmpqZom/gjle4JBVaV5dI + N5rcnHzcvXw= + =asqr + -----END PGP PUBLIC KEY BLOCK----- + permissions: "0644" + +# install the snap +snap: + commands: + 00: 'snap install k8s --classic --channel=1.31/beta' + +runcmd: +# fetch dpdk driver binding script +- su ubuntu -c "git config --global http.proxy http://10.18.2.1:3128" +- su ubuntu -c "git clone https://github.com/DPDK/dpdk.git /home/ubuntu/dpdk" +- apt update +- DEBIAN_FRONTEND=noninteractive apt install -y linux-headers-6.8.1-1004-realtime linux-image-6.8.1-1004-realtime linux-modules-6.8.1-1004-realtime linux-modules-extra-6.8.1-1004-realtime + +# enable kernel options +- update-grub + +# reboot to activate realtime-kernel and kernel options +power_state: + mode: reboot diff --git a/docs/src/assets/how-to-ipv6-only-manifest.yaml b/docs/src/assets/how-to-ipv6-only-manifest.yaml new file mode 100644 index 000000000..cfa6fc2f6 --- /dev/null +++ b/docs/src/assets/how-to-ipv6-only-manifest.yaml @@ -0,0 +1,35 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: nginx-ipv6 +spec: + selector: + matchLabels: + run: nginx-ipv6 + replicas: 1 + template: + metadata: + labels: + run: nginx-ipv6 + spec: + containers: + - name: nginx-ipv6 + image: rocks.canonical.com/cdk/diverdane/nginxipv6:1.0.0 + ports: + - containerPort: 80 +--- +apiVersion: v1 +kind: Service +metadata: + name: nginx-ipv6 + labels: + run: nginx-ipv6 +spec: + type: NodePort + ipFamilies: + - IPv6 + ports: + - port: 80 + protocol: TCP + selector: + run: nginx-ipv6 diff --git a/docs/src/assets/reference-bootstrap-config.yaml b/docs/src/assets/reference-bootstrap-config.yaml new file mode 100644 index 000000000..74e80dab8 --- /dev/null +++ b/docs/src/assets/reference-bootstrap-config.yaml @@ -0,0 +1,49 @@ +cluster-config: + network: + enabled: true + dns: + enabled: true + cluster-domain: cluster.local + ingress: + enabled: true + load-balancer: + enabled: true + cidrs: + - 10.0.0.0/24 + - 10.1.0.10-10.1.0.20 + l2-mode: true + local-storage: + enabled: true + local-path: /storage/path + default: false + gateway: + enabled: true + metrics-server: + enabled: true + cloud-provider: external +control-plane-taints: +- node-role.kubernetes.io/control-plane:NoSchedule +pod-cidr: 10.100.0.0/16 +service-cidr: 10.200.0.0/16 +disable-rbac: false +secure-port: 6443 +k8s-dqlite-port: 9090 +datastore-type: k8s-dqlite +extra-sans: +- custom.kubernetes +extra-node-config-files: + bootstrap-extra-file.yaml: extra-args-test-file-content +extra-node-kube-apiserver-args: + --request-timeout: 2m +extra-node-kube-controller-manager-args: + --leader-elect-retry-period: 3s +extra-node-kube-scheduler-args: + --authorization-webhook-cache-authorized-ttl: 11s +extra-node-kube-proxy-args: + --config-sync-period: 14m +extra-node-kubelet-args: + --authentication-token-webhook-cache-ttl: 3m +extra-node-containerd-args: + --log-level: debug +extra-node-k8s-dqlite-args: + --watch-storage-available-size-interval: 6s diff --git a/docs/src/snap/howto/epa.md b/docs/src/snap/howto/epa.md index 278cb3420..5528da38e 100644 --- a/docs/src/snap/howto/epa.md +++ b/docs/src/snap/howto/epa.md @@ -285,108 +285,9 @@ With these preparation steps we have enabled the features of EPA: ````{group-tab} MAAS To prepare a machine for CPU isolation, HugePages, real-time kernel, -SR-IOV and DPDK we leverage cloud-init through MAAS. - -``` -#cloud-config - -apt: - sources: - rtk.list: - source: "deb https://:@private-ppa.launchpadcontent.net/canonical-kernel-rt/ppa/ubuntu jammy main" - -write_files: - # set kernel option with hugepages and cpu isolation - - path: /etc/default/grub.d/100-telco_kernel_options.cfg - content: | - GRUB_CMDLINE_LINUX_DEFAULT="${GRUB_CMDLINE_LINUX_DEFAULT} intel_iommu=on iommu=pt usbcore.autosuspend=-1 selinux=0 enforcing=0 nmi_watchdog=0 crashkernel=auto softlockup_panic=0 audit=0 tsc=nowatchdog intel_pstate=disable mce=off hugepagesz=1G hugepages=1000 hugepagesz=2M hugepages=0 default_hugepagesz=1G kthread_cpus=0-31 irqaffinity=0-31 nohz=on nosoftlockup nohz_full=32-127 rcu_nocbs=32-127 rcu_nocb_poll skew_tick=1 isolcpus=managed_irq,32-127 console=tty0 console=ttyS0,115200n8" - permissions: "0644" - - # create sriov VFs - - path: /etc/netplan/99-sriov_vfs.yaml - content: | - network: - ethernets: - enp152s0f1: - virtual-function-count: 128 - permissions: "0600" - - # ensure VFs are bound to vfio-pci driver (so they can be consumed by pods) - - path: /var/lib/cloud/scripts/per-boot/dpdk_bind.sh - content: | - #!/bin/bash - if [ -d /home/ubuntu/dpdk ]; then - modprobe vfio-pci - vfs=$(python3 /home/ubuntu/dpdk/usertools/dpdk-devbind.py -s | grep drv=iavf | awk '{print $1}' | tail -n +11) - python3 /home/ubuntu/dpdk/usertools/dpdk-devbind.py --bind=vfio-pci $vfs - fi - permissions: "0755" - - # set proxy variables - - path: /etc/environment - content: | - HTTPS_PROXY=http://10.18.2.1:3128 - HTTP_PROXY=http://10.18.2.1:3128 - NO_PROXY=10.0.0.0/8,192.168.0.0/16,127.0.0.1,172.16.0.0/16,.svc,localhost - https_proxy=http://10.18.2.1:3128 - http_proxy=http://10.18.2.1:3128 - no_proxy=10.0.0.0/8,192.168.0.0/16,127.0.0.1,172.16.0.0/16,.svc,localhost - append: true - - # add rtk ppa key - - path: /etc/apt/trusted.gpg.d/rtk.asc - content: | - -----BEGIN PGP PUBLIC KEY BLOCK----- - Comment: Hostname: - Version: Hockeypuck 2.2 - - xsFNBGAervwBEADHCeEuR7WKRiEII+uFOu8J+W47MZOcVhfNpu4rdcveL4qe4gj4 - nsROMHaINeUPCmv7/4EXdXtTm1VksXeh4xTeqH6ZaQre8YZ9Hf4OYNRcnFOn0KR+ - aCk0OWe9xkoDbrSYd3wmx8NG/Eau2C7URzYzYWwdHgZv6elUKk6RDbDh6XzIaChm - kLsErCP1SiYhKQvD3Q0qfXdRG908lycCxgejcJIdYxgxOYFFPcyC+kJy2OynnvQr - 4Yw6LJ2LhwsA7bJ5hhQDCYZ4foKCXX9I59G71dO1fFit5O/0/oq0xe7yUYCejf7Z - OqD+TzEK4lxLr1u8j8lXoQyUXzkKIL0SWEFT4tzOFpWQ2IBs/sT4X2oVA18dPDoZ - H2SGxCUcABfne5zrEDgkUkbnQRihBtTyR7QRiE3GpU19RNVs6yAu+wA/hti8Pg9O - U/5hqifQrhJXiuEoSmmgNb9QfbR3tc0ZhKevz4y+J3vcnka6qlrP1lAirOVm2HA7 - STGRnaEJcTama85MSIzJ6aCx4omCgUIfDmsi9nAZRkmeomERVlIAvcUYxtqprLfu - 6plDs+aeff/MAmHbak7yF+Txj8+8F4k6FcfNBT51oVSZuqFwyLswjGVzWol6aEY7 - akVIrn3OdN2u6VWlU4ZO5+sjP4QYsf5K2oVnzFVIpYvqtO2fGbxq/8dRJQARAQAB - zSVMYXVuY2hwYWQgUFBBIGZvciBDYW5vbmljYWwgS2VybmVsIFJUwsGOBBMBCgA4 - FiEEc4Tsv+pcopCX6lNfLz1Vl/FsjCEFAmAervwCGwMFCwkIBwIGFQoJCAsCBBYC - AwECHgECF4AACgkQLz1Vl/FsjCF9WhAAnwfx9njs1M3rfsMMuhvPxx0WS65HDlq8 - SRgl9K2EHtZIcS7lHmcjiTR5RD1w+4rlKZuE5J3EuMnNX1PdCYLSyMQed+7UAtX6 - TNyuiuVZVxuzJ5iS7L2ZoX05ASgyoh/Loipc+an6HzHqQnNC16ZdrBL4AkkGhDgP - ZbYjM3FbBQkL2T/08NcwTrKuVz8DIxgH7yPAOpBzm91n/pV248eK0a46sKauR2DB - zPKjcc180qmaVWyv9C60roSslvnkZsqe/jYyDFuSsRWqGgE5jNyIb8EY7K7KraPv - 3AkusgCh4fqlBxOvF6FJkiYeZZs5YXvGQ296HTfVhPLOqctSFX2kuUKGIq2Z+H/9 - qfJFGS1iaUsoDEUOaU27lQg5wsYa8EsCm9otroH2P3g7435JYRbeiwlwfHMS9EfK - dwD38d8UzZj7TnxGG4T1aLb3Lj5tNG6DSko69+zqHhuknjkRuAxRAZfHeuRbACgE - nIa7Chit8EGhC2GB12pr5XFWzTvNFdxFhbG+ed7EiGn/v0pVQc0ZfE73FXltg7et - bkoC26o5Ksk1wK2SEs/f8aDZFtG01Ys0ASFICDGW2tusFvDs6LpPUUggMjf41s7j - 4tKotEE1Hzr38EdY+8faRaAS9teQdH5yob5a5Bp5F5wgmpqZom/gjle4JBVaV5dI - N5rcnHzcvXw= - =asqr - -----END PGP PUBLIC KEY BLOCK----- - permissions: "0644" - -# install the snap -snap: - commands: - 00: 'snap install k8s --classic --channel=1.31/beta' - -runcmd: -# fetch dpdk driver binding script -- su ubuntu -c "git config --global http.proxy http://10.18.2.1:3128" -- su ubuntu -c "git clone https://github.com/DPDK/dpdk.git /home/ubuntu/dpdk" -- apt update -- DEBIAN_FRONTEND=noninteractive apt install -y linux-headers-6.8.1-1004-realtime linux-image-6.8.1-1004-realtime linux-modules-6.8.1-1004-realtime linux-modules-extra-6.8.1-1004-realtime - -# enable kernel options -- update-grub - -# reboot to activate realtime-kernel and kernel options -power_state: - mode: reboot +SR-IOV and DPDK we leverage cloud-init through MAAS available to download {download}`here `. + +```{literalinclude} /src/assets/how-to-epa-maas-cloud-init ``` ```{note} @@ -426,23 +327,13 @@ EPA capabilities. ```{include} ../../_parts/install.md ``` -2. Create a file called *configuration.yaml*. In this configuration file we let +2. Create a file called *configuration.yaml* or download it {download}`here `. In this configuration file we let the snap start with its default CNI (calico), with CoreDNS deployed and we also point k8s to the external etcd. - ```yaml - cluster-config: - network: - enabled: true - dns: - enabled: true - local-storage: - enabled: true - extra-node-kubelet-args: - --reserved-cpus: "0-31" - --cpu-manager-policy: "static" - --topology-manager-policy: "best-effort" - ``` +```{literalinclude} /src/assets/configuration.yaml +:language: yaml +``` 3. Bootstrap {{product}} using the above configuration file. @@ -689,7 +580,6 @@ EOF ```{note} To ensure proper resource management and prevent conflicts, Kubernetes enforces that a pod requesting HugePages also explicitly requests a minimum -Now, ensure that the `1Gi` HugePage is allocated in the pod: ``` Now ensure that the 1Gi HugePage is allocated in the pod: @@ -769,7 +659,6 @@ Confirm that the test is running by checking the pod's logs: ``` sudo k8s kubectl logs realtime-kernel-test -f - ``` This should produce output including: @@ -850,7 +739,6 @@ Label the node with information about the available CPU/NUMA nodes: ``` sudo k8s kubectl label node pc6b-rb4-n3 topology.kubernetes.io/zone=NUMA - ``` The output should indicate the label has been applied: diff --git a/docs/src/snap/howto/networking/dualstack.md b/docs/src/snap/howto/networking/dualstack.md index efa1b0c19..2c7f210da 100644 --- a/docs/src/snap/howto/networking/dualstack.md +++ b/docs/src/snap/howto/networking/dualstack.md @@ -59,47 +59,12 @@ cluster bootstrap process. The key configuration parameters are: ``` To test that the cluster is configured with dual-stack, apply the following - manifest that creates a service with `ipFamilyPolicy: RequireDualStack`: - ``` - apiVersion: apps/v1 - kind: Deployment - metadata: - name: nginxdualstack - spec: - selector: - matchLabels: - run: nginxdualstack - replicas: 1 - template: - metadata: - labels: - run: nginxdualstack - spec: - containers: - - name: nginxdualstack - image: rocks.canonical.com/cdk/diverdane/nginxdualstack:1.0.0 - ports: - - containerPort: 80 - --- - apiVersion: v1 - kind: Service - metadata: - name: nginx-dualstack - labels: - run: nginxdualstack - spec: - type: NodePort - ipFamilies: - - IPv4 - - IPv6 - ipFamilyPolicy: RequireDualStack - ports: - - port: 80 - protocol: TCP - selector: - run: nginxdualstack + manifest that creates a service with `ipFamilyPolicy: RequireDualStack`. + It also creates an nginx deployment sample workload. ``` + sudo k8s kubectl apply -f https://raw.githubusercontent.com/canonical/k8s-snap/main/docs/src/assets/how-to-dualstack-manifest.yaml + ``` 1. **Check IPv6 Connectivity** diff --git a/docs/src/snap/howto/networking/ipv6.md b/docs/src/snap/howto/networking/ipv6.md index 65bd5cc99..782ed0c0c 100644 --- a/docs/src/snap/howto/networking/ipv6.md +++ b/docs/src/snap/howto/networking/ipv6.md @@ -62,51 +62,10 @@ sudo k8s kubectl get pods -A ``` Deploy a pod with an nginx web-server and expose it via a service to verify -connectivity of the IPv6-only cluster. Create a manifest file -`nginx-ipv6.yaml` with the following content: - -```yaml -apiVersion: apps/v1 -kind: Deployment -metadata: - name: nginx-ipv6 -spec: - selector: - matchLabels: - run: nginx-ipv6 - replicas: 1 - template: - metadata: - labels: - run: nginx-ipv6 - spec: - containers: - - name: nginx-ipv6 - image: rocks.canonical.com/cdk/diverdane/nginxipv6:1.0.0 - ports: - - containerPort: 80 ---- -apiVersion: v1 -kind: Service -metadata: - name: nginx-ipv6 - labels: - run: nginx-ipv6 -spec: - type: NodePort - ipFamilies: - - IPv6 - ports: - - port: 80 - protocol: TCP - selector: - run: nginx-ipv6 -``` - -Deploy the web-server and its service by running: +connectivity of the IPv6-only cluster: ```sh -sudo k8s kubectl apply -f nginx-ipv6.yaml +sudo k8s kubectl apply -f https://raw.githubusercontent.com/canonical/k8s-snap/main/docs/src/assets/how-to-ipv6-only-manifest.yaml ``` 3. **Verify IPv6 Connectivity** diff --git a/docs/src/snap/reference/bootstrap-config-reference.md b/docs/src/snap/reference/bootstrap-config-reference.md index 758828e04..a607b3374 100644 --- a/docs/src/snap/reference/bootstrap-config-reference.md +++ b/docs/src/snap/reference/bootstrap-config-reference.md @@ -15,56 +15,9 @@ by listing all available options and their details. See below for an example. The following example configures and enables certain features, sets an external cloud provider, marks the control plane nodes as unschedulable, changes the pod and service CIDRs from the defaults and adds an extra SAN to the generated -certificates. +certificates. It is also available to download + {download}`here ` -```yaml -cluster-config: - network: - enabled: true - dns: - enabled: true - cluster-domain: cluster.local - ingress: - enabled: true - load-balancer: - enabled: true - cidrs: - - 10.0.0.0/24 - - 10.1.0.10-10.1.0.20 - l2-mode: true - local-storage: - enabled: true - local-path: /storage/path - default: false - gateway: - enabled: true - metrics-server: - enabled: true - cloud-provider: external -control-plane-taints: -- node-role.kubernetes.io/control-plane:NoSchedule -pod-cidr: 10.100.0.0/16 -service-cidr: 10.200.0.0/16 -disable-rbac: false -secure-port: 6443 -k8s-dqlite-port: 9090 -datastore-type: k8s-dqlite -extra-sans: -- custom.kubernetes -extra-node-config-files: - bootstrap-extra-file.yaml: extra-args-test-file-content -extra-node-kube-apiserver-args: - --request-timeout: 2m -extra-node-kube-controller-manager-args: - --leader-elect-retry-period: 3s -extra-node-kube-scheduler-args: - --authorization-webhook-cache-authorized-ttl: 11s -extra-node-kube-proxy-args: - --config-sync-period: 14m -extra-node-kubelet-args: - --authentication-token-webhook-cache-ttl: 3m -extra-node-containerd-args: - --log-level: debug -extra-node-k8s-dqlite-args: - --watch-storage-available-size-interval: 6s +```{literalinclude} /src/assets/reference-bootstrap-config.yaml +:language: yaml ```