You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Copy the **.arg.template** file from the **CanvOS** directory and name the copy **.arg**. Edit the `.arg` file to include the following fields. These are the most commonly used fields.
7
-
- ARCH
8
-
- OS_DISTRIBUTION
9
-
- OS_VERSION
10
-
- K8S_DISTRIBUTION
11
-
- K8S_VERSION
12
-
- IMAGE_REGISTRY
13
-
- IMAGE_REPO
14
-
- CUSTOM_TAG
6
+
Specify the system architecture, OS distribution, and version. These configurations apply to your Edge host's OS both before and after cluster formation.
15
7
16
-
2.Specify the system architecture, OS distribution, and version. These configurations apply to your Edge host's OS both before and after cluster formation.
8
+
<li>Specify the Kubernetes distribution and version. This is used with the OS distribution and version to create an immutable provider image with your specified OS and Kubernetes. </li>
17
9
18
-
3. Specify the Kubernetes distribution and version. This is used with the OS distribution and version to create an immutable provider image with your specified OS and Kubernetes.
19
-
20
-
21
-
::: info
10
+
:::info
22
11
23
12
To build multiple versions of a provider image with different Kubernetes versions, use the `k8s_version.json` file in the repository. You must leave the `K8S_VERSION` field in your `.arg` file empty to use the JSON file. This file is only used when `K8S_VERSION` is not detected as an argument.
24
13
25
14
:::
26
15
27
-
4. Specify the image registry, image repository name, and custom tag for your provider images. The custom tag, together with the Palette agent version (the same number as the Git tag you are using), the version and distribution of Kubernetes, and the OS used by the image forms the tag of the image.
16
+
<li>Specify the image registry, image repository name, and custom tag for your provider images. The custom tag, together with the Palette agent version (the same number as the Git tag you are using), the version and distribution of Kubernetes, and the OS used by the image forms the tag of the image.</li>
17
+
28
18
29
19
For example, if your `.arg` file contains the following arguments, the full image reference would be
Refer to [Edge Artifact Build Configurations](./arg.md) for all available .arg configuration parameters.
43
-
44
-
:::preview
45
-
46
-
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change. Do not use this feature in production workloads.
47
-
48
-
:::
32
+
The `.arg` file uses the default values for any remaining arguments. Refer to [Edge Artifact Build Configurations](./arg) for all available `.arg` configuration parameters.
49
33
50
-
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 will 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.8.5-palette-learn`.
1.From the CanvOS directory, copy the **user-data.template** file and name the copy **user-data**. Edit the `user-data` file to include the following fields under `stylus.site`.
6
+
From the CanvOS directory, copy the **user-data.template** file and name the copy **user-data**. Edit the `user-data` file to include the following fields under `stylus.site`.
7
7
- edgeHostToken
8
8
- paletteEndpoint
9
9
- projectName
10
10
11
-
:::tip
12
-
13
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.
14
12
15
13
```shell
@@ -18,7 +16,5 @@ stylus:
18
16
site:
19
17
...
20
18
```
21
-
Refer to **Cloud Init Stages** and the **Edge Installer Configuration Reference** for supported keys and stages.
22
-
23
-
:::
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.
0 commit comments