Skip to content

Commit

Permalink
docs: update Edge tutorial user data (#3403)
Browse files Browse the repository at this point in the history
* 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 <lenny.chen@spectrocloud.com>
(cherry picked from commit 2e643b7)
  • Loading branch information
lennessyy committed Jul 19, 2024
1 parent 6fcdd3f commit be0f038
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions docs/docs-content/tutorials/edge/deploy-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,6 @@ To complete this tutorial, you will need the following:
uname -m
```

<br />

:::warning

The Linux machine must have network connectivity to your VMware vCenter environment.
Expand Down Expand Up @@ -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.
<PointsOfInterest points={[
{ x: 250, y: 160, label: 1, description: "Stores the registration token and lets the agent use the auto-registration functionality and authenticate with the provided token.", tooltipPlacement: "rightTop", },
{ x: 600, y: 300, label: 2, description: "Sets the login credentials for Edge hosts. The login credentials allow you to SSH log in to the edge host for debugging purposes.", tooltipPlacement: "rightTop", }
]}>
Use the following command to create the **user-data** file containing the tenant registration token.
```shell
cat << EOF > user-data
Expand All @@ -217,12 +209,21 @@ stylus:
users:
- name: kairos
passwd: kairos
install:
poweroff: true
EOF
```
</PointsOfInterest>
:::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. <br />
Review the newly created user data file.
```bash
cat user-data
Expand All @@ -244,8 +245,6 @@ users:
passwd: kairos
```
<br />
## Build Artifacts
The CanvOS utility uses [Earthly](https://earthly.dev/) to build the target artifacts. Issue the following command to
Expand Down

0 comments on commit be0f038

Please sign in to comment.