From 7228791ce4ca9f8a620528b7ec704e90e0df4461 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 20 Nov 2024 13:02:47 -0700 Subject: [PATCH 1/2] fix: patch release --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3b7d8a0463..a6ab814a53 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "spectro-cloud-docs", - "version": "4.5.5", + "version": "4.5.11", "private": true, "scripts": { "docusaurus": "docusaurus", From 1a8295859f750fc2b2244c2b8fe6d7b54a266b25 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Fri, 22 Nov 2024 14:22:33 -0800 Subject: [PATCH 2/2] docs: draft user data form docs --- .../palette-canvos/build-installer-iso.md | 8 +++ .../edgeforge-workflow/palette-canvos/fips.md | 9 ++++ .../palette-canvos/palette-canvos.md | 14 +++++ .../edgeforge-workflow/prepare-user-data.md | 3 ++ .../host-management/edit-user-data.md | 51 +++++++++++++++++++ 5 files changed, 85 insertions(+) create mode 100644 docs/docs-content/clusters/edge/local-ui/host-management/edit-user-data.md diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-installer-iso.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-installer-iso.md index 50dc69a3ca..ab0fb53e80 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-installer-iso.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-installer-iso.md @@ -146,6 +146,14 @@ Use the following instructions to build the Edge Installer ISO. The optional ste override or supplement configuration you provided to the installer ISO. For more information, refer to [Apply Site User Data](../../site-deployment/site-installation/site-user-data.md). + :::info + + You can take advantage of the Tech Preview feature to edit user data in Local UI after installation. However, we + still recommend you provide user data during EdgeForge for production workloads, because not all user data fields can + be updated in Local UI. + + ::: + ### Build Content Bundle Optionally, you can include a content bundle in your Edge installer ISO. When you include a content bundle in your Edge diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md index 98804a372c..d9274e39c9 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md @@ -254,6 +254,15 @@ workaround. passwd: kairos ``` + :::info + + You can take advantage of the Tech Preview feature to edit user data in Local UI after installation. Refer to + [Edit User Data](../../local-ui/host-management/edit-user-data.md) for more information. However, we still recommend + you provide user data during EdgeForge for production workloads, because not all user data fields can be updated in + Local UI. + + ::: + The command in the `install` block is required for FIPS installations. Configurations in the `stylus` block provide the Edge Host with the registration token and the Palette endpoint. And the configurations in the `stage` block create a system user that you can use to log in to the Operating System (OS). diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md index 407ee6bbae..474479a0be 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md @@ -223,6 +223,15 @@ customization. cat user-data ``` + :::info + + You can take advantage of the Tech Preview feature to edit user data in Local UI after installation. Refer to + [Edit User Data](../../local-ui/host-management/edit-user-data.md) for more information. However, we still recommend + you provide user data during EdgeForge for production workloads, because not all user data fields can be updated in + Local UI. + + ::: + 10. The CanvOS utility uses [Earthly](https://earthly.dev/)(https://earthly.dev/) to build the target artifacts. By default, images are created for all the Palette-supported Kubernetes versions. Comment out the versions you do not need in the file **Earthfile** to speed up the build process and save disk space. @@ -704,6 +713,11 @@ git checkout v4.4.12 EOF ``` + You can take advantage of the Tech Preview feature to edit user data in Local UI after installation. Refer to + [Edit User Data](../../local-ui/host-management/edit-user-data.md) for more information. However, we still recommend + you provide user data during EdgeForge for production workloads, because not all user data fields can be updated in + Local UI. + :::info If you need to pull images from a private image registry, you can supply the credentials for the registry in the diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/prepare-user-data.md b/docs/docs-content/clusters/edge/edgeforge-workflow/prepare-user-data.md index 32f20a53c7..065b27c5ce 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/prepare-user-data.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/prepare-user-data.md @@ -14,6 +14,9 @@ configuration during site deployment as site-specific configuration. This can re installer configuration you provide to the installer ISO. For more information, refer to [Apply Site User Data](../site-deployment/site-installation/site-user-data.md). +After installation, you can also use Local UI to make edits to the user data file before you create a cluster. Refer to +[Edit User Data](../local-ui/host-management/edit-user-data.md) for more information. + This article guides you through several important configuration blocks in the **user-data** file. However, you can use many additional parameters to further customize your installation. Review the Edge [Install Configuration](../edge-configuration/installer-reference.md) resource to learn more about all the supported diff --git a/docs/docs-content/clusters/edge/local-ui/host-management/edit-user-data.md b/docs/docs-content/clusters/edge/local-ui/host-management/edit-user-data.md new file mode 100644 index 0000000000..1ad0186e2e --- /dev/null +++ b/docs/docs-content/clusters/edge/local-ui/host-management/edit-user-data.md @@ -0,0 +1,51 @@ +--- +sidebar_label: "Edit User Data" +title: "Edit User Data" +description: "Instructions for editing user data in Local UI." +hide_table_of_contents: false +sidebar_position: 20 +tags: ["edge"] +--- + +The **user-data** file is a YAML file that contains installer configuration for the Palette agent. This file is usually +prepared before the EdgeForge process and is written into the installer ISO. + +Local UI allows you to make edits to most fields in the **user-data** file after installation has completed before +cluster creation. The new settings will apply after the host reboots. + +:::preview + +::: + +## Limitations + +- The following fields cannot be edited. + - `stylus.site.deviceUIDPaths` + - `stylus.site.tagsFromFile` + - `stylus.site.tagsFromScript` + - `stylus.localUI.port` + - `stylus.includeTui` + - `stylus.debug` + - `stylus.trace` + - `stylus.disablePasswordUpdate` + - `stylus.imageRedirectWebhook` + - `install.bind_mounts` + +## Prerequisites + +- You have set `EnableUserdataForm` to true in your user data during EdgeForge. +- You host is not assigned to any cluster. + +## Edit User Data + +1. Log in to [Local UI](./access-console.md). + +2. In the + +## Validate + +1. Log in to [Local UI](./access-console.md). + +2. Click **Configure**. + +3. Confirm that the pre-populated values have been updated to the new values you configured.