From 94a802c1e653d378914106c7a03d77d3b84383b0 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Tue, 13 Jun 2023 00:24:33 +0200 Subject: [PATCH 1/4] docs(docker-compose): Update example directory layout --- docker-compose/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docker-compose/README.md b/docker-compose/README.md index 18d5675..95f9d4e 100644 --- a/docker-compose/README.md +++ b/docker-compose/README.md @@ -111,8 +111,9 @@ Above example of a multi-component (two in this case) `grafana` service will giv ├── common-settings.yml ├── docker-compose.override.yml ├── docker-compose.yml - └── env - └── fully.qualified.domain.name.example + ├── env + │   └── fqdn_context.env.example + └── README.md ``` Check out file contents over in the [examples/grafana](examples/grafana) subdir. @@ -131,8 +132,9 @@ With an alternative single-component `hashicorpvault` service the result may loo ├── common-settings.yml ├── docker-compose.override.yml ├── docker-compose.yml - └── env - └── fully.qualified.domain.name.example + ├── env + │   └── fqdn_context.env.example + └── README.md ``` Check out file contents over in the [examples/hashicorpvault](examples/hashicorpvault) subdir. From 448401b7b05398bf4b2ec3684d9e42b6a3874a64 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Tue, 13 Jun 2023 00:30:18 +0200 Subject: [PATCH 2/4] docs(docker-compose): Link pip section with a more detailed explanation (#7) --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a60b02..058615b 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,9 @@ Get Cookiecutter like so: pip install cookiecutter ``` -Execute a template like so, `docker-compose` as an example: +Unfamiliar with Python and `pip`? Check out [Developing](#developing) further down to get started with a virtual environment. + +When all is set execute a template like so, `docker-compose` as an example: ``` cookiecutter https://quico.space/Quico/py-cookiecutter-templates.git --directory 'docker-compose' ``` From 299c15e30d3a611d02892937b3ed2868987f5191 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Tue, 13 Jun 2023 00:30:51 +0200 Subject: [PATCH 3/4] docs(docker-compose): Update example directory layout (#7) --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 058615b..e7ada62 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,10 @@ project_slug [dir-name]: grafana service [grafana]: component_list [grafana]: grafana,nginx context [ctx]: cncf +Select build: +1 - no +2 - yes +Choose from 1, 2 [1]: ``` The end result is a directory structure that has everything you need to hit the ground running. @@ -56,8 +60,9 @@ The end result is a directory structure that has everything you need to hit the ├── common-settings.yml ├── docker-compose.override.yml ├── docker-compose.yml - └── env - └── fully.qualified.domain.name.example + ├── env + │   └── fqdn_context.env.example + └── README.md ``` # Developing From 4bc93e5546bf72b0636ffcc070f1493c988457bc Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Tue, 13 Jun 2023 00:34:19 +0200 Subject: [PATCH 4/4] docs(docker-compose): Update example directory layout (#7) --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e7ada62..0085d95 100644 --- a/README.md +++ b/README.md @@ -191,28 +191,37 @@ Make some code changes, for example to the Docker Compose Cookiecutter template. service [mydir]: myservice component_list [myservice]: mycomponent_one,mycomponent_two context [ctx]: ux_novosibirsk + Select build: + 1 - no + 2 - yes + Choose from 1, 2 [1]: 2 ``` - Observe that in `/tmp/cookiecutter-docker-compose` you now have your rendered Docker Compose dir: ``` - # tree /tmp/cookiecutter-docker-compose + # tree -a . - /tmp/cookiecutter-docker-compose + . └── mydir ├── build-context │   ├── mycomponent_one │   │   ├── docker-data + │   │   │   └── .gitkeep │   │   ├── Dockerfile │   │   └── extras + │   │   └── .gitkeep │   └── mycomponent_two │   ├── docker-data + │   │   └── .gitkeep │   ├── Dockerfile │   └── extras + │   └── .gitkeep ├── common-settings.yml ├── docker-compose.override.yml ├── docker-compose.yml - └── env - └── fqdn_context.env.example + ├── env + │   └── fqdn_context.env.example + └── README.md ``` - For rapid testing you will most likely want to not type prompt answers repeatedly. Give them as command line arguments instead, also specify `--no-input` to suppress prompts: