k3s

Documentation

Index

• Constants
• func New(id string, opts ...Option) (types.Harness, error)
• type Opt
• type Option
  • func WithAuthFromKeychain(registry string) Option
  • func WithAuthFromStatic(registry, username, password, auth string) Option
  • func WithImage(image string) Option
  • func WithNetworks(networks ...string) Option
  • func WithRegistryMirror(registry string, endpoints ...string) Option
  • func WithSandboxEnv(envs provider.Env) Option
  • func WithSandboxImage(image string) Option
  • func WithSandboxMounts(mounts ...mount.Mount) Option
  • func WithSandboxNetworks(networks ...string) Option
• type RegistryAuthOpt
• type RegistryMirrorOpt
• type RegistryOpt
• type RegistryTlsOpt

Constants

const (
	K3sImage = "cgr.dev/chainguard/k3s:latest"
)

Functions

func New

func New(id string, opts ...Option) (types.Harness, error)

Types

type Opt

type Opt struct {
	Image         string
	Traefik       bool
	Cni           bool
	MetricsServer bool
	Networks      []string

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

	Sandbox provider.DockerRequest
}

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 WithImage

func WithImage(image string) Option

func WithNetworks

func WithNetworks(networks ...string) Option

func WithRegistryMirror

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

func WithSandboxEnv

func WithSandboxEnv(envs provider.Env) Option

func WithSandboxImage

func WithSandboxImage(image string) Option

func WithSandboxMounts

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

func WithSandboxNetworks

func WithSandboxNetworks(networks ...string) Option

type RegistryAuthOpt

type RegistryAuthOpt struct {
	Username string
	Password string
	Auth     string
}

type RegistryMirrorOpt

type RegistryMirrorOpt struct {
	Endpoints []string
}

type RegistryOpt

type RegistryOpt struct {
	Auth *RegistryAuthOpt
	Tls  *RegistryTlsOpt
}

type RegistryTlsOpt

type RegistryTlsOpt struct {
	CertFile string
	KeyFile  string
	CaFile   string
}