diff --git a/docker-compose/README.md b/docker-compose/README.md index 44c6c02..74e4654 100644 --- a/docker-compose/README.md +++ b/docker-compose/README.md @@ -1,11 +1,6 @@ -# Cookiecutter docker-compose template +# docker-compose template -## Get started - -Get Cookiecutter like so: -``` -pip install cookiecutter -``` +## Run it Execute this template like so: ``` @@ -25,11 +20,7 @@ Done, directory structure and files for your next `docker-compose` project are r Each `docker-compose` project forms a *__service__* that may consist of either a single or multiple *__components__*. -The `service` variable by default is empty. In this example we've chosen to name the service `grafana`. We want `grafana` to consist of two components, namely Grafana itself and Nginx. - -Syntax for a multi-component `component_list` is a comma-separated list without spaces. The string `grafana,nginx` will be treated as a list of two components. Capitalization doesn't matter, we're lowercasing all strings automatically. - -The template prefills `component_list` with whatever you previously entered as the `service` name. To create directory structure for a _single-component service_ confirm the default. If `component_list` and `service` are identical directory structure will be that for a _single-component service_. +The `service` variable by default is empty. In this example we've chosen to name the service `grafana`. We want `grafana` to consist of two components, namely Grafana itself and Nginx. Syntax for a multi-component `component_list` is a comma-separated list without spaces. The string `grafana,nginx` will be treated as a list of two components. Capitalization doesn't matter, we're lowercasing all strings automatically. The template prefills `component_list` with whatever you previously entered as the `service` name. To create directory structure for a _single-component service_ confirm the default. If `component_list` and `service` are identical directory structure will be that for a _single-component service_. The last prompt for a *__context__* is a generic string to help you distinguish deployments. It can be whatever you want such as for example a team name, here `cncf`. @@ -60,7 +51,7 @@ Above example of a multi-component (two in this case) `grafana` service will giv └── env └── fully.qualified.domain.name.example ``` -Check out file contents over in the [examples/grafana subdir](/examples/grafana). +Check out file contents over in the [examples/grafana subdir](examples/grafana). ### Single-component @@ -80,4 +71,4 @@ With an alternative single-component `hashicorpvault` service the result may loo └── env └── fully.qualified.domain.name.example ``` -Check out file contents over in the [examples/hashicorpvault subdir](/examples/hashicorpvault). +Check out file contents over in the [examples/hashicorpvault subdir](examples/hashicorpvault).