How to install with custom configuration

This guide will walk you through deploying Canonical Kubernetes using Juju with custom configuration options.

Prerequisites

This guide assumes the following:

• You have Juju installed on your system with your cloud credentials configured and a controller bootstrapped

• A Juju model is created and selected

Creating the configuration file

Before deploying the charm, create a YAML file with your desired configuration options. Here’s an example configuration, which for this guide we’ll save as k8s-config.yaml:

k8s:
  # Specify the datastore type
  bootstrap-datastore: dqlite

  # Configure pod and service CIDR ranges
  bootstrap-pod-cidr: "192.168.0.0/16"
  bootstrap-service-cidr: "10.152.183.0/24"

  # Enable required features
  dns-enabled: true
  gateway-enabled: true
  ingress-enabled: true
  metrics-server-enabled: true

  # Configure DNS settings
  dns-cluster-domain: "cluster.local"
  dns-upstream-nameservers: "8.8.8.8 8.8.4.4"

  # Add & Remove node-labels from the snap's default labels
  #   The k8s snap applies its default labels, these labels define what
  #   are added or removed from those defaults
  # <key>=<value> ensures the label is added to all the nodes of this application
  # <key>=-       ensures the label is removed from all the nodes of this application
  # See charm-configuration notes for more information regarding node labelling
  node-labels: >-
    environment=production
    node-role.kubernetes.io/worker=-
    zone=us-east-1

  # Configure local storage
  local-storage-enabled: true
  local-storage-reclaim-policy: "Retain"

You can find a full list of configuration options in the charm configurations page.

Note

Remember that some configuration options can only be set during initial deployment and cannot be changed afterward. Always review the charm configurations documentation before deployment to ensure your settings align with your requirements.

Deploying the charm with custom configuration

Deploy the k8s charm with your custom configuration:

juju deploy k8s --config ./k8s-config.yaml --channel=1.32/stable

Bootstrap the cluster

Monitor the installation progress:

juju status --watch 1s

Wait for the unit to reach the active/idle state, indicating that the Canonical Kubernetes cluster is ready.