Refactor common functions into separate file
This commit is contained in:
382
common-functions
Executable file
382
common-functions
Executable file
@@ -0,0 +1,382 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
||||||
|
|
||||||
|
docker_ports_options() {
|
||||||
|
local PORTS=("$@")
|
||||||
|
for (( i=0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++ )); do
|
||||||
|
echo -n "-p ${PORTS[i]}:${PLUGIN_DATASTORE_PORTS[i]} "
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
get_random_ports() {
|
||||||
|
local iterations="${1:-1}"
|
||||||
|
for (( i=0; i < iterations; i++ )); do
|
||||||
|
local port=$RANDOM
|
||||||
|
local quit=0
|
||||||
|
while [ "$quit" -ne 1 ]; do
|
||||||
|
netstat -an | grep $port > /dev/null
|
||||||
|
if [ $? -gt 0 ]; then
|
||||||
|
quit=1
|
||||||
|
else
|
||||||
|
port=$((port + 1))
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
echo $port
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
get_container_ip() {
|
||||||
|
docker inspect --format '{{ .NetworkSettings.IPAddress }}' "$1"
|
||||||
|
}
|
||||||
|
|
||||||
|
get_database_name() {
|
||||||
|
# some datastores do not like special characters in database names
|
||||||
|
# so we need to normalize them out
|
||||||
|
echo "$1" | tr .- _
|
||||||
|
}
|
||||||
|
|
||||||
|
get_service_name() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
echo "dokku.${PLUGIN_COMMAND_PREFIX}.$SERVICE"
|
||||||
|
}
|
||||||
|
|
||||||
|
get_url_from_config() {
|
||||||
|
local EXISTING_CONFIG="$1"
|
||||||
|
local CONFIG_VAR="$2"
|
||||||
|
echo "$EXISTING_CONFIG" | grep "$CONFIG_VAR" | sed "s/$CONFIG_VAR:\s*//" | xargs
|
||||||
|
}
|
||||||
|
|
||||||
|
is_container_status() {
|
||||||
|
local CID="$1"
|
||||||
|
local TEMPLATE="{{.State.$2}}"
|
||||||
|
local CONTAINER_STATUS=$(docker inspect -f "$TEMPLATE" "$CID" || true)
|
||||||
|
|
||||||
|
if [[ "$CONTAINER_STATUS" == "true" ]]; then
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
promote() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local APP="$2"
|
||||||
|
local PLUGIN_DEFAULT_CONFIG_VAR="${PLUGIN_DEFAULT_ALIAS}_URL"
|
||||||
|
local EXISTING_CONFIG=$(config_all "$APP")
|
||||||
|
update_plugin_scheme_for_app "$APP"
|
||||||
|
local SERVICE_URL=$(service_url "$SERVICE")
|
||||||
|
local CONFIG_VARS=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
|
||||||
|
local PREVIOUS_DEFAULT_URL=$(get_url_from_config "$EXISTING_CONFIG" "$PLUGIN_DEFAULT_CONFIG_VAR")
|
||||||
|
|
||||||
|
[[ -z ${CONFIG_VARS[*]} ]] && dokku_log_fail "Not linked to app $APP"
|
||||||
|
[[ ${CONFIG_VARS[*]} =~ $PLUGIN_DEFAULT_CONFIG_VAR ]] && dokku_log_fail "Service $1 already promoted as $PLUGIN_DEFAULT_CONFIG_VAR"
|
||||||
|
|
||||||
|
local NEW_CONFIG_VARS=""
|
||||||
|
if [[ -n $PREVIOUS_DEFAULT_URL ]]; then
|
||||||
|
local PREVIOUS_ALIAS=$(echo "$EXISTING_CONFIG" | grep "$PREVIOUS_DEFAULT_URL" | grep -v "$PLUGIN_DEFAULT_CONFIG_VAR") || true
|
||||||
|
if [[ -z $PREVIOUS_ALIAS ]]; then
|
||||||
|
local ALIAS=$(service_alternative_alias "$EXISTING_CONFIG")
|
||||||
|
NEW_CONFIG_VARS+="${ALIAS}_URL=$PREVIOUS_DEFAULT_URL "
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
local PROMOTE_URL=$(get_url_from_config "$EXISTING_CONFIG" "${CONFIG_VARS[0]}")
|
||||||
|
NEW_CONFIG_VARS+="$PLUGIN_DEFAULT_CONFIG_VAR=$PROMOTE_URL"
|
||||||
|
|
||||||
|
# shellcheck disable=SC2086
|
||||||
|
config_set "$APP" $NEW_CONFIG_VARS
|
||||||
|
}
|
||||||
|
|
||||||
|
remove_from_links_file() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local APP="$2"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
|
|
||||||
|
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
||||||
|
touch "$LINKS_FILE"
|
||||||
|
sed -i.bak "/^$APP\$/d" "$LINKS_FILE" && rm "$LINKS_FILE.bak"
|
||||||
|
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
||||||
|
}
|
||||||
|
|
||||||
|
verify_service_name() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
[[ ! -n "$SERVICE" ]] && dokku_log_fail "(verify_service_name) SERVICE must not be null"
|
||||||
|
[[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] && dokku_log_fail "$PLUGIN_SERVICE service $SERVICE does not exist"
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
service_alias() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
echo "$SERVICE_NAME" | tr ._ -
|
||||||
|
}
|
||||||
|
|
||||||
|
service_alternative_alias() {
|
||||||
|
local EXISTING_CONFIG="$1"
|
||||||
|
local COLORS=(AQUA BLACK BLUE FUCHSIA GRAY GREEN LIME MAROON NAVY OLIVE PURPLE RED SILVER TEAL WHITE YELLOW)
|
||||||
|
local ALIAS;
|
||||||
|
|
||||||
|
while [[ -z $ALIAS ]]; do
|
||||||
|
local IDX=$((RANDOM % ${#COLORS[*]}))
|
||||||
|
local COLOR=${COLORS[IDX]}
|
||||||
|
ALIAS="${PLUGIN_ALT_ALIAS}_${COLOR}"
|
||||||
|
local IN_USE=$(echo "$EXISTING_CONFIG" | grep "${ALIAS}_URL")
|
||||||
|
if [[ -n $IN_USE ]]; then
|
||||||
|
unset ALIAS
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
echo "$ALIAS"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_exposed_ports() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
|
[[ ! -f $PORT_FILE ]] && echo '-' && return 0
|
||||||
|
local PORTS=($(cat "$PORT_FILE"))
|
||||||
|
for (( i=0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++ )); do
|
||||||
|
echo -n "${PLUGIN_DATASTORE_PORTS[i]}->${PORTS[i]} "
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
service_info() {
|
||||||
|
local SERVICE="$1" INFO_FLAG="$2"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local SERVICE_URL=$(service_url "$SERVICE")
|
||||||
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
|
local SERVICE_CONTAINER_ID="$(cat "$SERVICE_ROOT/ID")"
|
||||||
|
local flag key valid_flags
|
||||||
|
|
||||||
|
local flag_map=(
|
||||||
|
"--config-dir: ${SERVICE_ROOT}/config"
|
||||||
|
"--data-dir: ${SERVICE_ROOT}/data"
|
||||||
|
"--dsn: ${SERVICE_URL}"
|
||||||
|
"--exposed-ports: $(service_exposed_ports "$SERVICE")"
|
||||||
|
"--id: ${SERVICE_CONTAINER_ID}"
|
||||||
|
"--internal-ip: $(get_container_ip "${SERVICE_CONTAINER_ID}")"
|
||||||
|
"--links: $(service_linked_apps "$SERVICE")"
|
||||||
|
"--status: $(service_status "$SERVICE")"
|
||||||
|
"--version: $(service_version "$SERVICE")"
|
||||||
|
)
|
||||||
|
if [[ -z "$INFO_FLAG" ]]; then
|
||||||
|
dokku_log_info2 "Container Information"
|
||||||
|
for flag in "${flag_map[@]}"; do
|
||||||
|
key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
|
||||||
|
dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
|
||||||
|
done
|
||||||
|
else
|
||||||
|
local match=false
|
||||||
|
for flag in "${flag_map[@]}"; do
|
||||||
|
valid_flags="${valid_flags} $(echo "$flag" | cut -d':' -f1)"
|
||||||
|
if [[ "$flag" == "${INFO_FLAG}:"* ]]; then
|
||||||
|
echo "${flag#*: }" && match=true
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
[[ "$match" == "true" ]] || dokku_log_fail "Invalid flag passed, valid flags:${valid_flags}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
service_link() {
|
||||||
|
local APP="$2"
|
||||||
|
local SERVICE="$1"
|
||||||
|
update_plugin_scheme_for_app "$APP"
|
||||||
|
local SERVICE_URL=$(service_url "$SERVICE")
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local EXISTING_CONFIG=$(config_all "$APP")
|
||||||
|
local LINK=$(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1) || true
|
||||||
|
local DEFAULT_ALIAS=$(echo "$EXISTING_CONFIG" | grep "${PLUGIN_DEFAULT_ALIAS}_URL") || true
|
||||||
|
local SERVICE_ALIAS=$(service_alias "$SERVICE")
|
||||||
|
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
|
|
||||||
|
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
|
||||||
|
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
||||||
|
touch "$LINKS_FILE"
|
||||||
|
echo "$APP" >> "$LINKS_FILE"
|
||||||
|
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
||||||
|
|
||||||
|
local ALIAS="$PLUGIN_DEFAULT_ALIAS"
|
||||||
|
if [[ -n $DEFAULT_ALIAS ]]; then
|
||||||
|
ALIAS=$(service_alternative_alias "$EXISTING_CONFIG")
|
||||||
|
fi
|
||||||
|
|
||||||
|
if declare -f -F add_passed_docker_option > /dev/null; then
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
local passed_phases=(build deploy run)
|
||||||
|
add_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
||||||
|
else
|
||||||
|
dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
||||||
|
fi
|
||||||
|
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_linked_apps() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
||||||
|
|
||||||
|
[[ -z $(< "$LINKS_FILE") ]] && echo '-' && return 0
|
||||||
|
|
||||||
|
tr '\n' ' ' < "$LINKS_FILE"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_list() {
|
||||||
|
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2> /dev/null)
|
||||||
|
if [[ -z $SERVICES ]]; then
|
||||||
|
dokku_log_warn "There are no $PLUGIN_SERVICE services"
|
||||||
|
else
|
||||||
|
LIST="NAME,VERSION,STATUS,EXPOSED PORTS,LINKS\n"
|
||||||
|
for SERVICE in $SERVICES; do
|
||||||
|
LIST+="$SERVICE,$(service_version "$SERVICE"),$(service_status "$SERVICE"),$(service_exposed_ports "$SERVICE"),$(service_linked_apps "$SERVICE")\n"
|
||||||
|
done
|
||||||
|
printf "%b" "$LIST" | column -t -s,
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
service_logs() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local ID=$(cat "$SERVICE_ROOT/ID")
|
||||||
|
|
||||||
|
if [[ $2 == "-t" ]]; then
|
||||||
|
DOKKU_LOGS_ARGS="--follow"
|
||||||
|
else
|
||||||
|
DOKKU_LOGS_ARGS="--tail 100"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# shellcheck disable=SC2086
|
||||||
|
docker logs $DOKKU_LOGS_ARGS "$ID"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_set_alias() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local ALIAS_FILE="$SERVICE_ROOT/ALIAS"
|
||||||
|
|
||||||
|
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
||||||
|
touch "$ALIAS_FILE"
|
||||||
|
echo "$2" > "$ALIAS_FILE"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_status() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local ID="$(cat "$SERVICE_ROOT/ID")"
|
||||||
|
|
||||||
|
is_container_status "$ID" "Dead" && echo "dead" && return 0
|
||||||
|
is_container_status "$ID" "OOMKilled" && echo "oomkilled" && return 0
|
||||||
|
is_container_status "$ID" "Paused" && echo "paused" && return 0
|
||||||
|
is_container_status "$ID" "Restarting" && echo "restarting" && return 0
|
||||||
|
is_container_status "$ID" "Running" && echo "running" && return 0
|
||||||
|
echo "stopped" && return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
service_port_expose() {
|
||||||
|
service_start "$1" "true"
|
||||||
|
service_port_unpause "$1" "true" "${@:2}"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_port_pause() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
|
||||||
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
|
local LOG_FAIL="$2"
|
||||||
|
|
||||||
|
if [[ "$LOG_FAIL" == "true" ]]; then
|
||||||
|
[[ ! -f "$PORT_FILE" ]] && dokku_log_fail "Service not exposed"
|
||||||
|
else
|
||||||
|
[[ ! -f "$PORT_FILE" ]] && return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
docker stop "$EXPOSED_NAME" > /dev/null
|
||||||
|
docker rm "$EXPOSED_NAME" > /dev/null
|
||||||
|
if [[ "$LOG_FAIL" == "true" ]]; then
|
||||||
|
dokku_log_info1 "Service $SERVICE unexposed"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
service_port_unexpose() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
|
service_port_pause "$SERVICE" "true"
|
||||||
|
rm -rf "$PORT_FILE"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_port_unpause() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
local EXPOSED_NAME="${SERVICE_NAME}.ambassador"
|
||||||
|
local PORT_FILE="$SERVICE_ROOT/PORT"
|
||||||
|
local LOG_FAIL="$2"
|
||||||
|
# shellcheck disable=SC2068
|
||||||
|
local PORTS=(${@:3})
|
||||||
|
# shellcheck disable=SC2068
|
||||||
|
PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})})
|
||||||
|
local ID=$(cat "$SERVICE_ROOT/ID")
|
||||||
|
|
||||||
|
[[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}"
|
||||||
|
|
||||||
|
if [[ "$LOG_FAIL" == "true" ]]; then
|
||||||
|
[[ -f "$PORT_FILE" ]] && PORTS=($(cat "$PORT_FILE")) && dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}"
|
||||||
|
else
|
||||||
|
[[ ! -f "$PORT_FILE" ]] && return 0
|
||||||
|
PORTS=($(cat "$PORT_FILE"))
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "${PORTS[@]}" > "$PORT_FILE"
|
||||||
|
|
||||||
|
# shellcheck disable=SC2046
|
||||||
|
docker 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" svendowideit/ambassador > /dev/null
|
||||||
|
if [[ "$LOG_FAIL" == "true" ]]; then
|
||||||
|
dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
service_stop() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE";
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
local ID=$(docker ps -f status=running | grep -e "$SERVICE_NAME$" | awk '{print $1}') || true
|
||||||
|
[[ -z $ID ]] && dokku_log_warn "Service is already stopped" && return 0
|
||||||
|
|
||||||
|
if [[ -n $ID ]]; then
|
||||||
|
dokku_log_info1_quiet "Stopping container"
|
||||||
|
docker stop "$SERVICE_NAME" > /dev/null
|
||||||
|
service_port_pause "$SERVICE"
|
||||||
|
dokku_log_info2 "Container stopped"
|
||||||
|
else
|
||||||
|
dokku_log_verbose_quiet "No container exists for $SERVICE"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
service_unlink() {
|
||||||
|
local APP="$2"
|
||||||
|
local SERVICE="$1"
|
||||||
|
update_plugin_scheme_for_app "$APP"
|
||||||
|
local SERVICE_URL=$(service_url "$SERVICE")
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
local EXISTING_CONFIG=$(config_all "$APP")
|
||||||
|
local SERVICE_ALIAS=$(service_alias "$SERVICE")
|
||||||
|
local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
|
||||||
|
|
||||||
|
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
|
||||||
|
remove_from_links_file "$SERVICE" "$APP"
|
||||||
|
|
||||||
|
if declare -f -F add_passed_docker_option > /dev/null; then
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
local passed_phases=(build deploy run)
|
||||||
|
remove_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
||||||
|
else
|
||||||
|
dokku docker-options:remove "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
||||||
|
fi
|
||||||
|
config_unset "$APP" "${LINK[*]}"
|
||||||
|
}
|
||||||
|
|
||||||
|
service_version() {
|
||||||
|
local SERVICE="$1"
|
||||||
|
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
||||||
|
docker inspect -f '{{.Config.Image}}' "$SERVICE_NAME"
|
||||||
|
}
|
||||||
375
functions
375
functions
@@ -1,385 +1,12 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
|
||||||
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
|
||||||
source "$PLUGIN_AVAILABLE_PATH/config/functions"
|
source "$PLUGIN_AVAILABLE_PATH/config/functions"
|
||||||
if [[ -f "$PLUGIN_AVAILABLE_PATH/docker-options/functions" ]]; then
|
if [[ -f "$PLUGIN_AVAILABLE_PATH/docker-options/functions" ]]; then
|
||||||
source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
|
source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
docker_ports_options() {
|
|
||||||
local PORTS=("$@")
|
|
||||||
for (( i=0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++ )); do
|
|
||||||
echo -n "-p ${PORTS[i]}:${PLUGIN_DATASTORE_PORTS[i]} "
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
get_random_ports() {
|
|
||||||
local iterations="${1:-1}"
|
|
||||||
for (( i=0; i < iterations; i++ )); do
|
|
||||||
local port=$RANDOM
|
|
||||||
local quit=0
|
|
||||||
while [ "$quit" -ne 1 ]; do
|
|
||||||
netstat -an | grep $port > /dev/null
|
|
||||||
if [ $? -gt 0 ]; then
|
|
||||||
quit=1
|
|
||||||
else
|
|
||||||
port=$((port + 1))
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
echo $port
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
get_container_ip() {
|
|
||||||
docker inspect --format '{{ .NetworkSettings.IPAddress }}' "$1"
|
|
||||||
}
|
|
||||||
|
|
||||||
get_service_name() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
echo "dokku.${PLUGIN_COMMAND_PREFIX}.$SERVICE"
|
|
||||||
}
|
|
||||||
|
|
||||||
get_url_from_config() {
|
|
||||||
local EXISTING_CONFIG="$1"
|
|
||||||
local CONFIG_VAR="$2"
|
|
||||||
echo "$EXISTING_CONFIG" | grep "$CONFIG_VAR" | sed "s/$CONFIG_VAR:\s*//" | xargs
|
|
||||||
}
|
|
||||||
|
|
||||||
is_container_status() {
|
|
||||||
local CID="$1"
|
|
||||||
local TEMPLATE="{{.State.$2}}"
|
|
||||||
local CONTAINER_STATUS=$(docker inspect -f "$TEMPLATE" "$CID" || true)
|
|
||||||
|
|
||||||
if [[ "$CONTAINER_STATUS" == "true" ]]; then
|
|
||||||
return 0
|
|
||||||
else
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
promote() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local APP="$2"
|
|
||||||
local PLUGIN_DEFAULT_CONFIG_VAR="${PLUGIN_DEFAULT_ALIAS}_URL"
|
|
||||||
local EXISTING_CONFIG=$(config_all "$APP")
|
|
||||||
update_plugin_scheme_for_app "$APP"
|
|
||||||
local SERVICE_URL=$(service_url "$SERVICE")
|
|
||||||
local CONFIG_VARS=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
|
|
||||||
local PREVIOUS_DEFAULT_URL=$(get_url_from_config "$EXISTING_CONFIG" "$PLUGIN_DEFAULT_CONFIG_VAR")
|
|
||||||
|
|
||||||
[[ -z ${CONFIG_VARS[*]} ]] && dokku_log_fail "Not linked to app $APP"
|
|
||||||
[[ ${CONFIG_VARS[*]} =~ $PLUGIN_DEFAULT_CONFIG_VAR ]] && dokku_log_fail "Service $1 already promoted as $PLUGIN_DEFAULT_CONFIG_VAR"
|
|
||||||
|
|
||||||
local NEW_CONFIG_VARS=""
|
|
||||||
if [[ -n $PREVIOUS_DEFAULT_URL ]]; then
|
|
||||||
local PREVIOUS_ALIAS=$(echo "$EXISTING_CONFIG" | grep "$PREVIOUS_DEFAULT_URL" | grep -v "$PLUGIN_DEFAULT_CONFIG_VAR") || true
|
|
||||||
if [[ -z $PREVIOUS_ALIAS ]]; then
|
|
||||||
local ALIAS=$(service_alternative_alias "$EXISTING_CONFIG")
|
|
||||||
NEW_CONFIG_VARS+="${ALIAS}_URL=$PREVIOUS_DEFAULT_URL "
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
local PROMOTE_URL=$(get_url_from_config "$EXISTING_CONFIG" "${CONFIG_VARS[0]}")
|
|
||||||
NEW_CONFIG_VARS+="$PLUGIN_DEFAULT_CONFIG_VAR=$PROMOTE_URL"
|
|
||||||
|
|
||||||
# shellcheck disable=SC2086
|
|
||||||
config_set "$APP" $NEW_CONFIG_VARS
|
|
||||||
}
|
|
||||||
|
|
||||||
remove_from_links_file() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local APP="$2"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
|
||||||
|
|
||||||
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
|
||||||
touch "$LINKS_FILE"
|
|
||||||
sed -i.bak "/^$APP\$/d" "$LINKS_FILE" && rm "$LINKS_FILE.bak"
|
|
||||||
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
|
||||||
}
|
|
||||||
|
|
||||||
verify_service_name() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
[[ ! -n "$SERVICE" ]] && dokku_log_fail "(verify_service_name) SERVICE must not be null"
|
|
||||||
[[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] && dokku_log_fail "$PLUGIN_SERVICE service $SERVICE does not exist"
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
service_alias() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
|
||||||
echo "$SERVICE_NAME" | tr ._ -
|
|
||||||
}
|
|
||||||
|
|
||||||
service_alternative_alias() {
|
|
||||||
local EXISTING_CONFIG="$1"
|
|
||||||
local COLORS=(AQUA BLACK BLUE FUCHSIA GRAY GREEN LIME MAROON NAVY OLIVE PURPLE RED SILVER TEAL WHITE YELLOW)
|
|
||||||
local ALIAS;
|
|
||||||
|
|
||||||
while [[ -z $ALIAS ]]; do
|
|
||||||
local IDX=$((RANDOM % ${#COLORS[*]}))
|
|
||||||
local COLOR=${COLORS[IDX]}
|
|
||||||
ALIAS="${PLUGIN_ALT_ALIAS}_${COLOR}"
|
|
||||||
local IN_USE=$(echo "$EXISTING_CONFIG" | grep "${ALIAS}_URL")
|
|
||||||
if [[ -n $IN_USE ]]; then
|
|
||||||
unset ALIAS
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
echo "$ALIAS"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_exposed_ports() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
|
||||||
[[ ! -f $PORT_FILE ]] && echo '-' && return 0
|
|
||||||
local PORTS=($(cat "$PORT_FILE"))
|
|
||||||
for (( i=0; i < ${#PLUGIN_DATASTORE_PORTS[@]}; i++ )); do
|
|
||||||
echo -n "${PLUGIN_DATASTORE_PORTS[i]}->${PORTS[i]} "
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
service_info() {
|
|
||||||
local SERVICE="$1" INFO_FLAG="$2"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local SERVICE_URL=$(service_url "$SERVICE")
|
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
|
||||||
local SERVICE_CONTAINER_ID="$(cat "$SERVICE_ROOT/ID")"
|
|
||||||
local flag key valid_flags
|
|
||||||
|
|
||||||
local flag_map=(
|
|
||||||
"--config-dir: ${SERVICE_ROOT}/config"
|
|
||||||
"--data-dir: ${SERVICE_ROOT}/data"
|
|
||||||
"--dsn: ${SERVICE_URL}"
|
|
||||||
"--exposed-ports: $(service_exposed_ports "$SERVICE")"
|
|
||||||
"--id: ${SERVICE_CONTAINER_ID}"
|
|
||||||
"--internal-ip: $(get_container_ip "${SERVICE_CONTAINER_ID}")"
|
|
||||||
"--links: $(service_linked_apps "$SERVICE")"
|
|
||||||
"--status: $(service_status "$SERVICE")"
|
|
||||||
"--version: $(service_version "$SERVICE")"
|
|
||||||
)
|
|
||||||
if [[ -z "$INFO_FLAG" ]]; then
|
|
||||||
dokku_log_info2 "Container Information"
|
|
||||||
for flag in "${flag_map[@]}"; do
|
|
||||||
key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
|
|
||||||
dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
|
|
||||||
done
|
|
||||||
else
|
|
||||||
local match=false
|
|
||||||
for flag in "${flag_map[@]}"; do
|
|
||||||
valid_flags="${valid_flags} $(echo "$flag" | cut -d':' -f1)"
|
|
||||||
if [[ "$flag" == "${INFO_FLAG}:"* ]]; then
|
|
||||||
echo "${flag#*: }" && match=true
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
[[ "$match" == "true" ]] || dokku_log_fail "Invalid flag passed, valid flags:${valid_flags}"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
service_link() {
|
|
||||||
local APP="$2"
|
|
||||||
local SERVICE="$1"
|
|
||||||
update_plugin_scheme_for_app "$APP"
|
|
||||||
local SERVICE_URL=$(service_url "$SERVICE")
|
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local EXISTING_CONFIG=$(config_all "$APP")
|
|
||||||
local LINK=$(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1) || true
|
|
||||||
local DEFAULT_ALIAS=$(echo "$EXISTING_CONFIG" | grep "${PLUGIN_DEFAULT_ALIAS}_URL") || true
|
|
||||||
local SERVICE_ALIAS=$(service_alias "$SERVICE")
|
|
||||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
|
||||||
|
|
||||||
[[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
|
|
||||||
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
|
||||||
touch "$LINKS_FILE"
|
|
||||||
echo "$APP" >> "$LINKS_FILE"
|
|
||||||
sort "$LINKS_FILE" -u -o "$LINKS_FILE"
|
|
||||||
|
|
||||||
local ALIAS="$PLUGIN_DEFAULT_ALIAS"
|
|
||||||
if [[ -n $DEFAULT_ALIAS ]]; then
|
|
||||||
ALIAS=$(service_alternative_alias "$EXISTING_CONFIG")
|
|
||||||
fi
|
|
||||||
|
|
||||||
if declare -f -F add_passed_docker_option > /dev/null; then
|
|
||||||
# shellcheck disable=SC2034
|
|
||||||
local passed_phases=(build deploy run)
|
|
||||||
add_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
|
||||||
else
|
|
||||||
dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
|
||||||
fi
|
|
||||||
config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_linked_apps() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local LINKS_FILE="$SERVICE_ROOT/LINKS"
|
|
||||||
|
|
||||||
[[ -z $(< "$LINKS_FILE") ]] && echo '-' && return 0
|
|
||||||
|
|
||||||
tr '\n' ' ' < "$LINKS_FILE"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_list() {
|
|
||||||
local SERVICES=$(ls "$PLUGIN_DATA_ROOT" 2> /dev/null)
|
|
||||||
if [[ -z $SERVICES ]]; then
|
|
||||||
dokku_log_warn "There are no $PLUGIN_SERVICE services"
|
|
||||||
else
|
|
||||||
LIST="NAME,VERSION,STATUS,EXPOSED PORTS,LINKS\n"
|
|
||||||
for SERVICE in $SERVICES; do
|
|
||||||
LIST+="$SERVICE,$(service_version "$SERVICE"),$(service_status "$SERVICE"),$(service_exposed_ports "$SERVICE"),$(service_linked_apps "$SERVICE")\n"
|
|
||||||
done
|
|
||||||
printf "%b" "$LIST" | column -t -s,
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
service_logs() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local ID=$(cat "$SERVICE_ROOT/ID")
|
|
||||||
|
|
||||||
if [[ $2 == "-t" ]]; then
|
|
||||||
DOKKU_LOGS_ARGS="--follow"
|
|
||||||
else
|
|
||||||
DOKKU_LOGS_ARGS="--tail 100"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# shellcheck disable=SC2086
|
|
||||||
docker logs $DOKKU_LOGS_ARGS "$ID"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_set_alias() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local ALIAS_FILE="$SERVICE_ROOT/ALIAS"
|
|
||||||
|
|
||||||
mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
|
|
||||||
touch "$ALIAS_FILE"
|
|
||||||
echo "$2" > "$ALIAS_FILE"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_status() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local ID="$(cat "$SERVICE_ROOT/ID")"
|
|
||||||
|
|
||||||
is_container_status "$ID" "Dead" && echo "dead" && return 0
|
|
||||||
is_container_status "$ID" "OOMKilled" && echo "oomkilled" && return 0
|
|
||||||
is_container_status "$ID" "Paused" && echo "paused" && return 0
|
|
||||||
is_container_status "$ID" "Restarting" && echo "restarting" && return 0
|
|
||||||
is_container_status "$ID" "Running" && echo "running" && return 0
|
|
||||||
echo "stopped" && return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
service_port_expose() {
|
|
||||||
service_start "$1" "true"
|
|
||||||
service_port_unpause "$1" "true" "${@:2}"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_port_pause() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
|
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
|
||||||
local LOG_FAIL="$2"
|
|
||||||
|
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
|
||||||
[[ ! -f "$PORT_FILE" ]] && dokku_log_fail "Service not exposed"
|
|
||||||
else
|
|
||||||
[[ ! -f "$PORT_FILE" ]] && return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
docker stop "$EXPOSED_NAME" > /dev/null
|
|
||||||
docker rm "$EXPOSED_NAME" > /dev/null
|
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
|
||||||
dokku_log_info1 "Service $SERVICE unexposed"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
service_port_unexpose() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
|
||||||
service_port_pause "$SERVICE" "true"
|
|
||||||
rm -rf "$PORT_FILE"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_port_unpause() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
|
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
|
||||||
local EXPOSED_NAME="${SERVICE_NAME}.ambassador"
|
|
||||||
local PORT_FILE="$SERVICE_ROOT/PORT"
|
|
||||||
local LOG_FAIL="$2"
|
|
||||||
# shellcheck disable=SC2068
|
|
||||||
local PORTS=(${@:3})
|
|
||||||
# shellcheck disable=SC2068
|
|
||||||
PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})})
|
|
||||||
local ID=$(cat "$SERVICE_ROOT/ID")
|
|
||||||
|
|
||||||
[[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}"
|
|
||||||
|
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
|
||||||
[[ -f "$PORT_FILE" ]] && PORTS=($(cat "$PORT_FILE")) && dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}"
|
|
||||||
else
|
|
||||||
[[ ! -f "$PORT_FILE" ]] && return 0
|
|
||||||
PORTS=($(cat "$PORT_FILE"))
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "${PORTS[@]}" > "$PORT_FILE"
|
|
||||||
|
|
||||||
# shellcheck disable=SC2046
|
|
||||||
docker 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" svendowideit/ambassador > /dev/null
|
|
||||||
if [[ "$LOG_FAIL" == "true" ]]; then
|
|
||||||
dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
service_stop() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE";
|
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
|
||||||
local ID=$(docker ps -f status=running | grep -e "$SERVICE_NAME$" | awk '{print $1}') || true
|
|
||||||
[[ -z $ID ]] && dokku_log_warn "Service is already stopped" && return 0
|
|
||||||
|
|
||||||
if [[ -n $ID ]]; then
|
|
||||||
dokku_log_info1_quiet "Stopping container"
|
|
||||||
docker stop "$SERVICE_NAME" > /dev/null
|
|
||||||
service_port_pause "$SERVICE"
|
|
||||||
dokku_log_info2 "Container stopped"
|
|
||||||
else
|
|
||||||
dokku_log_verbose_quiet "No container exists for $SERVICE"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
service_unlink() {
|
|
||||||
local APP="$2"
|
|
||||||
local SERVICE="$1"
|
|
||||||
update_plugin_scheme_for_app "$APP"
|
|
||||||
local SERVICE_URL=$(service_url "$SERVICE")
|
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
|
||||||
local EXISTING_CONFIG=$(config_all "$APP")
|
|
||||||
local SERVICE_ALIAS=$(service_alias "$SERVICE")
|
|
||||||
local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
|
|
||||||
|
|
||||||
[[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
|
|
||||||
remove_from_links_file "$SERVICE" "$APP"
|
|
||||||
|
|
||||||
if declare -f -F add_passed_docker_option > /dev/null; then
|
|
||||||
# shellcheck disable=SC2034
|
|
||||||
local passed_phases=(build deploy run)
|
|
||||||
remove_passed_docker_option passed_phases[@] "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
|
||||||
else
|
|
||||||
dokku docker-options:remove "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_ALIAS"
|
|
||||||
fi
|
|
||||||
config_unset "$APP" "${LINK[*]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
service_version() {
|
|
||||||
local SERVICE="$1"
|
|
||||||
local SERVICE_NAME="$(get_service_name "$SERVICE")"
|
|
||||||
docker inspect -f '{{.Config.Image}}' "$SERVICE_NAME"
|
|
||||||
}
|
|
||||||
|
|
||||||
# non-generic functions
|
# non-generic functions
|
||||||
|
|
||||||
service_create() {
|
service_create() {
|
||||||
|
|||||||
Reference in New Issue
Block a user