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

refactor(docker-compose): No needs for FIXME Markdown italics

Browse Source
This commit is contained in:
hygienic-books 2023-06-24 23:37:35 +02:00
parent 467e98b01a
commit bb6777f389
3 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docker-compose/examples/grafana/README.md
View File

@ -1,10 +1,10 @@
# _FIXME_ # FIXME
Search and replace all mentions of _FIXME_ with sensible content in this file and in [docker-compose.yml](docker-compose.yml). 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 _FIXME_ capitalization _FIXME_. Docker Compose files to spin up an instance of Grafana FIXME capitalization FIXME.
# How to run # How to run
@ -64,7 +64,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'
``` ```
_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). 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
``` ```
@ -80,7 +80,7 @@ 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_ FIXME Add details about files that aren't self-explanatory FIXME
``` ```
build-context/ build-context/

14
docker-compose/examples/hashicorpvault/README.md
View File

@ -1,10 +1,10 @@
# _FIXME_ # FIXME
Search and replace all mentions of _FIXME_ with sensible content in this file and in [docker-compose.yml](docker-compose.yml). 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 _FIXME_ capitalization _FIXME_. Docker Compose files to spin up an instance of Vault FIXME capitalization FIXME.
# How to run # How to run
@ -30,7 +30,7 @@ docker context create fully.qualified.domain.name --docker 'host=ssh://root@full
``` ```
## Build ## Build
_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. 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-vault' build docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --file "${COMPOSE_OVERRIDE}" --env-file "${COMPOSE_ENV}" --profile 'build-vault' build
@ -38,7 +38,7 @@ docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --fi
## Pull ## Pull
_FIXME_ Rewrite either [Build](#build) or this paragraph for which images are built and which ones pulled, `--profile 'full'` may not make sense _FIXME_ Pull images from Docker Hub verbatim. FIXME Rewrite either [Build](#build) or this paragraph for which images are built and which ones pulled, `--profile 'full'` may not make sense FIXME Pull images from Docker Hub verbatim.
``` ```
docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV}" --profile 'full' pull docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV}" --profile 'full' pull
@ -69,7 +69,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'
``` ```
_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). 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
``` ```
@ -85,7 +85,7 @@ 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_ FIXME Add details about files that aren't self-explanatory FIXME
``` ```
build-context/ build-context/

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

@ -1,10 +1,10 @@
# _FIXME_ # FIXME
Search and replace all mentions of _FIXME_ with sensible content in this file and in [docker-compose.yml](docker-compose.yml). 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() }} _FIXME_ capitalization _FIXME_. Docker Compose files to spin up an instance of {{ cookiecutter.__service_slug.capitalize() }} FIXME capitalization FIXME.
# How to run # How to run
@ -36,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 %}
_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. 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.
``` ```
docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --file "${COMPOSE_OVERRIDE}" --env-file "${COMPOSE_ENV}" --profile 'build-{{ cookiecutter.__service_slug }}' build docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --file "${COMPOSE_OVERRIDE}" --env-file "${COMPOSE_ENV}" --profile 'build-{{ cookiecutter.__service_slug }}' build
@ -47,7 +47,7 @@ docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --fi
## Pull ## Pull
{% if cookiecutter.build == "yes" %}_FIXME_ Rewrite either [Build](#build) or this paragraph for which images are built and which ones pulled, `--profile 'full'` may not make sense _FIXME_ {% endif %}Pull images from Docker Hub verbatim. {% if cookiecutter.build == "yes" %}FIXME Rewrite either [Build](#build) or this paragraph for which images are built and which ones pulled, `--profile 'full'` may not make sense FIXME {% endif %}Pull images from Docker Hub verbatim.
``` ```
docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV}" --profile 'full' pull docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV}" --profile 'full' pull
@ -91,7 +91,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 %}
``` ```
_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). 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
``` ```
@ -117,7 +117,7 @@ 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_ FIXME Add details about files that aren't self-explanatory FIXME
``` ```
build-context/ build-context/