Adopt Docker compose v2 and hyphen-less docker compose

OHDSI · Jan 4, 2024 · a593585 · a593585
1 parent ca19fa9
commit a593585
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 20 deletions.
diff --git a/.github/workflows/default.yml b/.github/workflows/default.yml
@@ -29,9 +29,9 @@ jobs:
             -subj '/CN=127.0.0.1' -extensions EXT -config <( \
             printf "[dn]\nCN=127.0.0.1\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:127.0.0.1\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
       - name: Build traefik container
-        run: docker-compose --env-file .env up -d
+        run: docker compose --env-file .env up -d
       - name: Build default profile
-        run: docker-compose --env-file .env --profile default up -d
+        run: docker compose --env-file .env --profile default up -d
       - name: Setup postgres client on Linux
         if: runner.os == 'Linux'
         run: sudo apt-get install --yes --no-install-recommends postgresql-client

diff --git a/.github/workflows/perseus.yml b/.github/workflows/perseus.yml
@@ -29,10 +29,10 @@ jobs:
             -subj '/CN=127.0.0.1' -extensions EXT -config <( \
             printf "[dn]\nCN=127.0.0.1\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:127.0.0.1\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
       - name: Build traefik container
-        run: docker-compose up -d
+        run: docker compose up -d
       - name: Check traefik container
         run: docker logs traefik
       - name: Build perseus profile
-        run: docker-compose --profile perseus up -d
+        run: docker compose --profile perseus up -d
       - name: Test perseus frontend
         run: curl -s --retry 10 --retry-connrefused ${{matrix.httpType}}://127.0.0.1/perseus/sign-in
diff --git a/.github/workflows/solrvocab.yml b/.github/workflows/solrvocab.yml
@@ -29,13 +29,13 @@ jobs:
             -subj '/CN=127.0.0.1' -extensions EXT -config <( \
             printf "[dn]\nCN=127.0.0.1\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:127.0.0.1\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
       - name: Build traefik container
-        run: docker-compose --env-file .env up -d
+        run: docker compose --env-file .env up -d
       - name: Build atlasdb profile
-        run: docker-compose --env-file .env --profile atlasdb up -d
+        run: docker compose --env-file .env --profile atlasdb up -d
       - name: Build empty SOLR instance
-        run: docker-compose --env-file .env --profile solr-vocab-no-import up -d
+        run: docker compose --env-file .env --profile solr-vocab-no-import up -d
       - name: Build webapi profile with SOLR_VOCAB enabled
-        run: SOLR_VOCAB_ENDPOINT=http://broadsea-solr-vocab:8983/solr docker-compose --env-file .env --profile webapi-from-image up -d
+        run: SOLR_VOCAB_ENDPOINT=http://broadsea-solr-vocab:8983/solr docker compose --env-file .env --profile webapi-from-image up -d
       - name: Test WebAPI info endpoint
         run: |
           sleep 30

diff --git a/.github/workflows/webapi_auth.yml b/.github/workflows/webapi_auth.yml
@@ -16,17 +16,17 @@ jobs:
       - name: Create certs folder
         run: mkdir -p ./certs
       - name: Build traefik container
-        run: docker-compose --env-file .env up -d
+        run: docker compose --env-file .env up -d
       - name: Build atlasdb profile
-        run: docker-compose --env-file .env --profile atlasdb up -d
+        run: docker compose --env-file .env --profile atlasdb up -d
       - name: Build webapi profile with ldap enabled
-        run: SECURITY_AUTH_LDAP_ENABLED=true docker-compose --env-file .env --profile webapi-from-image up -d
+        run: SECURITY_AUTH_LDAP_ENABLED=true docker compose --env-file .env --profile webapi-from-image up -d
       - name: Test WebAPI info endpoint
         run: |
           sleep 30
           curl -s -k --retry 10 --retry-connrefused ${{matrix.httpType}}://127.0.0.1/WebAPI/info
       - name: Build OpenLDAP
-        run: docker-compose --env-file .env --profile openldap up -d
+        run: docker compose --env-file .env --profile openldap up -d
       - name: Test openldap auth in WebAPI
         run: |
           curl -d "login=user1&password=$(<./secrets/openldap/OPENLDAP_ACCOUNT_PASSWORDS)" -H "Content-Type: application/x-www-form-urlencoded" -X POST ${{matrix.httpType}}://127.0.0.1/WebAPI/user/login/ldap
@@ -45,11 +45,11 @@ jobs:
       - name: Create certs folder
         run: mkdir -p ./certs
       - name: Build traefik container
-        run: docker-compose --env-file .env up -d
+        run: docker compose --env-file .env up -d
       - name: Build atlasdb profile
-        run: docker-compose --env-file .env --profile atlasdb up -d
+        run: docker compose --env-file .env --profile atlasdb up -d
       - name: Build webapi profile with ldap enabled
-        run: SECURITY_AUTH_JDBC_ENABLED=true docker-compose --env-file .env --profile webapi-from-image up -d
+        run: SECURITY_AUTH_JDBC_ENABLED=true docker compose --env-file .env --profile webapi-from-image up -d
       - name: Test WebAPI info endpoint
         run: |
           sleep 30

diff --git a/README.md b/README.md
@@ -33,14 +33,16 @@ Additionally, Broadsea offers limited support for services not specifically need
 -   Posit Connect for sites with commercial Posit licenses, for deploying Shiny apps
 -   DBT for ETL design
 
-### A Note on Docker Compose Commands
+### A Note on Docker Compose V2
 
-Throughout this README, we will show docker compose commands with the convention of `docker-compose`. However, on some systems such as Red Hat Linux, you will need to use `docker compose` (no hyphen).
+Throughout this README, we will show docker compose commands with the convention of `docker compose` (no hyphen), per the new Docker Compose V2 standard outlined by [Docker](https://docs.docker.com/compose/migrate/#docker-compose-vs-docker-compose). 
+
+**For Broadsea 3.1, you will need Docker version 1.27.0+.**
 
 ### Broadsea Dependencies
 
 -   Linux, Mac, or Windows with WSL
--   Docker
+-   Docker 1.27.0+
 -   Git
 -   Chromium-based web browser (Chrome, Edge, etc.)
 
@@ -60,7 +62,7 @@ git clone https://github.com/OHDSI/Broadsea.git
 -   In a command line / terminal window - navigate to the directory where this README.md file is located and start the Broadsea Docker Containers using the below command. On Linux you may need to use 'sudo' to run this command. Wait up to one minute for the Docker containers to start. 
 
 ```         
-docker-compose --profile default up -d
+docker compose --profile default up -d
 ```
 
 -   In your web browser open the URL: `"http://127.0.0.1"`
@@ -371,7 +373,7 @@ It supports any OS where Docker containers can run, including Windows, Mac OS X,
 ### View the status of the running Docker containers:
 
 ```         
-docker-compose ps
+docker compose ps
 ```
 
 ### Viewing Log Files