k3s

Documentation

Index

• Constants
• func New(id string, cli *provider.DockerClient, opts ...Option) (types.Harness, error)
• type Hooks
• type K3sContainerSnapshotter
• type Opt
• type Option
  • func WithAuthFromKeychain(registry string) Option
  • func WithAuthFromStatic(registry, username, password, auth string) Option
  • func WithCniDisabled(disabled bool) Option
  • func WithContainerSnapshotter(snapshotter K3sContainerSnapshotter) Option
  • func WithContainerVolumeName(volumeName string) Option
  • func WithHooks(hooks Hooks) Option
  • func WithHostKubeconfigPath(path string) Option
  • func WithHostPort(port int) Option
  • func WithImageRef(ref name.Reference) Option
  • func WithKubeletConfig(kubeletConfig string) Option
  • func WithMetricsServerDisabled(disabled bool) Option
  • func WithNetworkPolicyDisabled(disabled bool) Option
  • func WithNetworks(networks ...string) Option
  • func WithRegistryMirror(registry string, endpoints ...string) Option
  • func WithResources(req provider.ContainerResourcesRequest) Option
  • func WithSandboxEnv(envs provider.Env) Option
  • func WithSandboxImageRef(ref name.Reference) Option
  • func WithSandboxMounts(mounts ...mount.Mount) Option
  • func WithSandboxNetworks(networks ...string) Option
  • func WithSandboxResources(req provider.ContainerResourcesRequest) Option
  • func WithTraefikDisabled(disabled bool) Option
• type RegistryMirrorOpt
• type RegistryOpt

Constants

const (
	K3sImageTag       = "cgr.dev/chainguard/k3s:latest"
	KubectlImageTag   = "cgr.dev/chainguard/kubectl:latest-dev"
	KubeletConfigPath = "/etc/rancher/k3s/kubelet.yaml"
)

Functions

func New

func New(id string, cli *provider.DockerClient, opts ...Option) (types.Harness, error)

Types

type Hooks

type Hooks struct {
	// PreStart is a list of commands to run after the k3s container successfully
	// starts (the api server is available).
	PostStart []string
}

Hooks are the hooks that can be run at various stages of the k3s lifecycle.

type K3sContainerSnapshotter

type K3sContainerSnapshotter string

const (
	K3sContainerSnapshotterNative    K3sContainerSnapshotter = "native"
	K3sContainerSnapshotterOverlayfs K3sContainerSnapshotter = "overlayfs"
)

type Opt

type Opt struct {
	ImageRef      name.Reference
	Traefik       bool
	Cni           bool
	MetricsServer bool
	NetworkPolicy bool
	Networks      []string
	Resources     provider.ContainerResourcesRequest
	Hooks         Hooks

	// HostPort exposes the clusters apiserver on a given port when set
	HostPort int

	// HostKubeconfigPath writes the clusters kubeconfig to a given path on the
	// host, this is optional and does nothing if not set
	HostKubeconfigPath string

	Registries map[string]*RegistryOpt
	Mirrors    map[string]*RegistryMirrorOpt

	Sandbox             provider.DockerRequest
	ContainerVolumeName string
	Snapshotter         K3sContainerSnapshotter
	KubeletConfig       string
}

type Option

type Option func(*Opt) error

func WithAuthFromKeychain

func WithAuthFromKeychain(registry string) Option

func WithAuthFromStatic

func WithAuthFromStatic(registry, username, password, auth string) Option

func WithCniDisabled

func WithCniDisabled(disabled bool) Option

func WithContainerSnapshotter

func WithContainerSnapshotter(snapshotter K3sContainerSnapshotter) Option

func WithContainerVolumeName

func WithContainerVolumeName(volumeName string) Option

func WithHooks

func WithHooks(hooks Hooks) Option

func WithHostKubeconfigPath

func WithHostKubeconfigPath(path string) Option

func WithHostPort

func WithHostPort(port int) Option

WithHostPort exposes the clusters apiserver on a given port.

func WithImageRef

func WithImageRef(ref name.Reference) Option

func WithKubeletConfig

func WithKubeletConfig(kubeletConfig string) Option

func WithMetricsServerDisabled

func WithMetricsServerDisabled(disabled bool) Option

func WithNetworkPolicyDisabled

func WithNetworkPolicyDisabled(disabled bool) Option

func WithNetworks

func WithNetworks(networks ...string) Option

func WithRegistryMirror

func WithRegistryMirror(registry string, endpoints ...string) Option

func WithResources

func WithResources(req provider.ContainerResourcesRequest) Option

func WithSandboxEnv

func WithSandboxEnv(envs provider.Env) Option

func WithSandboxImageRef

func WithSandboxImageRef(ref name.Reference) Option

func WithSandboxMounts

func WithSandboxMounts(mounts ...mount.Mount) Option

func WithSandboxNetworks

func WithSandboxNetworks(networks ...string) Option

func WithSandboxResources

func WithSandboxResources(req provider.ContainerResourcesRequest) Option

func WithTraefikDisabled

func WithTraefikDisabled(disabled bool) Option

type RegistryMirrorOpt

type RegistryMirrorOpt struct {
	Endpoints []string
}

type RegistryOpt

type RegistryOpt struct {
	Auth *base.RegistryAuthOpt
	Tls  *base.RegistryTlsOpt
}