docker

Documentation

Index

• Constants
• func TagName(kind ResourceKind) string
• type ConfigEntry
• type ConfigFile
• type Container
  • func (c Container) Name() string
• type GetContainersOptions
• type Image
  • func (i Image) Reference() (oci.Reference, bool)
• type Options
• type Platform
  • func NewPlatform(ctx context.Context, dockerURI string, options *Options) (*Platform, error)
  • func (p *Platform) GetContainers(ctx context.Context, options *GetContainersOptions) ([]Container, error)
  • func (p *Platform) GetImage(ctx context.Context, nameOrID string) (*Image, error)
  • func (p *Platform) GetVersion(ctx context.Context) (string, string, error)
  • func (p *Platform) Graph(ctx context.Context) (*graph.Graph[platform.Node], error)
• type Resource
• type ResourceKind

Constants

const (
	ResourceKindContainer      = "container"
	ResourceKindSwarmTask      = "swarm/task"
	ResourceKindSwarmService   = "swarm/service"
	ResourceKindSwarmNamespace = "swarm/namespace"
	ResourceKindComposeProject = "compose/project"
	ResourceKindComposeService = "compose/service"
)

Functions

func TagName

func TagName(kind ResourceKind) string

Types

type ConfigEntry

type ConfigEntry struct {
	Auth     string `json:"auth,omitempty"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	Email    string `json:"email,omitempty"`
}

type ConfigFile

type ConfigFile struct {
	Auths       map[string]ConfigEntry `json:"auths"`
	HttpHeaders map[string]string      `json:"HttpHeaders,omitempty"`
}

type Container

type Container struct {
	ID      string `json:"Id"`
	Names   []string
	Image   string
	ImageID string
	Labels  map[string]string
}

func (Container) Name

func (c Container) Name() string

type GetContainersOptions

type GetContainersOptions struct {
	All     bool
	Filters map[string][]string
}

type Image

type Image struct {
	ID          string `json:"Id"`
	RepoTags    []string
	RepoDigests []string
}

func (Image) Reference

func (i Image) Reference() (oci.Reference, bool)

type Options

type Options struct {
	IncludeAllContainers bool
}

type Platform

type Platform struct {
	// contains filtered or unexported fields
}

func NewPlatform

func NewPlatform(ctx context.Context, dockerURI string, options *Options) (*Platform, error)

func (*Platform) GetContainers

func (p *Platform) GetContainers(ctx context.Context, options *GetContainersOptions) ([]Container, error)

func (*Platform) GetImage

func (p *Platform) GetImage(ctx context.Context, nameOrID string) (*Image, error)

func (*Platform) GetVersion

func (p *Platform) GetVersion(ctx context.Context) (string, string, error)

func (*Platform) Graph

func (p *Platform) Graph(ctx context.Context) (*graph.Graph[platform.Node], error)

Graph implements platform.Platform. SEE: https://docs.docker.com/reference/api/engine/version/v1.47/

type Resource

type Resource interface {
	platform.Node
	Kind() ResourceKind
	Name() string
	String() string
}

type ResourceKind

type ResourceKind string