docker

Documentation

Overview

Package docker provides utility functions for checking the Docker environment. It also provides two implementations of the NodeService interface defined in the privatebtc package.

Index

• Constants
• func CheckImageExistsInLocalCache(ctx context.Context, dockerClient *client.Client, imageName string) error
• func GetDockerHost() (string, error)
• func NewClient() (*client.Client, error)
• func PullImage(ctx context.Context, dockerClient *client.Client, imageName string) error
• type ImageNotFoundError
  • func (e *ImageNotFoundError) Error() string
  • func (e *ImageNotFoundError) Is(target error) bool

Constants

const BitcoinImage = "ruimarinho/bitcoin-core:latest"

BitcoinImage is the name of the docker Image used for the bitcoin node.

Functions

func CheckImageExistsInLocalCache

func CheckImageExistsInLocalCache(
	ctx context.Context,
	dockerClient *client.Client,
	imageName string,
) error

CheckImageExistsInLocalCache returns whether the given docker Image exists in the local Image cache.

func GetDockerHost

func GetDockerHost() (string, error)

GetDockerHost returns the actual docker host from different alternatives. Windows is not supported.

func NewClient

func NewClient() (*client.Client, error)

NewClient returns a new docker client.

func PullImage

func PullImage(
	ctx context.Context,
	dockerClient *client.Client,
	imageName string,
) error

PullImage pulls the docker Image with the given name.

Types

type ImageNotFoundError

type ImageNotFoundError struct {
	Image string
}

ImageNotFoundError is used to whenever the ruimarinho/bitcoin-core docker Image is not found in the local Image cache.

func (*ImageNotFoundError) Error

func (e *ImageNotFoundError) Error() string

func (*ImageNotFoundError) Is

func (e *ImageNotFoundError) Is(target error) bool

Is implements errors.Is.