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.

Sign up for GitHub

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: refactor taints guide DOC-1272 #3395

Merged
merged 14 commits into from
Jul 18, 2024
Merged

docs: refactor taints guide DOC-1272 #3395

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
fea45a4
docs: refactor taints guide DOC-1272
addetz Jul 16, 2024
730b45c
docs: add node labels guide DOC-1272
addetz Jul 17, 2024
76568c6
docs: fix vale DOC-1272
addetz Jul 17, 2024
fd63f1a
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Jul 17, 2024
4afd020
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Jul 17, 2024
c68491d
docs: fix broken anchors DOC-1272
addetz Jul 17, 2024
fdd64c1
docs: adjust wording on new pages DOC-1272
addetz Jul 17, 2024
d9e9450
docs:fix formatting DOC-1272
addetz Jul 17, 2024
feaf4de
Apply suggestions from code review
addetz Jul 18, 2024
3dca5e7
Apply suggestions from code review
addetz Jul 18, 2024
b33e246
docs: fix indentation of pages DOC-1272
addetz Jul 18, 2024
661bede
docs: tweak intro to compare node labels and taints DOC-1272
addetz Jul 18, 2024
1694fef
docs: fix vale DOC-1272
addetz Jul 18, 2024
1f2f66f
docs: fix formatting DOC-1272
addetz Jul 18, 2024
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
145 changes: 145 additions & 0 deletions docs/docs-content/clusters/cluster-management/node-labels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
---
sidebar_label: "Node Labels"
title: "Node Labels"
description: "Learn how to apply node labels to Palette clusters."
hide_table_of_contents: false
sidebar_position: 95
tags: ["clusters", "cluster management"]
---

Node labels provide pods the ability to specify which nodes they should be scheduled on. This ability can be useful in
scenarios where pods should be co-located or executed on dedicated nodes. A common usecase of node labels is to ensure
addetz marked this conversation as resolved.
Show resolved Hide resolved
that certain workloads only run on certain hardware configurations. Labels are optional configurations, as the scheduler
addetz marked this conversation as resolved.
Show resolved Hide resolved
will automatically place pods across nodes.

:::tip

You can think of node labels as having the opposite effect to [Taints and Tolerations](./taints.md). Taints allow you to
addetz marked this conversation as resolved.
Show resolved Hide resolved
mark nodes as not accepting certain pods, while node labels allow you to specify that your pods should only be scheduled
on certain nodes.

:::

Palette allows you to apply node labels during cluster provisioning. Once the cluster is in a healthy state, labels can
be modified on the **Nodes** tab of the cluster details page.

This guide covers the Palette UI flow.

:::info

Node labels can also be applied to node pools using our
[Terraform provider](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs).

:::

## Prerequisites

