docker

Documentation

Index

• Variables
• func AS(image string, alias string) string
• func BuildBaseImageArgs() []string
• func BuildImageArgs(dockerFileDir string, imageName string, sourceDir string) []string
• func BuildIntegrationImageArgs(imagePath string, mavenWorkingDirectory string) []string
• func CMD(command string) string
• func CMDShellWrap(command string) string
• func COPY(from string, to string) string
• func ContainerizeDependencyPaths(dependencyPaths []string, newDir string) []string
• func ContainerizeFilePaths(currentFilePaths []string, newDir string) []string
• func CreateBaseImageDockerFile() error
• func CreateIntegrationImageDockerFile(integrationRunCmd *exec.Cmd, startsFromLocalFolder bool) error
• func DockerfilePathArg(dockerfilePath string) []string
• func ENV(envVar string, value string) string
• func ENVAppend(envVar string, value string) string
• func ExtractRegistryName(image string) (string, error)
• func FROM(imageName string) string
• func FullImageArg(dockerImage string) []string
• func GetBaseImagePath() string
• func GetContainerDependenciesDir() string
• func GetContainerPropertiesDir() string
• func GetContainerRoutesDir() string
• func GetContainerWorkspaceDir() string
• func GetFullDockerImage(dockerImageName string, tag string) string
• func GetImage(dockerImageName string, tag string) string
• func GetLatestImage(dockerImageName string) string
• func ImageArg(dockerImageName string, tag string) []string
• func JoinPath(lhsPath string, rhsPath string) string
• func LatestImageArg(dockerImageName string) []string
• func RUN(command string) string
• func RUNMakeDir(dirName string) string
• func RUNMavenInstall() string
• func RunImageArgs(imagePath string) ([]string, error)
• func RunIntegrationImageArgs(imagePath string) ([]string, error)
• func WORKDIR(workDir string) string

Variables

var BaseImageName = "integration-base-image"

BaseImageName -- base image name.

var BaseWorkingDirectory = ""

BaseWorkingDirectory -- directory used by Docker to construct the base image.

var IntegrationWorkingDirectory = ""

IntegrationWorkingDirectory -- directory used by Docker to construct the integration image.

var NetworkName = "host"

NetworkName -- network used by Docker when running the image.

var RegistryName = ""

RegistryName -- the docker registry name.

Functions

func AS

func AS(image string, alias string) string

AS --.

func BuildBaseImageArgs

func BuildBaseImageArgs() []string

BuildBaseImageArgs constructs the docker command:

docker build -f <BaseWorkingDirectory>/Dockerfile -t <dockerRegistry>/<BaseImageName> <BaseWorkingDirectory>.

func BuildImageArgs

func BuildImageArgs(dockerFileDir string, imageName string, sourceDir string) []string

BuildImageArgs - standard docker build arguments.

func BuildIntegrationImageArgs

func BuildIntegrationImageArgs(imagePath string, mavenWorkingDirectory string) []string

BuildIntegrationImageArgs constructs the docker command:

docker build -f <BaseWorkingDirectory>/Dockerfile -t <imagePath> <mavenWorkingDirectory>.

func CMD

func CMD(command string) string

CMD --.

func CMDShellWrap

func CMDShellWrap(command string) string

CMDShellWrap --.

func COPY

func COPY(from string, to string) string

COPY --.

func ContainerizeDependencyPaths

func ContainerizeDependencyPaths(dependencyPaths []string, newDir string) []string

ContainerizeDependencyPaths -- make dependency paths valid given a valid container directory in newDir.

func ContainerizeFilePaths

func ContainerizeFilePaths(currentFilePaths []string, newDir string) []string

ContainerizeFilePaths -- make paths valid container paths given a valid container directory in newDir.

func CreateBaseImageDockerFile

func CreateBaseImageDockerFile() error

CreateBaseImageDockerFile --.

func CreateIntegrationImageDockerFile

func CreateIntegrationImageDockerFile(integrationRunCmd *exec.Cmd, startsFromLocalFolder bool) error

CreateIntegrationImageDockerFile --.

func DockerfilePathArg

func DockerfilePathArg(dockerfilePath string) []string

DockerfilePathArg --.

func ENV

func ENV(envVar string, value string) string

ENV --.

func ENVAppend

func ENVAppend(envVar string, value string) string

ENVAppend --.

func ExtractRegistryName

func ExtractRegistryName(image string) (string, error)

ExtractRegistryName -- Extract registry name from image path.

func FROM

func FROM(imageName string) string

FROM --.

func FullImageArg

func FullImageArg(dockerImage string) []string

FullImageArg --.

func GetBaseImagePath

func GetBaseImagePath() string

GetBaseImagePath returns Docker base image path.

func GetContainerDependenciesDir

func GetContainerDependenciesDir() string

GetContainerDependenciesDir -- directory inside the container where all the integration dependencies are copied.

func GetContainerPropertiesDir

func GetContainerPropertiesDir() string

GetContainerPropertiesDir -- directory inside the container where all the integration property files are copied.

func GetContainerRoutesDir

func GetContainerRoutesDir() string

GetContainerRoutesDir -- directory inside the container where all the integration routes are copied.

func GetContainerWorkspaceDir

func GetContainerWorkspaceDir() string

GetContainerWorkspaceDir -- directory inside the container where all the integration files are copied.

func GetFullDockerImage

func GetFullDockerImage(dockerImageName string, tag string) string

GetFullDockerImage - <docker-registry>/<image-name>:<tag>.

func GetImage

func GetImage(dockerImageName string, tag string) string

GetImage - <image-name>:<tag>.

func GetLatestImage

func GetLatestImage(dockerImageName string) string

GetLatestImage - <image-name>:latest.

func ImageArg

func ImageArg(dockerImageName string, tag string) []string

ImageArg --.

func JoinPath

func JoinPath(lhsPath string, rhsPath string) string

JoinPath -- for container paths.

func LatestImageArg

func LatestImageArg(dockerImageName string) []string

LatestImageArg --.

func RUN

func RUN(command string) string

RUN --.

func RUNMakeDir

func RUNMakeDir(dirName string) string

RUNMakeDir --.

func RUNMavenInstall

func RUNMavenInstall() string

RUNMavenInstall --.

func RunImageArgs

func RunImageArgs(imagePath string) ([]string, error)

RunImageArgs -- standard docker run arguments.

func RunIntegrationImageArgs

func RunIntegrationImageArgs(imagePath string) ([]string, error)

RunIntegrationImageArgs constructs the docker command:

docker run --network=<network-name> --env LAZY_ENV_VAR=value <dockerRegistry>/<ImageName>.

func WORKDIR

func WORKDIR(workDir string) string

WORKDIR --.