Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document user data form feature #4783

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,10 +222,20 @@ customization.
```bash
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. Open the **k8s_versions.json** file in the CanvOS directory. Remove the Kubernetes versions that you don't need from
the JSON object corresponding to your Kubernetes distribution.


If you are using a tag that is earlier than v4.4.12, the **k8s_versions.json** file does not exist in those tags.
Instead, open the **Earthfile** in the CanvOS directory. In the file, find the block that starts with
`build-provider-images-fips:` and delete the Kubernetes versions that you do not want. This will speed up the build
Expand Down Expand Up @@ -700,6 +710,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "spectro-cloud-docs",
"version": "4.5.5",
"version": "4.5.11",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down