latest--schema

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/k3d-yaml/_shared/latest--schema.json
Parent schema k3d-yaml
Type: object

Properties

apiVersion string required
Default: "k3d.io/v1alpha4"
Values: "k3d.io/v1alpha4"
kind string required
Default: "Simple"
Values: "Simple"
metadata object
1 nested properties
name string

Name of the cluster (must be a valid hostname and will be prefixed with 'k3d-'). Example: 'mycluster'.

format=hostname
servers number
min=1
agents number
min=0
kubeAPI object
3 nested properties
host string
format=hostname
hostIP string
Examples: "0.0.0.0", "192.168.178.55"
format=ipv4
hostPort string
Examples: "6443"
image string
Examples: "rancher/k3s:latest"
network string
subnet string
Default: "auto"
Examples: "172.28.0.0/16", "192.162.0.0/16"
token string
volumes object[]
ports object[]
options object
4 nested properties
k3d object
6 nested properties
wait boolean
Default: true
timeout
Examples: "60s", "1m", "1m30s"
disableLoadbalancer boolean
Default: false
disableImageVolume boolean
Default: false
disableRollback boolean
Default: false
loadbalancer object
1 nested properties
configOverrides array
Examples: "settings.workerConnections=2048", "settings.defaultProxyTimeout=900"
k3s object
2 nested properties
extraArgs object[]
nodeLabels object[]
kubeconfig object
2 nested properties
updateDefaultKubeconfig boolean
Default: true
switchCurrentContext boolean
Default: true
runtime object
5 nested properties
gpuRequest string
serversMemory string
agentsMemory string
hostPidMode boolean
Default: false
labels object[]
env object[]
registries object
4 nested properties
create object

Create a new container image registry alongside the cluster.

6 nested properties
name string
Examples: "myregistry", "registry.localhost"
host string
Default: "0.0.0.0"
Examples: "0.0.0.0", "localhost", "127.0.0.1"
hostPort string
Default: "random"
Examples: "5000", "2345"
image string
Default: "docker.io/library/registry:2"
Examples: "myregistry/registry:2"
proxy object
3 nested properties
remoteURL string
Examples: "https://registry-1.docker.io"
username string
password string
volumes string[]
Examples: "/tmp/registry:/var/lib/registry"
use string[]

Connect another container image registry to the cluster.

Examples: "otherregistry:5000"
config string

Reference a K3s registry configuration file or at it's contents here.

additionalProperties
hostAliases object[]

Additional IP to multiple hostnames mappings

Definitions

nodeFilters string[]
Examples:
  • "loadbalancer"
  • "server:*"
  • "server:0"
  • "agent:1"
  • "all"