Merge pull request #2 from Conjur-Enterprise/fix-compose

CNJR-2127: Update docker compose syntax

Author: gl-johnson

CONTRIBUTING.md

@@ -64,8 +64,8 @@ The file `docker-compose.yml` is a self-contained development environment for th
 To bring it up, run:
 
 ```sh-session
-$ docker-compose build
-$ docker-compose up -d pg conjur_4 conjur_5
+$ docker compose build
+$ docker compose up -d pg conjur_4 conjur_5
 ```
 
 Then configure the v4 and v5 servers:
@@ -82,7 +82,7 @@ $ ./ci/configure_v5.sh
 Obtain the API key for the v5 admin user:
 
 ```
-$ docker-compose exec conjur_5 rake 'role:retrieve-key[cucumber:user:admin]'
+$ docker compose exec conjur_5 rake 'role:retrieve-key[cucumber:user:admin]'
 3aezp05q3wkem3hmegymwzz8wh3bs3dr6xx3y3m2q41k5ymebkc
 ```
 
@@ -91,7 +91,7 @@ The password of the v4 admin user is "secret".
 Now you can run the client `dev` container:
 
 ```sh-session
-$ docker-compose run --rm dev
+$ docker compose run --rm dev
 ```
 
 This gives you a shell session with `conjur_4` and `conjur_5` available as linked containers.
@@ -115,7 +115,7 @@ $ bundle exec ./example/demo_v4.rb
 To bring it down, run:
 
 ```sh-session
-$ docker-compose down
+$ docker compose down
 ```
 
 ## Releasing

ci/configure_v4.sh

@@ -1,6 +1,6 @@
 #!/bin/bash -e
 
-cat << "CONFIGURE" | docker exec -i $(docker-compose ps -q conjur_4) bash
+cat << "CONFIGURE" | docker exec -i $(docker compose ps -q conjur_4) bash
 set -e
 
 /opt/conjur/evoke/bin/wait_for_conjur
@@ -9,4 +9,4 @@ evoke ca regenerate conjur_4
 env CONJUR_AUTHN_LOGIN=admin CONJUR_AUTHN_API_KEY=secret conjur policy load --as-group security_admin /etc/policy.yml
 CONFIGURE
 
-docker cp $(docker-compose ps -q conjur_4):/opt/conjur/etc/ssl/ca.pem ./tmp/conjur.pem
+docker cp $(docker compose ps -q conjur_4):/opt/conjur/etc/ssl/ca.pem ./tmp/conjur.pem

ci/configure_v5.sh

@@ -2,7 +2,7 @@
 
 source ./ci/oauth/keycloak/keycloak_functions.sh
 
-cat << "CONFIGURE" | docker exec -i $(docker-compose ps -q conjur_5) bash
+cat << "CONFIGURE" | docker exec -i $(docker compose ps -q conjur_5) bash
 set -e
 
 for _ in $(seq 20); do

ci/oauth/keycloak/keycloak_functions.sh

@@ -12,7 +12,7 @@ function _hydrate_keycloak_env_args() {
     set -o pipefail
     # Note: This prints all lines that look like:
     # KEYCLOAK_XXX=someval
-    docker-compose exec -T ${KEYCLOAK_SERVICE_NAME} printenv | awk '/KEYCLOAK/'
+    docker compose exec -T ${KEYCLOAK_SERVICE_NAME} printenv | awk '/KEYCLOAK/'
   )
 
   # shellcheck disable=SC2034
