From fe0a02c42d21a5fd6bb984803659b81c73f49448 Mon Sep 17 00:00:00 2001 From: "vault-token-factory-spectrocloud[bot]" <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Date: Thu, 30 Jan 2025 13:28:27 +0000 Subject: [PATCH] docs: add delete node pool section (#5569) (#5597) * docs: add delete node pool section * Apply suggestions from code review Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> * docs: remove reconfigure page * docs: improve deletion warning --------- Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> (cherry picked from commit d2cd868d9b14342ed97b3b35fdf88bf947a031da) Co-authored-by: caroldelwing --- .../cluster-management/cluster-management.md | 4 +- .../clusters/cluster-management/node-pool.md | 47 ++++++++++++++ .../cluster-management/reconfigure.md | 63 ------------------- redirects.js | 4 ++ 4 files changed, 53 insertions(+), 65 deletions(-) delete mode 100644 docs/docs-content/clusters/cluster-management/reconfigure.md diff --git a/docs/docs-content/clusters/cluster-management/cluster-management.md b/docs/docs-content/clusters/cluster-management/cluster-management.md index 02770acc78..8150b284c0 100644 --- a/docs/docs-content/clusters/cluster-management/cluster-management.md +++ b/docs/docs-content/clusters/cluster-management/cluster-management.md @@ -15,9 +15,9 @@ visibility into the workloads running inside your cluster and cluster costs. The following sections describe these capabilities in detail: -- [Reconfigure](reconfigure.md) - Scale your clusters up/down by adding/reducing the number of nodes in a node pool and +- [Node Pools](node-pool.md) - Scale your clusters up/down by adding/reducing the number of nodes in a node pool and adding additional worker pools. Resize nodes in a node pool by modifying the node specs (CPU, Memory, or Instance Type - for public clouds). Add additional fault domains such as availability zones to a node pool. + for public clouds). - [Updates](cluster-updates.md) - Upgrade core packs (OS, Kubernetes, CSI, CNI) and add-on layers, such as Monitoring and Security. diff --git a/docs/docs-content/clusters/cluster-management/node-pool.md b/docs/docs-content/clusters/cluster-management/node-pool.md index 97ab8fa5bc..ee59e00bc1 100644 --- a/docs/docs-content/clusters/cluster-management/node-pool.md +++ b/docs/docs-content/clusters/cluster-management/node-pool.md @@ -3,6 +3,7 @@ sidebar_label: "Node Pools" title: "Node Pools" description: "Learn about the node pools and applying changes to a node pool." hide_table_of_contents: false +toc_max_heading_level: 2 sidebar_position: 190 tags: ["clusters", "cluster management"] --- @@ -215,6 +216,52 @@ After you have modified a new node pool, you can validate the node pool by follo 5. Ensure the new node pool is listed in the **Node Pools** section and that all compute instances are in the healthy status. +## Delete a Node Pool + +You can delete a worker node pool from an active cluster using the following steps. + +:::warning + +The deletion of a node pool drains and removes its worker nodes. Before proceeding, ensure that your remaining node +pools have enough resources to take on the workloads from the pool being deleted, to prevent any disruption. + +::: + +### Prerequisites + +- An active cluster in Palette with at least one worker node pool. + +- The `cluster.update` permission, which is required to edit clusters. + +### Delete Node Pool + +1. Log in to [Palette](https://console.spectrocloud.com). + +2. From the left **Main Menu**, click **Clusters**. + +3. Select the cluster with the node pool you want to delete. + +4. Click the **Nodes** tab. + +5. Locate the node pool you want to delete and click the **Delete** button. + +6. Click **Delete** again to confirm the deletion. This action will drain and delete all nodes in the node pool. + +### Validate + +Use the following steps to confirm that the node pool was deleted successfully. + +1. Log in to [Palette](https://console.spectrocloud.com). + +2. From the left **Main Menu**, click on **Clusters**. + +3. Select the cluster that had the deleted node pool. + +4. Click the **Nodes** tab. + +5. Verify that the deleted node pool is no longer listed in the **Node Pools** section and that all the remaining + compute instances are in a healthy state. + ## Approve Cluster Repave ### Prerequisites diff --git a/docs/docs-content/clusters/cluster-management/reconfigure.md b/docs/docs-content/clusters/cluster-management/reconfigure.md deleted file mode 100644 index 32f9862f43..0000000000 --- a/docs/docs-content/clusters/cluster-management/reconfigure.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_label: "Reconfigure" -title: "Reconfigure" -description: "Reconfiguration-scaling Events on Palette" -hide_table_of_contents: false -sidebar_position: 0 -tags: ["clusters", "cluster management"] ---- - -Scaling a cluster up or down involves changing the size of node pools. The following are the steps to scale up/down a -cluster: - -- Access the ‘Nodes’ view of the cluster. -- For the desired node pool, change the size directly from the nodes panel or edit node pool settings. -- After the node pool configuration is updated, the scale-up/down operation is initiated in a few minutes. -- Provisioning status is updated with the ongoing progress of the scale operation. - -:::info - -The control plane node pool is scaled from 1 to 3 or 3 to 5 nodes, etc. However, the scale-down operation is not -supported for control plane nodes. - -::: - -## Reconfiguring the Cluster Nodes - -The following are the steps to reconfigure worker pool nodes: - -- Access the 'Nodes' view for the cluster. -- Edit the settings of the desired node pool. -- Change the number of nodes, rolling update setting, availability zones, flavor, and Disk size to the desired settings. -- Save the node pool settings. After the node pool settings are updated, the node pool reconfiguration begins within a - few minutes. The older nodes in the node pool are deleted and replaced by new nodes launched with a new instance type - configured. -- Provisioning status is updated with the ongoing progress of nodes being deleted and added. - -## Adding a New Worker Pool - -The following are the steps to add a new worker node pool to a cluster: - -- Invoke the option to ‘Add Node Pool’ from the cluster’s node information page. -- Provide node pool settings as follows: - - A descriptive name for the node pool - - The number of nodes in the node pool - - Rolling update setting, availability zones, flavor, and Disk size settings - - Save the node pool settings - -The new worker pool settings are updated, and cluster updates begin within a few minutes. Provisioning status updates -will be available with the ongoing progress of tasks related to adding new nodes. - -## Removing a Worker Pool - -The following steps need to be performed to remove a worker pool from the cluster: - -- Access the ‘Nodes’ view of the cluster -- Delete the desired worker pool and confirm the deletion -- Upon confirmation, the worker node deletion begins in a few minutes - -:::info - -Support of reconfiguration is not available for existing clusters imported into Palette for any cloud type. - -::: diff --git a/redirects.js b/redirects.js index 3bd8425330..89d238eafe 100644 --- a/redirects.js +++ b/redirects.js @@ -594,6 +594,10 @@ let redirects = [ from: "/clusters/cluster-management/noc-ui/", to: "/clusters/cluster-management/cluster-map-filters/", }, + { + from: "/clusters/cluster-management/reconfigure/", + to: "/clusters/cluster-management/node-pool/", + }, { from: [ "/integrations/antrea-cni",