Skip to content
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
12 changes: 12 additions & 0 deletions _partials/_project-id-copy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
partial_category: projects
partial_name: project-id-copy
---

On the **Project Overview** page, copy the **Project ID**, located in the top-right below the **User Menu**.

:::tip

You can also retrieve your project ID from the URL: `https://console.spectrocloud.com/projects/<project-id>`.

:::
23 changes: 12 additions & 11 deletions _partials/crossplane/_cluster-profile-existing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@ partial_name: cluster-profile-existing
1. Log in to [Palette](https://console.spectrocloud.com/). Ensure you log in as the tenant under which you
will deploy your cluster, and select the appropriate project.

2. From the left main menu, select **Clusters**.
2. From the left main menu, select **Profiles**.

3. Select the cluster profile to use.

4. From the browser address bar, copy the cluster profile URL, and set it as a variable.
4. Copy the **Profile ID**.

```shell
URL=<cluster-profile-URL>
```

```shell hideClipboard title="Example URL"
URL=https://console.spectrocloud.com/projects/6342eab2faa0813ead9082e0/profiles/cluster/689a4460ab5cs617a5afa29a
```
![Copying cluster profile ID](/automation_crossplane_cluster-profile-id.webp)

:::tip

You can also retrieve the cluster profile ID from the URL: `https://console.spectrocloud.com/projects/<project-id>/profiles/cluster/<profile-id>`.

:::


5. Use the cluster profile URL to fetch the value of your cluster profile ID and set it as a variable.
5. Set your **Profile ID** as a variable.

```shell
CLUSTER_PROFILE_ID="$(basename "${URL%/}")"
CLUSTER_PROFILE_ID=<profile-id>
echo Cluster Profile ID: $CLUSTER_PROFILE_ID
```

Expand Down
16 changes: 16 additions & 0 deletions _partials/profiles/_cluster-profile-id-copy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
partial_category: profiles
partial_name: cluster-profile-id-copy
---

Select the cluster profile you want to include in the {props.content} and copy the **Profile ID**. Repeat this step for all cluster profiles whose images you want to include in the {props.content}.

![Copying cluster profile ID](/automation_crossplane_cluster-profile-id.webp)

:::tip

You can also retrieve the cluster profile ID from the URL:
`https://console.spectrocloud.com/projects/<project-id>/profiles/cluster/<profile-id>`.

:::

36 changes: 27 additions & 9 deletions docs/docs-content/cluster-templates/modify-cluster-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ information about your cluster template:

- List of linked cluster profiles and their packs

- Next upgrade time (in Coordinated Universal Time (UTC), converted to each cluster's time zone)

The option to manually trigger cluster updates is available only if a cluster template is linked to a cluster _and_
there is a discrepancy between the cluster profile variable versions used in the cluster and the versions referenced in
the template. This is caused when a cluster profile has been recently added to or removed from the cluster template, or
Expand All @@ -70,13 +72,10 @@ now** button is disabled while the upgrade is in progress.

:::warning

- If there are any pending variable assignments, the banner **[N] cluster(s) pending variable assignment** is displayed.
Even if you attempt to force an upgrade, any clusters with pending variable assignments will _not_ be updated when you
select **Upgrade now**. Navigate to the [**Variable values**](#variable-values-tab) tab and assign a **New Value** to
each variable before attempting the upgrade again.

- If your changes require a cluster repave, the repave occurs during the next upgrade window; no
[repave approval](../clusters/cluster-management/node-pool.md#approve-cluster-repave) is required.
If there are any pending variable assignments, the banner **[N] cluster(s) pending variable assignment** is displayed.
Even if you attempt to force an upgrade, any clusters with pending variable assignments will _not_ be updated when you
select **Upgrade now**. Navigate to the [**Variable values**](#variable-values-tab) tab and assign a **New Value** to
each variable before attempting the upgrade again.

:::

Expand Down Expand Up @@ -150,6 +149,19 @@ Selecting **Review & Save** opens the **Review changes** dialog. The items displ
| :white_check_mark: | :white_check_mark: | :x: | **Review & Save** | - [Modified Packs](#modified-packs) |
| :white_check_mark: | :white_check_mark: | :white_check_mark: | **Review & Save** | - [Modified Packs](#modified-packs) <br /> - [Profile Variable Changes](#profile-variable-changes) |

<!-- prettier-ignore-start -->

:::warning

Cluster profile changes that modify operating system (OS) or Kubernetes configurations for clusters linked to a cluster
template (including packs that modify these configurations, such as the
<VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" /> pack) require a
[cluster repave](../clusters/cluster-management/node-pool.md#repave-behavior-and-configuration). Once you save your cluster profile changes, all clusters attached to the template are automatically repaved during the next upgrade window.

:::

<!-- prettier-ignore-end -->

###### Modified Packs

Select each pack to view the changes in read-only mode. Once you view a pack, the empty circle changes to a check mark.
Expand Down Expand Up @@ -233,18 +245,24 @@ If a cluster is currently deployed using the cluster template, the cluster will
specified in the linked maintenance policy. To force cluster updates and bypass the scheduled maintenance window,
navigate to the **Overview** tab, and select **Options > Upgrade now**.

<!-- prettier-ignore-start -->

:::warning

- If there are any pending variable assignments, the banner **[N] cluster(s) pending variable assignment** is displayed.
Even if you attempt to force an upgrade, any clusters with pending variable assignments will _not_ be updated when you
select **Upgrade now**. Navigate to the [**Variable values**](#variable-values-tab) tab and assign a **New Value** to
each variable before attempting the upgrade again.

- If your changes require a cluster repave, the repave occurs during the next upgrade window; no
[repave approval](../clusters/cluster-management/node-pool.md#approve-cluster-repave) is required.
- Cluster profile changes that modify operating system (OS) or Kubernetes configurations for clusters linked to a cluster
template (including packs that modify these configurations, such as the
<VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" /> pack) require a
[cluster repave](../clusters/cluster-management/node-pool.md#repave-behavior-and-configuration). Once you save your cluster profile changes, all clusters attached to the template are automatically repaved during the next upgrade window.

:::

<!-- prettier-ignore-end -->

### Variable Values Tab

If your cluster template is linked to a cluster profile that contains
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ issue and expiry date of the cluster by click on **View K8s Certificates** in th
This page focuses on how to renew the PKI certificates through Palette. You have two options for how you can renew the
cluster PKI certificates:

- [Automatic Certificate Renewal](#automatic-certificate-renewal)
- [Automatic Certificate Renewal](#automatic-certificate-renewal) <!-- omit in toc -->
- [Manual Certificate Renewal](#manual-certificate-renewal)

:::info
Expand Down Expand Up @@ -118,26 +118,38 @@ The renewal process may take several minutes, depending on the number of cluster
</TabItem>
<TabItem label="API" value="api">

1. Set your Palette API key as an environment variable. Add your actual API key in place of `REPLACE_ME`.
1. Set your Palette API key as an environment variable.

```shell
export API_KEY=REPLACE_ME
export API_KEY=<api-key>
```

2. Set the project ID as an environment variable. Add your project ID in place of `REPLACE_ME`. You can find the project
ID on the Palette landing page. The project ID is displayed in the top right corner of the page.
2. Set the project ID as an environment variable. The **Project ID** is located on the **Project Overview** page in the
top-right below the **User Menu**.

```shell
export PROJECT_ID=REPLACE_ME
export PROJECT_ID=<project-id>
```

3. Set the cluster ID as an environment variable. Add your cluster's ID in place of `REPLACE_ME`. You can get the
cluster ID from the cluster detail's page URL. The value after `clusters/` is the cluster ID.
:::tip

You can also retrieve your project ID from the URL: `https://console.spectrocloud.com/projects/<project-id>`.

:::

3. Set the cluster ID as an environment variable. The **Cluster ID** is located on the cluster's **Overview** tab.

```shell
export CLUSTER_ID=REPLACE_ME
export CLUSTER_ID=<cluster-id>
```

:::tip

You can also retrieve your cluster ID from the URL:
`https://console.spectrocloud.com/projects/<project-id>/clusters/<cluster-id>`.

:::

4. Use the Palette API endpoint `https://api.spectrocloud.com/v1/spectroclusters/{uid}/k8certificates/renew` to renew a
cluster's PKI certificates. The endpoint accepts the HTTP method `PATCH`, and the only required parameter is the
cluster ID.
Expand Down Expand Up @@ -182,24 +194,38 @@ Using the following steps, you can validate that the cluster's PKI certificates

Using the following steps, you can validate that the cluster's PKI certificates were renewed.

1. Set your Palette API key as an environment variable. Add your actual API key in place of `REPLACE_ME`.
1. Set your Palette API key as an environment variable.

```shell
export API_KEY=REPLACE_ME
export API_KEY=<api-key>
```

2. Set the project ID as an environment variable. Add your project ID in place of `REPLACE_ME`.
2. Set the project ID as an environment variable. The **Project ID** is located on the **Project Overview** page in the
top-right below the **User Menu**.

```shell
export PROJECT_ID=REPLACE_ME
export PROJECT_ID=<project-id>
```

3. Set the cluster ID as an environment variable. Add your cluster's ID in place of `REPLACE_ME`.
:::tip

You can also retrieve your project ID from the URL: `https://console.spectrocloud.com/projects/<project-id>`.

:::

3. Set the cluster ID as an environment variable. The **Cluster ID** is located on the cluster's **Overview** tab.

```shell
export CLUSTER_ID=REPLACE_ME
export CLUSTER_ID=<cluster-id>
```

:::tip

You can also retrieve your cluster ID from the URL:
`https://console.spectrocloud.com/projects/<project-id>/clusters/<cluster-id>`.

:::

4. Retrieve the cluster's certificate information from Palette by using the
`https://api.spectrocloud.com/v1/spectroclusters/{uid}/k8certificates` endpoint.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ This is the recommended best practice for updating a cluster in Palette.

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

2. Navigate to the left **Main Menu** and select **Profiles**.
2. Navigate to the left main menu and select **Profiles**.

3. Create a new version of the profile you want to update. For more information, refer to
[Version a Cluster Profile](../../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md).

4. Navigate to the left **Main Menu** and select **Clusters**.
4. Navigate to the left main menu and select **Clusters**.

5. Select the cluster you want to update, and navigate to the **Profile** tab of the cluster.

Expand Down Expand Up @@ -119,7 +119,7 @@ guidance on creating a new cluster profile version.

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

2. Navigate to the left **Main Menu** and select **Clusters**.
2. Navigate to the left main menu and select **Clusters**.

3. Select the cluster you want to update, and navigate to the **Profile** tab of the cluster.

Expand All @@ -131,18 +131,69 @@ guidance on creating a new cluster profile version.
</TabItem>
</Tabs>

### Validation
### Validate

You can follow these steps to validate all cluster update approaches.

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

2. Navigate to the left **Main Menu** and select **Clusters**.
2. Navigate to the left main menu and select **Clusters**.

3. Select the cluster you updated, and navigate to the **Profile** tab of the cluster.

4. Confirm that the cluster is now using an updated profile.

## Trigger Worker Node Upgrade on AWS IaaS Clusters

If you have enabled the
[**Skip worker node update (Optional)**](../public-cloud/aws/create-cluster.md#node-configuration-settings) option for
worker nodes on an AWS IaaS cluster, you can manually trigger a worker node upgrade at any time after updating the
control plane.

This action repaves the worker nodes to match the control plane's Kubernetes version. This may incur downtime for
workloads running on those nodes, so plan accordingly.

### Prerequisites

- An active AWS IaaS cluster in Palette with the **Skip worker node update (Optional)** option enabled.

- The cluster control plane must be updated to a newer Kubernetes version within the supported N-3 minor version skew.

### Enablement

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

2. Navigate to the left main menu and select **Clusters**.

3. Locate and select the AWS IaaS cluster you want to upgrade.

4. Click the **Nodes** tab to view the cluster's node pools.

5. Identify the worker node pool that has the **Skip worker node update (Optional)** option enabled and click the
**Edit** button next to it.

6. In the **Edit node pool** dialog, disable the **Skip worker node update (Optional)** option.

7. Click **Confirm** to save the changes and click **Continue** in the pop-up window to confirm the node pool repave.

Palette then schedules the worker node upgrade.

8. Repeat steps 5-7 for each worker node pool that you want to upgrade.

The worker nodes are repaved to match the control plane's Kubernetes version. This process may take some time depending
on the size of the node pool.

### Validate

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

2. Navigate to the left main menu and select **Clusters**.

3. Select the cluster you updated, and navigate to the **Nodes** tab of the cluster.

4. Confirm that the **K8s Version** column for the updated worker node pools now matches the control plane pool's
Kubernetes version.

## Palette Reconciliation After Updating

When cluster profile updates are applied, Palette will apply the changes to the cluster but will not delete any
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ nodes individually and fetch these logs. <br />

1. Select the running cluster.

2. Go to **Settings\* and select **Download Logs\*\*.
2. Go to **Settings** and select **Download Logs**.

3. Choose the desired log from the below options:
- Kube-System Logs
Expand Down
Loading