Skip to main content
Version: v1.5 (dev)

Creating an K3s Kubernetes Cluster

You can now provision K3s Kubernetes clusters on top of the Harvester cluster in Rancher using the built-in Harvester node driver.

k3s-cluster

note
  • Harvester K3s node driver is in Tech Preview.
  • VLAN network is required for Harvester node driver.
  • Harvester node driver only supports cloud images.
  • For the port requirements of the guest clusters deployed within Harvester, please refer to the port requirements for guest clusters.

Create your cloud credentials​

  1. Click ☰ > Cluster Management.
  2. Click Cloud Credentials.
  3. Click Create.
  4. Click Harvester.
  5. Enter your cloud credential name
  6. Select "Imported Harvester Cluster".
  7. Click Create.

create-harvester-cloud-credentials

Create K3s Kubernetes cluster​

You can create a K3s Kubernetes cluster from the Cluster Management page via the K3s node driver.

  1. Select Clusters menu.
  2. Click Create button.
  3. Toggle Switch to RKE2/K3s.
  4. Select Harvester node driver.
  5. Select a Cloud Credential.
  6. Enter Cluster Name (required).
  7. Enter Namespace (required).
  8. Enter Image (required).
  9. Enter Network Name (required).
  10. Enter SSH User (required).
  11. Click Create.

create-k3s-harvester-cluster

Add node affinity​

Available as of v1.0.3 + Rancher v2.6.7

The Harvester node driver now supports scheduling a group of machines to particular nodes through the node affinity rules. This provides high availability and better resource utilization.

Node affinity can be added to the machine pools during the cluster creation:

  1. Click the Show Advanced button and click the Add Node Selectoraffinity-add-node-selector
  2. Set priority to Required if you wish the scheduler to schedule the machines only when the rules are met.
  3. Click Add Rule to specify the node affinity rules, e.g., for the topology spread constraints use case, you can add the region and zone labels as follows:
    key: topology.kubernetes.io/region
    operator: in list 
    values: us-east-1
    ---
    key: topology.kubernetes.io/zone
    operator: in list 
    values: us-east-1a
    affinity-add-rules
  4. Click Create to save the node template. After the cluster is installed, you can check whether its machine nodes are scheduled according to the affinity rules.

Using Harvester K3s node driver in air gapped environment​

K3s provisioning relies on the qemu-guest-agent package to get the IP of the virtual machine.

However, it may not be feasible to install packages in an air gapped environment.

You can address the installation constraints with the following options:

  • Option 1. Use a VM image preconfigured with the required packages (e.g., iptables, qemu-guest-agent).
  • Option 2. Go to Show Advanced > User Data to allow VMs to install the required packages via an HTTP(S) proxy.

Example of user data in Harvester node template:

#cloud-config
apt:
  http_proxy: http://192.168.0.1:3128
  https_proxy: http://192.168.0.1:3128