From 03e4c519f163bdf018ea96ec1ee34269bbab4e50 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Tue, 7 Feb 2023 03:53:08 -0500 Subject: [PATCH] refactor: use DOCKER_BIN env var instead of calling docker directly This will allow us to alias the docker binary with podman for most actions - other than updating running containers. --- README.md | 2 +- common-functions | 42 +++++++++++++++++++++--------------------- docs/create.md | 2 +- functions | 26 +++++++++++++------------- install | 4 ++-- subcommands/destroy | 2 +- subcommands/upgrade | 2 +- 7 files changed, 40 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 7eeef3a..21e927f 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta" dokku postgres:create lollipop ``` -Official Postgres docker image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension. +Official Postgres "$DOCKER_BIN" image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension. ```shell dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1" diff --git a/common-functions b/common-functions index 946658b..6b3e291 100755 --- a/common-functions +++ b/common-functions @@ -94,7 +94,7 @@ docker_ports_options() { get_container_ip() { declare desc="retrieve the ip address of a container" declare CONTAINER_ID="$1" - docker container inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID" 2>/dev/null + "$DOCKER_BIN" container inspect --format '{{ .NetworkSettings.IPAddress }}' "$CONTAINER_ID" 2>/dev/null } get_database_name() { @@ -153,7 +153,7 @@ is_container_status() { declare desc="return 0 or 1 depending upon whether a given container has a certain status" declare CID="$1" STATUS="$2" local TEMPLATE="{{.State.$STATUS}}" - local CONTAINER_STATUS=$(docker container inspect -f "$TEMPLATE" "$CID" 2>/dev/null || true) + local CONTAINER_STATUS=$("$DOCKER_BIN" container inspect -f "$TEMPLATE" "$CID" 2>/dev/null || true) if [[ "$CONTAINER_STATUS" == "true" ]]; then return 0 @@ -208,7 +208,7 @@ retry-docker-command() { local i=0 success=false until [ $i -ge 100 ]; do set +e - suppress_output docker container exec "$ID" sh -c "$COMMAND" + suppress_output "$DOCKER_BIN" container exec "$ID" sh -c "$COMMAND" exit_code=$? set -e if [[ "$exit_code" == 0 ]]; then @@ -281,7 +281,7 @@ service_backup() { BACKUP_TMPDIR=$(mktemp -d --tmpdir) trap 'rm -rf "$BACKUP_TMPDIR" > /dev/null' RETURN INT TERM EXIT - docker container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" + "$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running" (service_export "$SERVICE" >"${BACKUP_TMPDIR}/export") @@ -308,7 +308,7 @@ service_backup() { fi # shellcheck disable=SC2086 - docker container run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE" + "$DOCKER_BIN" container run --rm $BACKUP_PARAMETERS "$PLUGIN_S3BACKUP_IMAGE" } service_commit_config() { @@ -444,15 +444,15 @@ service_container_rm() { local ID service_pause "$SERVICE" - ID=$(docker container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true + ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true # this may be 'true' in tests... if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then return 0 fi dokku_log_verbose_quiet "Removing container" - docker container update --restart=no "$SERVICE_NAME" >/dev/null 2>&1 - if ! docker container rm "$SERVICE_NAME" >/dev/null 2>&1; then + "$DOCKER_BIN" container update --restart=no "$SERVICE_NAME" >/dev/null 2>&1 + if ! "$DOCKER_BIN" container rm "$SERVICE_NAME" >/dev/null 2>&1; then dokku_log_fail "Unable to remove container for service $SERVICE" fi } @@ -470,13 +470,13 @@ service_enter() { local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local ID="$(cat "$SERVICE_ROOT/ID")" - docker container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" + "$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running" local EXEC_CMD="" has_tty && local DOKKU_RUN_OPTS+=" -i -t" # shellcheck disable=SC2086 - docker container exec $DOKKU_RUN_OPTS $ID $EXEC_CMD "${@:-/bin/bash}" + "$DOCKER_BIN" container exec $DOKKU_RUN_OPTS $ID $EXEC_CMD "${@:-/bin/bash}" } service_exists() { @@ -509,7 +509,7 @@ service_image_exists() { [[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && plugin_image_version="$(cat "$SERVICE_ROOT/IMAGE_VERSION")" local IMAGE="$plugin_image:$plugin_image_version" - if [[ "$(docker image ls -q "$IMAGE" 2>/dev/null)" == "" ]]; then + if [[ "$("$DOCKER_BIN" image ls -q "$IMAGE" 2>/dev/null)" == "" ]]; then return 1 fi @@ -668,11 +668,11 @@ service_logs() { DOKKU_LOGS_ARGS+=" --follow" fi - docker container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" + "$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist" is_container_status "$ID" "Running" || dokku_log_warn "Service logs may not be output as service is not running" # shellcheck disable=SC2086 - docker container logs $DOKKU_LOGS_ARGS "$ID" 2>&1 + "$DOCKER_BIN" container logs $DOKKU_LOGS_ARGS "$ID" 2>&1 } service_parse_args() { @@ -790,7 +790,7 @@ service_port_pause() { fi local GREP_NAME="^/${EXPOSED_NAME}$" - local CONTAINER_NAME="$(docker container ps -f name="$GREP_NAME" --format "{{.Names}}")" + local CONTAINER_NAME="$("$DOCKER_BIN" container ps -f name="$GREP_NAME" --format "{{.Names}}")" if [[ -z "$CONTAINER_NAME" ]]; then if [[ "$LOG_FAIL" == "true" ]]; then dokku_log_info1 "Service $SERVICE unexposed" @@ -799,8 +799,8 @@ service_port_pause() { return fi - docker container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true - docker container rm "$EXPOSED_NAME" >/dev/null 2>&1 || true + "$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true + "$DOCKER_BIN" container rm "$EXPOSED_NAME" >/dev/null 2>&1 || true if [[ "$LOG_FAIL" == "true" ]]; then dokku_log_info1 "Service $SERVICE unexposed" fi @@ -840,7 +840,7 @@ service_port_unpause() { echo "${PORTS[@]}" >"$PORT_FILE" # shellcheck disable=SC2046 - docker container run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null + "$DOCKER_BIN" container run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null if [[ "$LOG_FAIL" == "true" ]]; then dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")" fi @@ -891,7 +891,7 @@ service_status() { local ID="$(cat "$SERVICE_ROOT/ID")" local CONTAINER_STATUS - CONTAINER_STATUS=$(docker container inspect -f "{{.State.Status}}" "$ID" 2>/dev/null || true) + CONTAINER_STATUS=$("$DOCKER_BIN" container inspect -f "{{.State.Status}}" "$ID" 2>/dev/null || true) [[ -n "$CONTAINER_STATUS" ]] && echo "$CONTAINER_STATUS" && return 0 echo "missing" && return 0 } @@ -901,12 +901,12 @@ service_pause() { declare SERVICE="$1" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_NAME="$(get_service_name "$SERVICE")" - local ID=$(docker container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true + local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true [[ -z $ID ]] && dokku_log_warn "Service is already paused" && return 0 if [[ -n $ID ]]; then dokku_log_info2_quiet "Pausing container" - docker container stop "$SERVICE_NAME" >/dev/null + "$DOCKER_BIN" container stop "$SERVICE_NAME" >/dev/null service_port_pause "$SERVICE" dokku_log_verbose_quiet "Container paused" else @@ -949,7 +949,7 @@ service_version() { declare desc="display the running version for an image" declare SERVICE="$1" local SERVICE_NAME="$(get_service_name "$SERVICE")" - docker container inspect -f '{{.Config.Image}}' "$SERVICE_NAME" 2>/dev/null || true + "$DOCKER_BIN" container inspect -f '{{.Config.Image}}' "$SERVICE_NAME" 2>/dev/null || true } update_plugin_scheme_for_app() { diff --git a/docs/create.md b/docs/create.md index 0097076..1d70706 100644 --- a/docs/create.md +++ b/docs/create.md @@ -1,4 +1,4 @@ -Official Postgres docker image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension. +Official Postgres "$DOCKER_BIN" image ls does not include postgis extension (amongst others). The following example creates a new postgres service using `postgis/postgis:13-3.1` image, which includes the `postgis` extension. ```shell dokku postgres:create postgis-database --image "postgis/postgis" --image-version "13-3.1" diff --git a/functions b/functions index 0464882..eeb22e4 100755 --- a/functions +++ b/functions @@ -17,7 +17,7 @@ service_connect() { local SERVICE_TTY_OPTS has_tty && SERVICE_TTY_OPTS="-t" - docker container exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME" + "$DOCKER_BIN" container exec --env=LANG=C.UTF-8 --env=LC_ALL=C.UTF-8 -i $SERVICE_TTY_OPTS "$SERVICE_NAME" psql -h localhost -U postgres "$DATABASE_NAME" } service_create() { @@ -37,7 +37,7 @@ service_create() { dokku_log_warn "$PLUGIN_SERVICE service creation failed" exit 1 fi - docker image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed" + "$DOCKER_BIN" image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed" fi plugn trigger service-action pre-create "$PLUGIN_COMMAND_PREFIX" "$SERVICE" @@ -87,21 +87,21 @@ service_create_container() { [[ -f "$SERVICE_ROOT/IMAGE_VERSION" ]] && PLUGIN_IMAGE_VERSION="$(cat "$SERVICE_ROOT/IMAGE_VERSION")" # shellcheck disable=SC2086 - ID=$(docker container run --name "$SERVICE_NAME" $MEMORY_LIMIT $SHM_SIZE -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -e "POSTGRES_PASSWORD=$PASSWORD" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=postgres "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" $CONFIG_OPTIONS) + ID=$("$DOCKER_BIN" container run --name "$SERVICE_NAME" $MEMORY_LIMIT $SHM_SIZE -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" -e "POSTGRES_PASSWORD=$PASSWORD" --env-file="$SERVICE_ROOT/ENV" -d --restart always --label dokku=service --label dokku.service=postgres "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" $CONFIG_OPTIONS) echo "$ID" >"$SERVICE_ROOT/ID" dokku_log_verbose_quiet "Waiting for container to be ready" - docker container run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" "$PLUGIN_WAIT_IMAGE" -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null + "$DOCKER_BIN" container run --rm --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" "$PLUGIN_WAIT_IMAGE" -p "$PLUGIN_DATASTORE_WAIT_PORT" >/dev/null dokku_log_verbose_quiet "Creating container database" - docker container exec "$SERVICE_NAME" su - postgres -c "createdb -E utf8 $DATABASE_NAME" 2>/dev/null || dokku_log_verbose_quiet 'Already exists' + "$DOCKER_BIN" container exec "$SERVICE_NAME" su - postgres -c "createdb -E utf8 $DATABASE_NAME" 2>/dev/null || dokku_log_verbose_quiet 'Already exists' dokku_log_verbose_quiet "Securing connection to database" service_pause "$SERVICE" >/dev/null - docker container run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s <"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &>/dev/null + "$DOCKER_BIN" container run --rm -i -v "$SERVICE_HOST_ROOT/data:/var/lib/postgresql/data" "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" bash -s <"$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/scripts/enable_ssl.sh" &>/dev/null - PREVIOUS_ID=$(docker container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true - docker container start "$PREVIOUS_ID" >/dev/null + PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true + "$DOCKER_BIN" container start "$PREVIOUS_ID" >/dev/null service_port_unpause "$SERVICE" dokku_log_info2 "$PLUGIN_SERVICE container created: $SERVICE" @@ -116,7 +116,7 @@ service_export() { local PASSWORD="$(service_password "$SERVICE")" [[ -n $SSH_TTY ]] && stty -opost - docker container exec "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w "$DATABASE_NAME" + "$DOCKER_BIN" container exec "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_dump -Fc --no-acl --no-owner -h localhost -U postgres -w "$DATABASE_NAME" status=$? [[ -n $SSH_TTY ]] && stty opost exit $status @@ -133,7 +133,7 @@ service_import() { if [[ -t 0 ]]; then dokku_log_fail "No data provided on stdin." fi - docker container exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO --if-exists -d "$DATABASE_NAME" -U postgres -w + "$DOCKER_BIN" container exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO --if-exists -d "$DATABASE_NAME" -U postgres -w } service_start() { @@ -141,7 +141,7 @@ service_start() { local QUIET="$2" local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE" local SERVICE_NAME="$(get_service_name "$SERVICE")" - local ID=$(docker container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true + local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true if [[ -n $ID ]]; then [[ -z $QUIET ]] && dokku_log_warn "Service is already started" if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then @@ -152,11 +152,11 @@ service_start() { fi dokku_log_info2_quiet "Starting container" - local PREVIOUS_ID=$(docker container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true + local PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true local PASSWORD="$(service_password "$SERVICE")" if [[ -n $PREVIOUS_ID ]]; then - docker container start "$PREVIOUS_ID" >/dev/null + "$DOCKER_BIN" container start "$PREVIOUS_ID" >/dev/null service_port_unpause "$SERVICE" dokku_log_info2 "Container started" elif service_image_exists "$SERVICE" && [[ -n "$PASSWORD" ]]; then diff --git a/install b/install index 5a569da..32b4161 100755 --- a/install +++ b/install @@ -12,8 +12,8 @@ plugin-install() { echo " ! docker image pull ${IMAGE}" 1>&2 return fi - if [[ "$(docker image ls -q "${IMAGE}" 2>/dev/null)" == "" ]]; then - docker image pull "${IMAGE}" + if [[ "$("$DOCKER_BIN" image ls -q "${IMAGE}" 2>/dev/null)" == "" ]]; then + "$DOCKER_BIN" image pull "${IMAGE}" fi } diff --git a/subcommands/destroy b/subcommands/destroy index 11bf607..1294b8a 100755 --- a/subcommands/destroy +++ b/subcommands/destroy @@ -46,7 +46,7 @@ service-destroy-cmd() { service_container_rm "$SERVICE" dokku_log_verbose_quiet "Removing data" - docker container run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/config" "$PLUGIN_BUSYBOX_IMAGE" chmod 777 -R /config /data + "$DOCKER_BIN" container run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/config" "$PLUGIN_BUSYBOX_IMAGE" chmod 777 -R /config /data rm -rf "$SERVICE_ROOT" plugn trigger service-action post-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" diff --git a/subcommands/upgrade b/subcommands/upgrade index 717d525..880f7cd 100755 --- a/subcommands/upgrade +++ b/subcommands/upgrade @@ -45,7 +45,7 @@ service-upgrade-cmd() { dokku_log_warn "$PLUGIN_SERVICE service $SERVICE upgrade failed" exit 1 fi - docker image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed" + "$DOCKER_BIN" image pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed" fi service_commit_config "$SERVICE"