Quico/py-cookiecutter-templates
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(docker-compose): Pepper _FIXME_ markers throughout README.md to clean it prior to commit

Browse Source
This commit is contained in:
hygienic-books
2023-06-24 23:27:59 +02:00
parent 494228b367
commit 3026e30783
3 changed files with 26 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docker-compose/{{ cookiecutter.__project_slug }}/README.md
View File

@@ -1,6 +1,10 @@
# _FIXME_
Search and replace all mentions of _FIXME_ with sensible content in this file and in [docker-compose.yml](docker-compose.yml).
# {{ cookiecutter.__service_slug.capitalize() }} Docker Compose files
Docker Compose files to spin up an instance of {{ cookiecutter.__service_slug.capitalize() }}.
Docker Compose files to spin up an instance of {{ cookiecutter.__service_slug.capitalize() }} _FIXME_ capitalization _FIXME_.
# How to run
@@ -32,7 +36,7 @@ docker context create fully.qualified.domain.name --docker 'host=ssh://root@full
{%- set components = cookiecutter.__component_list_slug.split(',') -%}
{% for component in components %}
{%- if loop.first %}
We build the `{{ cookiecutter.__service_slug }}` image locally. Our adjustment to the official image is simply adding `/tmp/{{ cookiecutter.__service_slug }}` to it. See [build-context/{{ cookiecutter.__service_slug }}/Dockerfile](build-context/{{ cookiecutter.__service_slug }}/Dockerfile). We use `/tmp/{{ cookiecutter.__service_slug }}` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location.
_FIXME_ We build the `{{ cookiecutter.__service_slug }}` image locally. Our adjustment to the official image is simply adding `/tmp/{{ cookiecutter.__service_slug }}` to it. See [build-context/{{ cookiecutter.__service_slug }}/Dockerfile](build-context/{{ cookiecutter.__service_slug }}/Dockerfile). We use `/tmp/{{ cookiecutter.__service_slug }}` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location.
{%- endif %}
{%- endfor %}
@@ -79,7 +83,7 @@ Create ZFS datasets and set permissions as needed.
zfs create -p 'zpool/docker-data/{{ cookiecutter.__service_slug }}-'"${COMPOSE_CTX}"'/{{ cookiecutter.__service_slug }}/config'
{%- endif %}
```
When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml).
_FIXME_ delete when all is done _FIXME_ When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml).
* Create subdirs
```
@@ -105,6 +109,8 @@ Create ZFS datasets and set permissions as needed.
Place the following files on target server. Use the directory structure at [build-context](build-context) as a guide, specifically at `docker-data`.
_FIXME_ Add details about files that aren't self-explanatory _FIXME_
```
build-context/
{%- if ',' in cookiecutter.__component_list_slug -%}