Version: latest

Migrate a PCG

Clusters deployed through a Private Cloud Gateway (PCG) maintain a reference point to the PCG that deployed them. This reference point is required for Palette to know which PCG to use when the cluster needs to be removed. A Cluster API pivot occurs between the PCG and the cluster during a cluster deployment and removal. In a cluster creation, the pivot occurs from the PCG to the cluster. In a cluster removal, the Cluster API pivot occurs from the cluster to the PCG. Check out the Order of Operations page to learn more about the Cluster API pivot.

The cluster's PCG reference point is stored in the Palette management plane's internal database. You can retrieve a cluster's PCG reference point by using the Palette API endpoint GET /v1/spectroclusters/:uid. The response payload's metadata.annotations.overlordUid field contains the ID of the PCG that deployed the cluster.

{
    "metadata": {
        "annotations": {
            "jetUid": "***********************",
            "overlordUid": "6732677ce46389af646d517a",
            "ownerUid": "***********************",
            "palette.spectrocloud.com/disablenodeautoremidiation": "false",
            "permissions": "cluster.create,cluster.delete,cluster.get,cluster.import,cluster.list,cluster.update,tag.update",
            "projectUid": "***********************",
            "rootDomain": "console.spectrocloud.com",
            "scope": "project",
            "scopeVisibility": "16",
            "spectroComponentsUpgradeForbidden": "true",
            "tenantUid": "***********************"
        },

How do I get my PCG's overlordUid?

The overlordUid is a unique identifier of the PCG that deployed the cluster. However, this value is different from the actual cluster ID of the PCG. To retrieve a PCG cluster's overlordUid, use the following kubectl command on the PCG cluster.

kubectl get configmap overlord-config --namespace=jet-system --output=jsonpath='{.data.overlord-config\.yaml}' | grep 'overlordUid:' | sed 's/overlordUid: //'

You will get the overlordUid of the PCG cluster.

6732677ce46389af646d517a

What is a PCG migration?

A PCG migration is an action that updates the PCG reference point mapping in Palette for clusters deployed by a specific PCG. All clusters deployed by the original PCG will be updated to reference a new PCG. This action is internal to the Palette management plane. The migration process is necessary when you want to remove the existing PCG. The ability to migrate a PCG is helpful in scenarios such as:

Decommissioning an existing PCG.
PCG upgrade errors.

warning

A PCG migration is an irreversible action. Once a PCG is migrated, the original PCG is no longer associated with the clusters that it deployed.

Use the following steps to update the PCG reference point mapping to a different PCG.

Prerequisites

Tenant admin access to Palette.
At least two healthy PCGs with network connectivity to the Palette management plane.
The new PCG must target the same infrastructure provider as the existing PCG.

Migrate PCG

Log in to Palette as a tenant administrator.
Navigate to the left Main Menu and select Tenant Settings.
Select Private Cloud Gateways from the Tenant Settings Menu.
In the list of PCGs, identify the PCG that you want to migrate and click on the three-dot Menu at the end of the PCG row.
Select Migrate from the drop-down Menu.
In the Migrate Cloud Gateway dialog box, select the PCG from the PCG drop-down list that you want to migrate to.
Click Migrate.

We recommend you remove the cloud account created by the PCG that you migrated. This will prevent any future cluster deployments from using the cloud account associated with the migrated PCG. During a cluster deployment, if you accidentally select the cloud account mapped to the former PCG, Palette will automatically ensure the newly specified PCG is used as the PCG reference point instead of the former PCG that belongs to the cloud account selected.

Validate

After the migration is complete, you can validate it by checking that a cluster deployed with the migrated PCG no longer references the old PCG. Use the Palette API endpoint GET /v1/spectroclusters/:uid and verify the metadata.annotations.overlordUid field to ensure that the cluster now references the new PCG.

Log in to Palette.
Navigate to the left Main Menu and click Clusters.
Click on a cluster that was deployed by the PCG that you migrated. Take note of the cluster ID. You can find the ID in the URL of the browser. It is the last part of the URL, located after /clusters/.
```
https://console.spectrocloud.com/clusters/11111111111111111111
```
Retrieve a deployed cluster's overlordUid using the Palette API endpoint GET /v1/spectroclusters/:uid. You can use the curl command below. Make sure you replace the :uid path parameter with the cluster ID, and the apiKey and ProjectUid headers with your own values.
```
curl --location 'https://api.spectrocloud.com/v1/spectroclusters/:uid' \
--header 'ProjectUid: XXXXXXXXXXXX' \
--header 'Accept: application/json' \
--header 'apiKey: XXXXXXXXXXX'
```

Verify that the metadata.annotations.overlordUid field in the response payload matches the new PCG's overlordUid. Refer to the intro section of this guide for guidance on how to get the overlordUid of a PCG cluster.

{
 "metadata": {
     "annotations": {
         "jetUid": "*********************************",
         "overlordUid": "672fa7ad6e7f4d26fd91d81b",
         "ownerUid": "********************************",
         "palette.spectrocloud.com/disablenodeautoremidiation": "false",
         "permissions": "cluster.create,cluster.delete,cluster.get,cluster.import,cluster.list,cluster.update,tag.update",
         "projectUid": "**********************",
         "rootDomain": "console.spectrocloud.com",
         "scope": "project",
         "scopeVisibility": "16",
         "spectroComponentsUpgradeForbidden": "true",
         "tenantUid": "************************"
     },

What is a PCG migration?​

Prerequisites​

Migrate PCG​

Validate​

What is a PCG migration?

Prerequisites

Migrate PCG

Validate