Skip to content

Commit ffa3edb

Browse files
committed
A couple of more tweaks
1 parent 4a5b775 commit ffa3edb

File tree

4 files changed

+23
-20
lines changed

4 files changed

+23
-20
lines changed

_partials/_canvos-edge-arg-file.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Specify the system architecture, OS distribution, and version. These configurati
1717

1818

1919
For example, if your `.arg` file contains the following arguments, the full image reference would be
20-
`ttl.sh/ubuntu:k3s-1.33.5-v4.8.5-demo`.
20+
`ttl.sh/ubuntu:k3s-1.33.5-v4.7.2-demo`.
2121

2222
```text
2323
IMAGE_REGISTRY=ttl.sh
@@ -31,4 +31,4 @@ Specify the system architecture, OS distribution, and version. These configurati
3131

3232
The `.arg` file uses the default values for any remaining arguments. Refer to [Edge Artifact Build Configurations](/clusters/edge/edgeforge-workflow/palette-canvos/arg/) for all available `.arg` configuration parameters.
3333

34-
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]`. For example, one of the provider images might be `spectrocloud/ubuntu:k3s-1.33.5-v4.8.5-palette-learn`.
34+
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]`. For example, one of the provider images might be `spectrocloud/ubuntu:k3s-1.33.5-v4.7.2-palette-learn`.

_partials/_canvos-edge-user-data.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@ From the CanvOS directory, copy the **user-data.template** file and name the cop
88
- paletteEndpoint
99
- projectName
1010

11-
The `user-data` file uses the `cloud-init` `cloud-config` format. The first line of your file must be `#cloud-config` to ensure that `cloud-init` recognizes and applies the configuration correctly.
11+
The `user-data` file uses the `cloud-init` `cloud-config` format. The first line of your file must be `#cloud-config` to ensure that `cloud-init` recognizes and applies the configuration correctly. Delete any unused arguments.
1212

1313
```shell
1414
#cloud-config
1515
stylus:
1616
site:
1717
...
1818
```
19-
Refer to [Cloud Init Stages](/clusters/edge/edge-configuration/cloud-init/) and the [Edge Installer Configuration Reference](/clusters/edge/edge-configuration/installer-reference/) for supported keys and stages.
20-
19+
Refer to [Prepare User Data and Argument Files](/clusters/edge/edgeforge-workflow/prepare-user-data/) for more information about configuring your `user-data` file and to see sample files for different use cases. Refer to [Cloud Init Stages](/clusters/edge/edge-configuration/cloud-init/), and the [Edge Installer Configuration Reference](/clusters/edge/edge-configuration/installer-reference/) for supported keys and stages.

docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,10 @@ customization.
118118
5. If you are using a self-hosted instance of Palette and have determined a specific CanvOS version, checkout out the
119119
corresponding tag.
120120

121-
Otherwise, check out the newest available tag. This guide uses the tag **v4.8.5** as an example.
121+
Otherwise, check out the newest available tag. This guide uses the tag **v4.7.2** as an example.
122122

123123
```shell
124-
git checkout v4.8.5
124+
git checkout v4.7.2
125125
```
126126

127127
6. Review the files relevant for this guide.
@@ -144,6 +144,8 @@ customization.
144144
- IMAGE_REPO
145145
- CUSTOM_TAG
146146

147+
For more information about preparing the `.arg` file and full sample files, refer to [Prepare User Data and Argument Files](/clusters/edge/edgeforge-workflow/prepare-user-data/).
148+
147149
8. <PartialsComponent category="palette-edge-canvos-version" name="canvos-edge-arg-file" />
148150

