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

Day-2 operations for profile variables #2911

Merged
merged 4 commits into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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 @@ -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"]
---

Expand All @@ -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
Expand All @@ -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**.

Expand All @@ -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.
Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when there are this many .. i would just use absolute path. This way if anything moves this link won't bother you. No need to change it now but just something i do to make my life easier.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lenny we can't use absolute paths, we have to use relative paths otherwise it breaks versioning.

https://docusaurus.io/docs/markdown-features/links

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub did me dirty 😓


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.
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
---

Expand Down
Loading