From 26940bbb3fef1b54f946d91dc559121f27d0c87e Mon Sep 17 00:00:00 2001 From: SilviaAmAm Date: Wed, 3 Apr 2024 10:46:51 +0200 Subject: [PATCH 1/3] :construction_worker: Use docker compose V2 in CI --- .github/workflows/ci.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d81560cc3f..9c9cd230cf 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -56,8 +56,8 @@ jobs: - name: Start CI docker services run: | - docker-compose -f docker-compose.ci.yml up -d - docker-compose -f docker-compose.camunda.yml up -d + docker compose -f docker-compose.ci.yml up -d + docker compose -f docker-compose.camunda.yml up -d working-directory: docker - name: Wait for Camunda to be up @@ -145,8 +145,8 @@ jobs: - name: Start CI docker services run: | - docker-compose -f docker-compose.ci.yml up -d - docker-compose -f docker-compose.camunda.yml up -d + docker compose -f docker-compose.ci.yml up -d + docker compose -f docker-compose.camunda.yml up -d working-directory: docker - name: Wait for Camunda to be up From b9985bfd03ccaad82175c5c5e22e4f0d32b669ab Mon Sep 17 00:00:00 2001 From: SilviaAmAm Date: Wed, 3 Apr 2024 10:49:34 +0200 Subject: [PATCH 2/3] :memo: Updated .md files with docker compose V2 --- docker/camunda/README.md | 2 +- docker/embedding/README.md | 8 ++++---- docker/keycloak/README.md | 4 ++-- docker/objects-apis/README.md | 2 +- nlx/README.md | 6 +++--- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docker/camunda/README.md b/docker/camunda/README.md index 1f36dadab3..bb01e897c8 100644 --- a/docker/camunda/README.md +++ b/docker/camunda/README.md @@ -11,7 +11,7 @@ for production usage. Start a Camunda instance in your local environment from the parent directory: ```bash -docker-compose -f docker-compose.camunda.yml up -d +docker compose -f docker-compose.camunda.yml up -d ``` This brings up the database and Camunda stack. The Camunda cockpit is accessible on diff --git a/docker/embedding/README.md b/docker/embedding/README.md index e87568e571..c44fe19ef9 100644 --- a/docker/embedding/README.md +++ b/docker/embedding/README.md @@ -2,14 +2,14 @@ The JS SDK is built to support embedding forms in third party pages, like CMS pages. -The files here and the docker-compose configuration in the parent folder ( +The files here and the `docker compose` configuration in the parent folder ( `docker-compose.embedding.yml`) exist to test and demo this behaviour. ## Requirements To succesfully run an embed test setup, you need: -- docker-compose +- `docker compose` - an Open Forms 2.5.0+ instance, available over HTTPS. E.g. `https://openforms.example.com` - the instance must allow CORS requests from `https://localhost:9000` - the instance must have `localhost:9000` in the CSRF trusted origins @@ -19,7 +19,7 @@ Consult the installation/configuration [documentation](https://open-forms.readthedocs.io/en/stable/developers/sdk/embedding.html#backend-configuration) on how to properly configure your backend for embedding. -## Bring up docker-compose +## Bring up docker compose All instructions are relative to the top-level directory. @@ -38,7 +38,7 @@ All instructions are relative to the top-level directory. 2. Then, bring up the docker services: ```bash - docker-compose -f ./docker/docker-compose.embedding.yml up + docker compose -f ./docker/docker-compose.embedding.yml up ``` ## Embed test cases diff --git a/docker/keycloak/README.md b/docker/keycloak/README.md index 4d91e68ed2..aab284c2d5 100644 --- a/docker/keycloak/README.md +++ b/docker/keycloak/README.md @@ -6,12 +6,12 @@ an example of an Identity Provider that supports OIDC. We include a compose stack for development and CI purposes. This is **NOT** suitable for production usage. -## docker-compose +## docker compose Start a Keycloak instance in your local environment from the parent directory: ```bash -docker-compose -f docker-compose.keycloak.yml up -d +docker compose -f docker-compose.keycloak.yml up -d ``` This brings up Keycloak, the admin interface is accessible at http://localhost:8080/. diff --git a/docker/objects-apis/README.md b/docker/objects-apis/README.md index 60c03a9d42..cb990a81ae 100644 --- a/docker/objects-apis/README.md +++ b/docker/objects-apis/README.md @@ -10,7 +10,7 @@ Start an instance in your local environment from the parent directory: docker compose -f docker-compose.objects-apis.yml up -d ``` -Create a super user: +Create a superuser: ```bash docker compose -f docker-compose.objects-apis.yml exec objecttypes-web src/manage.py createsuperuser diff --git a/nlx/README.md b/nlx/README.md index 86b5b31507..c6e4af8dc5 100644 --- a/nlx/README.md +++ b/nlx/README.md @@ -2,7 +2,7 @@ [NLX][NLX] integration is optional. -This directory contains the docker-compose tooling and instructions on how to enable +This directory contains the `docker compose` tooling and instructions on how to enable NLX on the demo network and connect Open Forms services with it. Ensure you are in the Open Forms repository `nlx` directory for any steps documented @@ -45,10 +45,10 @@ sudo chmod go-rwx nlx-try-me/pki/certs/internal-cert-key.pem ## Running the NLX stack -Navigate to this (`nlx`) directory and start the components using docker-compose: +Navigate to this (`nlx`) directory and start the components using `docker compose`: ```bash -docker-compose up +docker compose up ``` and follow the rest of the guide at the From bde6df22918685954aab69a4c1a61fae970b3b43 Mon Sep 17 00:00:00 2001 From: SilviaAmAm Date: Wed, 3 Apr 2024 10:51:38 +0200 Subject: [PATCH 3/3] :memo: Updated .rst files with docker compose V2 --- docs/developers/embedding.rst | 2 +- docs/developers/extending.rst | 6 +++--- docs/installation/docker_compose.rst | 10 +++++----- docs/installation/index.rst | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/developers/embedding.rst b/docs/developers/embedding.rst index 8b30e022ea..b0e545cff3 100644 --- a/docs/developers/embedding.rst +++ b/docs/developers/embedding.rst @@ -192,7 +192,7 @@ More examples ------------- See (on Github) the directory ``docker/embedding`` README file for working examples of -different embedding cases. These should be easy to bring up with docker-compose, provided +different embedding cases. These should be easy to bring up with ``docker compose``, provided you have a backend instance ready to go. Backend configuration diff --git a/docs/developers/extending.rst b/docs/developers/extending.rst index a2a0ef904d..0705d9779a 100644 --- a/docs/developers/extending.rst +++ b/docs/developers/extending.rst @@ -167,9 +167,9 @@ your choice, for example: docker build -t myorg/open-forms:1.0.0 . -or use the relevant docker-compose command variants. +or use the relevant ``docker compose`` command variants. -**Running all the services with docker-compose** +**Running all the services with docker compose** You can create your own ``docker-compose.yml`` inspired by the Open Forms docker-compose configuration, or use the `docker-compose.override.yml `_ @@ -179,7 +179,7 @@ environment variables your extensions require. .. code-block:: bash - docker-compose up + docker compose up Testing in CI diff --git a/docs/installation/docker_compose.rst b/docs/installation/docker_compose.rst index f74cdccab0..7b8afbb77e 100644 --- a/docs/installation/docker_compose.rst +++ b/docs/installation/docker_compose.rst @@ -43,12 +43,12 @@ Getting started $ unzip master.zip $ cd open-forms-master -2. Start the docker containers with ``docker-compose``. If you want to run the +2. Start the docker containers with ``docker compose``. If you want to run the containers in the background, add the ``-d`` option to the command below: .. code:: bash - $ docker-compose up + docker compose up Creating network "open-forms-master_default" with the default driver Creating volume "open-forms-master_db" with default driver @@ -67,7 +67,7 @@ Getting started .. code:: bash - $ docker-compose exec web src/manage.py createsuperuser + docker compose exec web src/manage.py createsuperuser 4. Navigate to ``http://127.0.0.1:8000/admin/`` and use the credentials created above to log in. @@ -76,11 +76,11 @@ Getting started .. code:: bash - $ docker-compose stop + docker compose stop 6. If you want to get newer versions, you need to ``pull`` because the ``docker-compose.yml`` contains no explicit versions: .. code:: bash - $ docker-compose pull + $ docker compose pull diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 84d95f3ac3..f5a664fca8 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -8,7 +8,7 @@ and expertise. 1. Deploy using :ref:`Ansible ` for public testing and production purposes -2. Run with :ref:`Docker-Compose ` on your computer for private testing purposes +2. Run with :ref:`Docker Compose ` on your computer for private testing purposes 3. Run from :ref:`Python code ` on your computer for development purposes .. note::