docs: patch fix the edge tutorial (#1409)

* docs: patch fix the edge tutorial * docs: update broken links * docs: lang clean up * Apply suggestions from code review Co-authored-by: Karl Cardenas <karl@spectrocloud.com> * Apply suggestions from code review Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> --------- Co-authored-by: Karl Cardenas <karl@spectrocloud.com> Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
spectrocloud · Jul 10, 2023 · 240ef9f · 240ef9f
1 parent d6d489b
commit 240ef9f
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 14 deletions.
diff --git a/content/docs/02-getting-started/04-onboarding-workflow.md b/content/docs/02-getting-started/04-onboarding-workflow.md
@@ -37,7 +37,7 @@ The product tour is followed by a Palette experience session.  Here we make sure
 
   * A system-level cluster profile is included for the users to explore the Palette functionalities easier and faster.
 
-* [Import Cluster](/clusters/brownfield-clusters#overview)
+* [Import Cluster](/clusters/imported-clusters)
   * Bring your own cluster into Palette in two easy steps.
 
 * Out-of-the-box (OOTB) Configurations:

diff --git a/content/docs/04-clusters/03-edge/04-edgeforge-workflow/03.5-palette-canvos.md b/content/docs/04-clusters/03-edge/04-edgeforge-workflow/03.5-palette-canvos.md
@@ -687,7 +687,7 @@ You can validate the ISO image by creating a bootable USB flash drive using any
 After building the Edge artifacts and creating an Edge cluster profile, the next step is to use the Edge Installer ISO image to prepare your Edge host. To learn more about utilizing Edge artifacts to prepare Edge hosts and deploy Palette-managed Edge clusters, we encourage you to check out the reference resources below.
 <br />
 
-- [Deploy an Edge Cluster on VMware](/clusters/edge/deploy-cluster) 
+- [Deploy an Edge Cluster on VMware](/clusters/edge/site-deployment/deploy-cluster) 
 
 
 - [Prepare Edge Host for Installation](/clusters/edge/site-deployment/stage)
diff --git a/content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md b/content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md
@@ -120,17 +120,46 @@ git checkout v3.4.3
 ```
 <br />
 
-## Review Arguments
+## Define Arguments
 
-The **.arg.template** sample file in the current directory contains customizable arguments, such as image tag, registry, repository, and OS distribution. Rename the sample **.arg.template** file to **.arg** and review the arguments to use during the build process.
+CanvOS requires arguments such as image tag, registry, repository, and OS distribution. The arguments are defined in the  **.arg** file. In this step, you will create the  **.arg** file and define all the required arguments.
+
+
+Issue the command below to assign an image tag value for the provider images. This guide uses the default value `demo` as an example. However, you can assign any lowercase and alphanumeric string to the `CUSTOM_TAG` variable. 
+<br />
+
+```bash
+export CUSTOM_TAG=demo
+```
 <br />
 
+Issue the command below to create the **.arg** file with the custom tag. The remaining arguments will use the default values. For example, `ubuntu` is the default operating system, `demo` is the default tag, and [ttl.sh](https://ttl.sh/) is the default image registry. The default ttl.sh image registry is free and does not require a sign-up. Images pushed to ttl.sh are ephemeral and will expire after the 24 hrs time limit. 
+
+Using the arguments defined in the **.arg** file, the final provider images you generate will have the following naming convention, `[IMAGE_REGISTRY]/[IMAGE_REPO]:[CUSTOM_TAG]`. In this example, the provider images will be `ttl.sh/ubuntu:k3s-1.25.2-v3.4.3-demo`. Refer to the **.arg.template** sample file in the current directory or the [README](https://github.com/spectrocloud/CanvOS#readme) to learn more about the default values. 
+<br /> 
+
 ```bash
-mv .arg.template .arg && cat .arg
+cat << EOF > .arg
+CUSTOM_TAG=$CUSTOM_TAG
+IMAGE_REGISTRY=ttl.sh
+OS_DISTRIBUTION=ubuntu
+IMAGE_REPO=ubuntu
+OS_VERSION=22
+K8S_DISTRIBUTION=k3s
+ISO_NAME=palette-edge-installer
+PE_VERSION=$(git describe --abbrev=0 --tags)
+platform=linux/amd64
+EOF
 ```
 
+View the newly created file to ensure the arguments are defined per your requirements.
+<br />
+
+```bash
+cat .arg
+```
+<br />
 
-CanvOS allows you to customize arguments defined in the **.arg** file. However, this tutorial will use the default values for all arguments. For example, `ubuntu` is the default operating system, and `demo` is the default tag. As a result, the provider image is named `ttl.sh/ubuntu:k3s-1.25.2-v3.4.3-demo`. 
 
 Refer to the [Build Edge Artifacts](/clusters/edge/edgeforge-workflow/palette-canvos) guide to learn more about customizing arguments.
 <br />
@@ -155,15 +184,15 @@ Use the following command to create the **user-data** file containing the tenant
 <PointsOfInterest
   points={[
     {
-      x: 270,
+      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: 190,
-      y: 225,
+      x: 170,
+      y: 224,
       label: 2,
       description: "Instructs the installer to turn the host machine off once the installation is complete.",
     },
@@ -173,7 +202,7 @@ Use the following command to create the **user-data** file containing the tenant
       label: 3,
       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",
-    },
+    }
   ]}
 >
 
@@ -193,12 +222,27 @@ EOF
 
 </PointsOfInterest>
 
-Review the newly created user data file to ensure the token is set correctly.
+Review the newly created user data file.
 <br />
 
 ```bash
 cat user-data
 ```
+The expected output should show that the `edgeHostToken` and login credentials for Edge hosts are set correctly. The `edgeHostToken` value must match your Palette registration token. Otherwise, your Edge hosts will not register themselves with Palette automatically. Below is a sample output with a dummy token value. 
+<br />
+
+```bash hideClipboard
+#cloud-config
+stylus:
+  site:
+    edgeHostToken: 62ElvdMeX5MdOESgTleBjjKQg8YkaIN3
+install:
+  poweroff: true
+users:
+  - name: kairos
+    passwd: kairos
+```
+
 <br/>
 
 ## Build Artifacts
@@ -247,8 +291,8 @@ After completing the build process, list the edge installer ISO image and checks
 ls build/
 ```
 
-```bash
-# Output hideClipboard
+```bash hideClipboard
+# Output 
 palette-edge-installer.iso       
 palette-edge-installer.iso.sha256
 ```
@@ -571,7 +615,7 @@ Open a web browser and log in to [Palette](https://console.spectrocloud.com). Na
 ![A screenshot showing the VMs automatically registered with Palette. ](/tutorials/edge/clusters_edge_deploy-cluster_edge-hosts.png)
 
 
-If the three Edge hosts are not displayed in the Edge hosts tab, the automatic registration failed. In this happens, you can manually register hosts by clicking the **Add Edge Hosts** button and pasting the Edge host ID. Repeat this host registration process for each of the three VMs.
+If the three Edge hosts are not displayed in the **Edge hosts** tab, the automatic registration failed. If this happens, you can manually register hosts by clicking the **Add Edge Hosts** button and pasting the Edge host ID. Repeat this host registration process for each of the three VMs.
 If you need help, the detailed instructions are available in the [Register Edge Host](/clusters/edge/site-deployment/site-installation/edge-host-registration) guide.
 <br />