+ + + + + + + + K3d + + k3d¶ +https://k3d.io/ -> Run k3s in Docker! +Synopsis¶ +https://k3d.io/ +k3d is a wrapper CLI that helps you to easily create k3s clusters inside docker. +Nodes of a k3d cluster are docker containers running a k3s image. +All Nodes of a k3d cluster are part of the same docker network. +k3d [flags] + +Options¶ + -h, --help help for k3d + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + --version Show k3d and default k3s version + +SEE ALSO¶ + +k3d cluster - Manage cluster(s) +k3d completion - Generate completion scripts for [bash, zsh, fish, powershell | psh] +k3d config - Work with config file(s) +k3d docgen - Generate command docs +k3d image - Handle container images. +k3d kubeconfig - Manage kubeconfig(s) +k3d node - Manage node(s) +k3d registry - Manage registry/registries +k3d version - Show k3d and default k3s version + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d cluster + + k3d cluster¶ +Manage cluster(s) +Synopsis¶ +Manage cluster(s) +k3d cluster [flags] + +Options¶ + -h, --help help for cluster + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! +k3d cluster create - Create a new cluster +k3d cluster delete - Delete cluster(s). +k3d cluster list - List cluster(s) +k3d cluster start - Start existing k3d cluster(s) +k3d cluster stop - Stop existing k3d cluster(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d cluster create + + k3d cluster create¶ +Create a new cluster +Synopsis¶ +Create a new k3s cluster with containerized nodes (k3s in docker). +Every cluster will consist of one or more containers: + - 1 (or more) server node container (k3s) + - (optionally) 1 loadbalancer container as the entrypoint to the cluster (nginx) + - (optionally) 1 (or more) agent node containers (k3s) +k3d cluster create NAME [flags] + +Options¶ + -a, --agents int Specify how many agents you want to create + --agents-memory string Memory limit imposed on the agents nodes [From docker] + --api-port [HOST:]HOSTPORT Specify the Kubernetes API server port exposed on the LoadBalancer (Format: [HOST:]HOSTPORT) + - Example: `k3d cluster create --servers 3 --api-port 0.0.0.0:6550` + -c, --config string Path of a config file to use + -e, --env KEY[=VALUE][@NODEFILTER[;NODEFILTER...]] Add environment variables to nodes (Format: KEY[=VALUE][@NODEFILTER[;NODEFILTER...]] + - Example: `k3d cluster create --agents 2 -e "HTTP_PROXY=my.proxy.com" -e "SOME_KEY=SOME_VAL@server[0]"` + --gpus string GPU devices to add to the cluster node containers ('all' to pass all GPUs) [From docker] + -h, --help help for create + -i, --image string Specify k3s image that you want to use for the nodes + --k3s-agent-arg k3s agent Additional args passed to the k3s agent command on agent nodes (new flag per arg) + --k3s-server-arg k3s server Additional args passed to the k3s server command on server nodes (new flag per arg) + --kubeconfig-switch-context Directly switch the default kubeconfig's current-context to the new cluster's context (requires --kubeconfig-update-default) (default true) + --kubeconfig-update-default Directly update the default kubeconfig with the new cluster's context (default true) + -l, --label KEY[=VALUE][@NODEFILTER[;NODEFILTER...]] Add label to node container (Format: KEY[=VALUE][@NODEFILTER[;NODEFILTER...]] + - Example: `k3d cluster create --agents 2 -l "my.label@agent[0,1]" -v "other.label=somevalue@server[0]"` + --network string Join an existing network + --no-hostip Disable the automatic injection of the Host IP as 'host.k3d.internal' into the containers and CoreDNS + --no-image-volume Disable the creation of a volume for importing images + --no-lb Disable the creation of a LoadBalancer in front of the server nodes + --no-rollback Disable the automatic rollback actions, if anything goes wrong + -p, --port [HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER] Map ports from the node containers to the host (Format: [HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER]) + - Example: `k3d cluster create --agents 2 -p 8080:80@agent[0] -p 8081@agent[1]` + --registry-config string Specify path to an extra registries.yaml file + --registry-create Create a k3d-managed registry and connect it to the cluster + --registry-use stringArray Connect to one or more k3d-managed registries running locally + -s, --servers int Specify how many servers you want to create + --servers-memory string Memory limit imposed on the server nodes [From docker] + --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 (Format: [SOURCE:]DEST[@NODEFILTER[;NODEFILTER...]] + - Example: `k3d cluster create --agents 2 -v /my/path@agent[0,1] -v /tmp/test:/tmp/other@server[0]` + --wait Wait for the server(s) to be ready before returning. Use '--timeout DURATION' to not wait forever. (default true) + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d cluster - Manage cluster(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d cluster delete + + k3d cluster delete¶ +Delete cluster(s). +Synopsis¶ +Delete cluster(s). +k3d cluster delete [NAME [NAME ...] | --all] [flags] + +Options¶ + -a, --all Delete all existing clusters + -h, --help help for delete + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d cluster - Manage cluster(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d cluster list + + k3d cluster list¶ +List cluster(s) +Synopsis¶ +List cluster(s). +k3d cluster list [NAME [NAME...]] [flags] + +Options¶ + -h, --help help for list + --no-headers Disable headers + -o, --output string Output format. One of: json|yaml + --token Print k3s cluster token + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d cluster - Manage cluster(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d cluster start + + k3d cluster start¶ +Start existing k3d cluster(s) +Synopsis¶ +Start existing k3d cluster(s) +k3d cluster start [NAME [NAME...] | --all] [flags] + +Options¶ + -a, --all Start all existing clusters + -h, --help help for start + --timeout duration Maximum waiting time for '--wait' before canceling/returning. + --wait Wait for the server(s) (and loadbalancer) to be ready before returning. (default true) + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d cluster - Manage cluster(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d cluster stop + + k3d cluster stop¶ +Stop existing k3d cluster(s) +Synopsis¶ +Stop existing k3d cluster(s). +k3d cluster stop [NAME [NAME...] | --all] [flags] + +Options¶ + -a, --all Stop all existing clusters + -h, --help help for stop + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d cluster - Manage cluster(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d completion + + k3d completion¶ +Generate completion scripts for [bash, zsh, fish, powershell | psh] +Synopsis¶ +Generate completion scripts for [bash, zsh, fish, powershell | psh] +k3d completion SHELL [flags] + +Options¶ + -h, --help help for completion + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d config + + k3d config¶ +Work with config file(s) +Synopsis¶ +Work with config file(s) +k3d config [flags] + +Options¶ + -h, --help help for config + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! +k3d config init - + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d config init + + k3d config init¶ +k3d config init [flags] + +Options¶ + -f, --force Force overwrite of target file + -h, --help help for init + -o, --output string Write a default k3d config (default "k3d-default.yaml") + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d config - Work with config file(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d docgen + + k3d docgen¶ +Generate command docs +k3d docgen [flags] + +Options¶ + -h, --help help for docgen + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d image + + k3d image¶ +Handle container images. +Synopsis¶ +Handle container images. +k3d image [flags] + +Options¶ + -h, --help help for image + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! +k3d image import - Import image(s) from docker into k3d cluster(s). + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d image import + + k3d image import¶ +Import image(s) from docker into k3d cluster(s). +Synopsis¶ +Import image(s) from docker into k3d cluster(s). +k3d image import [IMAGE | ARCHIVE [IMAGE | ARCHIVE...]] [flags] + +Options¶ + -c, --cluster stringArray Select clusters to load the image to. (default [k3s-default]) + -h, --help help for import + -k, --keep-tarball Do not delete the tarball containing the saved images from the shared volume + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d image - Handle container images. + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d kubeconfig + + k3d kubeconfig¶ +Manage kubeconfig(s) +Synopsis¶ +Manage kubeconfig(s) +k3d kubeconfig [flags] + +Options¶ + -h, --help help for kubeconfig + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! +k3d kubeconfig get - Print kubeconfig(s) from cluster(s). +k3d kubeconfig merge - Write/Merge kubeconfig(s) from cluster(s) into new or existing kubeconfig/file. + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d kubeconfig get + + k3d kubeconfig get¶ +Print kubeconfig(s) from cluster(s). +Synopsis¶ +Print kubeconfig(s) from cluster(s). +k3d kubeconfig get [CLUSTER [CLUSTER [...]] | --all] [flags] + +Options¶ + -a, --all Output kubeconfigs from all existing clusters + -h, --help help for get + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d kubeconfig - Manage kubeconfig(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d kubeconfig merge + + k3d kubeconfig merge¶ +Write/Merge kubeconfig(s) from cluster(s) into new or existing kubeconfig/file. +Synopsis¶ +Write/Merge kubeconfig(s) from cluster(s) into new or existing kubeconfig/file. +k3d kubeconfig merge [CLUSTER [CLUSTER [...]] | --all] [flags] + +Options¶ + -a, --all Get kubeconfigs from all existing clusters + -h, --help help for merge + -d, --kubeconfig-merge-default Merge into the default kubeconfig ($KUBECONFIG or /home/thklein/.kube/config) + -s, --kubeconfig-switch-context Switch to new context (default true) + -o, --output string Define output [ - | FILE ] (default from $KUBECONFIG or /home/thklein/.kube/config + --overwrite [Careful!] Overwrite existing file, ignoring its contents + -u, --update Update conflicting fields in existing kubeconfig (default true) + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d kubeconfig - Manage kubeconfig(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d node + + k3d node¶ +Manage node(s) +Synopsis¶ +Manage node(s) +k3d node [flags] + +Options¶ + -h, --help help for node + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! +k3d node create - Create a new k3s node in docker +k3d node delete - Delete node(s). +k3d node list - List node(s) +k3d node start - Start an existing k3d node +k3d node stop - Stop an existing k3d node + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d node create + + k3d node create¶ +Create a new k3s node in docker +Synopsis¶ +Create a new containerized k3s node (k3s in docker). +k3d node create NAME [flags] + +Options¶ + -c, --cluster string Select the cluster that the node shall connect to. (default "k3s-default") + -h, --help help for create + -i, --image string Specify k3s image used for the node(s) (default "docker.io/rancher/k3s:v1.20.0-k3s2") + --memory string Memory limit imposed on the node [From docker] + --replicas int Number of replicas of this node specification. (default 1) + --role string Specify node role [server, agent] (default "agent") + --timeout duration Maximum waiting time for '--wait' before canceling/returning. + --wait Wait for the node(s) to be ready before returning. + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d node - Manage node(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d node delete + + k3d node delete¶ +Delete node(s). +Synopsis¶ +Delete node(s). +k3d node delete (NAME | --all) [flags] + +Options¶ + -a, --all Delete all existing nodes + -h, --help help for delete + -r, --registries Also delete registries + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d node - Manage node(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d node list + + k3d node list¶ +List node(s) +Synopsis¶ +List node(s). +k3d node list [NAME [NAME...]] [flags] + +Options¶ + -h, --help help for list + --no-headers Disable headers + -o, --output string Output format. One of: json|yaml + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d node - Manage node(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d node start + + k3d node start¶ +Start an existing k3d node +Synopsis¶ +Start an existing k3d node. +k3d node start NAME [flags] + +Options¶ + -h, --help help for start + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d node - Manage node(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d node stop + + k3d node stop¶ +Stop an existing k3d node +Synopsis¶ +Stop an existing k3d node. +k3d node stop NAME [flags] + +Options¶ + -h, --help help for stop + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d node - Manage node(s) + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d registry + + k3d registry¶ +Manage registry/registries +Synopsis¶ +Manage registry/registries +k3d registry [flags] + +Options¶ + -h, --help help for registry + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! +k3d registry create - Create a new registry +k3d registry delete - Delete registry/registries. +k3d registry list - List registries + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d registry create + + k3d registry create¶ +Create a new registry +Synopsis¶ +Create a new registry. +k3d registry create NAME [flags] + +Options¶ + -h, --help help for create + -i, --image string Specify image used for the registry (default "docker.io/library/registry:2") + --no-help Disable the help text (How-To use the registry) + -p, --port [HOST:]HOSTPORT Select which port the registry should be listening on on your machine (localhost) (Format: [HOST:]HOSTPORT) + - Example: `k3d registry create --port 0.0.0.0:5111` (default "random") + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d registry - Manage registry/registries + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d registry delete + + k3d registry delete¶ +Delete registry/registries. +Synopsis¶ +Delete registry/registries. +k3d registry delete (NAME | --all) [flags] + +Options¶ + -a, --all Delete all existing registries + -h, --help help for delete + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d registry - Manage registry/registries + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d registry list + + k3d registry list¶ +List registries +Synopsis¶ +List registries. +k3d registry list [NAME [NAME...]] [flags] + +Options¶ + -h, --help help for list + --no-headers Disable headers + -o, --output string Output format. One of: json|yaml + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d registry - Manage registry/registries + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +
+ + + + + + + + K3d version + + k3d version¶ +Show k3d and default k3s version +Synopsis¶ +Show k3d and default k3s version +k3d version [flags] + +Options¶ + -h, --help help for version + +Options inherited from parent commands¶ + --timestamps Enable Log timestamps + --trace Enable super verbose output (trace logging) + --verbose Enable verbose output (debug logging) + +SEE ALSO¶ + +k3d - https://k3d.io/ -> Run k3s in Docker! + + + + + + + + + + Last update: April 14, 2021 + + + + + + + + + + + +