149151
:::preview
@@ -283,7 +285,7 @@ customization.
283285
system.repo: ubuntu
284286
system.k8sDistribution: k3s
285287
system.osName: ubuntu
286-
system.peVersion: v4.8.5
288+
system.peVersion: v4.7.2
287289
system.customTag: palette-learn
288290
system.osVersion: 22
289291
```
@@ -297,7 +299,7 @@ customization.
297299
298300
```hideClipboard bash
299301
REPOSITORY TAG IMAGE ID CREATED SIZE
300-
spectrocloud/ubuntu k3s-1.33.5-v4.8.5-palette-learn 075134ad5d4b 10 minutes ago 4.11GB
302+
spectrocloud/ubuntu k3s-1.33.5-v4.7.2-palette-learn 075134ad5d4b 10 minutes ago 4.11GB
301303
```
302304
303305
14. To use the provider image with your Edge deployment, push it to the image registry specified in the `.arg` file. Log
@@ -312,7 +314,7 @@ customization.
312314
cluster deployment.
313315
314316
```bash
315-
docker push $IMAGE_REGISTRY/ubuntu:k3s-1.33.5-v4.8.5-palette-learn
317+
docker push $IMAGE_REGISTRY/ubuntu:k3s-1.33.5-v4.7.2-palette-learn
316318
```
317319
318320
16. After pushing the provider images to the image registry, open a web browser and log in to
@@ -362,7 +364,7 @@ customization.
362364
system.repo: ubuntu
363365
system.k8sDistribution: k3s
364366
system.osName: ubuntu
365-
system.peVersion: v4.8.5
367+
system.peVersion: v4.7.2
366368
system.customTag: palette-learn
367369
system.osVersion: 22
368370
```
@@ -484,10 +486,10 @@ required Edge artifacts.
484486
5. If you are using a self-hosted instance of Palette and have determined a specific CanvOS version, checkout out the
485487
corresponding tag.
486488
487-
Otherwise, check out the newest available tag. This guide uses **v4.8.5** tag as an example.
489+
Otherwise, check out the newest available tag. This guide uses **v4.7.2** tag as an example.
488490
489491
```shell
490-
git checkout v4.8.5
492+
git checkout v4.7.2
491493
```
492494
493495
6. Review the files relevant for this guide.
@@ -498,6 +500,8 @@ required Edge artifacts.
498500
- `earthly.sh` - Script to invoke the `Earthfile`, and generate target artifacts.
499501
- `user-data.template` - A sample file containing user data.
500502
503+
For more information about preparing the `.arg` file, refer to [Prepare User Data and Argument Files](/clusters/edge/edgeforge-workflow/prepare-user-data/)
504+
501505
7. Copy the **.arg.template** file from the **CanvOS** directory and name the copy **.arg**. Edit the `.arg` file to
502506
include the following arguments. These are the most commonly used arguments.
503507
@@ -675,7 +679,7 @@ Refer to the [Edge Configuration Stages](../../edge-configuration/cloud-init.md)
675679
system.repo: opensuse-leap
676680
system.k8sDistribution: k3s
677681
system.osName: opensuse-leap
678-
system.peVersion: v4.8.5
682+
system.peVersion: v4.7.2
679683
system.customTag: palette-learn
680684
system.osVersion:
681685
```
@@ -690,7 +694,7 @@ Refer to the [Edge Configuration Stages](../../edge-configuration/cloud-init.md)
690694

691695
```hideClipboard bash
692696
REPOSITORY TAG IMAGE ID CREATED SIZE
693-
spectrocloud/opensuse-leap k3s-1.33.5-v4.8.5-palette-learn 2427e3667b2f 24 minutes ago 2.22GB
697+
spectrocloud/opensuse-leap k3s-1.33.5-v4.7.2-palette-learn 2427e3667b2f 24 minutes ago 2.22GB
694698
```
695699

696700
14. To use the provider images in your cluster profile, push them to the image registry mentioned in the `.arg` file.
@@ -709,7 +713,7 @@ Refer to the [Edge Configuration Stages](../../edge-configuration/cloud-init.md)
709713
that the utility created.
710714

711715
```bash
712-
docker push spectrocloud/opensuse-leap:k3s-1.33.5-v4.8.5-palette-learn
716+
docker push spectrocloud/opensuse-leap:k3s-1.33.5-v4.7.2-palette-learn
713717
```
714718

715719
16. After pushing the provider images to the image registry, open a web browser and log in to
@@ -759,7 +763,7 @@ Refer to the [Edge Configuration Stages](../../edge-configuration/cloud-init.md)
759763
system.repo: opensuse-leap
760764
system.k8sDistribution: k3s
761765
system.osName: opensuse-leap
762-
system.peVersion: v4.8.5
766+
system.peVersion: v4.7.2
763767
system.customTag: palette-learn
764768
system.osVersion:
765769
```

docs/docs-content/clusters/edge/edgeforge-workflow/prepare-user-data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,10 @@ subject to change. For production workloads, create the `.arg` and `user-data` f
9595
git tag
9696
```
9797

98-
3. Check out the latest available tag. This guide uses the tag v4.8.5 as an example.
98+
3. Check out the latest available tag. This guide uses the tag v4.7.2 as an example.
9999

100100
```bash
101-
git checkout v4.8.5
101+
git checkout v4.7.2
102102
```
103103

104104
### Prepare .arg File
@@ -158,7 +158,7 @@ information about the deployment lifecycle of locally managed Edge hosts, refer
158158
159159
13. Cloud-init stages allow you to configure your Edge host declaratively. These stages are included in your `user-data`
160160
file. For more information about cloud-init stages, refer to
161-
[Cloud-init Stages](../edge-configuration/cloud-init.md).
161+
[Cloud Init Stages](../edge-configuration/cloud-init.md).
162162

163163
To configure cloud-init stages for your Edge host, use the `stages` block. For example, the following configuration
164164
installs Amazon Systems Manager agent on your Edge host during the `after-install-chroot` stage.

0 commit comments

Comments
 (0)