otty / apps

All apps/k3d

k3d

A lightweight wrapper to run k3s clusters in Docker.

Runs as k3d|macOS, Linux, Windows|k3d.io

Open form in Otty otty.toml

Command form

ai-draft · 6 tasks · 26 fields

Create and manage k3s clusters in Docker. Node, registry, image and kubeconfig commands are left out.

Opens the form; the finished command lands at your prompt, unrun

Run in Otty

otty gui k3d

k3dExample values, fixed in this page — nothing here reaches a terminal

Basic

Verbose output

--verbose

Trace output

--trace

Log timestamps

--timestamps

ParametersOnly these flags are editable in the form

Verbose output

Verbose output.
boolean

--verbose

Trace output

Trace output.
boolean

--trace

Log timestamps

Print timestamps in log output.
boolean

--timestamps

`k3d cluster create`

Create a cluster

Create a new k3s cluster.

Create a clusterExample values, fixed in this page — nothing here reaches a terminal

Basic

Cluster name*

string

Servers

integer

Agents

integer

Wait until ready

--wait

TasksEach one presets the form for one job

Create a cluster

nameserversagentswait

Create with port mapping

nameportagents

ParametersOnly these flags are editable in the form

Cluster name

Name of the cluster to create.
string · positional 0

Servers

How many servers to create.
integer

--servers-s

Agents

Number of agents to create.
integer

--agents-a

Port mapping

Map ports from node containers to the host (repeatable).
string · repeatable

--port-p

Volume mount

Mount volumes into the nodes (repeatable).
string · repeatable

--volume-v

k3s image

k3s image for the nodes.
string

--image-i

API port

Kubernetes API server port exposed on the load balancer.
string

--api-port

Docker network

Docker network to use.
string

--network

No load balancer

Do not create a load balancer.
boolean

--no-lb

Wait until ready

Wait for the servers to be ready before returning.
boolean

--wait

Timeout

Roll back if the cluster is not created within this duration.
string

--timeout

Config file

path

--config-c

`k3d cluster list`

List clusters

List clusters.

List clustersExample values, fixed in this page — nothing here reaches a terminal

TasksEach one presets the form for one job

List clusters

ParametersOnly these flags are editable in the form

Cluster

Cluster to list; leave empty for all.
string · positional 0

No headers

Do not print headers.
boolean

--no-headers

Output format

Output format.
string

--output-ojsonyaml

`k3d cluster start`

Start a cluster

Start a stopped cluster.

Start a clusterExample values, fixed in this page — nothing here reaches a terminal

Basic

Cluster*

string

Wait until ready

--wait

TasksEach one presets the form for one job

Start a cluster

clusterwait

ParametersOnly these flags are editable in the form

Cluster

Cluster to start.
string · positional 0

All clusters

Start all clusters.
boolean

--all

Wait until ready

Wait for the servers and load balancer to be ready.
boolean

--wait

Timeout

Maximum waiting time for the wait option.
string

--timeout

`k3d cluster stop`

Stop a cluster

Stop a running cluster.

Stop a clusterExample values, fixed in this page — nothing here reaches a terminal

Basic

Cluster*

string

TasksEach one presets the form for one job

Stop a cluster

cluster

ParametersOnly these flags are editable in the form

Cluster

Cluster to stop.
string · positional 0

All clusters

Stop all clusters.
boolean

--all-a

`k3d cluster delete`

Delete a cluster

Delete a cluster and its containers.

Delete a clusterExample values, fixed in this page — nothing here reaches a terminal

Basic

Cluster*

string

TasksEach one presets the form for one job

Delete a cluster

cluster

ParametersOnly these flags are editable in the form

Cluster

Cluster to delete.
string · positional 0

All clusters

Delete all clusters.
boolean

--all-a

SourcesEvery flag above is checked against these

src

completion

github.com

src

completion

github.com

src

completion

github.com

src

completion

github.com

src

completion

github.com

src

completion

github.com

Before it fills your prompt, Otty checks the installed k3d against its version. A form that does not match your version is not offered.