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..e7733ac262 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,57 @@ 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. 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: + 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 +``` + +:::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 You can use the `before-install` stage to remove partitions if needed. @@ -167,6 +218,7 @@ stages: - snap install amazon-ssm-agent --classic ``` + #### 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. 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