Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 3.59 KB

MAKE.md

File metadata and controls

88 lines (70 loc) · 3.59 KB
Raw

Makefile guide

The make tasks are structured in layers. This document describes them from top to bottom.

This document assumes knowledge of how the Docker containers are connected. A summary:

There are 5 containers that can be used or created with these tasks:

  • vault: Container "volume" wrapping sensitive data (i.e. SSL certificates).
  • assets: Container "volume" wrapping all static files (js, css, images and nginx config).
  • app: Container "daemon" running the node.js app. Compiles html on request. Mounts the assets volume.
  • proxy: Container "daemon" running nginx. Mounts the vault and the assets volumes.
  • compiler: Container "task" wrapping npm and other tasks. Mounts the local filesystem as it is only used in development.

Variables

  • VERSION — The version of the project. It is used when building Docker images.
  • BASE_PATH — Defines the base path to mount files into containers.
  • VERBOSE — When true it compiles js and css non-minified.
  • LOCAL_FS — When true it mounts local files to the containers.
  • FLUSH_CACHE — When true it skips any cache generated by browserify.
  • CI — When true runs the compile container without self-cleaning

Porcelain tasks

Some porcelain tasks have aliases to make them less boring. The alias are between parenthesis.

Note All porcelain tasks can be found in Makefile.

  • deploy: Removes any container belonging to the project and creates new ones.
  • deploy-production: Same as above with implicit setup for production.
  • deploy-staging: Same as above with implicit setup for staging.
  • init: Creates the project Docker containers.
  • clean: Removes the project Docker containers.
  • build: Builds the node app image and the assets image.
  • push: Pushes the app image and the assets image to the Docker Hub.
  • pull: Pulls the app image and the assets images from the Docker Hub.
  • stats: Lists the stats for all containers.
  • ps: Lists the containers for the specified.
  • ls: Lists the images for the current version.
  • nuke: Removes all images for the given VERSION.
  • release: Creates a tag version from the given VERSION, tags the snapshot image created by CI and pushes to the Docker Hub

Sugar

  • stuff: Compiles assets.
  • css: Compiles CSS.
  • vendors: Compiles vendors.
  • spa: Compiles the Single Page Application.
  • images: Compiles images.

The following are one-time tasks unless dependencies change.

  • compiler-build: Creates the compiler Docker image.
  • vault-load VAULT_PATH=path/to/vault.tar: Loads the vault image. SSL certificates at ./etc/nginx/ssl.

Plumbing tasks

Note All plumbing tasks can be found in the tasks directory under the name of the image/container it operates.

  • {name}-build: Compiles a Docker image. {name} can be app, assets, compiler or vault.
  • {name}-create: Creates a Docker container. {name}can beapp, assets, vaultorproxy`.
  • {name}-rm: Removes a Docker container. {name}can beapp, assets, vaultorproxy`.
  • {name}-push: Pushes a Docker image. {name} can be app, assets or compiler.
  • {name}-pull: Pulls a Docker image. {name} can be app, assets or compiler.
  • {name}-log: Tails the logs for a container. {name} can be app or proxy. This does not work in production as the logs are stored in /var/log/syslog.
  • app-sh: Opens a shell to inspect the app container.
  • assets-compile: Compiles assets.
  • assets-css: Compiles css.
  • assets-css-watch: Compiles css watching for changes.
  • assets-spa: Compiles the react application.
  • assets-vendors: Compiles the react dependencies.