k3d cluster create <cluster name>

Create a new k3s cluster

Arguments

NameDescription
cluster nameName of the cluster to create

Options

NameDescription
-a, --agents <number of agents>Number of agents to create
--agents-memory <memory limit>Memory limit imposed on the agents nodes
--api-port <port>Specify the Kubernetes API server port exposed on the LoadBalancer
-c, --config <path>Path of a config file to use
-e, --env <environment variables>Add environment variables to nodes
--gpus <devices>GPU devices to add to the cluster node containers
-h, --helpHelp for create
--host-alias <ip:host[,host,...]>Add ip:host[,host,...] mappings
--host-pid-modeEnable host pid mode of server(s) and agent(s)
-i, --image <image>Specify k3s image that you want to use for the nodes
--k3s-arg <ARG@NODEFILTER[;@NODEFILTER]>Additional args passed to k3s command
--k3s-node-label <KEY[=VALUE][@NODEFILTER[;NODEFILTER...]]>Add label to k3s node
--kubeconfig-switch-contextDirectly switch the default kubeconfig's current-context to the new cluster's context (requires --kubeconfig-update-default) (default true)
--kubeconfig-update-defaultDirectly update the default kubeconfig with the new cluster's context (default true)
--lb-config-override <path>Use dotted YAML path syntax to override nginx loadbalancer settings
--network <network>Specify the docker network to use
--no-image-volumeDon't create a volume for the container's root filesystem
--no-lbDon't create a loadbalancer for the cluster
--no-rollbackDon't rollback changes if cluster creation failed
-p, --port <port>Map ports from the node containers (via the serverlb) to the host
--registry-config <path>Specify path to an extra registries.yaml file
--registry-create <NAME[:HOST][:HOSTPORT]>Create a k3d-managed registry and connect it to the cluster (Format: NAME[:HOST][:HOSTPORT] - Example: `k3d cluster create --registry-create mycluster-registry
--registry-use <NAME[:HOST][:HOSTPORT]>Connect to one or more k3d-managed registries running locally
--runtime-labelAdd label to container runtime (Format: KEY[=VALUE][@NODEFILTER[;NODEFILTER...]] - Example: `k3d cluster create --agents 2 --runtime-label "my.label@agent:0,1" --runtime-label "other.label=somevalue@server:0"`
-s, --servers <int>Specify how many servers you want to create
--servers-memory <string>Memory limit imposed on the server nodes [From docker]
--subnet <string>[Experimental: IPAM] Define a subnet for the newly created container network
--timeout <duration>Rollback changes if cluster couldn't be created in specified duration
--token <string>Specify a cluster token. By default, we generate one
-v, --volume <[SOURCE:]DEST[@NODEFILTER[;NODEFILTER...]]>Mount volumes into the nodes
--waitWait for the server(s) to be ready before returning