From 41581a489e2753f892dc93ae4eb182baf9a3ec33 Mon Sep 17 00:00:00 2001 From: "vault-token-factory-spectrocloud[bot]" <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Date: Fri, 19 Jul 2024 16:08:06 +0000 Subject: [PATCH] docs: update Edge tutorial user data (#3403) (#3433) * docs: add known issue * docs: add install poweroff true * docs: fix known issue * docs: add warning to highlight poweroff parameter --------- Co-authored-by: Lenny Chen (cherry picked from commit 2e643b70880341ef94793eaa811f82c67c167db0) Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> --- .../tutorials/edge/deploy-cluster.md | 25 +++++++++---------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/docs-content/tutorials/edge/deploy-cluster.md b/docs/docs-content/tutorials/edge/deploy-cluster.md index 2a820a8ec0..ce117523a5 100644 --- a/docs/docs-content/tutorials/edge/deploy-cluster.md +++ b/docs/docs-content/tutorials/edge/deploy-cluster.md @@ -61,8 +61,6 @@ To complete this tutorial, you will need the following: uname -m ``` -
- :::warning The Linux machine must have network connectivity to your VMware vCenter environment. @@ -198,13 +196,7 @@ placeholder with your actual registration token. export token=[your_token_here] ``` -Use the following command to create the **user-data** file containing the tenant registration token. You can click on -the _Points of Interest_ numbers below to learn more about the main attributes relevant to this example. - - +Use the following command to create the **user-data** file containing the tenant registration token. ```shell cat << EOF > user-data @@ -217,12 +209,21 @@ stylus: users: - name: kairos passwd: kairos + +install: + poweroff: true EOF ``` - +:::warning + +Ensure that you include the `install.poweroff.true` parameter. This ensures that the Edge host will power off after +installation. If you do not include this parameter, this could lead to a VM you will use in a subsequent step to refuse +to power off automatically and cause a timeout error unless you manually shut down the VM. + +::: -Review the newly created user data file.
+Review the newly created user data file. ```bash cat user-data @@ -244,8 +245,6 @@ users: passwd: kairos ``` -
- ## Build Artifacts The CanvOS utility uses [Earthly](https://earthly.dev/) to build the target artifacts. Issue the following command to