Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace docker compose V1 with V2 #4097

Merged
merged 3 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand 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
Expand Down
2 changes: 1 addition & 1 deletion docker/camunda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docker/embedding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docker/keycloak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/.
Expand Down
2 changes: 1 addition & 1 deletion docker/objects-apis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/embedding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/developers/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.docker.com/compose/multiple-compose-files/extends/>`_
Expand All @@ -179,7 +179,7 @@ environment variables your extensions require.

.. code-block:: bash

docker-compose up
docker compose up


Testing in CI
Expand Down
10 changes: 5 additions & 5 deletions docs/installation/docker_compose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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
2 changes: 1 addition & 1 deletion docs/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ and expertise.

1. Deploy using :ref:`Ansible <installation_ansible>` for public testing and
production purposes
2. Run with :ref:`Docker-Compose <installation_docker_compose>` on your computer for private testing purposes
2. Run with :ref:`Docker Compose <installation_docker_compose>` on your computer for private testing purposes
3. Run from :ref:`Python code <developers_installation>` on your computer for development purposes

.. note::
Expand Down
6 changes: 3 additions & 3 deletions nlx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading