From 467e98b01a92cc9a43c4ca45059f17f40259ccf9 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Sat, 24 Jun 2023 23:36:59 +0200 Subject: [PATCH] docs(docker-compose): Add pull instructions --- docker-compose/examples/grafana/README.md | 8 ++++++++ docker-compose/examples/hashicorpvault/README.md | 8 ++++++++ .../{{ cookiecutter.__project_slug }}/README.md | 8 ++++++++ 3 files changed, 24 insertions(+) diff --git a/docker-compose/examples/grafana/README.md b/docker-compose/examples/grafana/README.md index 04cb29c..262f0ba 100644 --- a/docker-compose/examples/grafana/README.md +++ b/docker-compose/examples/grafana/README.md @@ -28,6 +28,14 @@ On your deployment machine create the necessary Docker context to connect to and docker context create fully.qualified.domain.name --docker 'host=ssh://root@fully.qualified.domain.name' ``` +## Pull + +Pull images from Docker Hub verbatim. + +``` +docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV}" --profile 'full' pull +``` + ## Start ``` diff --git a/docker-compose/examples/hashicorpvault/README.md b/docker-compose/examples/hashicorpvault/README.md index 955c348..c5e8ea5 100644 --- a/docker-compose/examples/hashicorpvault/README.md +++ b/docker-compose/examples/hashicorpvault/README.md @@ -36,6 +36,14 @@ _FIXME_ We build the `vault` image locally. Our adjustment to the official image docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --file "${COMPOSE_OVERRIDE}" --env-file "${COMPOSE_ENV}" --profile 'build-vault' build ``` +## 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. + +``` +docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV}" --profile 'full' pull +``` + ## Start ``` diff --git a/docker-compose/{{ cookiecutter.__project_slug }}/README.md b/docker-compose/{{ cookiecutter.__project_slug }}/README.md index 0b250d0..128ec65 100644 --- a/docker-compose/{{ cookiecutter.__project_slug }}/README.md +++ b/docker-compose/{{ cookiecutter.__project_slug }}/README.md @@ -45,6 +45,14 @@ docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --fi {%- endfor %} {%- endif %} +## 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. + +``` +docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV}" --profile 'full' pull +``` + ## Start ```