# Functions
AddDockerCredential : Add (or update) a single docker login in the keychain entry.
CheckContainerStatus : check that containers exist with each of the given prefixes.
CheckImageStatus of Codewind installed/uninstalled.
ClearDockerConfigSecret We erase the contents rather than deleting the file as the docker-compose file expects the secret to be present.
DetermineDebugPortForPFE determines a debug port to use for PFE based on the external PFE port.
DockerCompose to set up the Codewind environment.
DockerComposeRemove to remove Codewind images.
DockerComposeStop to stop Codewind containers.
GetClientVersion : returns the docker server version string.
GetCodewindProjectContainers returns a list of containers ([]types.Container) matching "/cw".
GetContainerList from docker.
GetContainerListWithOptions from docker.
GetContainerLogs : returns the container log for the specified container.
GetContainerTags of the Codewind version(s) currently running.
GetFilesFromContainer : returns the tar file stream for the path in the specified container.
GetImageList from docker.
GetImageTags of Codewind images.
GetPFEHostAndPort will return the current hostname and port that PFE is running on.
GetServerVersion : returns the docker server version string.
InspectContainer : returns the result of 'docker inspect' for the specified container.
LoginToRegistry : Log in locally to a docker registry with the supplied credentials.
NewDockerClient creates a new client for the docker API.
PingHealth - pings environment api every 15 seconds to check if containers started.
PullImage - pull pfe/performance images from dockerhub.
RemoveDockerCredential : Remove a single docker login in the keychain entry.
RemoveImage of Codewind and project.
StopContainer will stop only codewind containers.
UsingLocalDockerHost returns true if we are using the default local docker host.
ValidateImageDigest - will ensure the image digest matches that of the one in dockerhub returns imageID, docker error.
WriteToComposeFile the contents of the docker compose yaml.
# Constants
ErrDockerVersion exported for test purposes.
ErrOpContainerError exported for test purposes.
ErrOpContainerInspect exported for test purposes.
ErrOpContainerList exported for test purposes.
ErrOpContainerLogs exported for test purposes.
PerformanceContainerName : name of the Codewind performance container.
PfeContainerName : name of the Codewind PFE container.
# Variables
ErrContainerInspect - exported for testing purposes.
ErrContainerList - exported for testing purposes.
ErrContainerLogs - exported for testing purposes.
ErrCopyFromContainer - exported for testing purposes.
ErrServerVersion - exported for testing purposes.
LocalCWContainerNames : array of all the container names for a locally deployed Codewind.
# Structs
Compose struct for the docker compose yaml file.
No description provided by the author
No description provided by the author
DockerError struct will format the error.
MockDockerClientWithCw - This mock client will return container and images lists, with Codewind items included.
MockDockerErrorClient - This mock client will return errors for each call to a docker function.
# Interfaces
DockerClient requires all the functions called on the docker client.