ACR builder
Build
See Dockerfile
Usage
Required Parameters
--compose-file Docker Compose file to be invoked for build and push
--docker-registry Docker registry to push to. This parameter will populate the ACR_BUILD_DOCKER_REGISTRY reserved environment variable (see Build Environment)
--docker-user Username for the docker registry specified above
--docker-secret Password or token for registry specified above
Conditional or Optional parameters
--git-url Git url to the project. Clone operation will be ignored if --git-clone-to folder exist and is not empty and this parameter will not be requried
--git-clone-to Directory to clone to. If the directory exists, we won't clone again and will just clean and pull the directory. The default value is /checkout
--git-branch The git branch to checkout. If it is not given, no checkout command would be performed
--git-head-revision Desired git HEAD revision, note that providing this parameter will cause the branch parameter to be ignored
--git-oath-user Git OAuth only, Git username
--git-oath-token Git OAuth only, Git personal access token
--local-source Local source directory. Specifying this parameter tells the builder no source control is used and it would use the specified directory as source
--build-number Build number, this argument would set the reserved ACR_BUILD_BUILD_NUMBER build environment. (see Build Environment)
--docker-build-arg Build arguments to be passed to docker build or docker-compose build. This parameter can be specified multiple times.
--build-env Custom environment variables defined for the build process. This parameter can be specified multiple times. (For more details, see Build Environment)
--push Specify if push is required if build is successful
Build Environment
By setting environment variable with parameter --build-env <VAR_NAME>=<VAR_VALUE>, the builder would be aware of the environmental variables throughout the build and the environment will be set for all child processes. ACR builder has a set of reserved environment variables such as ACR_BUILD_BUILD_NUMBER and ACR_BUILD_DOCKER_REGISTRY mentioned in the parameters paragraph. The user will set them by passing in the optional parameters --build-number and --docker-registry and they cannot be override with --build-env
Furthermore, ACR builder also populates the following variables during build so the child process can make use of these values:
// TODO remove ACR prefixes
ACR_BUILD_SOURCE_DIR Source directory on the current build system
ACR_BUILD_DOCKER_COMPOSE_FILE Current docker compose file being used, relative to the source directory
ACR_BUILD_GIT_URL Git URL
ACR_BUILD_GIT_BRANCH Current Git branch
ACR_BUILD_PUSH_IMAGES Indicate whether current build will push on success
// TODO:
BUILD_NUMBER
BUILD_ID
BUILD_TIMESTAMP ISO format
Compose File
In docker-compose.yml, Build image should be prefixed by the reserved environmental variable ACR_BUILD_DOCKER_REGISTRY so they are pushed to the desired registry. You can also use the reserved ACR_BUILD_BUILD_NUMBER to postfix your image or tag
version: '2'
services:
hello:
build: ./hello-builder
image: ${ACR_BUILD_DOCKER_REGISTRY}/hello-builder-1.0-${ACR_BUILD_BUILD_NUMBER}
hello-multistage:
build: ./hello-multistage
image: ${ACR_BUILD_DOCKER_REGISTRY}/hello-multistage:${ACR_BUILD_BUILD_NUMBER}