k3d

Documentation

Index

• type K3d
  • func (p *K3d) BindCredential() error
  • func (p *K3d) CreateCheck() error
  • func (p *K3d) CreateK3sCluster() (err error)
  • func (p *K3d) DeleteK3sCluster(f bool) (err error)
  • func (p *K3d) DescribeCluster(kubeConfig string) *types.ClusterInfo
  • func (p *K3d) GenerateClusterName() string
  • func (p *K3d) GenerateMasterExtraArgs(_ *types.Cluster, _ types.Node) string
  • func (p *K3d) GenerateWorkerExtraArgs(_ *types.Cluster, _ types.Node) string
  • func (p *K3d) GetCluster(kubeConfig string) *types.ClusterInfo
  • func (p *K3d) GetCreateFlags() []types.Flag
  • func (p *K3d) GetCredentialFlags() []types.Flag
  • func (p *K3d) GetDeleteFlags() []types.Flag
  • func (p *K3d) GetJoinFlags() []types.Flag
  • func (p *K3d) GetOptionFlags() []types.Flag
  • func (p *K3d) GetProviderName() string
  • func (p *K3d) GetProviderOptions(opt []byte) (interface{}, error)
  • func (p *K3d) GetSSHConfig() *types.SSH
  • func (p *K3d) GetSSHFlags() []types.Flag
  • func (p *K3d) GetUsageExample(action string) string
  • func (p *K3d) IsClusterExist() (bool, []string, error)
  • func (p *K3d) JoinCheck() error
  • func (p *K3d) JoinK3sNode() (err error)
  • func (p *K3d) MergeClusterOptions() error
  • func (p *K3d) SSHK3sNode(ip string) error
  • func (p *K3d) SetConfig(config []byte) error
  • func (p *K3d) SetLogLevelAndOutput()
  • func (p *K3d) SetOptions(opt []byte) error

Types

type K3d

type K3d struct {
	*cluster.ProviderBase `json:",inline"`
	typesk3d.Options      `json:",inline"`
}

K3d provider k3d struct.

func (*K3d) BindCredential

func (p *K3d) BindCredential() error

BindCredential bind k3d credential.

func (*K3d) CreateCheck

func (p *K3d) CreateCheck() error

CreateCheck check create command and flags.

func (*K3d) CreateK3sCluster

func (p *K3d) CreateK3sCluster() (err error)

CreateK3sCluster create K3S cluster.

func (*K3d) DeleteK3sCluster

func (p *K3d) DeleteK3sCluster(f bool) (err error)

DeleteK3sCluster delete K3S cluster.

func (*K3d) DescribeCluster

func (p *K3d) DescribeCluster(kubeConfig string) *types.ClusterInfo

DescribeCluster describe cluster info.

func (*K3d) GenerateClusterName

func (p *K3d) GenerateClusterName() string

GenerateClusterName generates and returns cluster name.

func (*K3d) GenerateMasterExtraArgs

func (p *K3d) GenerateMasterExtraArgs(_ *types.Cluster, _ types.Node) string

GenerateMasterExtraArgs generates K3S master extra args.

func (*K3d) GenerateWorkerExtraArgs

func (p *K3d) GenerateWorkerExtraArgs(_ *types.Cluster, _ types.Node) string

GenerateWorkerExtraArgs generates K3S worker extra args.

func (*K3d) GetCluster

func (p *K3d) GetCluster(kubeConfig string) *types.ClusterInfo

GetCluster returns cluster status.

func (*K3d) GetCreateFlags

func (p *K3d) GetCreateFlags() []types.Flag

GetCreateFlags returns k3d create flags.

func (*K3d) GetCredentialFlags

func (p *K3d) GetCredentialFlags() []types.Flag

GetCredentialFlags returns k3d credential flags.

func (*K3d) GetDeleteFlags

func (p *K3d) GetDeleteFlags() []types.Flag

GetDeleteFlags returns k3d delete flags.

func (*K3d) GetJoinFlags

func (p *K3d) GetJoinFlags() []types.Flag

GetJoinFlags returns k3d join flags.

func (*K3d) GetOptionFlags

func (p *K3d) GetOptionFlags() []types.Flag

GetOptionFlags returns k3d option flags.

func (*K3d) GetProviderName

func (p *K3d) GetProviderName() string

GetProviderName returns provider name.

func (*K3d) GetProviderOptions

func (p *K3d) GetProviderOptions(opt []byte) (interface{}, error)

GetProviderOptions get provider options.

func (*K3d) GetSSHConfig

func (p *K3d) GetSSHConfig() *types.SSH

GetSSHConfig returns k3d ssh config.

func (*K3d) GetSSHFlags

func (p *K3d) GetSSHFlags() []types.Flag

GetSSHFlags returns k3d ssh flags.

func (*K3d) GetUsageExample

func (p *K3d) GetUsageExample(action string) string

GetUsageExample returns k3d usage example prompt.

func (*K3d) IsClusterExist

func (p *K3d) IsClusterExist() (bool, []string, error)

IsClusterExist determine if the cluster exists.

func (*K3d) JoinCheck

func (p *K3d) JoinCheck() error

JoinCheck check join command and flags.

func (*K3d) JoinK3sNode

func (p *K3d) JoinK3sNode() (err error)

JoinK3sNode join K3S node.

func (*K3d) MergeClusterOptions

func (p *K3d) MergeClusterOptions() error

MergeClusterOptions merge k3d cluster options.

func (*K3d) SSHK3sNode

func (p *K3d) SSHK3sNode(ip string) error

SSHK3sNode ssh K3s node.

func (*K3d) SetConfig

func (p *K3d) SetConfig(config []byte) error

SetConfig set cluster config.

func (*K3d) SetLogLevelAndOutput

func (p *K3d) SetLogLevelAndOutput()

func (*K3d) SetOptions

func (p *K3d) SetOptions(opt []byte) error

SetOptions set options.