Skip to content

Commit 15c525e

Browse files
StacySpectrogithub-actions[bot]
authored andcommitted
ci: auto-formatting prettier issues
1 parent ddf134d commit 15c525e

File tree

2 files changed

+78
-73
lines changed

2 files changed

+78
-73
lines changed

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

Lines changed: 56 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -132,24 +132,25 @@ customization.
132132
- `earthly.sh` - Script to invoke the `Earthfile`, and generate target artifacts.
133133
- `user-data.template` - A sample file containing user data.
134134

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.
137+
138+
- ARCH
139+
- OS_DISTRIBUTION
140+
- OS_VERSION
141+
- K8S_DISTRIBUTION
142+
- K8S_VERSION
143+
- IMAGE_REGISTRY
144+
- IMAGE_REPO
145+
- CUSTOM_TAG
145146

146147
8. <PartialsComponent category="palette-edge-canvos-version" name="canvos-edge-arg-file" />
147148

148-
:::preview
149+
:::preview
149150

150-
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.
153154

154155
:::
155156

@@ -299,7 +300,8 @@ customization.
299300
spectrocloud/ubuntu k3s-1.33.5-v4.8.5-palette-learn 075134ad5d4b 10 minutes ago 4.11GB
300301
```
301302
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
303305
command.
304306
305307
```bash
@@ -479,7 +481,8 @@ required Edge artifacts.
479481
480482
<PartialsComponent category="palette-edge-canvos-version" name="canvos-version" />
481483
482-
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.
483486
484487
Otherwise, check out the newest available tag. This guide uses **v4.8.5** tag as an example.
485488
@@ -495,59 +498,59 @@ required Edge artifacts.
495498
- `earthly.sh` - Script to invoke the `Earthfile`, and generate target artifacts.
496499
- `user-data.template` - A sample file containing user data.
497500
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.
499503
500-
- ARCH
501-
- OS_DISTRIBUTION
502-
- OS_VERSION
503-
- K8S_DISTRIBUTION
504-
- K8S_VERSION
505-
- IMAGE_REGISTRY
506-
- IMAGE_REPO
507-
- CUSTOM_TAG
504+
- ARCH
505+
- OS_DISTRIBUTION
506+
- OS_VERSION
507+
- K8S_DISTRIBUTION
508+
- K8S_VERSION
509+
- IMAGE_REGISTRY
510+
- IMAGE_REPO
511+
- CUSTOM_TAG
508512
509513
8. <PartialsComponent category="palette-edge-canvos-version" name="canvos-edge-arg-file" />
510514
511-
512515
:::preview
513516
514-
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.
517520
518521
:::
519522
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.
521524
522-
```bash
523-
cat .arg
524-
```
525+
```bash
526+
cat .arg
527+
```
525528
526-
:::warning
529+
:::warning
527530
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.
529532
530-
:::
533+
:::
531534
532535
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.
534537
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.
537540
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).
541544
542-
:::warning
545+
:::warning
543546
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).
549552
550-
:::
553+
:::
551554
552555
10. Use the following command to append the [WireGuard](https://www.wireguard.com/install/) installation instructions to
553556
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.
577580
578581
:::warning
579582
580-
If you haven't set a default project for the 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.
581585

582586
:::
583587

@@ -601,8 +605,8 @@ required Edge artifacts.
601605
cat user-data
602606
```
603607

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.
606610

607611
12. CanvOS utility uses [Earthly](https://earthly.dev/) to build the target artifacts. Issue the following command to
608612
start the build process.

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

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -105,37 +105,38 @@ subject to change. For production workloads, create the `.arg` and `user-data` f
105105

106106
4. <PartialsComponent category="palette-edge-canvos-version" name="canvos-edge-arg-file" />
107107

108-
8. (Optional) If your build machine isn't in a restricted network environment, or your build process does not require
108+
5. (Optional) If your build machine isn't in a restricted network environment, or your build process does not require
109109
access to a proxy server, skip this step.
110110

111111
You can use `HTTP_PROXY` and `HTTPS_PROXY` to specify the URLs of the proxy servers to be used for your build.
112112

113-
9. Refer to [Edge Artifact Build Configurations](./palette-canvos/arg.md) for a comprehensive list of arguments you can
113+
6. Refer to [Edge Artifact Build Configurations](./palette-canvos/arg.md) for a comprehensive list of arguments you can
114114
use to customize the build.
115115

116116
### Prepare User Data
117117

118-
10. <PartialsComponent category="palette-edge-canvos-version" name="canvos-edge-user-data" />
118+
7. <PartialsComponent category="palette-edge-canvos-version" name="canvos-edge-user-data" />
119119

120-
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.
122123

123-
```yaml
124-
#cloud-config
125-
stylus:
126-
managementMode: local
127-
```
124+
```yaml
125+
#cloud-config
126+
stylus:
127+
managementMode: local
128+
```
128129
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
131-
[Edge Deployment Lifecycle](../edge-native-lifecycle.md).
130+
Edge hosts installed in local management mode require you to provide assets needed to provision clusters. For more
131+
information about the deployment lifecycle of locally managed Edge hosts, refer to
132+
[Edge Deployment Lifecycle](../edge-native-lifecycle.md).
132133
133134
12. If you want to deploy a locally managed Edge host, skip this step.
134135
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.
139140
140141
```yaml
141142
#cloud-config
@@ -155,16 +156,16 @@ subject to change. For production workloads, create the `.arg` and `user-data` f
155156
156157
#### Configure Cloud-init Stages (Optional)
157158
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
161+
[Cloud-init Stages](../edge-configuration/cloud-init.md).
160162

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

164166
```yaml
165167
#cloud-config
166-
...
167-
168+
---
168169
stages:
169170
after-install-chroot:
170171
- name: "Install SSM"

0 commit comments

Comments
 (0)