@@ -30,22 +30,22 @@ function _hydrate_keycloak_env_args() {
 # _create_keycloak_user '$APP_USER' '$APP_PW' '$APP_EMAIL'
 #
 # This is because those variables are not available to this script. They are
-# available to bash commands run via "docker-compose exec keycloak bash
+# available to bash commands run via "docker compose exec keycloak bash
 # -c...", since they're defined in the docker-compose.yml.
 function _create_keycloak_user() {
   local user_var=$1
   local pw_var=$2
   local email_var=$3
 
-  docker-compose exec -T \
+  docker compose exec -T \
     ${KEYCLOAK_SERVICE_NAME} \
     bash -c "/scripts/create_user \"$user_var\" \"$pw_var\" \"$email_var\""
 }
 
 function create_keycloak_users() {
   echo "Defining keycloak client"
 
-  docker-compose exec -T ${KEYCLOAK_SERVICE_NAME} /scripts/create_client
+  docker compose exec -T ${KEYCLOAK_SERVICE_NAME} /scripts/create_client
 
   echo "Creating user 'alice' in Keycloak"
 
@@ -58,14 +58,14 @@ function create_keycloak_users() {
 }
 
 function wait_for_keycloak_server() {
-  docker-compose exec -T \
+  docker compose exec -T \
     ${KEYCLOAK_SERVICE_NAME} /scripts/wait_for_server
 }
 
 function fetch_keycloak_certificate() {
   # there's a dep on the docker-compose.yml volumes.
   # Fetch SSL cert to communicate with keycloak (OIDC provider).
   echo "Initialize keycloak certificate in conjur server"
-  docker-compose exec -T \
+  docker compose exec -T \
     conjur_5 /scripts/fetch_certificate
 }

dev/start

@@ -1,22 +1,22 @@
 #!/bin/bash -ex
 
 function v5_development() {
-  docker-compose up -d --no-deps conjur_5 pg gem client
+  docker compose up -d --no-deps conjur_5 pg gem client
 
-  docker-compose exec -T conjur_5 conjurctl wait
+  docker compose exec -T conjur_5 conjurctl wait
 
-  local api_key=$(docker-compose exec -T conjur_5 rake 'role:retrieve-key[cucumber:user:admin]')
-  api_key=$(docker-compose exec -T conjur_5 conjurctl role retrieve-key cucumber:user:admin | tr -d '\r')
+  local api_key=$(docker compose exec -T conjur_5 rake 'role:retrieve-key[cucumber:user:admin]')
+  api_key=$(docker compose exec -T conjur_5 conjurctl role retrieve-key cucumber:user:admin | tr -d '\r')
 
-  docker exec -e CONJUR_AUTHN_API_KEY="$api_key" -it --detach-keys 'ctrl-\' $(docker-compose ps -q gem) bash
+  docker exec -e CONJUR_AUTHN_API_KEY="$api_key" -it --detach-keys 'ctrl-\' $(docker compose ps -q gem) bash
 }
 
 # Set up VERSION file for local development
 if [ ! -f "../VERSION" ]; then
   echo -n "0.0.dev" > ../VERSION
 fi
 
-docker-compose pull
-docker-compose build
+docker compose pull
+docker compose build
 
 v5_development

dev/stop

@@ -2,4 +2,4 @@
 
 echo 'Removing test environment'
 echo '---'
-docker-compose down --rmi 'local' --volumes
+docker compose down --rmi 'local' --volumes

test.sh

@@ -10,7 +10,7 @@ TOP_LEVEL=$(git rev-parse --show-toplevel)
 function finish {
   echo 'Removing test environment'
   echo '---'
-  docker-compose down --rmi 'local' --volumes
+  docker compose down --rmi 'local' --volumes
 }
 
 trap finish EXIT
@@ -41,20 +41,20 @@ function startConjur() {
   # failing to ensure that has caused many mysterious failures in CI.
   # However, unconditionally pulling prevents working offline even
   # with a warm cache. So try to pull, but ignore failures.
-  docker-compose pull --ignore-pull-failures
-  docker-compose build --build-arg RUBY_VERSION="$RUBY_VERSION"
-  docker-compose up -d pg conjur_4 conjur_5
+  docker compose pull --ignore-pull-failures
+  docker compose build --build-arg RUBY_VERSION="$RUBY_VERSION"
+  docker compose up -d pg conjur_4 conjur_5
 }
 
 function runTests_5() {
   echo 'Waiting for Conjur v5 to come up, and configuring it...'
   ./ci/configure_v5.sh
 
-  local api_key=$(docker-compose exec -T conjur_5 rake 'role:retrieve-key[cucumber:user:admin]')
+  local api_key=$(docker compose exec -T conjur_5 rake 'role:retrieve-key[cucumber:user:admin]')
 
   echo 'Running tests'
   echo '-----'
-  docker-compose run --rm \
+  docker compose run --rm \
     -e CONJUR_AUTHN_API_KEY="$api_key" \
     -e SSL_CERT_FILE=/etc/ssl/certs/keycloak.pem \
     tester_5 \
@@ -65,11 +65,11 @@ function runTests_4() {
   echo 'Waiting for Conjur v4 to come up, and configuring it...'
   ./ci/configure_v4.sh
 
-  local api_key=$(docker-compose exec -T conjur_4 su conjur -c "conjur-plugin-service authn env RAILS_ENV=appliance rails r \"puts User['admin'].api_key\" 2>/dev/null")
+  local api_key=$(docker compose exec -T conjur_4 su conjur -c "conjur-plugin-service authn env RAILS_ENV=appliance rails r \"puts User['admin'].api_key\" 2>/dev/null")
 
   echo 'Running tests'
   echo '-----'
-  docker-compose run --rm \
+  docker compose run --rm \
     -e CONJUR_AUTHN_API_KEY="$api_key" \
     tester_4 rake jenkins_cucumber_v4
 }