docker

package

v0.10.0 Latest Latest Go to latest Published: Oct 21, 2021 License: Apache-2.0 Imports: 20 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

Package docker provides the ability for Vela to integrate with Docker as a runtime environment.

Usage:

import "github.com/go-vela/pkg-runtime/runtime/docker"

View Source

const Version = "v1.40"

nolint: godot // ignore comment ending in a list

Version represents the supported Docker API version for the mock.

The Docker API version is pinned to ensure compatibility between the Docker API and client. The goal is to maintain n-1 compatibility.

The maximum supported Docker API version for the client is here:

For example (use the compatibility matrix above for reference):

* the Docker version of v20.10 has a maximum API version of v1.41 * to maintain n-1, the API version is pinned to v1.40

This section is empty.

func New(opts ...ClientOpt) (*client, error)

New returns an Engine implementation that integrates with a Docker runtime.

nolint: golint // ignore returning unexported client

func NewMock(opts ...ClientOpt) (*client, error)

NewMock returns an Engine implementation that integrates with a mock Docker runtime.

This function is intended for running tests only.

nolint: golint // ignore returning unexported client

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the runtime client.

func WithHostVolumes(volumes []string) ClientOpt

WithHostVolumes sets the Docker host volumes in the runtime client.

func WithPrivilegedImages(images []string) ClientOpt

WithPrivilegedImages sets the Docker privileged images in the runtime client.