diff --git a/_partials/index.ts b/_partials/index.ts new file mode 100644 index 0000000000..6c691941af --- /dev/null +++ b/_partials/index.ts @@ -0,0 +1,2 @@ +// This file is generated. DO NOT EDIT! +export * as partialexample2689 from "@site/_partials/_partial_example.mdx"; diff --git a/docs/docs-content/clusters/edge/local-ui/cluster-management/create-cluster.md b/docs/docs-content/clusters/edge/local-ui/cluster-management/create-cluster.md index 3c106e9df3..36775b1c72 100644 --- a/docs/docs-content/clusters/edge/local-ui/cluster-management/create-cluster.md +++ b/docs/docs-content/clusters/edge/local-ui/cluster-management/create-cluster.md @@ -3,7 +3,7 @@ sidebar_label: "Create Local Cluster" title: "Create Local Cluster" description: "Instructions for creating a locally manageg cluster in Edge Host Management Console." hide_table_of_contents: false -sidebar_position: 32 +sidebar_position: 30 tags: ["edge"] --- @@ -16,7 +16,7 @@ cluster using Local UI. ## Limitations -- You can only create single node clusters consisting solely of the Edge host you create the cluster from. You cannot +- You can only create single-node clusters consisting solely of the Edge host you create the cluster from. You cannot include other Edge hosts in the same local or remote network. ## Prerequisites @@ -34,7 +34,7 @@ cluster using Local UI. 1. Log into the local UI by visiting the 5080 port of your Edge device's IP address or domain name. For more information, refer to [Access Local UI](../host-management/access-console.md). -2. From the left **Main Menu**, click **Clusters**. +2. From the left **Main Menu**, click **Cluster**. 3. Click **Create cluster**. @@ -57,7 +57,10 @@ cluster using Local UI. 6. If your selected cluster profile has profile variables, you will now be prompted to enter the values for those profile variables. The variables with default values will be auto-populated unless the variable value is masked when - you defined the variable. Enter the values for the profile variables and click **Next**. + you defined the variable. For more information on cluster profile variables, refer to + [Define and Manage Profile Variables](../../../../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md). + + Enter the values for the profile variables and click **Next**. 7. In the **Cluster Config** step, enter a virtual IP address to be used by your cluster. Optionally, you can also specify a Network Time Protocol server and an SSH public key. @@ -82,4 +85,4 @@ cluster using Local UI. 1. Log in to the local UI. -2. Click **Clusters**. Verify that you cluster has entered the running status. +2. Click **Cluster**. Verify that your cluster has entered the running status. diff --git a/docs/docs-content/clusters/edge/local-ui/cluster-management/export-cluster-definition.md b/docs/docs-content/clusters/edge/local-ui/cluster-management/export-cluster-definition.md index b8a3e4a87e..f2eaa477ba 100644 --- a/docs/docs-content/clusters/edge/local-ui/cluster-management/export-cluster-definition.md +++ b/docs/docs-content/clusters/edge/local-ui/cluster-management/export-cluster-definition.md @@ -3,7 +3,7 @@ sidebar_label: "Export Cluster Definition" title: "Export Cluster Definition" description: "Instructions for exporting cluster definition." hide_table_of_contents: false -sidebar_position: 32 +sidebar_position: 50 tags: ["edge"] --- diff --git a/docs/docs-content/clusters/edge/local-ui/cluster-management/update-cluster.md b/docs/docs-content/clusters/edge/local-ui/cluster-management/update-cluster.md new file mode 100644 index 0000000000..921ff7e66d --- /dev/null +++ b/docs/docs-content/clusters/edge/local-ui/cluster-management/update-cluster.md @@ -0,0 +1,71 @@ +--- +sidebar_label: "Update Local Cluster" +title: "Update Local Cluster" +description: "Instructions for updating a locally manageg cluster in Edge Host Management Console." +hide_table_of_contents: false +sidebar_position: 40 +tags: ["edge"] +--- + +You can update existing local clusters from the local UI by uploading a new cluster profile version. This guide explains +how to update an existing cluster in local UI. + +:::preview + +::: + +## Prerequisites + +- Network access to the Edge device’s IP and port where the local UI is exposed. The default port is 5080. + +- Credentials to log into the local UI. Any OS user can be used to log in to the local UI. + +- A local cluster created in local UI. For more information, refer to [Create Local Cluster](create-cluster.md). + +## Update Local Cluster + +1. Log into the local UI by visiting the 5080 port of your Edge device's IP address or domain name. For more + information, refer to [Access Local UI](../host-management/access-console.md). + +2. From the left **Main Menu**, select **Cluster**, and then select the **Configuration** tab. + +3. In the upper-right corner, select **Upload Configuration**. + +4. In the **Upload Configuration** wizard, browse or drag and drop the new cluster profile version **.tgz** file. Once + the upload finishes, select **Review Changes**. + + To learn more about how to export a cluster profile and import it during this step, refer to + [Export Cluster Definition](./export-cluster-definition.md). + +5. Local UI displays the **Review Changes** modal, where you can review the update summary and verify all incoming + changes to the cluster profile variables. Your current configuration is displayed on the left, and the incoming + changes are displayed on the right. + + For more information on cluster profile variables, refer to + [Define and Manage Profile Variables](../../../../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md). + +6. Click each profile variable and review the changes. You can specify values for new profile variables, override the + incoming default values, or leave the incoming changes as is, depending on your local cluster configuration. + + :::info + + If your current cluster configuration overrides the default profile variable values, local UI will preserve your + configuration in case the update introduces new defaults. To use the new default values, click **Use default** in the + respective profile variable field. + + ::: + +7. Once all incoming changes have the **Reviewed** status, click **Confirm Changes**. + +8. Review all profile variables on the **Configuration** tab to make sure that the cluster configuration matches your + expectations. + +9. In the bottom-left corner, click **Update**. + +## Validate + +1. Log in to the local UI. + +2. From the left **Main Menu**, select **Cluster**. + +3. Verify that your cluster is in the **Running** status. diff --git a/docs/docs-content/clusters/edge/local-ui/cluster-management/upload-content-bundle.md b/docs/docs-content/clusters/edge/local-ui/cluster-management/upload-content-bundle.md index 22129fe76c..1c3af0f084 100644 --- a/docs/docs-content/clusters/edge/local-ui/cluster-management/upload-content-bundle.md +++ b/docs/docs-content/clusters/edge/local-ui/cluster-management/upload-content-bundle.md @@ -3,7 +3,7 @@ sidebar_label: "Upload Content Bundle" title: "Upload Content Bundle" description: "Instructions for building and uploading content to Edge hosts." hide_table_of_contents: false -sidebar_position: 32 +sidebar_position: 60 tags: ["edge"] ---