dockerw — a docker-compose Wrapper

A "simple" drop-in container wrapper that requires all of your configuration

index

• Notice
• Prerequisites
• How to get started
  • Standalone (preferred)
    • How does git work again?
    • Why UNIX only?
  • In-project or local
• Creating containers
• Contributions

Notice

This repository requires a lot of configuration on your part. This is to be expected, seeing how docker also requires lots of configuration and I didn't want to limit my efforts to a single project. I would advise against using this repository when you're trying to set up a single local docker environment (see lando or devilbox). However, when you're like me and manage lots of projects this might just be the tool you need.

Prerequisites

Install docker via the official docs
Install docker-compose as a python package

How to get started

Standalone (preferred)

Get yourself a UNIX system that runs a semi up-to-date version of bash as of writing this (2020) and clone the repository

$ git clone [email protected]:cytodev/docker-compose-wrapper.git

cd into the directory and install the scripts

elevated permissions might be required for the next few steps

$ cd docker-compose-wrapper
$ make install
$ cd ../
$ rm -rf docker-compose-wrapper

Now you're free to use the dockerw command just like you're used to using the git command.

How does git work again?

Simple, type git init to start your project -- this translates to dockerw init to start a local container cluster.

Why UNIX only?

Because of the directory structure and installation process. I haven't used any other OS on a serious level since ever, so I will leave integration to the contributors -- they will know what to do.

in-project or local

Probably preferred on NT (MS Windows) machines or restricted UNIX systems

$ cd <your_development_directory>
$ git clone [email protected]:cytodev/docker-compose-wrapper.git .dockerw
$ cd .dockerw
#[ you might want to stick to the version you installed ]#######################
#[ if not, you can skip the next line ]#########################################
$ git remote rm origin
#[ these next steps are for easy access, but not required ]#####################
$ cd ../
$ ln -s ./.dockerw/dockerw

Please note that you can only use the dockerw command in this directory and only by specifying that you want to execute this command via the ./<file>. (mileage may vary on NT)

Creating containers

Creating new containers can be done by using the dockerw create command added in v1.2.0. This command will ask some basic questions in order to set up the scaffolding needed for a container.

See the example branch to get a general idea on how to set this repository up in your use-case.

Contributions

You are more than welcome to submit issues as well as feature requests in the issue tracker.

Contributing to the project can be done by forking it and submitting a pull request once it's all tested and tidy.