- A [Palette](https://console.spectrocloud.com) account with the permissions to create cluster profiles and manage
clusters. Refer to the [Roles and Permissions](../../user-management/palette-rbac/project-scope-roles-permissions.md)
guide for more information.
- [kubectl](https://kubernetes.io/docs/reference/kubectl/) or [K9s](https://k9scli.io/) installed locally.

## Enablement

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

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

3. Create a cluster profile to deploy to your environment. Refer to the
[Create a Full Profile](../../profiles/cluster-profiles/create-cluster-profiles/create-full-profile.md) guide for
more information.

4. Add a manifest to your cluster profile with a custom workload of your choice. Refer to the
[Add a Manifest](../../profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/create-manifest-addon.md)
for additional guidance.

5. Add a node selector to the pod specification of your manifest. Refer to the
[Assign Pods to Nodes](https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes/) official
documentation page for more details.

```yaml
nodeSelector:
key1: value1
```

:::info

You can also specify a node by name by using the `nodeName: name` option on your pod specification. We recommend
addetz marked this conversation as resolved.
Show resolved Hide resolved
using a node selector, as it provides a more scalable and robust solution.

When using packs or Helm charts, the `nodeSelector` or `nodeName` options can only be specified if they are exposed
for configuration in the `values.yaml` file.

:::

6. Save the changes made to your cluster profile.

7. Navigate to the left **Main Menu** and select **Clusters**.

8. Click on **Add New Cluster**.

9. Fill in the **Basic Information** for your cluster and click **Next**.

10. On the **Cluster Profile** tab, select the cluster profile you previously created. Click **Next**.

11. Select a **Subscription**, **Region**, and **SSH Key** on the **Cluster Config** tab. Click **Next**.

12. On the **Nodes Config** tab, configure your control plane pool and worker pools by providing the instance type,
availability zones and disk size.

13. The control plane pool and worker pool provide the **Additional Labels (Optional)** section. Palette accepts labels
in the `key:value` format. Fill in the labels corresponding to the values provided in your pod specification node
selector. Click on **Next**.

![Screenshot of adding node labels during cluster creation](/clusters_cluster-management_node-labels_cluster-creation-labels.webp)

:::info

Node labels can also be updated on a deployed cluster by editing a worker node pool from the **Nodes** tab of the
cluster details page.

:::

14. Accept the default settings on the **Cluster Settings** tab and click on **Validate**.

15. Click on **Finish Configuration** and deploy your cluster.

:::further

Refer to our [Deploy a Cluster](../../tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md) tutorial for
detailed guidance on how to deploy a cluster with Palette using Amazon Web Services (AWS), Microsoft Azure, or
Google Cloud Platform (GCP) cloud providers.
addetz marked this conversation as resolved.
Show resolved Hide resolved

:::

## Validate

You can follow these steps to validate that your node labels are applied successfully.

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

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

3. Select the cluster you deployed, and download the [kubeconfig](./kubeconfig.md) file.

![Screenshot of kubeconfig file download](/clusters_cluster-management_node-labels_kubeconfig-download.webp)

4. Open a terminal window and set the environment variable `KUBECONFIG` to point to the kubeconfig file you downloaded.

```
export KUBECONFIG=~/Downloads/admin.azure-cluster.kubeconfig
```

5. Confirm the cluster deployment process has scheduled your pods as expected. Remember that only pods will be scheduled
on nodes with labels matching their node selectors.

```
kubectl get pods --all-namespaces --output wide --watch
```

:::tip

For a more user-friendly experience, consider using [K9s](https://k9scli.io/) or a similar tool to explore your
cluster workloads.

:::
8 changes: 4 additions & 4 deletions docs/docs-content/clusters/cluster-management/node-pool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ settings may not be available.
| **Node pool name** | A descriptive name for the node pool. |
| **Number of nodes in the pool** | Number of nodes to be provisioned for the node pool. For the control plane pool, this number can be 1, 3, or 5. |
| **Allow worker capability** | Select this option to allow workloads to be provisioned on control plane nodes. |
| **Additional Labels** | Optional labels apply placement constraints on a pod. For example, you can add a label to make a node eligible to receive the workload. To learn more, refer to the [Overview on Labels](taints.md#labels). |
| **Taints** | Sets toleration to pods and allows (but does not require) the pods to schedule onto nodes with matching taints. To learn more, refer to the [Overview on Taints](taints.md#taints). |
| **Additional Labels** | Optional labels apply placement constraints on a pod. For example, you can add a label to make a node eligible to receive the workload. To learn more, refer to the [Node Labels](./node-labels.md). |
| **Taints** | Sets toleration to pods and allows (but does not require) the pods to schedule onto nodes with matching taints. To learn more, refer to the [Taints and Tolerations](./taints.md) guide. |
addetz marked this conversation as resolved.
Show resolved Hide resolved
| **Availability Zones** | The Availability Zones from which to select available servers for deployment. If you select multiple zones, Palette will deploy servers evenly across them as long as sufficient servers are available to do so. |
| **Disk Size** | Give the required storage size. |

Expand All @@ -87,8 +87,8 @@ settings may not be available.
| **Node pool name** | A descriptive name for the worker pool. |
| **Number of nodes in the pool** | Number of nodes to be provisioned for the node pool. |
| **Node repave interval** | The time interval in seconds between repaves. The default value is 0 seconds. |
| **Additional Labels** | Optional labels apply placement constraints on a pod. For example, you can add a label to make a node eligible to receive the workload. To learn more, refer to the [Overview on Labels](taints.md#labels). |
| **Taints** | Sets toleration to pods and allows (but does not require) the pods to schedule onto nodes with matching taints. To learn more, refer to the [Overview on Taints](taints.md#apply-taints-to-nodes). |
| **Additional Labels** | Optional labels apply placement constraints on a pod. For example, you can add a label to make a node eligible to receive the workload. To learn more, refer to the [Node Labels](./node-labels.md) guide. |
| **Taints** | Sets toleration to pods and allows (but does not require) the pods to schedule onto nodes with matching taints. To learn more, refer to the [Taints and Tolerations](./taints.md) guide. |
addetz marked this conversation as resolved.
Show resolved Hide resolved
| **Rolling update** | Apply the update policy. **Expand first** launches new nodes and then terminates old notes. **Contract first** terminates old nodes and then launches new ones. |
| **Instance Option** | AWS options for compute capacity. **On Demand** gives you full control over the instance lifecycle without long-term commitment. **Spot** allows the use of spare EC2 capacity at a discount but which can be reclaimed if needed. |
| **Instance Type** | The compute size. |
Expand Down
Loading
Loading