docker

Documentation

Overview

package docker provides an implementation of github.com/frantjc/forge.ContainerRuntime by interacting with a Docker daemon via a *github.com/docker/docker/client.Client.

Index

• type Container
  • func (c *Container) CopyFrom(ctx context.Context, source string) (io.ReadCloser, error)
  • func (c *Container) CopyTo(ctx context.Context, destination string, content io.Reader) error
  • func (c *Container) Exec(ctx context.Context, containerConfig *forge.ContainerConfig, ...) (int, error)
  • func (c *Container) GetID() string
  • func (c *Container) GoString() string
  • func (c *Container) Kill(ctx context.Context) error
  • func (c *Container) Remove(ctx context.Context) error
  • func (c *Container) Restart(ctx context.Context) error
  • func (c *Container) Run(ctx context.Context, streams *forge.Streams) (int, error)
  • func (c *Container) Start(ctx context.Context) error
  • func (c *Container) Stop(ctx context.Context) error
• type ContainerRuntime
  • func New(c *client.Client, dindPath string) *ContainerRuntime
  • func (d *ContainerRuntime) BuildDockerfile(ctx context.Context, dockerfile, reference string) (forge.Image, error)
  • func (d *ContainerRuntime) CreateContainer(ctx context.Context, image forge.Image, config *forge.ContainerConfig) (forge.Container, error)
  • func (d *ContainerRuntime) GetContainer(ctx context.Context, id string) (forge.Container, error)
  • func (d *ContainerRuntime) GoString() string
  • func (d *ContainerRuntime) PullImage(ctx context.Context, reference string) (forge.Image, error)
• type Image
  • func (i *Image) Blob() io.Reader
  • func (i *Image) Config() (*imagespecsv1.ImageConfig, error)
  • func (i *Image) Digest() (digest.Digest, error)
  • func (i *Image) GoString() string
  • func (i *Image) Manifest() (manifest *imagespecsv1.Manifest, _ error)
  • func (i *Image) MarshalJSON() ([]byte, error)

Types

type Container

type Container struct {
	ID string
	*client.Client
}

func (*Container) CopyFrom

func (c *Container) CopyFrom(ctx context.Context, source string) (io.ReadCloser, error)

func (*Container) CopyTo

func (c *Container) CopyTo(ctx context.Context, destination string, content io.Reader) error

func (*Container) Exec

func (c *Container) Exec(ctx context.Context, containerConfig *forge.ContainerConfig, streams *forge.Streams) (int, error)

func (*Container) GetID

func (c *Container) GetID() string

func (*Container) GoString

func (c *Container) GoString() string

func (*Container) Kill

func (c *Container) Kill(ctx context.Context) error

func (*Container) Remove

func (c *Container) Remove(ctx context.Context) error

func (*Container) Restart

func (c *Container) Restart(ctx context.Context) error

func (*Container) Run

func (c *Container) Run(ctx context.Context, streams *forge.Streams) (int, error)

func (*Container) Start

func (c *Container) Start(ctx context.Context) error

func (*Container) Stop

func (c *Container) Stop(ctx context.Context) error

type ContainerRuntime

type ContainerRuntime struct {
	// Client interacts with a Docker daemon.
	*client.Client
	// DockerInDockerPath signals whether or not to mount the docker.sock of the
	// *github.com/docker/docker/client.Client and configuration to direct
	// `docker` to it into each container that it runs.
	DockerInDockerPath string
}

ContainerRuntime implements github.com/frantjc/forge.ContainerRuntime.

func New

func New(c *client.Client, dindPath string) *ContainerRuntime

func (*ContainerRuntime) BuildDockerfile

func (d *ContainerRuntime) BuildDockerfile(ctx context.Context, dockerfile, reference string) (forge.Image, error)

func (*ContainerRuntime) CreateContainer

func (d *ContainerRuntime) CreateContainer(ctx context.Context, image forge.Image, config *forge.ContainerConfig) (forge.Container, error)

func (*ContainerRuntime) GetContainer

func (d *ContainerRuntime) GetContainer(ctx context.Context, id string) (forge.Container, error)

func (*ContainerRuntime) GoString

func (d *ContainerRuntime) GoString() string

func (*ContainerRuntime) PullImage

func (d *ContainerRuntime) PullImage(ctx context.Context, reference string) (forge.Image, error)

type Image

type Image struct {
	v1.Image
	name.Reference
}

func (*Image) Blob

func (i *Image) Blob() io.Reader

func (*Image) Config

func (i *Image) Config() (*imagespecsv1.ImageConfig, error)

func (*Image) Digest

func (i *Image) Digest() (digest.Digest, error)

func (*Image) GoString

func (i *Image) GoString() string

func (*Image) Manifest

func (i *Image) Manifest() (manifest *imagespecsv1.Manifest, _ error)

func (*Image) MarshalJSON

func (i *Image) MarshalJSON() ([]byte, error)