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: add docs for cluster adoption #5218

Merged
merged 19 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from 18 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 @@ -29,6 +29,8 @@ Refer to the following resources to learn how to upload content and create a clu

- [Create Local Cluster](./create-cluster.md)

- [Pair Local Cluster with Palette](./local-to-central.md)

- [Link Hosts](./link-hosts.md)

- [Scale a Cluster](./scale-cluster.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ tags: ["edge"]
You can create and manage single-node as well as multi-node clusters on airgapped hosts locally from Local UI. This page
teaches you how to create a cluster using Local UI.

Unlike clusters that are managed by Palette, a local cluster is managed locally through Local UI. You can use Local UI
to create, update, scale, and delete the cluster. If your situation changes and you need central management of the
cluster, you can choose to [pair your local cluster to a Palette instance](./local-to-central.md) for centralized
management.

:::preview

:::
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
---
sidebar_label: "Pair Local Cluster with Palette"
title: "Pair Local Cluster with Palette"
description:
"Learn how to move a local cluster created on hosts with airgap installation mode to be managed by a Palette instance."
hide_table_of_contents: false
sidebar_position: 55
tags: ["edge"]
---

Clusters provisioned on hosts that are installed in the airgap installation mode are managed locally by Local UI. You
have the option to transfer the management of a local cluster from Local UI to a Palette instance to be managed
centrally by pairing the local cluster with a Palette instance.

lennessyy marked this conversation as resolved.
Show resolved Hide resolved
:::preview

:::

![Diagram of the order of operations for transferring a cluster to central management.](/clusters_edge_local-ui_local-to-central.webp)

## Pair Local Cluster with Palette

Moving a local cluster to central management is a two-step process. You first send a pairing request from your local
cluster to Palette using Local UI. Next, you accept the pairing request and select matching profiles in Palettes to
match the cluster stack.

### Prerequisites

- An active locally managed cluster. The cluster must be in the **Running** state and all nodes must be healthy.

- An Edge host registration token. For more information on how to create registration tokens, refer to
[Edge Host Registration](../../site-deployment/site-installation/create-registration-token.md).

- All Edge hosts in your cluster must be able to connect to the Palette instance you intend to use to manage the
cluster.

- Your Palette environment has cluster profiles whose latest version exactly matches all layers of the local cluster.
Refer to [Accept Pairing Request from Palette](#accept-pairing-request-from-palette) for details and examples.

- You have the required permissions to manage cluster pairing requests. For more information, refer to
[Roles and Permissions](../../../../user-management/palette-rbac/permissions.md).

### Procedure

#### Send Pairing Request from Local Cluster

1. Log in to Local UI. For guidance on how to log into Local UI, check out the
[Access Local UI](../host-management/access-console.md) guide.

2. On the left **Main Menu**, click **Settings**.

3. On the **Settings** tab, click on the radio button labeled **Centrally Managed**. You will be prompted to enter
information required for pairing your cluster with Palette.

4. Enter the URL for the Palette API endpoint. If you are using Palette SaaS, the endpoint is `api.spectrocloud.com`.
lennessyy marked this conversation as resolved.
Show resolved Hide resolved
For self-hosted Palette or VerteX instances, check in with your system administrator for the proper Palette URL
endpoint.

5. Enter your registration token in the **Registration token** field.

6. Click **Pair** to send the pairing request. A pairing ID will be displayed on the Local UI screen once a pairing
request has been sent. You may use the ID to identify this pairing request in a later step.

#### Accept Pairing Request from Palette

7. Log in to [Palette](https://console.palette.com).

8. From the left **Main Menu**, click **Clusters**.

9. At the top of the page, a box will be displayed prompting you to review pairing requests that Palette has received.
Click **Pair** to start reviewing the requests.

10. Identify the pairing request corresponding to your cluster by its pairing ID. Click **Pair**.

11. Palette will warn you that once paired, the cluster can only be managed centrally and that local cluster operations
will no longer be permitted. Check the box that says **I understand** and click **Confirm**. This will take you to
the **Pair Cluster** wizard.

12. You may change the cluster name as well as the description and tags for your cluster. The fields will be
pre-populated with their existing values. Once you are satisfied with your changes, click **Next step**.

13. Match the profile used by your local cluster by selecting profiles in your Palette environment. To make a successful
match, ensure that every pack in the profile used by your cluster is matched with the same pack in the exact same
version. You can only choose the latest version of a profile in Palette and must make sure that the latest version
of the profiles you use can match the cluster.

In the following example, the second and third columns are valid matches because every layer in the original cluster
has a matching layer in the matched profile. **Combination B** is valid even though it only has one full profile
instead of an infra and an add-on profile, because all the layers are exactly the same.

The fourth column shows an example of an invalid match because the **Add-on** profile has a pack that is in the
wrong version. The fifth column is also invalid because it has an additional pack that is not found in the local
cluster's cluster profile.

| Local cluster profile | Combination A | Combination B | Combination C | Combination D |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| **Infra profile** | **Infra profile** | **Full profile** | **Infra profile** | **Infra profile** |
| Amazon EBS CSI 1.20.0 | Amazon EBS CSI 1.20.0 | Amazon EBS CSI 1.20.0 | Amazon EBS CSI 1.20.0 | Amazon EBS CSI 1.20.0 |
| Calico 3.25.1 | Calico 3.25.1 | Calico 3.25.1 | Calico 3.25.1 | Calico 3.25.1 |
| PXK-E 1.31.0 | PXK-E 1.31.0 | PXK-E 1.31.0 | PXK-E 1.31.0 | PXK-E 1.31.0 |
| Ubuntu 22.04 | Ubuntu 22.04 | Ubuntu 22.04 | Ubuntu 22.04 | Ubuntu 22.04 |
| **Add-on profile** | **Add-on profile** | | **Add-on profile** | **Add-on profile** |
| Prometheus-Grafana 44.3.1 | Prometheus-Grafana 44.3.1 | Prometheus-Grafana 44.3.1 | Prometheus-Grafana 40.3.1 | Prometheus-Grafana 44.3.1 |
| | | | | Hello-Universe 2.0.0 |
| | Valid match ✅ | Valid match ✅ | Invalid match ❌ | Invalid match ❌ |

Once your have selected a valid match, click **Confirm**. Then click **Next step**.

14. Review the profile configurations. Once you are done, click **Validate**.

15. Click **Pair cluster** to start pairing your cluster.

### Validate

1. Log in to [Palette](https://console.palette.com).

2. From the left **Main Menu**, click **Clusters**.

3. Confirm that the cluster is now registered with Palette and can be managed centrally.

## Withdraw Pairing Request From Local Cluster

If you send a pairing request in error from your local cluster, you can withdraw the pairing request before it is
accepted by your Palette instance.

### Prerequisite

- Access to [Local UI](../host-management/access-console.md).

- A pending pairing request. Refer to
[Send Pairing Request From Local Cluster](#send-pairing-request-from-local-cluster).

### Procedure

1. Log in to [Local UI](../host-management/access-console.md).

2. On the left **Main Menu**, click **Settings**.

3. Copy the **Pairing ID** and save it in a safe location. This ID may be useful when you need to delete the pairing
request in Palette manually.

4. Click **Cancel Pairing Request**.

5. Your host will inform Palette that the pairing request has been cancelled. This will remove the pending pairing
request from your Palette instance as well.

However, if your host cannot connect to your Palette instance, this request will not be able to reach Palette. If
your host cannot connect to Palette, refer to
[Reject Pairing Request form Palette](#reject-pairing-request-in-palette) to reject the pending pairing request
manually.

### Validate

1. Log in to [Local UI](../host-management/access-console.md).

2. On the left **Main Menu**, click **Settings**.

3. Confirm that your cluster is locally managed and does not have a pending pairing request anymore.

## Reject Pairing Request in Palette
lennessyy marked this conversation as resolved.
Show resolved Hide resolved

If you receive a pairing request that you do not recognize, or if you have a pending pairing request that you know has
been canceled, you can reject the pairing request. You can use tags and the unique pairing ID to identify each pairing
request.

### Prerequisites

- A pending pairing request. Refer to [Pair Local Cluster with Palette](#pair-local-cluster-with-palette) to learn how
to make one.

- You have the required permissions to manage cluster pairing requests. For more information, refer to
[Roles and Permissions](../../../../user-management/palette-rbac/permissions.md).

- The pairing ID of the pairing request.

### Procedure

1. Log in to [Palette](https://console.palette.com).

2. From the left **Main Menu**, click **Clusters**.

3. At the top of the page, a box will be displayed prompting you to review pairing requests that Palette has received.
Click **Pair** to start reviewing the requests.

4. Identify the pairing request corresponding to your cluster by its pairing ID or tags. Click **Reject**.

### Validate

1. Log in to [Palette](https://console.palette.com).

2. From the left **Main Menu**, click **Clusters**.

3. If you rejected the only pairing request, confirm that the pairing prompt box is no longer present in the
**Clusters** page.

If you still have pending pairing requests remaining, at the top of the page, a box will be displayed prompting you
to review pairing requests that Palette has received. Click **Pair** to start reviewing the requests. Confirm that
the request you rejected is no longer present.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@ sidebar_position: 10
tags: ["edge"]
---

To successfully register an Edge host with Palette you must provide the Edge Installer with a tenant registration token.
Registration tokens are tokens that are associated with a project in Palette. You will need the registration token in
the following situations:

- When you need to register an Edge host with Palette. For more information, refer to
[Edge Host Registration](./edge-host-registration.md).
- When you need to pair a locally managed cluster with Palette so that it can be managed centrally. For more
information, refer to [Pair Local Cluster with Palette](../../local-ui/cluster-management/local-to-central.md).

To create a registration token, use the following steps.

## Prerequisites
Expand Down
11 changes: 11 additions & 0 deletions docs/docs-content/user-management/palette-rbac/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ scopes you can assign permissions to.
| Cloud Account | `cloudaccount` | ✅ | ✅ | ✅ | Cloud account creation and management |
| Cloud Config | `cloudconfig` | ✅ | ✅ | ✅ | Cluster level cloud configuration |
| Cluster | `cluster` | ✅ | ✅ | ✅ | Creation and management of Palette workload clusters |
| Cluster Pair | `clusterPair` | ✅ | ✅ | | Management of cluster pairing requests. |
| Cluster Group | `clusterGroup` | ✅ | ✅ | | Creation and management of cluster groups |
| Cluster Profile | `clusterProfile` | ✅ | ✅ | ✅ | Creation and management of Palette cluster profiles |
| DNS Mapping | `dnsMapping` | | ✅ | ✅ | Domain Name Server mapping services creation and management |
Expand Down Expand Up @@ -116,6 +117,16 @@ the list of operations.
- update

</AccordionPanel>

<AccordionPanel title="Cluster Pair">

- delete
- get
- list
- update

</AccordionPanel>

<AccordionPanel title="Cluster Group">

- create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,10 @@ review the permissions associated with each Project role, click on the role name
- clusterGroup.list
- clusterProfile.get
- clusterProfile.list
- clusterPair.delete
- clusterPair.get
- clusterPair.list
- clusterPair.update
- dnsMapping.create
- dnsMapping.delete
- dnsMapping.get
Expand Down Expand Up @@ -538,6 +542,10 @@ review the permissions associated with each Project role, click on the role name
- clusterGroup.get
- clusterGroup.list
- clusterGroup.update
- clusterPair.delete
- clusterPair.get
- clusterPair.list
- clusterPair.update
- clusterProfile.create
- clusterProfile.delete
- clusterProfile.get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ review the permissions associated with each Tenant role, click on the role name
- clusterGroup.get
- clusterGroup.list
- clusterGroup.update
- clusterPair.delete
- clusterPair.get
- clusterPair.list
- clusterPair.update
- clusterProfile.create
- clusterProfile.delete
- clusterProfile.get
Expand Down Expand Up @@ -359,6 +363,10 @@ review the permissions associated with each Tenant role, click on the role name
- clusterGroup.get
- clusterGroup.list
- clusterGroup.update
- clusterPair.delete
- clusterPair.get
- clusterPair.list
- clusterPair.update
- clusterProfile.create
- clusterProfile.delete
- clusterProfile.get
Expand Down
Binary file not shown.
Loading