Documentation

Kubernetes local cluster

Configure a local Kubernetes cluster and generated kubeconfig.

Use this pattern when your local stack needs a Kubernetes cluster managed by vectron stack.

The default Kubernetes driver is k3d. This example sets driver = "minikube" explicitly because that is a common local-cluster shape when you want a single-node Minikube cluster.

schema_version = 1
tld = "local.dev.test"

enabled = ["kubernetes"]

[kubernetes]
driver = "minikube"
cluster_name = "local-dev"
control_planes = 1
workers = 0
wait_seconds = 120
kubeconfig_path = ".vectron_stack/generated/kubernetes/kubeconfig"
api_server_address = "127.0.0.1"
api_server_port = 6443
local_registry_port = 5001
stop_after_init = true
stop_on_vectron_stop = true

Lifecycle choices

  • kubeconfig_path points to the generated kubeconfig used by local tooling.
  • stop_after_init = true stops the cluster after initialization when the selected driver supports it.
  • stop_on_vectron_stop = true ties cluster shutdown to the normal vectron stop flow when supported.
  • recreate_existing = true is intentionally omitted here because it recreates an existing cluster with the same name.

What to customize

  • driver: accepted values are kind, k3d, and minikube.
  • cluster_name: use a stable, lower-case workspace name.
  • api_server_port and local_registry_port: keep them free on your machine.
  • workers: keep 0 for a small local cluster, or increase it only when your workflow needs worker nodes.

See the [kubernetes] reference for driver constraints and exact defaults.