Kubernetes - Quickstart

Scaleway Kubernetes Kapsule and Kosmos provide a managed environment to create, configure, and run a cluster of preconfigured machines for containerized applications. This allows you to create Kubernetes clusters without the complexity of managing the infrastructure. You can create a Kapsule cluster to your required specifications, edit it after creation, and delete it all when you no longer need it. You might also want to check out our how-to on deploying an image on your cluster.

Kubernetes decision treeLink to this anchor

Before you startLink to this anchor

To complete the actions presented below, you must have:

• A Scaleway account logged into the console
• Owner status or IAM permissions allowing you to perform actions in the intended Organization

How to create a Kubernetes clusterLink to this anchor

Cluster configurationLink to this anchor

1. Navigate to Kubernetes under the Containers section of the Scaleway console side menu. The Kubernetes dashboard displays.
2. Click Create cluster to launch the cluster creation wizard.
3. On the cluster configuration page, provide the following details:
   • Check the Organization and Project for the new cluster.
     Important

     You cannot move a cluster from one Organization or Project to another once created.

   • Select Kubernetes Kapsule as the cluster type, which uses exclusively Scaleway Instances.
     Note

     This guide covers the creation of a Kubernetes Kapsule cluster. For Kubernetes Kosmos clusters, refer to the Kubernetes Kosmos documentation.

   • Choose the geographical region for the cluster.
   • Select the control plane offer for your cluster. Options include shared or dedicated control planes.
     Tip

     Need help deciding on a control plane offer? Learn more about our Kubernetes control plane offers.

   • Specify the Kubernetes version for your cluster.
4. Enter the cluster’s details. Provide a name for the cluster. Optionally, you can add a description and tags for better organization.
5. Configure the Private Network for the cluster to ensure secure and isolated network communication. Each cluster is auto-configured with a /22 IP subnet. Click Select Private Network to:
   • Attach an existing Private Network (VPC) within the same Availability Zone from the drop-down menu.
   • Attach a new Private Network to the cluster.
   Important

   The Private Network cannot be detached, and the cluster cannot be moved to another Private Network post-creation.

6. Click Configure pools to proceed.

Pool configurationLink to this anchor

This section outlines the settings for your cluster pools. You can configure as many pools for your cluster as you require.

1. Configure the following for each pool:
   • Choose an Availability Zone for the pool’s nodes.
   • Select the node type for the pool.
     Tip

     Need advice on choosing a node type? Learn more about Kubernetes nodes.

   • Configure the system volume. This volume contains the operating system of the nodes in your pool.
   • Configure pool options, including node count and whether to enable autoscaling. Options also include enabling autoheal and linking to a placement group, or you can retain default settings.
     Tip

     • Unsure about the autoheal feature? Learn more about autoheal.
     • Need more information about placement groups? Learn more about placement groups.
   • Enable full isolation, if required.
     Tip

     Need more information on full isolation? Learn more about full isolation.

2. Click Add pool to integrate the pool into the cluster.
3. To add more pools, click Expand and repeat the steps above.
   Tip

   You can add or remove pools as needed before finalizing your cluster configuration. To remove a pool, click Remove within the respective pool.

4. Once all pools are configured, click Review to finalize your cluster setup.

Review configurationLink to this anchor

1. Review the configuration details of your Kubernetes cluster and its pools.
   Tip

   To modify any element, click the «Edit Icon» Edit icon next to the respective configuration component.

2. Click Create cluster to deploy your cluster. Once deployment is complete, the cluster appears in the clusters list. You can now download the kubeconfig file for your cluster and learn how to connect to a Kubernetes Kapsule cluster with kubectl.

How to add a Scaleway pool to a Kubernetes clusterLink to this anchor

1. Click Kubernetes in the Containers section of the side menu. The Kubernetes dashboard displays.
2. Click «See more Icon» next to the cluster you want to edit. Click Add pool in the menu. The pool configuration wizard displays.
3. This page concerns the configuration of your cluster. Enter the following information:
   • The geographical region of the pool.
   • The node type for the pool.
   • If required, configure the pool options like autoscaling, autohealing, or link the pool to an existing placement group.
   • The name for the pool. Optionally, you can assign tags to it.
4. Click Add pool.

How to add a multi-cloud pool to a Kubernetes clusterLink to this anchor

1. Click Kubernetes in the Containers section of the side menu. The Kubernetes dashboard displays.
2. Click «See more Icon» next to the pool you want to edit. Click Add pool in the menu. The pool configuration wizard displays.
3. Click Add pool.

How to add external nodes to a multi-cloud poolLink to this anchor

1. Click Kubernetes in the Containers section of the Scaleway console side menu. The Kubernetes dashboard displays.

2. Click Create cluster. The first page of the cluster creation wizard displays. This concerns the configuration of your cluster.

3. Complete the following steps of the wizard:

   • Choose a cluster type. Select Kubernetes Kosmos to create a cluster, that allows you to attach a compute Instance or dedicated server from any Cloud provider to a Scaleway Kubernetes control plane.
     Note

     This document concerns the creation and management of a Kubernetes Kosmos cluster. To create a Kubernetes Kapsule cluster, refer to the Kubernetes Kapsule documentation.

   • The geographical region of the cluster.
   • The Kubernetes version for the cluster.
   • A name for the cluster and, optionally, a description and tags.

4. Click Create cluster to create your cluster without any Scaleway pools. If you choose this option, your cluster and its control plane are deployed, and you are taken to the cluster’s overview tab. Continue to How to manage your Kubernetes Kosmos cluster to find out how to add multi-cloud pools to your cluster.

   Alternatively, click Add and configure a pool to add a pool of Scaleway nodes to your cluster. In this case, the second page of the cluster creation wizard displays. This concerns the settings for your pool.

5. Enter the following information to configure a Scaleway pool:

   • The Availability Zone in which all your pool’s nodes will be created.
   • The node type you need.
   • The configuration for your pool options, including the number of nodes and whether to enable autoscale. You can also choose whether to enable autoheal and whether to link the cluster to a placement group. Alternatively, you can leave these options at default values.

6. Click Create cluster. Your cluster is deployed, and you are taken to the cluster’s Overview tab.

How to edit a Kubernetes clusterLink to this anchor

1. Click Kubernetes in the Containers section of the side menu. The Kubernetes dashboard displays.
2. Click «See more Icon» next to the cluster you want to edit.
3. Choose the option you require:
   • Add pool: Add additional computing resources to the cluster.
   • Get kubeconfig: Download the .kubeconfig file of the cluster.
   • Delete: Delete the cluster.

How to delete a Kubernetes clusterLink to this anchor

1. Click Kubernetes in the Containers section of the side menu. The Kubernetes dashboard displays.
2. Click «See more Icon» to display the options menu, then click Delete. A cluster deletion pop-up displays.
3. Type DELETE to confirm the deletion of your cluster. Tick the checkbox to automatically delete all volumes (including those with volume type “retain”) and Load Balancers whose names start with the cluster ID. Validate your choice by clicking Delete cluster.
   Important

   Deleting your cluster will permanently destroy your cluster and all its associated pools and Instances. External compute resources cannot be destroyed automatically and will remain active until destroyed at the concerned cloud service provider (CSP).