Skip to content

Commit 2e643b7

Browse files
lennessyyLenny Chen
andauthored
docs: update Edge tutorial user data (#3403)
* 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 <[email protected]>
1 parent 7ae0c53 commit 2e643b7

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

docs/docs-content/tutorials/edge/deploy-cluster.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,6 @@ To complete this tutorial, you will need the following:
6161
uname -m
6262
```
6363

64-
<br />
65-
6664
:::warning
6765

6866
The Linux machine must have network connectivity to your VMware vCenter environment.
@@ -198,13 +196,7 @@ placeholder with your actual registration token.
198196
export token=[your_token_here]
199197
```
200198

201-
Use the following command to create the **user-data** file containing the tenant registration token. You can click on
202-
the _Points of Interest_ numbers below to learn more about the main attributes relevant to this example.
203-
204-
<PointsOfInterest points={[
205-
{ 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", },
206-
{ 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", }
207-
]}>
199+
Use the following command to create the **user-data** file containing the tenant registration token.
208200

209201
```shell
210202
cat << EOF > user-data
@@ -217,12 +209,21 @@ stylus:
217209
users:
218210
- name: kairos
219211
passwd: kairos
212+
213+
install:
214+
poweroff: true
220215
EOF
221216
```
222217

223-
</PointsOfInterest>
218+
:::warning
219+
220+
Ensure that you include the `install.poweroff.true` parameter. This ensures that the Edge host will power off after
221+
installation. If you do not include this parameter, this could lead to a VM you will use in a subsequent step to refuse
222+
to power off automatically and cause a timeout error unless you manually shut down the VM.
223+
224+
:::
224225

225-
Review the newly created user data file. <br />
226+
Review the newly created user data file.
226227

227228
```bash
228229
cat user-data
@@ -244,8 +245,6 @@ users:
244245
passwd: kairos
245246
```
246247

247-
<br />
248-
249248
## Build Artifacts
250249

251250
The CanvOS utility uses [Earthly](https://earthly.dev/) to build the target artifacts. Issue the following command to

0 commit comments

Comments
 (0)