diff --git a/README.md b/README.md index 5965767..a22623e 100644 --- a/README.md +++ b/README.md @@ -57,8 +57,8 @@ The end result is a directory structure that has everything you need to hit the │   └── extras │   └── .gitkeep ├── common-settings.yml - ├── docker-compose.override.yml - ├── docker-compose.yml + ├── compose.override.yaml + ├── compose.yaml ├── env │   └── fqdn_context.env.example └── README.md @@ -215,8 +215,8 @@ Make some code changes, for example to the Docker Compose Cookiecutter template. │   └── extras │   └── .gitkeep ├── common-settings.yml - ├── docker-compose.override.yml - ├── docker-compose.yml + ├── compose.override.yaml + ├── compose.yaml ├── env │   └── fqdn_context.env.example └── README.md diff --git a/docker-compose/README.md b/docker-compose/README.md index 13ca408..966a539 100644 --- a/docker-compose/README.md +++ b/docker-compose/README.md @@ -34,7 +34,7 @@ Your four answers translate as follows into rendered files. │   ├── Dockerfile ... ``` -2. The `service` variable by default copies your `project_slug` answer. It's a style decision whether you leave it at that and just hit `Enter`. The service name will come up in rendered `docker-compose.yml` at purely cosmetic locations such as the `networks:` key, `container_name:` and `/opt/docker-data` volume mount presets, here with `ftp` as the service name: +2. The `service` variable by default copies your `project_slug` answer. It's a style decision whether you leave it at that and just hit `Enter`. The service name will come up in rendered `compose.yaml` at purely cosmetic locations such as the `networks:` key, `container_name:` and `/opt/docker-data` volume mount presets, here with `ftp` as the service name: ``` services: mysql: @@ -93,8 +93,8 @@ Above example of a multi-component (two in this case) `grafana` service will giv │   └── extras │   └── .gitkeep ├── common-settings.yml - ├── docker-compose.override.yml - ├── docker-compose.yml + ├── compose.override.yaml + ├── compose.yaml ├── env │   └── fqdn_context.env.example └── README.md @@ -114,8 +114,8 @@ With an alternative single-component `hashicorpvault` service the result may loo │   └── extras │   └── .gitkeep ├── common-settings.yml - ├── docker-compose.override.yml - ├── docker-compose.yml + ├── compose.override.yaml + ├── compose.yaml ├── env │   └── fqdn_context.env.example └── README.md @@ -126,7 +126,7 @@ Check out file contents over in the [examples/hashicorpvault](examples/hashicorp Consider Cookiecutter's project directory and rendered files a starting point. It won't do everything perfectly. -Imagine if you will a service that consists of [Infinispan](https://infinispan.org/) among other things. In Docker Hub's content-addressable image store Infinispan's location is at `infinispan/server` so you obviously want that exact string with a forward slash to show up in your `docker-compose.yml` as the `image:` key's value, same with your `Dockerfile`. The `image:` key's value comes from what you enter in Cookiecutter's `component_list` prompt. Component strings are then used to also pre-fill the `volumes:` key. +Imagine if you will a service that consists of [Infinispan](https://infinispan.org/) among other things. In Docker Hub's content-addressable image store Infinispan's location is at `infinispan/server` so you obviously want that exact string with a forward slash to show up in your `compose.yaml` as the `image:` key's value, same with your `Dockerfile`. The `image:` key's value comes from what you enter in Cookiecutter's `component_list` prompt. Component strings are then used to also pre-fill the `volumes:` key. _**This**_ will cause obvious issues (but the `image:` key is kinda correct): ``` diff --git a/docker-compose/examples/grafana/README.md b/docker-compose/examples/grafana/README.md index 2d7f95b..ec41e85 100644 --- a/docker-compose/examples/grafana/README.md +++ b/docker-compose/examples/grafana/README.md @@ -1,6 +1,6 @@ # 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 [compose.yaml](compose.yaml). # Grafana Docker Compose files @@ -18,7 +18,7 @@ When everything's ready start Grafana with Docker Compose, otherwise head down t export COMPOSE_DIR='/opt/containers/grafana' export COMPOSE_CTX='ux_vilnius' export COMPOSE_PROJECT='grafana-'"${COMPOSE_CTX}" -export COMPOSE_FILE="${COMPOSE_DIR}"'/docker-compose.yml' +export COMPOSE_FILE="${COMPOSE_DIR}"'/compose.yaml' export COMPOSE_ENV= ``` @@ -77,7 +77,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/config' ``` - FIXME When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml) FIXME + FIXME When changing bind mount locations to real ones remember to also update `volumes:` in [compose.yaml](compose.yaml) FIXME * Create subdirs ``` diff --git a/docker-compose/examples/grafana/docker-compose.override.yml b/docker-compose/examples/grafana/compose.override.yaml similarity index 100% rename from docker-compose/examples/grafana/docker-compose.override.yml rename to docker-compose/examples/grafana/compose.override.yaml diff --git a/docker-compose/examples/grafana/docker-compose.yml b/docker-compose/examples/grafana/compose.yaml similarity index 100% rename from docker-compose/examples/grafana/docker-compose.yml rename to docker-compose/examples/grafana/compose.yaml diff --git a/docker-compose/examples/grafana/env/fqdn_context.env.example b/docker-compose/examples/grafana/env/fqdn_context.env.example index b2c2a78..00114b0 100644 --- a/docker-compose/examples/grafana/env/fqdn_context.env.example +++ b/docker-compose/examples/grafana/env/fqdn_context.env.example @@ -27,7 +27,7 @@ SUBNET=172.30.95.0/24 -# See 'docker-compose.override.yml' for how to make a variable available in +# See 'compose.override.yaml' for how to make a variable available in # a Dockerfile # --- # EXAMPLE_ARG_FROM_ENV_FILE=must_be_available_in_dockerfile diff --git a/docker-compose/examples/hashicorpvault/README.md b/docker-compose/examples/hashicorpvault/README.md index 68d400d..8b34088 100644 --- a/docker-compose/examples/hashicorpvault/README.md +++ b/docker-compose/examples/hashicorpvault/README.md @@ -1,6 +1,6 @@ # 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 [compose.yaml](compose.yaml). # Vault Docker Compose files @@ -18,8 +18,8 @@ When everything's ready start Vault with Docker Compose, otherwise head down to export COMPOSE_DIR='/opt/containers/hashicorpvault' export COMPOSE_CTX='ux_vilnius' export COMPOSE_PROJECT='vault-'"${COMPOSE_CTX}" -export COMPOSE_FILE="${COMPOSE_DIR}"'/docker-compose.yml' -export COMPOSE_OVERRIDE="${COMPOSE_DIR%/}"'/docker-compose.override.yml' +export COMPOSE_FILE="${COMPOSE_DIR}"'/compose.yaml' +export COMPOSE_OVERRIDE="${COMPOSE_DIR%/}"'/compose.override.yaml' export COMPOSE_ENV= ``` @@ -81,7 +81,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/config' ``` - FIXME When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml) FIXME + FIXME When changing bind mount locations to real ones remember to also update `volumes:` in [compose.yaml](compose.yaml) FIXME * Create subdirs ``` diff --git a/docker-compose/examples/hashicorpvault/docker-compose.override.yml b/docker-compose/examples/hashicorpvault/compose.override.yaml similarity index 100% rename from docker-compose/examples/hashicorpvault/docker-compose.override.yml rename to docker-compose/examples/hashicorpvault/compose.override.yaml diff --git a/docker-compose/examples/hashicorpvault/docker-compose.yml b/docker-compose/examples/hashicorpvault/compose.yaml similarity index 100% rename from docker-compose/examples/hashicorpvault/docker-compose.yml rename to docker-compose/examples/hashicorpvault/compose.yaml diff --git a/docker-compose/examples/hashicorpvault/env/fqdn_context.env.example b/docker-compose/examples/hashicorpvault/env/fqdn_context.env.example index 95e09be..be0e112 100644 --- a/docker-compose/examples/hashicorpvault/env/fqdn_context.env.example +++ b/docker-compose/examples/hashicorpvault/env/fqdn_context.env.example @@ -26,7 +26,7 @@ SUBNET=172.30.95.0/24 -# See 'docker-compose.override.yml' for how to make a variable available in +# See 'compose.override.yaml' for how to make a variable available in # a Dockerfile # --- # EXAMPLE_ARG_FROM_ENV_FILE=must_be_available_in_dockerfile diff --git a/docker-compose/{{ cookiecutter.__project_slug }}/README.md b/docker-compose/{{ cookiecutter.__project_slug }}/README.md index b831c9c..579f2fd 100644 --- a/docker-compose/{{ cookiecutter.__project_slug }}/README.md +++ b/docker-compose/{{ cookiecutter.__project_slug }}/README.md @@ -1,6 +1,6 @@ # 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 [compose.yaml](compose.yaml). # {{ cookiecutter.__service_slug.capitalize() }} Docker Compose files @@ -18,8 +18,8 @@ When everything's ready start {{ cookiecutter.__service_slug.capitalize() }} wit export COMPOSE_DIR='/opt/containers/{{ cookiecutter.__project_slug }}' export COMPOSE_CTX='ux_vilnius' export COMPOSE_PROJECT='{{ cookiecutter.__service_slug }}-'"${COMPOSE_CTX}" -export COMPOSE_FILE="${COMPOSE_DIR}"'/docker-compose.yml'{% if cookiecutter.build == "yes" %} -export COMPOSE_OVERRIDE="${COMPOSE_DIR%/}"'/docker-compose.override.yml'{% endif %} +export COMPOSE_FILE="${COMPOSE_DIR}"'/compose.yaml'{% if cookiecutter.build == "yes" %} +export COMPOSE_OVERRIDE="${COMPOSE_DIR%/}"'/compose.override.yaml'{% endif %} export COMPOSE_ENV= ``` @@ -108,7 +108,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 %} ``` - FIXME When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml) FIXME + FIXME When changing bind mount locations to real ones remember to also update `volumes:` in [compose.yaml](compose.yaml) FIXME * Create subdirs ``` diff --git a/docker-compose/{{ cookiecutter.__project_slug }}/docker-compose.override.yml b/docker-compose/{{ cookiecutter.__project_slug }}/compose.override.yaml similarity index 100% rename from docker-compose/{{ cookiecutter.__project_slug }}/docker-compose.override.yml rename to docker-compose/{{ cookiecutter.__project_slug }}/compose.override.yaml diff --git a/docker-compose/{{ cookiecutter.__project_slug }}/docker-compose.yml b/docker-compose/{{ cookiecutter.__project_slug }}/compose.yaml similarity index 100% rename from docker-compose/{{ cookiecutter.__project_slug }}/docker-compose.yml rename to docker-compose/{{ cookiecutter.__project_slug }}/compose.yaml diff --git a/docker-compose/{{ cookiecutter.__project_slug }}/env/fqdn_context.env.example b/docker-compose/{{ cookiecutter.__project_slug }}/env/fqdn_context.env.example index ddd4b4d..5c2c5dd 100644 --- a/docker-compose/{{ cookiecutter.__project_slug }}/env/fqdn_context.env.example +++ b/docker-compose/{{ cookiecutter.__project_slug }}/env/fqdn_context.env.example @@ -33,7 +33,7 @@ SUBNET=172.30.95.0/24 -# See 'docker-compose.override.yml' for how to make a variable available in +# See 'compose.override.yaml' for how to make a variable available in # a Dockerfile # --- # EXAMPLE_ARG_FROM_ENV_FILE=must_be_available_in_dockerfile