docker

package

v0.14.0 Latest Latest Go to latest Published: Mar 17, 2024 License: MIT Imports: 33 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/frantjc/forge

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Container
type ContainerRuntime
- func New(c *client.Client) *ContainerRuntime
type Image
type Volume

Constants ¶

View Source

const VolumeDriver = "local"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.Client
}

func New ¶

func New(c *client.Client) *ContainerRuntime

func (*ContainerRuntime) BuildDockerfile ¶

func (d *ContainerRuntime) BuildDockerfile(ctx context.Context, dir, 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) CreateVolume ¶

func (r *ContainerRuntime) CreateVolume(ctx context.Context, name string) (forge.Volume, error)

func (*ContainerRuntime) GetContainer ¶

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

func (*ContainerRuntime) GoString ¶

func (f *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)

type Volume ¶

type Volume struct {
	ID string
	*client.Client
}

func (*Volume) GetID ¶

func (v *Volume) GetID() string

func (*Volume) GoString ¶

func (v *Volume) GoString() string

func (*Volume) Remove ¶

func (v *Volume) Remove(ctx context.Context) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL