-a, --agents <spanclass="c1"># specify how many agent nodes you want to create (integer, default: 0)</span>
--api-port <spanclass="c1"># specify the port on which the cluster will be accessible (format '[HOST:]HOSTPORT', default: random)</span>
-c, --config <spanclass="c1"># use a config file (format 'PATH')</span>
-e, --env <spanclass="c1"># add environment variables to the nodes (quoted string, format: 'KEY[=VALUE][@NODEFILTER[;NODEFILTER...]]', use flag multiple times)</span>
--gpus <spanclass="c1"># [from docker CLI] add GPU devices to the node containers (string, e.g. 'all')</span>
-i, --image <spanclass="c1"># specify which k3s image should be used for the nodes (string, default: 'docker.io/rancher/k3s:v1.20.0-k3s2', tag changes per build)</span>
--k3s-agent-arg <spanclass="c1"># add additional arguments to the k3s agent (quoted string, use flag multiple times) (see https://rancher.com/docs/k3s/latest/en/installation/install-options/agent-config/#k3s-agent-cli-help)</span>
--k3s-server-arg <spanclass="c1"># add additional arguments to the k3s server (quoted string, use flag multiple times) (see https://rancher.com/docs/k3s/latest/en/installation/install-options/server-config/#k3s-server-cli-help)</span>
--kubeconfig-switch-context <spanclass="c1"># (implies --kubeconfig-update-default) automatically sets the current-context of your default kubeconfig to the new cluster's context (default: true)</span>
--kubeconfig-update-default <spanclass="c1"># enable the automated update of the default kubeconfig with the details of the newly created cluster (also sets '--wait=true') (default: true)</span>
-l, --label <spanclass="c1"># add (docker) labels to the node containers (format: 'KEY[=VALUE][@NODEFILTER[;NODEFILTER...]]', use flag multiple times)</span>
--network <spanclass="c1"># specify an existing (docker) network you want to connect to (string)</span>
--no-hostip <spanclass="c1"># disable the automatic injection of the Host IP as 'host.k3d.internal' into the containers and CoreDNS (default: false)</span>
--no-image-volume <spanclass="c1"># disable the creation of a volume for storing images (used for the 'k3d image import' command) (default: false)</span>
--no-lb <spanclass="c1"># disable the creation of a load balancer in front of the server nodes (default: false)</span>
--no-rollback <spanclass="c1"># disable the automatic rollback actions, if anything goes wrong (default: false)</span>
-p, --port <spanclass="c1"># add some more port mappings (format: '[HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER]', use flag multiple times)</span>
--registry-create <spanclass="c1"># create a new (docker) registry dedicated for this cluster (default: false)</span>
--registry-use <spanclass="c1"># use an existing local (docker) registry with this cluster (string, use multiple times)</span>
-s, --servers <spanclass="c1"># specify how many server nodes you want to create (integer, default: 1)</span>
--token <spanclass="c1"># specify a cluster token (string, default: auto-generated)</span>
--timeout <spanclass="c1"># specify a timeout, after which the cluster creation will be interrupted and changes rolled back (duration, e.g. '10s')</span>
-v, --volume <spanclass="c1"># specify additional bind-mounts (format: '[SOURCE:]DEST[@NODEFILTER[;NODEFILTER...]]', use flag multiple times)</span>
--wait <spanclass="c1"># enable waiting for all server nodes to be ready before returning (default: true)</span>
--no-headers <spanclass="c1"># do not print headers (default: false)</span>
--token <spanclass="c1"># show column with cluster tokens (default: false)</span>
-o, --output <spanclass="c1"># format the output (format: 'json|yaml')</span>
completion <spanclass="o">[</span>bash <spanclass="p">|</span> zsh <spanclass="p">|</span> fish <spanclass="p">|</span><spanclass="o">(</span>psh <spanclass="p">|</span> powershell<spanclass="o">)]</span><spanclass="c1"># generate completion scripts for common shells</span>
config
init <spanclass="c1"># write a default k3d config (as a starting point)</span>
-f, --force <spanclass="c1"># force overwrite target file (default: false)</span>
-o, --output <spanclass="c1"># file to write to (string, default "k3d-default.yaml")</span>
<spanclass="nb">help</span><spanclass="o">[</span>COMMAND<spanclass="o">]</span><spanclass="c1"># show help text for any command</span>
image
import <spanclass="o">[</span>IMAGE <spanclass="p">|</span> ARCHIVE <spanclass="o">[</span>IMAGE <spanclass="p">|</span> ARCHIVE ...<spanclass="o">]]</span><spanclass="c1"># Load one or more images from the local runtime environment or tar-archives into k3d clusters</span>
-c, --cluster <spanclass="c1"># clusters to load the image into (string, use flag multiple times, default: k3s-default)</span>
-k, --keep-tarball <spanclass="c1"># do not delete the image tarball from the shared volume after completion (default: false)</span>
kubeconfig
get <spanclass="o">(</span>CLUSTERNAME <spanclass="o">[</span>CLUSTERNAME ...<spanclass="o">]</span><spanclass="p">|</span> --all<spanclass="o">)</span><spanclass="c1"># get kubeconfig from cluster(s) and write it to stdout</span>
-a, --all <spanclass="c1"># get kubeconfigs from all clusters (default: false)</span>
merge <spanclass="p">|</span> write <spanclass="o">(</span>CLUSTERNAME <spanclass="o">[</span>CLUSTERNAME ...<spanclass="o">]</span><spanclass="p">|</span> --all<spanclass="o">)</span><spanclass="c1"># get kubeconfig from cluster(s) and merge it/them into a (kubeconfig-)file</span>
-a, --all <spanclass="c1"># get kubeconfigs from all clusters (default: false)</span>
-s, --kubeconfig-switch-context <spanclass="c1"># switch current-context in kubeconfig to the new context (default: true)</span>
-d, --kubeconfig-merge-default <spanclass="c1"># update the default kubeconfig (usually $KUBECONFIG or $HOME/.kube/config)</span>
-o, --output <spanclass="c1"># specify the output file where the kubeconfig should be written to (string)</span>
-c, --cluster <spanclass="c1"># specify the cluster that the node shall connect to (string, default: k3s-default)</span>
-i, --image <spanclass="c1"># specify which k3s image should be used for the node(s) (string, default: 'docker.io/rancher/k3s:v1.20.0-k3s2', tag changes per build)</span>
--replicas <spanclass="c1"># specify how many replicas you want to create with this spec (integer, default: 1)</span>
--role <spanclass="c1"># specify the node role (string, format: 'agent|server', default: agent)</span>
--timeout <spanclass="c1"># specify a timeout duration, after which the node creation will be interrupted, if not done yet (duration, e.g. '10s')</span>
--wait <spanclass="c1"># wait for the node to be up and running before returning (default: true)</span>
<scriptid="__config"type="application/json">{"base":"../..","features":["tabs"],"translations":{"clipboard.copy":"Copy to clipboard","clipboard.copied":"Copied to clipboard","search.config.lang":"en","search.config.pipeline":"trimmer, stopWordFilter","search.config.separator":"[\\s\\-]+","search.placeholder":"Search","search.result.placeholder":"Type to start searching","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.term.missing":"Missing"},"search":"../../assets/javascripts/workers/search.fb4a9340.min.js","version":null}</script>