Copyright © 2020-2023 The k3d Author(s) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Copyright © 2020-2023 The k3d Author(s) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

GetDefaultObjectName prefixes the passed name with the default prefix.

GetHelperImageVersion returns the CLI version or 'latest'.

existing k3d node roles.

DefaultAPIHost defines the default host (IP) for the Kubernetes API.

DefaultAPIPort defines the default Kubernetes API Port.

DefaultClusterName specifies the default name used for newly created clusters.

DefaultClusterNameMaxLength specifies the maximal length of a passed in cluster name This restriction allows us to construct an name consisting of <DefaultObjectNamePrefix[3]>-<ClusterName>-<TypeSuffix[5-10]>-<Counter[1-3]> ..

should end up in $XDG_CONFIG_HOME.

Registry Defaults.

DefaultImageVolumeMountPath defines the mount path inside k3d nodes where we will mount the shared image volume by default.

DefaultK3dInternalHostRecord defines the default /etc/hosts entry for the k3d host.

DefaultK3sImageRepo specifies the default image repository for the used k3s image.

DefaultKubeconfigPrefix defines the default prefix for kubeconfig files.

DefaultLBImageRepo defines the default cluster load balancer image.

Default temporary path for the LocalRegistryHosting configmap, from where it will be applied via kubectl.

DefaultNodeWaitForLogMessageCrashLoopBackOffLimit defines the maximum number of retries to find the target log message, if the container is in a crash loop.

DefaultObjectNamePrefix defines the name prefix for every object created by k3d.

Registry Defaults.

DefaultRegistryImageRepo defines the default image used for the k3d-managed registry.

DefaultRegistryImageTag defines the default image tag used for the k3d-managed registry.

Registry Defaults.

Registry Defaults.

Registry Defaults.

DefaultNetwork defines the default (Docker) runtime network.

DefaultToolsImageRepo defines the default image used for the tools container.

Debug options.

k3d config environment variables for options that don't have a place in the config file or CLI.

k3d config environment variables for options that don't have a place in the config file or CLI.

Fixes.

k3d config environment variables for options that don't have a place in the config file or CLI.

k3d config environment variables for options that don't have a place in the config file or CLI.

k3d config environment variables for options that don't have a place in the config file or CLI.

Images.

k3d config environment variables for options that don't have a place in the config file or CLI.

Log config.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

List of k3d technical label name.

all defined lifecyclestages.

all defined lifecyclestages.

existing k3d node roles.

NodeStatusRestarting defines the status string that signals the node container is restarting.

NodeWaitForLogMessageRestartWarnTime is the time after which to warn about a restarting container.

existing k3d node roles.

existing k3d node roles.

existing k3d node roles.

ClusterExternalNodeRoles is a list of roles for nodes that do not belong to a specific cluster.

ClusterInternalNodeRoles is a list of roles for nodes that belong to a cluster.

DefaultNodeEnv defines some default environment variables that should be set on every node.

DefaultRoleCmds maps the node roles to their respective default commands.

DefaultRuntimeLabels specifies a set of labels that will be attached to k3d runtime objects by default.

DefaultRuntimeLabelsVar specifies a set of labels that will be attached to k3d runtime objects by default but are not static (e.g.

DefaultTmpfsMounts specifies tmpfs mounts that are required for all k3d nodes.

DoNotCopyServerFlags defines a list of commands/args that shouldn't be copied from an existing node when adding a similar node to a cluster.

ImportModes defines the loading methods for image loading.

NodeRoles defines the roles available for nodes.

AgentOpts describes some additional agent role specific opts.

Cluster describes a k3d cluster.

ClusterCreateOpts describe a set of options one can set when creating a cluster.

ClusterDeleteOpts describe a set of options one can set when deleting a cluster.

ClusterNetwork describes a network which a cluster is running in.

ClusterStartOpts describe a set of options one can set when (re-)starting a cluster.

ExposureOpts describes settings that the user can set for accessing the Kubernetes API.

ExternalDatastore describes an external datastore used for HA/multi-server clusters.

ImageImportOpts describes a set of options one can set for loading image(s) into cluster(s).

LoadbalancerConfig defines the coarse file structure to configure the k3d-proxy * Example: * ports: * 1234.tcp: * - k3d-k3s-default-server-0 * - k3d-k3s-default-server-1 * 4321.udp: * - k3d-k3s-default-agent-0 * - k3d-k3s-default-agent-1 */.

Node describes a k3d node.

NodeCreateOpts describes a set of options one can set when creating a new node.

NodeDeleteOpts describes a set of options one can set when deleting a node.

NodeHook is an action that is bound to a specifc stage of a node lifecycle.

NodeStartOpts describes a set of options one can set when (re-)starting a node.

NodeState describes the current state of a node.

Registry describes a k3d-managed registry.

RegistryExternal describes a minimal spec for an "external" registry "external" meaning, that it's unrelated to the current cluster e.g.

ServerOpts describes some additional server role specific opts.

NodeHookAction is an interface to implement actions that should trigger at specific points of the node lifecycle.

LoadMode describes how images are loaded into the cluster.

LifecycleStage defines descriptors for specific stages in the lifecycle of a node or cluster object.

Role defines a k3d node role.