package
3.4.0
Repository: https://github.com/rancher/k3d.git
Documentation: pkg.go.dev

# Functions

CheckName ensures that a cluster name is also a valid host name according to RFC 1123.
ClusterCreate creates a new cluster consisting of - some containerized k3s nodes - a docker network.
ClusterDelete deletes an existing cluster.
ClusterGet returns an existing cluster with all fields and node lists populated.
ClusterList returns a list of all existing clusters.
ClusterStart starts a whole cluster (i.e.
ClusterStop stops a whole cluster (i.e.
GenerateClusterToken generates a random 20 character string.
GetHostIP returns the routable IP address to be able to access services running on the host system from inside the cluster.
KubeconfigGet grabs the kubeconfig file from /output from a server node container, modifies it by updating some fields with cluster-specific information and returns a Config object for further processing.
KubeconfigGetDefaultFile loads the default KubeConfig file.
KubeconfigGetDefaultPath returns the path of the default kubeconfig, but errors if the KUBECONFIG env var specifies more than one file.
KubeconfigGetWrite ..
KubeconfigMerge merges a new kubeconfig into an existing kubeconfig and returns the result.
KubeconfigRemoveCluster removes a cluster's details from a given kubeconfig.
KubeconfigRemoveClusterFromDefaultConfig removes a cluster's details from the default kubeconfig.
KubeconfigWrite writes a kubeconfig to a path atomically.
KubeconfigWriteToPath takes a kubeconfig and writes it to some path, which can be '-' for os.Stdout.
NodeAddToCluster adds a node to an existing cluster.
NodeAddToClusterMulti adds multiple nodes to a chosen cluster.
NodeCreate creates a new containerized k3s node.
NodeCreateMulti creates a list of nodes.
NodeDelete deletes an existing node.
NodeGet returns a node matching the specified node fields.
NodeList returns a list of all existing clusters.
NodeWaitForLogMessage follows the logs of a node container and returns if it finds a specific line in there (or timeout is reached).
SortClusters : in place sort cluster list by cluster name alphabetical order.
UpdateLoadbalancerConfig updates the loadbalancer config with an updated list of servers belonging to that cluster.
ValidateHostname ensures that a cluster name is also a valid host name according to RFC 1123.

# Variables

No description provided by the author

# Structs

WriteKubeConfigOptions provide a set of options for writing a KubeConfig file.