Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 3.81 KB

README.md

File metadata and controls

88 lines (68 loc) · 3.81 KB
Raw

docker-make

This repository contains a set of shell scripts and GNU Makefiles to drive a simple docker build workflow with a local docker-compose based development environment and the ability to push containers to a remote Docker registry (in this implementation, ECR and Heroku).

Configuration goes in mk/Makefile.cfg. Local changes and overrides that don't belong in the repository can be placed in mk/Makefile.cfg.local.

Dependencies

  1. Some targets assume that jq is available

Make targets

  • all - do it all; recursively if necessary
  • build - invoke build process (but not, e.g. pushing of packages)
  • check - recursively calls check for language-specific modules, which check availability of necessary build tools and versions
  • clean - clean up after ourselves; not as aggressive as nuke
  • nuke - nuke it from orbit; it is the only way to be sure
  • depend - generate dependencies
  • docker_bootstrap_init
  • docker_build - run the docker build process
  • docker_build_force(_*) - override deps and JFDI
  • docker_cleanup - more than clean; less than nuke -- everything but volumes
  • docker_compile - compile dockerb templates into Dockerfiles in build directory
  • docker_images - list local images in the current ${DOCKER_NS}
  • docker_labels - list labels on current default image; override to alternate image with C=
  • docker_login - log in to configured remote docker registry
  • docker_logout - log out of configured remote docker registry
  • docker_tag(_*) - tag docker named docker image (or all)
  • docker_nuke(_*) - nuke named docker image (or all)
  • docker_rebuild(_*) - force re-build of named docker image (or all)
  • docker_remote_list - directly query remote registry for images
  • docker_remote_push(_*) - push images marked as "remote" to registry
  • docker_remote_tag(_*) - push tags for "remote" images to registry

Make variables

The docker-make infrastructure is configured by setting a number of make variables and then including an appropriate subset of the makefiles in the mk directory. It then in turn defines a number of make and environment variables that you can use to further customize the build.

Docker-make expects you to define at least the following variables. Refer to docker/Makefile for a working example.

  • ROOT - points to the root of the repo; for instance ROOT=$(abspath ${CURDIR}/..). By convention defined at the top of a makefile that depends on docker-make. Exported to the environment as BUILD_ROOT.

  • REL_ROOT - Make variable defined by the infrastructure to be the relative path from the current directory to ROOT. Do not override. Exported to the environment as BUILD_RELROOT.

  • REL_CURDIR - Make variable defined by the infrastructure to be the relative path from the ROOT to the current directory. Do not override.

  • SUBDIR - optional variable that lists the sub-directories for recursive make.

  • BUILD_SERVICE - defined at the top of a makefile to specify the service to be built. Used only if building multiple services from the same repository. NOTE: not merely for use to build multiple containers in a single repo, but rather for multiple parallel logical repos in a large monorepo, each using docker-make.

  • ROOT_SERVICE - relative path from repository root to the directory holding service sub-repos in a monorepo; may be empty.

Using git subtree to merge into other projects

Instead of manually tracking this repository, if you have few/no changes to the core functionality, you can use git subtree to merge it into your repository. One way to do so is to check out a copy of this repo and run:

docker-make$ git subtree split --prefix=mk --annotate="[mk] " -b mk

Then in your repository, assuming it is in a parallel directory, repo:

repo$ git subtree add --prefix=mk --squash ../docker-make mk