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
Copy file name to clipboardExpand all lines: docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md
+56-52Lines changed: 56 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -132,24 +132,25 @@ customization.
132
132
-`earthly.sh` - Script to invoke the `Earthfile`, and generate target artifacts.
133
133
-`user-data.template` - A sample file containing user data.
134
134
135
-
7. 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.
136
-
137
-
- ARCH
138
-
- OS_DISTRIBUTION
139
-
- OS_VERSION
140
-
- K8S_DISTRIBUTION
141
-
- K8S_VERSION
142
-
- IMAGE_REGISTRY
143
-
- IMAGE_REPO
144
-
- CUSTOM_TAG
135
+
7. Copy the **.arg.template** file from the **CanvOS** directory and name the copy **.arg**. Edit the `.arg` file to
136
+
include the following fields. These are the most commonly used fields.
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
151
-
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change.
152
-
Do not use this feature in production workloads.
151
+
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
152
+
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change. Do
153
+
not use this feature in production workloads.
153
154
154
155
:::
155
156
@@ -299,7 +300,8 @@ customization.
299
300
spectrocloud/ubuntu k3s-1.33.5-v4.8.5-palette-learn 075134ad5d4b 10 minutes ago 4.11GB
300
301
```
301
302
302
-
14. To use the provider image with your Edge deployment, push it to the image registry specified in the `.arg` file. Log in to your container registry. Provide your credentials when prompted. The example below provides a Docker login
303
+
14. To use the provider image with your Edge deployment, push it to the image registry specified in the `.arg` file. Log
304
+
in to your container registry. Provide your credentials when prompted. The example below provides a Docker login
5. If you are using a self-hosted instance of Palette and have determined a specific CanvOS version, checkout out the corresponding tag.
484
+
5. If you are using a self-hosted instance of Palette and have determined a specific CanvOS version, checkout out the
485
+
corresponding tag.
483
486
484
487
Otherwise, check out the newest available tag. This guide uses **v4.8.5** tag as an example.
485
488
@@ -495,59 +498,59 @@ required Edge artifacts.
495
498
- `earthly.sh` - Script to invoke the `Earthfile`, and generate target artifacts.
496
499
- `user-data.template` - A sample file containing user data.
497
500
498
-
7. Copy the **.arg.template** file from the **CanvOS** directory and name the copy **.arg**. Edit the `.arg` file to include the following arguments. These are the most commonly used arguments.
501
+
7. Copy the **.arg.template** file from the **CanvOS** directory and name the copy **.arg**. Edit the `.arg` file to
502
+
include the following arguments. These are the most commonly used arguments.
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
515
-
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change.
516
-
Do not use this feature in production workloads.
517
+
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
518
+
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change. Do
519
+
not use this feature in production workloads.
517
520
518
521
:::
519
522
520
-
View the newly created file to ensure the customized arguments are set correctly.
523
+
View the newly created file to ensure the customized arguments are set correctly.
521
524
522
-
```bash
523
-
cat .arg
524
-
```
525
+
```bash
526
+
cat .arg
527
+
```
525
528
526
-
:::warning
529
+
:::warning
527
530
528
-
Ensure the final artifact name conforms to the `[IMAGE_REGISTRY]/[IMAGE_REPO]:[CUSTOM_TAG]`naming pattern.
531
+
Ensure the final artifact name conforms to the `[IMAGE_REGISTRY]/[IMAGE_REPO]:[CUSTOM_TAG]`naming pattern.
529
532
530
-
:::
533
+
:::
531
534
532
535
9. (Optional) This step is only required if your builds occur in a proxied network environment, and your proxy servers
533
-
require client certificates, or if your base image is in a registry that requires client certificates.
536
+
require client certificates, or if your base image is in a registry that requires client certificates.
534
537
535
-
You can provide the base-64 encoded certificates in PEM format in the `certs` folder at the root directory of the
536
-
`CanvOS` repository. You can provide as many certificates as you need in the folder.
538
+
You can provide the base-64 encoded certificates in PEM format in the `certs` folder at the root directory of the
539
+
`CanvOS` repository. You can provide as many certificates as you need in the folder.
537
540
538
-
If you are using a CanvOS tag that is earlier than `4.5.15`, you need to use the `PROXY_CERT_PATH` build argument to
539
-
provide a path to the certificate. This approach only allows you to specify one certificate. For more information,
540
-
refer to [Earthly Build Arguments](../../edgeforge-workflow/palette-canvos/arg.md).
541
+
If you are using a CanvOS tag that is earlier than `4.5.15`, you need to use the `PROXY_CERT_PATH` build argument to
542
+
provide a path to the certificate. This approach only allows you to specify one certificate. For more information,
543
+
refer to [Earthly Build Arguments](../../edgeforge-workflow/palette-canvos/arg.md).
541
544
542
-
:::warning
545
+
:::warning
543
546
544
-
These proxy settings are only configured for the build process itself, when your builder machine needs to pull
545
-
certain images to build the Edge artifacts. These certificates will not be present on the host after it has been
546
-
deployed. To configure the proxy network settings for a host, refer to
547
-
[Configure HTTP Proxy](../../local-ui/host-management/configure-proxy.md) or
548
-
[Configure Proxy in User Data](../prepare-user-data.md#configure-proxy-settings-optional).
547
+
These proxy settings are only configured for the build process itself, when your builder machine needs to pull
548
+
certain images to build the Edge artifacts. These certificates will not be present on the host after it has been
549
+
deployed. To configure the proxy network settings for a host, refer to
550
+
[Configure HTTP Proxy](../../local-ui/host-management/configure-proxy.md) or
551
+
[Configure Proxy in User Data](../prepare-user-data.md#configure-proxy-settings-optional).
549
552
550
-
:::
553
+
:::
551
554
552
555
10. Use the following command to append the [WireGuard](https://www.wireguard.com/install/) installation instructions to
553
556
the `Dockerfile`. You can install more tools and dependencies and configure the image to meet your needs. Add your
@@ -577,7 +580,8 @@ required Edge artifacts.
577
580
578
581
:::warning
579
582
580
-
If you haven't set a default project forthe registration token, ensure that you provide the `stylus.site.projectName` parameter with the value `Default`in the `user-data` file.
583
+
If you haven't set a default project for the registration token, ensure that you provide the
584
+
`stylus.site.projectName` parameter with the value `Default`in the `user-data` file.
581
585
582
586
:::
583
587
@@ -601,8 +605,8 @@ required Edge artifacts.
601
605
cat user-data
602
606
```
603
607
604
-
Refer to the [Edge Configuration Stages](../../edge-configuration/cloud-init.md) and
605
-
[User Data Parameters](../../edge-configuration/installer-reference.md) documents to learn more.
608
+
Refer to the [Edge Configuration Stages](../../edge-configuration/cloud-init.md) and
609
+
[User Data Parameters](../../edge-configuration/installer-reference.md) documents to learn more.
606
610
607
611
12. CanvOS utility uses [Earthly](https://earthly.dev/) to build the target artifacts. Issue the following command to
11. Decide if you want your Edge host centrally managed by Palette or managed locally. The default configuration is a centrally managed Edge host. If you want to deploy an Edge host that is not connected to a Palette instance, change the management mode to `local` by adding the `managementMode` parameter to under the
121
-
`stylus` parameter.
120
+
8. Decide if you want your Edge host centrally managed by Palette or managed locally. The default configuration is a
121
+
centrally managed Edge host. If you want to deploy an Edge host that is not connected to a Palette instance, change
122
+
the management mode to `local` by adding the `managementMode` parameter to under the `stylus` parameter.
122
123
123
-
```yaml
124
-
#cloud-config
125
-
stylus:
126
-
managementMode: local
127
-
```
124
+
```yaml
125
+
#cloud-config
126
+
stylus:
127
+
managementMode: local
128
+
```
128
129
129
-
Edge hosts installed in local management mode require you to provide assets needed to provision clusters. For more
130
-
information about the deployment lifecycle of locally managed Edge hosts, refer to
12. If you want to deploy a locally managed Edge host, skip this step.
134
135
135
-
To deploy the Edge host in central management mode, provide the Palette endpoint in
136
-
addition to either a registration token or QR code registration configuration. For more information about Edge host
137
-
registration, refer to [Edge Host Registration](../site-deployment/site-installation/edge-host-registration.md). For
138
-
example, the following configuration provides the default Palette endpoint, a registration token, and a project name.
136
+
To deploy the Edge host in central management mode, provide the Palette endpoint in addition to either a
137
+
registration token or QR code registration configuration. For more information about Edge host registration, refer
138
+
to [Edge Host Registration](../site-deployment/site-installation/edge-host-registration.md). For example, the
139
+
following configuration provides the default Palette endpoint, a registration token, and a project name.
139
140
140
141
```yaml
141
142
#cloud-config
@@ -155,16 +156,16 @@ subject to change. For production workloads, create the `.arg` and `user-data` f
155
156
156
157
#### Configure Cloud-init Stages (Optional)
157
158
158
-
13. Cloud-init stages allow you to configure your Edge host declaratively. These stages are included in your `user-data` file. For more information about cloud-init stages,
159
-
refer to [Cloud-init Stages](../edge-configuration/cloud-init.md).
159
+
13. Cloud-init stages allow you to configure your Edge host declaratively. These stages are included in your `user-data`
160
+
file. For more information about cloud-init stages, refer to
0 commit comments