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.

ClusterPrep takes care of the steps required before creating/starting the cluster containers.

ClusterPrepNetwork creates a new cluster network, if needed or sets everything up to re-use an existing network.

ClusterRun orchestrates the steps of cluster creation, configuration and starting.

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.

NodeFilterByRoles filters a list of nodes by their roles.

NodeGet returns a node matching the specified node fields.

NodeList returns a list of all existing clusters.

NodeRun creates and starts a node.

NodeStart starts an existing node.

NodeWaitForLogMessage follows the logs of a node container and returns if it finds a specific line in there (or timeout is reached).

RegistryConnectClusters connects an existing registry to one or more clusters.

RegistryConnectNetworks connects an existing registry to one or more networks.

RegistryCreate creates a registry node.

RegistryFromNode transforms a node spec to a registry spec.

RegistryGenerateK3sConfig generates the k3s specific registries.yaml configuration for multiple registries.

RegistryGenerateLocalRegistryHostingConfigMapYAML generates a ConfigMap used to advertise the registries in the cluster.

RegistryGet gets a registry node by name and returns it as a registry object.

RegistryMergeConfig merges a source registry config into an existing dest registry cofnig.

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.

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