driver

Documentation

Index

• Variables
• func Boot(ctx, clientContext context.Context, d *DriverHandle, pw progress.Writer) (*client.Client, error)
• func Register(f Factory)
• type Auth
• type BuildkitConfig
• type Driver
• type DriverHandle
  • func GetDriver(ctx context.Context, name string, f Factory, endpointAddr string, ...) (*DriverHandle, error)
  • func (d *DriverHandle) Client(ctx context.Context) (*client.Client, error)
  • func (d *DriverHandle) HistoryAPISupported(ctx context.Context) bool
• type Factory
  • func GetDefaultFactory(ctx context.Context, ep string, c dockerclient.APIClient, ...) (Factory, error)
  • func GetFactories(instanceRequired bool) []Factory
  • func GetFactory(name string, instanceRequired bool) (Factory, error)
• type Feature
• type Info
• type InitConfig
• type KubeClientConfig
• type KubeClientConfigInCluster
  • func (k KubeClientConfigInCluster) ClientConfig() (*rest.Config, error)
  • func (k KubeClientConfigInCluster) Namespace() (string, bool, error)
• type Status
  • func (s Status) String() string

Variables

var ErrNotConnecting = errors.Errorf("driver not connecting")

var ErrNotRunning = errors.Errorf("driver not running")

Functions

func Boot

func Boot(ctx, clientContext context.Context, d *DriverHandle, pw progress.Writer) (*client.Client, error)

func Register

func Register(f Factory)

Types

type Auth

type Auth interface {
	GetAuthConfig(registryHostname string) (clitypes.AuthConfig, error)
}

type BuildkitConfig

type BuildkitConfig struct {
}

type Driver

type Driver interface {
	Factory() Factory
	Bootstrap(context.Context, progress.Logger) error
	Info(context.Context) (*Info, error)
	Version(context.Context) (string, error)
	Stop(ctx context.Context, force bool) error
	Rm(ctx context.Context, force, rmVolume, rmDaemon bool) error
	Client(ctx context.Context) (*client.Client, error)
	Features(ctx context.Context) map[Feature]bool
	HostGatewayIP(ctx context.Context) (net.IP, error)
	IsMobyDriver() bool
	Config() InitConfig
}

type DriverHandle

type DriverHandle struct {
	Driver
	// contains filtered or unexported fields
}

func GetDriver

func GetDriver(ctx context.Context, name string, f Factory, endpointAddr string, api dockerclient.APIClient, auth Auth, kcc KubeClientConfig, flags []string, files map[string][]byte, do map[string]string, platforms []specs.Platform, contextPathHash string, dialMeta map[string][]string) (*DriverHandle, error)

func (*DriverHandle) Client

func (d *DriverHandle) Client(ctx context.Context) (*client.Client, error)

func (*DriverHandle) HistoryAPISupported

func (d *DriverHandle) HistoryAPISupported(ctx context.Context) bool

type Factory

type Factory interface {
	Name() string
	Usage() string
	Priority(ctx context.Context, endpoint string, api dockerclient.APIClient, dialMeta map[string][]string) int
	New(ctx context.Context, cfg InitConfig) (Driver, error)
	AllowsInstances() bool
}

func GetDefaultFactory

func GetDefaultFactory(ctx context.Context, ep string, c dockerclient.APIClient, instanceRequired bool, dialMeta map[string][]string) (Factory, error)

func GetFactories

func GetFactories(instanceRequired bool) []Factory

func GetFactory

func GetFactory(name string, instanceRequired bool) (Factory, error)

type Feature

type Feature string

const CacheExport Feature = "Cache export"

const DockerExporter Feature = "Docker exporter"

const MultiPlatform Feature = "Multi-platform build"

const OCIExporter Feature = "OCI exporter"

type Info

type Info struct {
	Status Status
	// DynamicNodes must be empty if the actual nodes are statically listed in the store
	DynamicNodes []store.Node
}

type InitConfig

type InitConfig struct {
	// This object needs updates to be generic for different drivers
	Name             string
	EndpointAddr     string
	DockerAPI        dockerclient.APIClient
	KubeClientConfig KubeClientConfig
	BuildkitFlags    []string
	Files            map[string][]byte
	DriverOpts       map[string]string
	Auth             Auth
	Platforms        []specs.Platform
	ContextPathHash  string // can be used for determining pods in the driver instance
	DialMeta         map[string][]string
}

type KubeClientConfig

type KubeClientConfig interface {
	ClientConfig() (*rest.Config, error)
	Namespace() (string, bool, error)
}

type KubeClientConfigInCluster

type KubeClientConfigInCluster struct{}

func (KubeClientConfigInCluster) ClientConfig

func (k KubeClientConfigInCluster) ClientConfig() (*rest.Config, error)

func (KubeClientConfigInCluster) Namespace

func (k KubeClientConfigInCluster) Namespace() (string, bool, error)

type Status

type Status int

const (
	Inactive Status = iota
	Starting
	Running
	Stopping
	Stopped
)

func (Status) String

func (s Status) String() string