docker

Documentation

Index

• Variables
• func ConnectToSocket() (net.Conn, error)
• func CreateDockerCli(quiet, verifyTLS bool) (command.Cli, error)
• func DeployCompose(ctx context.Context, dockerCli command.Cli, project *types.Project, ...) error
• func GetSocketGroupOwner() (string, error)
• func LoadCompose(ctx context.Context, workingDir, projectName string, composeFiles []string) (*types.Project, error)
• func NewHttpClient() *http.Client
• func VerifySocketConnection(apiVersion string) error
• func VerifySocketRead(httpClient *http.Client, apiVersion string) error

Variables

var (
	ErrDockerSocketConnectionFailed = errors.New("failed to connect to docker socket")
	ErrNoContainerToStart           = errors.New("no container to start")
)

Functions

func ConnectToSocket

func ConnectToSocket() (net.Conn, error)

ConnectToSocket connects to the docker socket

func CreateDockerCli

func CreateDockerCli(quiet, verifyTLS bool) (command.Cli, error)

func DeployCompose

func DeployCompose(ctx context.Context, dockerCli command.Cli, project *types.Project, deployConfig *config.DeployConfig, payload webhook.ParsedPayload) error

DeployCompose deploys a project as specified by the Docker Compose specification (LoadCompose)

func GetSocketGroupOwner

func GetSocketGroupOwner() (string, error)

func LoadCompose

func LoadCompose(ctx context.Context, workingDir, projectName string, composeFiles []string) (*types.Project, error)

LoadCompose parses and loads Compose files as specified by the Docker Compose specification

func NewHttpClient

func NewHttpClient() *http.Client

func VerifySocketConnection

func VerifySocketConnection(apiVersion string) error

VerifySocketConnection verifies whether the application can connect to the docker socket

func VerifySocketRead

func VerifySocketRead(httpClient *http.Client, apiVersion string) error

VerifySocketRead verifies whether the application can read from the docker socket