run

Documentation

Index

• func CheckClusterName(name string) error
• func CheckTools(c *cli.Context) error
• func CreateCluster(c *cli.Context) error
• func DeleteCluster(c *cli.Context) error
• func GenerateRandomString(n int) string
• func GetAllContainerNames(clusterName string, serverCount, workerCount int) []string
• func GetContainerName(role, clusterName string, postfix int) string
• func GetKubeConfig(c *cli.Context) error
• func ImportImage(c *cli.Context) error
• func ListClusters(c *cli.Context) error
• func MergePortSpecs(nodeToPortSpecMap map[string][]string, role, name string) ([]string, error)
• func Shell(c *cli.Context) error
• func StartCluster(c *cli.Context) error
• func StopCluster(c *cli.Context) error
• func ValidateHostname(name string) error
• type ClusterSpec
• type PublishedPorts
  • func CreatePublishedPorts(specs []string) (*PublishedPorts, error)
  • func (p *PublishedPorts) AddPort(portSpec string) (*PublishedPorts, error)
  • func (p PublishedPorts) Offset(offset int) *PublishedPorts

Functions

func CheckClusterName

func CheckClusterName(name string) error

CheckClusterName ensures that a cluster name is also a valid host name according to RFC 1123. We further restrict the length of the cluster name to maximum 'clusterNameMaxSize' so that we can construct the host names based on the cluster name, and still stay within the 64 characters limit.

func CheckTools

func CheckTools(c *cli.Context) error

CheckTools checks if the docker API server is responding

func CreateCluster

func CreateCluster(c *cli.Context) error

CreateCluster creates a new single-node cluster container and initializes the cluster directory

func DeleteCluster

func DeleteCluster(c *cli.Context) error

DeleteCluster removes the containers belonging to a cluster and its local directory

func GenerateRandomString

func GenerateRandomString(n int) string

GenerateRandomString thanks to https://stackoverflow.com/a/31832326/6450189 GenerateRandomString is used to generate a random string that is used as a cluster secret

func GetAllContainerNames

func GetAllContainerNames(clusterName string, serverCount, workerCount int) []string

GetAllContainerNames returns a list of all containernames that will be created

func GetContainerName

func GetContainerName(role, clusterName string, postfix int) string

GetContainerName generates the container names

func GetKubeConfig

func GetKubeConfig(c *cli.Context) error

GetKubeConfig grabs the kubeconfig from the running cluster and prints the path to stdout

func ImportImage

func ImportImage(c *cli.Context) error

ImportImage saves an image locally and imports it into the k3d containers

func ListClusters

func ListClusters(c *cli.Context) error

ListClusters prints a list of created clusters

func MergePortSpecs

func MergePortSpecs(nodeToPortSpecMap map[string][]string, role, name string) ([]string, error)

MergePortSpecs merges published ports for a given node

func Shell

func Shell(c *cli.Context) error

Shell starts a new subshell with the KUBECONFIG pointing to the selected cluster

func StartCluster

func StartCluster(c *cli.Context) error

StartCluster starts a stopped cluster container

func StopCluster

func StopCluster(c *cli.Context) error

StopCluster stops a running cluster container (restartable)

func ValidateHostname

func ValidateHostname(name string) error

ValidateHostname ensures that a cluster name is also a valid host name according to RFC 1123.

Types

type ClusterSpec

type ClusterSpec struct {
	AgentArgs         []string
	APIPort           apiPort
	AutoRestart       bool
	ClusterName       string
	Env               []string
	Image             string
	NodeToPortSpecMap map[string][]string
	PortAutoOffset    int
	ServerArgs        []string
	Verbose           bool
	Volumes           []string
}

type PublishedPorts

type PublishedPorts struct {
	ExposedPorts map[nat.Port]struct{}
	PortBindings map[nat.Port][]nat.PortBinding
}

PublishedPorts is a struct used for exposing container ports on the host system

func CreatePublishedPorts

func CreatePublishedPorts(specs []string) (*PublishedPorts, error)

CreatePublishedPorts is the factory function for PublishedPorts

func (*PublishedPorts) AddPort

func (p *PublishedPorts) AddPort(portSpec string) (*PublishedPorts, error)

AddPort creates a new PublishedPort struct with one more port, based on 'portSpec'

func (PublishedPorts) Offset

func (p PublishedPorts) Offset(offset int) *PublishedPorts

Offset creates a new PublishedPort structure, with all host ports are changed by a fixed 'offset'