docker

Documentation

Overview

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

Usage:

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

Index

• Constants
• func New(opts ...ClientOpt) (*client, error)
• func NewMock(opts ...ClientOpt) (*client, error)
• type ClientOpt
  • func WithHostVolumes(volumes []string) ClientOpt
  • func WithLogger(logger *logrus.Entry) ClientOpt
  • func WithPrivilegedImages(images []string) ClientOpt

Constants

const Version = "v1.40"

nolint: godot // ignore period at end for 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:

https://docs.docker.com/engine/api/#api-version-matrix

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

Functions

func New

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

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

nolint: revive // ignore returning unexported client

func NewMock

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: revive // ignore returning unexported client

Types

type ClientOpt

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the runtime client for Docker.

func WithHostVolumes

func WithHostVolumes(volumes []string) ClientOpt

WithHostVolumes sets the host volumes in the runtime client for Docker.

func WithLogger

func WithLogger(logger *logrus.Entry) ClientOpt

WithLogger sets the logger in the runtime client for Docker.

func WithPrivilegedImages

func WithPrivilegedImages(images []string) ClientOpt

WithPrivilegedImages sets the privileged images in the runtime client for Docker.