Docker Compose Makefile Save

Makefile template for docker-compose

Project README

Docker compose makefile

Build Status Release Commits since last release Github All Releases GitHub issues GitHub pull requests license GitHub stars

Template and lib for docker-compose

INSTALLATION

INSTALLATION

To install mk-lib run command

curl -sL https://git.io/vh4Gn | sh

UPGRADE

To upgrade existing mk-lib run command

make mk-upgrade

USAGE

Screen

Common (see samples)

  • make console - open container's console

From Makefile.minimal.mk (see samples)

  • make start - start all containers
  • make start c=hello - start container hello
  • make stop - stop all containers
  • make status - show list of containers with statuses
  • make logs - show logs
  • make clean - clean all data

From this library

  • make help - show help (see above)
  • make mk-upgrade - check for updates of mk-lib
  • make mk-version - show current version of mk-lib

VARIABLES

  • ROOT_DIR - full path to dir with Makefile
  • MK_DIR - fill path to .mk-lib dir
  • DOCKER_COMPOSE - docker-compose executable command
  • DOCKER_COMPOSE_FILE - docker-compose.yml file

SAMPLES

Basic commands (you can copy and paste it into your Makefile)

up: ## Start all or c=<name> containers in foreground
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up $(c)

start: ## Start all or c=<name> containers in background
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up -d $(c)

stop: ## Stop all or c=<name> containers
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) stop $(c)

status: ## Show status of containers
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) ps

restart: ## Restart all or c=<name> containers
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) stop $(c)
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up $(c) -d

logs: ## Show logs for all or c=<name> containers
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) logs --tail=100 -f $(c)

clean: confirm ## Clean all data
	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) down

You may see samples here

CUSTOMIZATION

You can create .make.env file in directory with Makefile or current directory

Available variables

  • DOCKER_COMPOSE = {docker-compose executable command}
  • DOCKER_COMPOSE_FILE = {custom docker-compose.yml file}

TO-DO

  • check dependencies
  • update readme

CHANGELOG

See CHANGELOG

LICENSE

MIT (see LICENSE)

AUTHOR

Roman Kudlay ([email protected])

Open Source Agenda is not affiliated with "Docker Compose Makefile" Project. README Source: krom/docker-compose-makefile
Stars
85
Open Issues
0
Last Commit
4 months ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating