k3d

https://k3d.io/stable/
Admin
k3d is a lightweight wrapper to run k3s (Rancher's minimal Kubernetes distribution) in Docker for...
Tokens:37,010
Snippets:381
Trust Score:9.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Zsh completion setup

Source: https://k3d.io/stable/usage/commands/k3d_completion

Enable zsh completion and load k3d completions. For persistent setup, redirect the output to the first directory in fpath and start a new shell.

```zsh
# If shell completion is not already enabled in your environment,
# you will need to enable it.  You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

# To load completions for each session, execute once:
$ k3d completion zsh > "${fpath[1]}/_k3d"

# You will need to start a new shell for this setup to take effect.
```

--------------------------------

### k3d cluster start command syntax

Source: https://k3d.io/stable/usage/commands/k3d_cluster_start

Shows the basic syntax for starting existing k3d clusters. Use this command to start one or more clusters by name, or use the --all flag to start all existing clusters.

```bash
k3d cluster start [NAME [NAME...] | --all] [flags]

```

--------------------------------

### Install k3d via arkade

Source: https://k3d.io/stable

Installs k3d using arkade.

```bash
arkade get k3d
```

--------------------------------

### Install latest release with wget

Source: https://k3d.io/stable

Downloads and runs the k3d install script using wget to install the latest release.

```bash
wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
```

--------------------------------

### Install k3d via Go

Source: https://k3d.io/stable

Installs k3d using go install, which provides unreleased/bleeding-edge changes.

```bash
go install github.com/k3d-io/k3d/v5@latest
```

--------------------------------

### k3d node start options

Source: https://k3d.io/stable/usage/commands/k3d_node_start

Options for the k3d node start command, including the help flag.

```bash
  -h, --help   help for start

```

--------------------------------

### Fish completion setup

Source: https://k3d.io/stable/usage/commands/k3d_completion

Load k3d completions for fish by sourcing the generated script. For persistent setup, redirect the output to the fish completions directory.

```fish
$ k3d completion fish | source

# To load completions for each session, execute once:
$ k3d completion fish > ~/.config/fish/completions/k3d.fish
```

--------------------------------

### Start Podman machine on macOS

Source: https://k3d.io/stable/usage/advanced/podman

Starts an already existing Podman machine.

```bash
podman machine start

```

--------------------------------

### k3d cluster start options

Source: https://k3d.io/stable/usage/commands/k3d_cluster_start

Lists the flags available for the k3d cluster start command. The --all flag starts all existing clusters, --timeout sets the maximum waiting time for --wait, and --wait waits for the server(s) and loadbalancer to be ready before returning (default true).

```bash
  -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)

```

--------------------------------

### Install latest release with curl

Source: https://k3d.io/stable

Downloads and runs the k3d install script using curl to install the latest release.

```bash
curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
```

--------------------------------

### Install k3d via asdf

Source: https://k3d.io/stable

Adds the k3d plugin and installs the latest version using asdf.

```bash
asdf plugin-add k3d && asdf install k3d latest
```

--------------------------------

### Install k3d via Scoop

Source: https://k3d.io/stable

Installs k3d on Windows using Scoop.

```powershell
scoop install k3d
```

--------------------------------

### Bash completion setup

Source: https://k3d.io/stable/usage/commands/k3d_completion

Load k3d completions for bash by sourcing the generated script. For persistent setup, redirect the output to the appropriate bash completion directory.

```bash
$ source <(k3d completion bash)

# To load completions for each session, execute once:
# Linux:
$ k3d completion bash > /etc/bash_completion.d/k3d
# macOS:
$ k3d completion bash > /usr/local/etc/bash_completion.d/k3d
```

--------------------------------

### Install k3d via Homebrew

Source: https://k3d.io/stable

Installs k3d using Homebrew on macOS or Linux.

```bash
brew install k3d
```

--------------------------------

### k3d configuration file with all options (YAML)

Source: https://k3d.io/stable/usage/configfile

Complete example of a k3d configuration file (apiVersion: k3d.io/v1alpha5, kind: Simple) showing all supported settings. Use as a reference for creating your own cluster configuration. Note that the apiVersion will change in the future as stability improves.

```yaml
# k3d configuration file, saved as e.g. /home/me/myk3dcluster.yaml
apiVersion: k3d.io/v1alpha5 # this will change in the future as we make everything more stable
kind: Simple # internally, we also have a Cluster config, which is not yet available externally
metadata:
  name: mycluster # name that you want to give to your cluster (will still be prefixed with `k3d-`)
servers: 1 # same as `--servers 1`
agents: 2 # same as `--agents 2`
kubeAPI: # same as `--api-port myhost.my.domain:6445` (where the name would resolve to 127.0.0.1)
  host: "myhost.my.domain" # important for the `server` setting in the kubeconfig
  hostIP: "127.0.0.1" # where the Kubernetes API will be listening on
  hostPort: "6445" # where the Kubernetes API listening port will be mapped to on your host system
image: rancher/k3s:v1.35.2-k3s1 # same as `--image rancher/k3s:v1.35.2-k3s1`
network: my-custom-net # same as `--network my-custom-net`
subnet: "172.28.0.0/16" # same as `--subnet 172.28.0.0/16`
token: superSecretToken # same as `--token superSecretToken`
volumes: # repeatable flags are represented as YAML lists
  - volume: /my/host/path:/path/in/node # same as `--volume '/my/host/path:/path/in/node@server:0;agent:*'`
    nodeFilters:
      - server:0
      - agent:*
ports:
  - port: 8080:80 # same as `--port '8080:80@loadbalancer'`
    nodeFilters:
      - loadbalancer
env:
  - envVar: bar=baz # same as `--env 'bar=baz@server:0'`
    nodeFilters:
      - server:0
files:
  - description: 'Source: Embedded, Destination: Magic shortcut path'
    source: |
      apiVersion: v1
      kind: Namespace
      metadata:
        name: foo
    destination: k3s-manifests-custom/foo.yaml # Resolved to /var/lib/rancher/k3s/server/manifests/custom/foo.yaml
  - description: 'Source: Relative, Destination: Absolute path, Node: Servers only'
    source: ns-baz.yaml
    destination: /var/lib/rancher/k3s/server/manifests/baz.yaml
    nodeFilters:
    - "server:*"
registries: # define how registries should be created or used
  create: # creates a default registry to be used with the cluster; same as `--registry-create registry.localhost`
    name: registry.localhost
    host: "0.0.0.0"
    hostPort: "5000"
    proxy: # omit this to have a "normal" registry, set this to create a registry proxy (pull-through cache)
      remoteURL: https://registry-1.docker.io # mirror the DockerHub registry
      username: "" # unauthenticated
      password: "" # unauthenticated
    volumes:
      - /some/path:/var/lib/registry # persist registry data locally
  use:
    - k3d-myotherregistry:5000 # some other k3d-managed registry; same as `--registry-use 'k3d-myotherregistry:5000'`
  config: | # define contents of the `registries.yaml` file (or reference a file); same as `--registry-config /path/to/config.yaml`
    mirrors:
      "my.company.registry":
        endpoint:
          - http://my.company.registry:5000
hostAliases: # /etc/hosts style entries to be injected into /etc/hosts in the node containers and in the NodeHosts section in CoreDNS
  - ip: 1.2.3.4
    hostnames: 
      - my.host.local
      - that.other.local
  - ip: 1.1.1.1
    hostnames:
      - cloud.flare.dns
options:
  k3d: # k3d runtime settings
    wait: true # wait for cluster to be usable before returning; same as `--wait` (default: true)
    timeout: "60s" # wait timeout before aborting; same as `--timeout 60s`
    disableLoadbalancer: false # same as `--no-lb`
    disableImageVolume: false # same as `--no-image-volume`
    disableRollback: false # same as `--no-Rollback`
    loadbalancer:
      configOverrides:
        - settings.workerConnections=2048
  k3s: # options passed on to K3s itself
    extraArgs: # additional arguments passed to the `k3s server|agent` command; same as `--k3s-arg`
      - arg: "--tls-san=my.host.domain"
        nodeFilters:
          - server:*
    nodeLabels:
      - label: foo=bar # same as `--k3s-node-label 'foo=bar@agent:1'` -> this results in a Kubernetes node label
        nodeFilters:
          - agent:1
  kubeconfig:
    updateDefaultKubeconfig: true # add new cluster to your default Kubeconfig; same as `--kubeconfig-update-default` (default: true)
    switchCurrentContext: true # also set current-context to the new cluster's context; same as `--kubeconfig-switch-context` (default: true)
  runtime: # runtime (docker) specific options
    gpuRequest: all # same as `--gpus all`
    labels:
      - label: bar=baz # same as `--runtime-label 'bar=baz@agent:1'` -> this results in a runtime (docker) container label
        nodeFilters:
          - agent:1
    ulimits:
      - name: nofile
        soft: 26677
        hard: 26677

```

--------------------------------

### k3d node start command syntax

Source: https://k3d.io/stable/usage/commands/k3d_node_start

Starts an existing k3d node. The command requires a node name and accepts flags.

```bash
k3d node start NODE [flags]

```

--------------------------------

### k3d cluster create with --registry-create

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --registry-create option to create a k3d-managed registry and connect it to the cluster.

```bash
k3d cluster create --registry-create mycluster-registry:0.0.0.0:5432

```

--------------------------------

### k3d cluster create with volume mounts

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the -v/--volume flag to mount volumes into nodes. The format is [SOURCE:]DEST[@NODEFILTER[;NODEFILTER...]], and the example mounts a path to agent and server nodes.

```bash
k3d cluster create --agents 2 -v /my/path@agent:0,1 -v /tmp/test:/tmp/other@server:0
```

--------------------------------

### Install k3d via Chocolatey

Source: https://k3d.io/stable

Installs k3d on Windows using Chocolatey.

```powershell
choco install k3d
```

--------------------------------

### k3d kubeconfig get options

Source: https://k3d.io/stable/usage/commands/k3d_kubeconfig_get

Lists the options for the k3d kubeconfig get command, including --all and --help.

```bash
  -a, --all    Output kubeconfigs from all existing clusters
  -h, --help   help for get

```

--------------------------------

### k3d cluster create with runtime-ulimit

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --runtime-ulimit flag to add ulimits to the container runtime. The format is NAME[=SOFT]:[HARD], and the example sets nofile and noproc limits.

```bash
k3d cluster create --agents 2 --runtime-ulimit "nofile=1024:1024" --runtime-ulimit "noproc=1024:1024"
```

--------------------------------

### Create Calico installation manifest

Source: https://k3d.io/stable/usage/advanced/calico

Creates the installation manifest that instructs the Tigera Operator to install Calico. The operator periodically checks for this manifest.

```bash
kubectl create -f https://raw.githubusercontent.com/projectcalico/calico/v3.29.0/manifests/custom-resources.yaml

```

--------------------------------

### Install k3d via AUR

Source: https://k3d.io/stable

Installs the rancher-k3d-bin package from the Arch User Repository using yay.

```bash
yay -S rancher-k3d-bin
```

--------------------------------

### k3d cluster create with --port

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --port option to map ports from node containers to the host.

```bash
k3d cluster create --agents 2 -p 8080:80@agent:0 -p 8081@agent:1

```

--------------------------------

### k3d cluster create with --env

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --env option to add environment variables to nodes.

```bash
k3d cluster create --agents 2 -e "HTTP_PROXY=my.proxy.com@server:0" -e "SOME_KEY=SOME_VAL@server:0"

```

--------------------------------

### Install specific release with wget

Source: https://k3d.io/stable

Installs a specific k3d release by setting the TAG environment variable to the desired version, e.g., v5.0.0.

```bash
wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
```

--------------------------------

### k3d cluster create with --runtime-label

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --runtime-label option to add labels to container runtime.

```bash
k3d cluster create --agents 2 --runtime-label "my.label@agent:0,1" --runtime-label "other.label=somevalue@server:0"

```

--------------------------------

### k3d cluster create with --k3s-arg

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --k3s-arg option to pass additional args to the k3s command.

```bash
k3d cluster create --k3s-arg "--disable=traefik@server:0"

```

--------------------------------

### Start custom local registry with Docker

Source: https://k3d.io/stable/usage/registries

Creates a Docker volume and runs a registry container named 'registry.localhost' with port 12345 mapped to host port 5000. The container restarts automatically.

```bash
docker volume create local_registry
docker container run -d --name registry.localhost -v local_registry:/var/lib/registry --restart always -p 12345:5000 registry:2

```

--------------------------------

### PowerShell completion setup

Source: https://k3d.io/stable/usage/commands/k3d_completion

Load k3d completions for PowerShell by piping the generated script to Invoke-Expression. For persistent setup, redirect the output to a file and source it from your PowerShell profile.

```powershell
PS> k3d completion powershell | Out-String | Invoke-Expression

# To load completions for every new session, run:
PS> k3d completion powershell > k3d.ps1
# and source this file from your PowerShell profile.
```

--------------------------------

### k3d cluster create with --k3s-node-label

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --k3s-node-label option to add labels to k3s nodes.

```bash
k3d cluster create --agents 2 --k3s-node-label "my.label@agent:0,1" --k3s-node-label "other.label=somevalue@server:0"

```

--------------------------------

### Symlink Docker socket to Podman socket

Source: https://k3d.io/stable/usage/advanced/podman

Creates a symbolic link from /run/podman/podman.sock to /var/run/docker.sock so k3d finds the Podman socket. The commented alternative installs podman-docker if available. Then runs `sudo k3d cluster create`.

```bash
sudo ln -s /run/podman/podman.sock /var/run/docker.sock
# or install your system podman-docker if available
sudo k3d cluster create

```

--------------------------------

### k3d kubeconfig get synopsis

Source: https://k3d.io/stable/usage/commands/k3d_kubeconfig_get

Shows the command syntax for printing kubeconfig(s) from cluster(s).

```bash
k3d kubeconfig get [CLUSTER [CLUSTER [...]] | --all] [flags]

```

--------------------------------

### Enable Podman system socket

Source: https://k3d.io/stable/usage/advanced/podman

Enables the Podman system socket for rootful usage. The commented alternative starts the socket daemonless.

```bash
sudo systemctl enable --now podman.socket
# or to start the socket daemonless
# sudo podman system service --time=0 &

```

--------------------------------

### Enable Podman user socket for rootless

Source: https://k3d.io/stable/usage/advanced/podman

Enables the Podman user socket for rootless usage. The commented alternative starts the service daemonless.

```bash
systemctl --user enable --now podman.socket
# or podman system service --time=0 &

```

--------------------------------

### Verify Calico installation with kubectl get tigerastatus

Source: https://k3d.io/stable/usage/advanced/calico

Checks the status of the Calico installation. After about a minute, you should see output similar to the example, with apiserver, calico, and ippools all available.

```bash
kubectl get tigerastatus

```

```text
NAME        AVAILABLE   PROGRESSING   DEGRADED   SINCE
apiserver   True        False         False      30s
calico      True        False         False      10s
ippools     True        False         False      70s

```

--------------------------------

### Install Tigera Operator

Source: https://k3d.io/stable/usage/advanced/calico

Installs the Tigera Operator, which helps configure, install, and upgrade Calico. This is the first step in installing Calico.

```bash
kubectl create -f https://raw.githubusercontent.com/projectcalico/calico/v3.29.0/manifests/tigera-operator.yaml

```

--------------------------------

### k3d config init command syntax

Source: https://k3d.io/stable/usage/commands/k3d_config_init

Shows the basic usage of the k3d config init command.

```bash
k3d config init [flags]

```

--------------------------------

### k3d config init options

Source: https://k3d.io/stable/usage/commands/k3d_config_init

Lists the flags available for the k3d config init command, including force overwrite and output file specification.

```bash
  -f, --force           Force overwrite of target file
  -h, --help            help for init
  -o, --output string   Write a default k3d config (default "k3d-default.yaml")

```

--------------------------------

### k3d registry create command syntax

Source: https://k3d.io/stable/usage/commands/k3d_registry_create

Shows the basic command syntax for creating a new registry with k3d.

```bash
k3d registry create NAME [flags]

```

--------------------------------

### k3d command synopsis

Source: https://k3d.io/stable/usage/commands/k3d

Shows the basic usage of the k3d CLI. Run k3d with no arguments to see help.

```bash
k3d [flags]

```

--------------------------------

### Initialize Podman machine on macOS

Source: https://k3d.io/stable/usage/advanced/podman

Initializes a Podman machine if not already done.

```bash
podman machine init

```

--------------------------------

### Install specific release with curl

Source: https://k3d.io/stable

Installs a specific k3d release by setting the TAG environment variable to the desired version, e.g., v5.0.0.

```bash
curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
```

--------------------------------

### Get cluster nodes with kubectl

Source: https://k3d.io/stable

Lists the nodes in the cluster using kubectl.

```bash
kubectl get nodes
```

--------------------------------

### k3d registry create options

Source: https://k3d.io/stable/usage/commands/k3d_registry_create

Lists the options available for the k3d registry create command, including flags for network, image, port, volumes, and proxy settings.

```bash
      --default-network string    Specify the network connected to the registry (default "bridge")
  -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")
      --proxy-password string     Specify the password of the proxied remote registry
      --proxy-remote-url string   Specify the url of the proxied remote registry
      --proxy-username string     Specify the username of the proxied remote registry
  -v, --volume [SOURCE:]DEST      Mount volumes into the registry node (Format: [SOURCE:]DEST

```

--------------------------------

### Get kubeconfig to a file

Source: https://k3d.io/stable/usage/kubeconfig

Alternative to k3d kubeconfig write, redirects the kubeconfig output to a file.

```bash
k3d kubeconfig get mycluster > some-file.yaml
```

--------------------------------

### k3d version command synopsis

Source: https://k3d.io/stable/usage/commands/k3d_version

Shows the basic usage of the k3d version command.

```bash
k3d version [flags]

```

--------------------------------

### Create a pull-through registry with k3d registry create

Source: https://k3d.io/stable/usage/registries

Creates a registry container named k3d-docker-io that proxies Docker Hub. It listens on local port 5000 and persists downloaded images to ~/.local/share/docker-io-registry.

```bash
k3d registry create docker-io `# Create a registry named k3d-docker-io` \
  -p 5000 `# listening on local host port 5000` \ 
  --proxy-remote-url https://registry-1.docker.io `# let it mirror the Docker Hub registry` \
  -v ~/.local/share/docker-io-registry:/var/lib/registry `# also persist the downloaded images on the device outside the container`
```

--------------------------------

### Create cluster from config file

Source: https://k3d.io/stable/usage/registries

Creates a cluster using the configuration file /home/me/test-regcache.yaml, which sets up the registry proxy and cluster in one step.

```bash
k3d cluster create -c /home/me/test-regcache.yaml
```

--------------------------------

### k3d node create options

Source: https://k3d.io/stable/usage/commands/k3d_node_create

Lists the available flags for the k3d node create command, including cluster, image, k3s-arg, labels, memory, network, replicas, role, runtime labels, ulimits, timeout, token, and wait.

```bash
  -c, --cluster string           Cluster URL or k3d cluster name to connect to. (default "k3s-default")
  -h, --help                     help for create
  -i, --image string             Specify k3s image used for the node(s) (default: copied from existing node)
      --k3s-arg stringArray      Additional args passed to k3d command
      --k3s-node-label strings   Specify k3s node labels in format "foo=bar"
      --memory string            Memory limit imposed on the node [From docker]
  -n, --network strings          Add node to (another) runtime network
      --replicas int             Number of replicas of this node specification. (default 1)
      --role string              Specify node role [server, agent] (default "agent")
      --runtime-label strings    Specify container runtime labels in format "foo=bar"
      --runtime-ulimit strings   Specify container runtime ulimit in format "ulimit=soft:hard"
      --timeout duration         Maximum waiting time for '--wait' before canceling/returning.
  -t, --token string             Override cluster token (required when connecting to an external cluster)
      --wait                     Wait for the node(s) to be ready before returning. (default true)

```

--------------------------------

### k3d cluster create with --api-port

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Example of using the --api-port option to specify the Kubernetes API server port exposed on the LoadBalancer.

```bash
k3d cluster create --servers 3 --api-port 0.0.0.0:6550

```

--------------------------------

### Create k3d cluster with kubelet eviction thresholds

Source: https://k3d.io/stable/faq/faq

Changes kubelet eviction thresholds during cluster creation to avoid pod evictions due to disk pressure. Uses --k3s-arg flags for eviction-hard and eviction-minimum-reclaim on agent nodes.

```bash
k3d cluster create \
  --k3s-arg '--kubelet-arg=eviction-hard=imagefs.available<1%,nodefs.available<1%@agent:*' \
  --k3s-arg '--kubelet-arg=eviction-minimum-reclaim=imagefs.available=1%,nodefs.available=1%@agent:*'
```

--------------------------------

### Get kubeconfig file

Source: https://k3d.io/stable/usage/exposing_services

Writes the kubeconfig for the k3s-default cluster to a file and sets the KUBECONFIG environment variable. This is redundant because k3d cluster create already merges it into the default kubeconfig.

```bash
export KUBECONFIG="$(k3d kubeconfig write k3s-default)"
```

--------------------------------

### k3d loadbalancer config override via config file

Source: https://k3d.io/stable/design/defaults

Define loadbalancer config overrides in a k3d configuration file under k3d.loadbalancer.configOverrides. The example shows overriding settings.workerConnections to 2048.

```yaml
# ... truncated ...
k3d:
  loadbalancer:
    configOverrides:
      - settings.workerConnections=2048

```

--------------------------------

### k3d config migrate options

Source: https://k3d.io/stable/usage/commands/k3d_config_migrate

Lists the command-specific options for k3d config migrate, including the help flag.

```bash
  -h, --help   help for migrate

```

--------------------------------

### k3d image options

Source: https://k3d.io/stable/usage/commands/k3d_image

Lists the options available for the k3d image command, including the help flag.

```bash
  -h, --help   help for image

```

--------------------------------

### Create a local registry with Podman network

Source: https://k3d.io/stable/usage/advanced/podman

Creates a local registry named 'mycluster-registry' using the 'podman' network, required because Podman lacks a default bridge network.

```bash
k3d registry create --default-network podman mycluster-registry

```

--------------------------------

### Deploy nginx-test-registry Deployment

Source: https://k3d.io/stable/usage/registries

Creates a Deployment named nginx-test-registry that references the image pushed to the local registry. Apply it with kubectl and then check the pod is running with kubectl get pods -l "app=nginx-test-registry".

```bash
cat <<EOF | kubectl apply -f -
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-test-registry
  labels:
    app: nginx-test-registry
spec:
  replicas: 1
  selector:
    matchLabels:
      app: nginx-test-registry
  template:
    metadata:
      labels:
        app: nginx-test-registry
    spec:
      containers:
      - name: nginx-test-registry
        image: k3d-registry.localhost:12345/nginx:latest
        ports:
        - containerPort: 80
EOF
```

--------------------------------

### Expose whole NodePort range

Source: https://k3d.io/stable/usage/exposing_services

Alternative cluster creation that exposes the entire NodePort range from the start. Warning: Docker creates iptable entries and a new proxy process per port-mapping, which may take a long time or freeze the system.

```bash
k3d cluster create mycluster --agents 3 -p "30000-32767:30000-32767@server:0"
```

--------------------------------

### k3d registry options

Source: https://k3d.io/stable/usage/commands/k3d_registry

Lists the command-specific options for k3d registry, including the help flag.

```bash
  -h, --help   help for registry

```

--------------------------------

### k3d cluster command syntax

Source: https://k3d.io/stable/usage/commands/k3d_cluster

Shows the basic syntax for the k3d cluster command.

```bash
k3d cluster [flags]

```

--------------------------------

### k3d node create command synopsis

Source: https://k3d.io/stable/usage/commands/k3d_node_create

Shows the basic syntax for creating a new k3s node in Docker. The command requires a node name and can be customized with various flags.

```bash
k3d node create NAME [flags]

```

--------------------------------

### Example Error: x509 certificate signed by unknown authority

Source: https://k3d.io/stable/faq/faq

Shows the error message when the corporate proxy certificate cannot be validated inside the container. The solution is to mount the CA certificate using `k3d cluster create --volume /path/to/your/certs.crt:/etc/ssl/certs/yourcert.crt`.

```text
Failed to create pod sandbox: rpc error: code = Unknown desc = failed to get sandbox image "docker.io/rancher/pause:3.1": failed to pull image "docker.io/rancher/pause:3.1": failed to pull and unpack image "docker.io/rancher/pause:3.1": failed to resolve reference "docker.io/rancher/pause:3.1": failed to do request: Head https://registry-1.docker.io/v2/rancher/pause/manifests/3.1: x509: certificate signed by unknown authority

```

--------------------------------

### Run alpine test pod

Source: https://k3d.io/stable/usage/registries

Creates a pod named testimage using the image pushed to the local registry. The command keeps the container running with tail -f /dev/null.

```bash
kubectl run --image k3d-registry.localhost:12345/testimage:local testimage --command -- tail -f /dev/null
```

--------------------------------

### k3d cluster edit options

Source: https://k3d.io/stable/usage/commands/k3d_cluster_edit

Displays the options for the k3d cluster edit command. This block includes the help flag and the --port-add flag, which maps ports from node containers to the host. The example shows adding port 8080:80 to the serverlb node.

```shell
  -h, --help                                                               help for edit
      --port-add [HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER]   [EXPERIMENTAL] Map ports from the node containers (via the serverlb) to the host (Format: [HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER])
                                                                            - Example: `k3d node edit k3d-mycluster-serverlb --port-add 8080:80`

```

--------------------------------

### Enable cgroup v2 delegation for rootless Podman

Source: https://k3d.io/stable/usage/advanced/podman

Creates a systemd user service drop-in to delegate cpu, cpuset, io, memory, and pids controllers, then reloads systemd. Required for proper CPU, CPUSET, and I/O delegation in cgroup v2.

```bash
mkdir -p /etc/systemd/system/user@.service.d
cat > /etc/systemd/system/user@.service.d/delegate.conf <<EOF
[Service]
Delegate=cpu cpuset io memory pids
EOF
systemctl daemon-reload

```

--------------------------------

### Dockerfile for custom K3s image with NVIDIA Container Toolkit

Source: https://k3d.io/stable/usage/advanced/cuda

Builds a custom K3s image based on nvcr.io/nvidia/cuda:12.4.1-base-ubuntu22.04 to support the NVIDIA Container Runtime. Installs the NVIDIA Container Toolkit, configures containerd, copies the K3s binaries, and deploys the NVIDIA device plugin manifest on startup. The CUDA tag must match the version you plan to use.

```dockerfile
ARG K3S_TAG="v1.28.8-k3s1"
ARG CUDA_TAG="12.4.1-base-ubuntu22.04"

FROM rancher/k3s:$K3S_TAG as k3s
FROM nvcr.io/nvidia/cuda:$CUDA_TAG

# Install the NVIDIA container toolkit
RUN apt-get update && apt-get install -y curl \
    && curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg \
    && curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | \
      sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
      tee /etc/apt/sources.list.d/nvidia-container-toolkit.list \
    && apt-get update && apt-get install -y nvidia-container-toolkit \
    && nvidia-ctk runtime configure --runtime=containerd

COPY --from=k3s / / --exclude=/bin
COPY --from=k3s /bin /bin

# Deploy the nvidia driver plugin on startup
COPY device-plugin-daemonset.yaml /var/lib/rancher/k3s/server/manifests/nvidia-device-plugin-daemonset.yaml

VOLUME /var/lib/kubelet
VOLUME /var/lib/rancher/k3s
VOLUME /var/lib/cni
VOLUME /var/log

ENV PATH="$PATH:/bin/aux"

ENTRYPOINT ["/bin/k3s"]
CMD ["agent"]

```

--------------------------------

### k3d config migrate command usage

Source: https://k3d.io/stable/usage/commands/k3d_config_migrate

Shows the command syntax for k3d config migrate, which takes an input file and optionally an output file.

```bash
k3d config migrate INPUT [OUTPUT] [flags]

```

--------------------------------

### Create a multi-server cluster with embedded etcd

Source: https://k3d.io/stable/usage/multiserver

Creates a k3d cluster named 'multiserver' with 3 server nodes using k3s' embedded etcd. The first server uses the --cluster-init flag and k3d waits for it to be ready before creating and connecting the other servers. Use an odd number of servers (1, 3, 5, ...) for etcd quorum. At least 2 cores and 4GiB of RAM are recommended.

```bash
k3d cluster create multiserver --servers 3

```

--------------------------------

### k3d cluster create basic usage

Source: https://k3d.io/stable/usage/commands/k3d_cluster_create

Basic syntax for creating a new k3s cluster with a specified name.

```bash
k3d cluster create NAME [flags]

```

--------------------------------

### k3d config command usage

Source: https://k3d.io/stable/usage/commands/k3d_config

Shows the basic usage of the k3d config command.

```bash
k3d config [flags]

```
Tokens:
Raw