From 4817e76e7e773eade63b957e1e78a0e94b99bf12 Mon Sep 17 00:00:00 2001 From: Carolina Delwing Rosa Date: Tue, 24 Oct 2023 17:27:24 -0400 Subject: [PATCH 1/6] docs: initial draft --- .../docs-content/clusters/edge/edge-configuration/cloud-init.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md index c6bc3006fc..2222a1ab35 100644 --- a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md +++ b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md @@ -167,6 +167,8 @@ stages: - snap install amazon-ssm-agent --classic ``` +#### Update Network With Netplan + #### Pass a Sensitive Information If you need to transmit sensitive information, such as credentials, during the site installation phase, you can make the Edge installer skip copying specific stages to the edge hosts. The Edge installer will skip copying the stages that follow the `skip-copy-[string]` naming convention. Refer to the [Sensitive Information in the User Data Stages](skip-copying-stages.md) guide to learn more. From 2f67b8a3b9e1b01274de1d550a8e53a4a49bee2e Mon Sep 17 00:00:00 2001 From: Carolina Delwing Rosa Date: Wed, 25 Oct 2023 11:15:15 -0400 Subject: [PATCH 2/6] docs: updated cloud-init.md with Netplan network configuration section --- .../edge/edge-configuration/cloud-init.md | 43 ++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md index 2222a1ab35..c90ec43c52 100644 --- a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md +++ b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md @@ -138,6 +138,48 @@ stages: insecure_skip_verify: true ``` + +#### Configure Network With Netplan + +You can use the `initramfs` stage and [Netplan](https://netplan.io) to configure network settings before the network initialization. Netplan is a tool that enables you to specify network configurations on Linux systems. Please note that this approach is available for Ubuntu systems only. Refer to the [Netplan Documentation]([https://netplan.readthedocs.io/en/stable/) and [Netplan How-to Guides](https://netplan.readthedocs.io/en/stable/examples/) for more information. + +
+ +```yaml +stages: + initramfs: + - users: + kairos: + groups: + - sudo + passwd: kairos + - commands: + - netplan apply + files: + - content: | + network: + version: 2 + renderer: networkd + ethernets: + ens160: + dhcp4: false + addresses: + - 10.10.190.11/18 + gateway4: 10.10.128.1 + nameservers: + addresses: + - 8.8.8.8 + - 1.1.1.1 + encoding: "" + group: 0 + owner: 0 + ownerstring: "" + path: /etc/netplan/99_config.yaml + permissions: 420 + name: Config network with Netplan +``` + + #### Erase Partitions You can use the `before-install` stage to remove partitions if needed. @@ -167,7 +209,6 @@ stages: - snap install amazon-ssm-agent --classic ``` -#### Update Network With Netplan #### Pass a Sensitive Information From 8a3e78bd8ca9761dcac3d466dbca9def26174bb5 Mon Sep 17 00:00:00 2001 From: Carolina Delwing Rosa Date: Wed, 25 Oct 2023 11:51:54 -0400 Subject: [PATCH 3/6] docs: fixed link on cloud-init.md file --- .../docs-content/clusters/edge/edge-configuration/cloud-init.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md index c90ec43c52..3ce7dfbff2 100644 --- a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md +++ b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md @@ -141,7 +141,7 @@ stages: #### Configure Network With Netplan -You can use the `initramfs` stage and [Netplan](https://netplan.io) to configure network settings before the network initialization. Netplan is a tool that enables you to specify network configurations on Linux systems. Please note that this approach is available for Ubuntu systems only. Refer to the [Netplan Documentation]([https://netplan.readthedocs.io/en/stable/) and [Netplan How-to Guides](https://netplan.readthedocs.io/en/stable/examples/) for more information. +You can use the `initramfs` stage and [Netplan](https://netplan.io) to configure network settings before the network initialization. Netplan is a tool that enables you to specify network configurations on Linux systems. Please note that this approach is available for Ubuntu systems only. Refer to the [Netplan Documentation](https://netplan.readthedocs.io/en/stable/) and [Netplan How-to Guides](https://netplan.readthedocs.io/en/stable/examples/) for more information.
From 41f107c6163d488cf5bbf903878e895602bc66fd Mon Sep 17 00:00:00 2001 From: caroldelwing <63267693+caroldelwing@users.noreply.github.com> Date: Wed, 25 Oct 2023 13:33:55 -0400 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: Karl Cardenas --- .../docs-content/clusters/edge/edge-configuration/cloud-init.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md index 3ce7dfbff2..a7a4725551 100644 --- a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md +++ b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md @@ -141,7 +141,7 @@ stages: #### Configure Network With Netplan -You can use the `initramfs` stage and [Netplan](https://netplan.io) to configure network settings before the network initialization. Netplan is a tool that enables you to specify network configurations on Linux systems. Please note that this approach is available for Ubuntu systems only. Refer to the [Netplan Documentation](https://netplan.readthedocs.io/en/stable/) and [Netplan How-to Guides](https://netplan.readthedocs.io/en/stable/examples/) for more information. +You can use the `initramfs` stage and [Netplan](https://netplan.io) to configure network settings before the network initialization. Netplan is a tool that enables you to specify network configurations on Linux systems. Note that this approach is available for Linux systems with Netplan installed. Refer to the [Netplan Documentation](https://netplan.readthedocs.io/en/stable/) for install guidance and the [Netplan How-to Guides](https://netplan.readthedocs.io/en/stable/examples/) for more information.
From d33a205708baa885a1815d824f0da4f30b853755 Mon Sep 17 00:00:00 2001 From: Carolina Delwing Rosa Date: Wed, 25 Oct 2023 13:46:11 -0400 Subject: [PATCH 5/6] docs: added tip section PE-2882 --- .../clusters/edge/edge-configuration/cloud-init.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md index a7a4725551..e7733ac262 100644 --- a/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md +++ b/docs/docs-content/clusters/edge/edge-configuration/cloud-init.md @@ -141,9 +141,8 @@ stages: #### Configure Network With Netplan -You can use the `initramfs` stage and [Netplan](https://netplan.io) to configure network settings before the network initialization. Netplan is a tool that enables you to specify network configurations on Linux systems. Note that this approach is available for Linux systems with Netplan installed. Refer to the [Netplan Documentation](https://netplan.readthedocs.io/en/stable/) for install guidance and the [Netplan How-to Guides](https://netplan.readthedocs.io/en/stable/examples/) for more information. +You can use the `initramfs` stage and [Netplan](https://netplan.io) to configure network settings before the network initialization. Netplan is a tool that enables you to specify network configurations on Linux systems. Note that this approach is available for Linux systems with Netplan installed. Refer to the [Netplan Documentation](https://netplan.readthedocs.io/en/stable/) for installation guidance and the [Netplan How-to Guides](https://netplan.readthedocs.io/en/stable/examples/) for more information. -
```yaml stages: @@ -179,6 +178,16 @@ stages: name: Config network with Netplan ``` +:::tip + +When using the EdgeForge workflow with CanvOS, ensure you add Netplan to the Dockerfile. In the example below, Netplan is installed in an Ubuntu image. + +```shell +apt-get update && apt-get install netplan.io -y +``` + +::: + #### Erase Partitions From 3377188d1e4cf1ce9fb67837f80575c074a736bb Mon Sep 17 00:00:00 2001 From: Carolina Delwing Rosa Date: Wed, 25 Oct 2023 13:51:31 -0400 Subject: [PATCH 6/6] chore: updated Vale vocabs --- vale/styles/Vocab/Internal/accept.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/vale/styles/Vocab/Internal/accept.txt b/vale/styles/Vocab/Internal/accept.txt index 03bc7e68ad..f78649e444 100644 --- a/vale/styles/Vocab/Internal/accept.txt +++ b/vale/styles/Vocab/Internal/accept.txt @@ -153,4 +153,5 @@ jq Caddy jumpbox Oras -oras \ No newline at end of file +oras +Netplan \ No newline at end of file