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

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

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).
# Grafana Docker Compose files # Grafana Docker Compose files
Docker Compose files to spin up an instance of Grafana. Docker Compose files to spin up an instance of Grafana _FIXME_ capitalization _FIXME_.
# How to run # How to run
@ -52,7 +56,7 @@ Create ZFS datasets and set permissions as needed.
zfs create -p 'zpool/docker-data/grafana-'"${COMPOSE_CTX}"'/nginx/data/logs' zfs create -p 'zpool/docker-data/grafana-'"${COMPOSE_CTX}"'/nginx/data/logs'
zfs create -p 'zpool/docker-data/grafana-'"${COMPOSE_CTX}"'/nginx/config' zfs create -p 'zpool/docker-data/grafana-'"${COMPOSE_CTX}"'/nginx/config'
``` ```
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 * Create subdirs
``` ```
@ -68,6 +72,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`. 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/ build-context/
├── grafana ├── grafana

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).
# Vault Docker Compose files # Vault Docker Compose files
Docker Compose files to spin up an instance of Vault. Docker Compose files to spin up an instance of Vault _FIXME_ capitalization _FIXME_.
# How to run # How to run
@ -26,7 +30,7 @@ docker context create fully.qualified.domain.name --docker 'host=ssh://root@full
``` ```
## Build ## Build
We build the `vault` image locally. Our adjustment to the official image is simply adding `/tmp/vault` to it. See [build-context/vault/Dockerfile](build-context/vault/Dockerfile). We use `/tmp/vault` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location. _FIXME_ We build the `vault` image locally. Our adjustment to the official image is simply adding `/tmp/vault` to it. See [build-context/vault/Dockerfile](build-context/vault/Dockerfile). We use `/tmp/vault` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location.
``` ```
docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --file "${COMPOSE_OVERRIDE}" --env-file "${COMPOSE_ENV}" --profile 'build' build docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --file "${COMPOSE_OVERRIDE}" --env-file "${COMPOSE_ENV}" --profile 'build' build
@ -57,7 +61,7 @@ Create ZFS datasets and set permissions as needed.
zfs create -p 'zpool/docker-data/vault-'"${COMPOSE_CTX}"'/vault/data/logs' zfs create -p 'zpool/docker-data/vault-'"${COMPOSE_CTX}"'/vault/data/logs'
zfs create -p 'zpool/docker-data/vault-'"${COMPOSE_CTX}"'/vault/config' zfs create -p 'zpool/docker-data/vault-'"${COMPOSE_CTX}"'/vault/config'
``` ```
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 * Create subdirs
``` ```
@ -73,6 +77,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`. 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/ build-context/
├── docker-data ├── docker-data

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 # {{ 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 # 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(',') -%} {%- set components = cookiecutter.__component_list_slug.split(',') -%}
{% for component in components %} {% for component in components %}
{%- if loop.first %} {%- 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 %} {%- endif %}
{%- endfor %} {%- 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' zfs create -p 'zpool/docker-data/{{ cookiecutter.__service_slug }}-'"${COMPOSE_CTX}"'/{{ cookiecutter.__service_slug }}/config'
{%- endif %} {%- 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 * 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`. 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/ build-context/
{%- if ',' in cookiecutter.__component_list_slug -%} {%- if ',' in cookiecutter.__component_list_slug -%}