Skip to content

Docker Functions

⬅ Parent

dumpDockerTestFile

Debugging, dumps the proc1file which is used to figure out

Usage

dumpDockerTestFile

Debugging, dumps the proc1file which is used to figure out if we are insideDocker or not; use this to confirm platform implementation

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

insideDocker

Are we inside a docker container right now?

Usage

insideDocker

Are we inside a docker container right now?

Return Code: 0 - Yes Return Code: 1 - No

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dockerLocalContainer

Run a build container using given docker image.

Usage

dockerLocalContainer [ --help ] [ --handler handler ] [ --image imageName ] [ --path imageApplicationPath ] [ --platform platform ] [ --env-file envFile ] [ --env envVariable=envValue ] [ extraArgs ]

Run a build container using given docker image.

Runs ARM64 by default.

Return Code: 1 - If already inside docker, or the environment file passed is not valid Return Code: 0 - Success Return Code: Any - docker run error code is returned if non-zero

Arguments

  • --help - Optional. Flag. Display this help.
  • --handler handler - Optional. Function. Use this error handler instead of the default error handler.
  • --image imageName - Optional. String. Docker image name to run. Defaults to BUILD_DOCKER_IMAGE.
  • --path imageApplicationPath - Path. Docker image path to map to current directory. Defaults to BUILD_DOCKER_PATH.
  • --platform platform - Optional. String. Platform to run (arm vs intel).
  • --env-file envFile - Optional. File. One or more environment files which are suitable to load for docker; must be valid --env envVariable=- envValue - Optional. File. One or more environment variables to set.
  • extraArgs - Optional. Mixed. The first non-file argument to dockerLocalContainer is passed directly through to docker run as arguments

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Environment

  • BUILD_DOCKER_PLATFORM - String.
  • Optional. Defaults to linux/arm64. Affects which image platform is used.

dockerPlatformDefault

Fetch the default platform for docker

Usage

dockerPlatformDefault

Fetch the default platform for docker Outputs one of: linux/arm64, linux/mips64, linux/amd64

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dockerImages

List docker images which are currently pulled

Usage

dockerImages [ --filter reference ]

List docker images which are currently pulled

Arguments

  • --filter reference - Optional. Filter list by reference provided.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dockerVolumeDelete

Delete a docker volume

Usage

dockerVolumeDelete name

Delete a docker volume

Arguments

  • name - String. Required. Volume name to delete.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dockerVolumeExists

Does a docker volume exist with name?

Usage

dockerVolumeExists name

Does a docker volume exist with name?

Arguments

  • name - String. Required.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dockerListContext

List the files which would be included in the docker

Usage

dockerListContext

List the files which would be included in the docker image

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error