docker

Documentation

Index

• Constants
• func New(id string, cli *provider.DockerClient, opts ...Option) (types.Harness, error)
• type HarnessDockerOptions
• type Option
  • func WithAuthFromKeychain(registry string) Option
  • func WithAuthFromStatic(registry, username, password, auth string) Option
  • func WithConfigVolumeName(configVolumeName string) Option
  • func WithContainerResources(request provider.ContainerResourcesRequest) Option
  • func WithEnvs(env ...provider.Env) Option
  • func WithHostSocketPath(socketPath string) Option
  • func WithImageRef(ref name.Reference) Option
  • func WithManagedVolumes(volumes ...container.ConfigMount) Option
  • func WithMounts(mounts ...container.ConfigMount) Option
  • func WithNetworks(networks ...string) Option
• type RegistryOpt

Constants

const DefaultDockerSocketPath = "/var/run/docker.sock"

Functions

func New

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

Types

type HarnessDockerOptions

type HarnessDockerOptions struct {
	ImageRef           name.Reference
	ManagedVolumes     []container.ConfigMount
	Networks           []string
	Mounts             []container.ConfigMount
	HostSocketPath     string
	Envs               provider.Env
	Registries         map[string]*RegistryOpt
	ConfigVolumeName   string
	ContainerResources provider.ContainerResourcesRequest
}

type Option

type Option func(*HarnessDockerOptions) error

func WithAuthFromKeychain

func WithAuthFromKeychain(registry string) Option

func WithAuthFromStatic

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

func WithConfigVolumeName

func WithConfigVolumeName(configVolumeName string) Option

func WithContainerResources

func WithContainerResources(request provider.ContainerResourcesRequest) Option

func WithEnvs

func WithEnvs(env ...provider.Env) Option

func WithHostSocketPath

func WithHostSocketPath(socketPath string) Option

func WithImageRef

func WithImageRef(ref name.Reference) Option

func WithManagedVolumes

func WithManagedVolumes(volumes ...container.ConfigMount) Option

func WithMounts

func WithMounts(mounts ...container.ConfigMount) Option

func WithNetworks

func WithNetworks(networks ...string) Option

type RegistryOpt

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