This repository has been archived on 2021-07-03. You can view files and clone it, but cannot push or open issues or pull requests.
abra/abra

561 lines
15 KiB
Plaintext
Raw Normal View History

2020-10-25 20:41:17 +00:00
#!/usr/bin/env bash
###### Global help
DOC="The cooperative cloud utility belt 🎩🐇
Usage:
abra
Options:
Commands:
"
### TODO(decentral1se): convert this into `DOC`
sub_help() {
echo "Usage: $PROGRAM_NAME [OPTIONS] COMMAND [ARGS]..."
echo ""
echo "Options:"
echo " --config Stack configuration to use"
echo " --env Environment variables to load"
echo " --help Show this message and exit"
echo " --stack Name of the target stack"
echo " --version Show program version"
echo ""
echo "Commands:"
echo " server manage remote host"
echo " cp copy files to a container"
echo " deploy let 'em rip"
echo " logs tail logs from a deployed service"
echo " multilogs tail logs from a whole stackk"
echo " run run a command in the specified service's container"
echo " secret manage secrets"
echo " upgrade upgrade to the latest version"
}
sub_secret_help() {
echo "Usage: $PROGRAM_NAME [global opts] secret <subcommand> [sub opts]"
echo ""
echo "Subcommands:"
echo " generate SECRET VERSION [PWGEN] generate & store secret"
echo " insert SECRET VERSION PW save PW in docker and pass"
}
sub_server_help() {
echo "Usage: $PROGRAM_NAME [global opts] server <subcommand> [sub opts]"
echo ""
echo "Subcommands:"
echo " add HOST [USER] [PORT] set up remote Docker context"
echo " rm HOST"
echo " use HOST activate remote Docker context"
echo " init HOST activate swarm mode"
}
###
# docopt parser below, refresh this parser with `docopt.sh abra`
# shellcheck disable=2016,1075
docopt() { parse() { if ${DOCOPT_DOC_CHECK:-true}; then local doc_hash
if doc_hash=$(printf "%s" "$DOC" | (sha256sum 2>/dev/null || shasum -a 256)); then
if [[ ${doc_hash:0:5} != "$digest" ]]; then
stderr "The current usage doc (${doc_hash:0:5}) does not match \
what the parser was generated with (${digest})
Run \`docopt.sh\` to refresh the parser."; _return 70; fi; fi; fi
local root_idx=$1; shift; argv=("$@"); parsed_params=(); parsed_values=()
left=(); testdepth=0; local arg; while [[ ${#argv[@]} -gt 0 ]]; do
if [[ ${argv[0]} = "--" ]]; then for arg in "${argv[@]}"; do
parsed_params+=('a'); parsed_values+=("$arg"); done; break
elif [[ ${argv[0]} = --* ]]; then parse_long
elif [[ ${argv[0]} = -* && ${argv[0]} != "-" ]]; then parse_shorts
elif ${DOCOPT_OPTIONS_FIRST:-false}; then for arg in "${argv[@]}"; do
parsed_params+=('a'); parsed_values+=("$arg"); done; break; else
parsed_params+=('a'); parsed_values+=("${argv[0]}"); argv=("${argv[@]:1}"); fi
done; local idx; if ${DOCOPT_ADD_HELP:-true}; then
for idx in "${parsed_params[@]}"; do [[ $idx = 'a' ]] && continue
if [[ ${shorts[$idx]} = "-h" || ${longs[$idx]} = "--help" ]]; then
stdout "$trimmed_doc"; _return 0; fi; done; fi
if [[ ${DOCOPT_PROGRAM_VERSION:-false} != 'false' ]]; then
for idx in "${parsed_params[@]}"; do [[ $idx = 'a' ]] && continue
if [[ ${longs[$idx]} = "--version" ]]; then stdout "$DOCOPT_PROGRAM_VERSION"
_return 0; fi; done; fi; local i=0; while [[ $i -lt ${#parsed_params[@]} ]]; do
left+=("$i"); ((i++)) || true; done
if ! required "$root_idx" || [ ${#left[@]} -gt 0 ]; then error; fi; return 0; }
parse_shorts() { local token=${argv[0]}; local value; argv=("${argv[@]:1}")
[[ $token = -* && $token != --* ]] || _return 88; local remaining=${token#-}
while [[ -n $remaining ]]; do local short="-${remaining:0:1}"
remaining="${remaining:1}"; local i=0; local similar=(); local match=false
for o in "${shorts[@]}"; do if [[ $o = "$short" ]]; then similar+=("$short")
[[ $match = false ]] && match=$i; fi; ((i++)) || true; done
if [[ ${#similar[@]} -gt 1 ]]; then
error "${short} is specified ambiguously ${#similar[@]} times"
elif [[ ${#similar[@]} -lt 1 ]]; then match=${#shorts[@]}; value=true
shorts+=("$short"); longs+=(''); argcounts+=(0); else value=false
if [[ ${argcounts[$match]} -ne 0 ]]; then if [[ $remaining = '' ]]; then
if [[ ${#argv[@]} -eq 0 || ${argv[0]} = '--' ]]; then
error "${short} requires argument"; fi; value=${argv[0]}; argv=("${argv[@]:1}")
else value=$remaining; remaining=''; fi; fi; if [[ $value = false ]]; then
value=true; fi; fi; parsed_params+=("$match"); parsed_values+=("$value"); done
}; parse_long() { local token=${argv[0]}; local long=${token%%=*}
local value=${token#*=}; local argcount; argv=("${argv[@]:1}")
[[ $token = --* ]] || _return 88; if [[ $token = *=* ]]; then eq='='; else eq=''
value=false; fi; local i=0; local similar=(); local match=false
for o in "${longs[@]}"; do if [[ $o = "$long" ]]; then similar+=("$long")
[[ $match = false ]] && match=$i; fi; ((i++)) || true; done
if [[ $match = false ]]; then i=0; for o in "${longs[@]}"; do
if [[ $o = $long* ]]; then similar+=("$long"); [[ $match = false ]] && match=$i
fi; ((i++)) || true; done; fi; if [[ ${#similar[@]} -gt 1 ]]; then
error "${long} is not a unique prefix: ${similar[*]}?"
elif [[ ${#similar[@]} -lt 1 ]]; then
[[ $eq = '=' ]] && argcount=1 || argcount=0; match=${#shorts[@]}
[[ $argcount -eq 0 ]] && value=true; shorts+=(''); longs+=("$long")
argcounts+=("$argcount"); else if [[ ${argcounts[$match]} -eq 0 ]]; then
if [[ $value != false ]]; then
error "${longs[$match]} must not have an argument"; fi
elif [[ $value = false ]]; then
if [[ ${#argv[@]} -eq 0 || ${argv[0]} = '--' ]]; then
error "${long} requires argument"; fi; value=${argv[0]}; argv=("${argv[@]:1}")
fi; if [[ $value = false ]]; then value=true; fi; fi; parsed_params+=("$match")
parsed_values+=("$value"); }; required() { local initial_left=("${left[@]}")
local node_idx; ((testdepth++)) || true; for node_idx in "$@"; do
if ! "node_$node_idx"; then left=("${initial_left[@]}"); ((testdepth--)) || true
return 1; fi; done; if [[ $((--testdepth)) -eq 0 ]]; then
left=("${initial_left[@]}"); for node_idx in "$@"; do "node_$node_idx"; done; fi
return 0; }; stdout() { printf -- "cat <<'EOM'\n%s\nEOM\n" "$1"; }; stderr() {
printf -- "cat <<'EOM' >&2\n%s\nEOM\n" "$1"; }; error() {
[[ -n $1 ]] && stderr "$1"; stderr "$usage"; _return 1; }; _return() {
printf -- "exit %d\n" "$1"; exit "$1"; }; set -e; trimmed_doc=${DOC:0:74}
usage=${DOC:39:13}; digest=8c7d3; shorts=(); longs=(); argcounts=(); node_0(){
required ; }; node_1(){ required 0; }; cat <<<' docopt_exit() {
[[ -n $1 ]] && printf "%s\n" "$1" >&2; printf "%s\n" "${DOC:39:13}" >&2; exit 1
}'; unset ; parse 1 "$@"; return 0; local prefix=${DOCOPT_PREFIX:-''}; unset
local docopt_i=1; [[ $BASH_VERSION =~ ^4.3 ]] && docopt_i=2
for ((;docopt_i>0;docopt_i--)); do declare -p ; done; }
# docopt parser above, complete command for generating this parser is `docopt.sh abra`
2020-09-13 22:16:46 +00:00
2020-09-13 21:33:55 +00:00
PROGRAM_NAME=$(basename "$0")
2020-09-13 22:16:46 +00:00
###### Utility functions
2020-09-13 22:16:46 +00:00
yml_pattern_exists() {
PATTERN=$1
if [ -f "$ABRA_CONFIG" ]; then
RESULT=$(yq read "$ABRA_CONFIG" "$PATTERN")
2020-09-13 22:16:46 +00:00
if [ "$RESULT" != 0 ]; then
return 0
fi
fi
return 1
}
2020-09-07 21:29:29 +00:00
parse_subcommand() {
SUBCOMMAND="$1"
PREFIX=$2
if [ -n "$PREFIX" ]; then
PPREFIX="_$2"
SPREFIX="$2 "
SSPREFIX=" $2"
fi
case $SUBCOMMAND in
"" | "-h" | "--help")
"sub${PPREFIX}_help"
;;
*)
shift 2
"sub${PPREFIX}_${SUBCOMMAND}" "$@"
if [ $? = 127 ]; then
echo "Error: '$SPREFIX$SUBCOMMAND' is not a known subcommand." >&2
echo " Run '$PROGRAM_NAME$SSPREFIX --help' for a list of known subcommands." >&2
exit 1
fi
;;
esac
}
error() {
echo "$(tput setaf 1)ERROR: $*$(tput sgr0)"
2020-09-23 09:53:34 +00:00
exit 1
}
warning() {
echo "$(tput setaf 3)WARNING: $*$(tput sgr0)"
}
success() {
echo "$(tput setaf 2)$*$(tput sgr0)"
}
###### Top-level arguments
ABRA_CONFIG=abra.yml
if [ "$1" == "-c" ]; then
ABRA_CONFIG=$2
shift 2
fi
if [ "$1" == "-e" ]; then
ABRA_ENV=$2
shift 2
fi
2020-09-13 07:31:43 +00:00
if [ "$1" == "-a" ]; then
STACK_NAME=$2
shift 2
fi
###### Load config
if [ -f "$ABRA_CONFIG" ]; then
2020-09-24 22:36:23 +00:00
require_yq
2020-09-13 22:16:46 +00:00
if yml_pattern_exists stack_name; then
STACK_NAME=$(yq read "$ABRA_CONFIG" stack_name)
2020-09-13 22:16:46 +00:00
fi
# FIXME load other variables somehow
fi
if [ -n "$ABRA_ENV" ]; then
# shellcheck disable=SC1090
source "$ABRA_ENV" || error "Unable to load env from '$ABRA_ENV'"
fi
###### Default settings
if [ -z "$COMPOSE_FILE" ]; then
COMPOSE_FILE="compose.yml"
fi
if [ -z "$ABRA_STACK_DIR" ]; then
ABRA_STACK_DIR="stacks/$SERVICE"
2020-09-13 22:16:46 +00:00
fi
2020-09-23 09:53:34 +00:00
load_context() {
if [ -z "$DOCKER_CONTEXT" ]; then
warning "\$DOCKER_CONTEXT not set, (slowly) looking it up"
# shellcheck disable=SC2063
2020-09-23 09:53:34 +00:00
DOCKER_CONTEXT=$(docker context ls | grep '*' | cut -d' ' -f1)
# FIXME 3wc: make sure grep doesn't parse this, we're want a literal '*'
2020-09-23 09:53:34 +00:00
fi
}
###### Safety checks
2020-09-24 22:36:23 +00:00
require_yq() {
if ! type yq > /dev/null 2>&1; then
error "yq program is not installed"
fi
}
require_multitail() {
if ! type multitail > /dev/null 2>&1; then
error "multitail program is not installed"
fi
}
2020-09-23 09:53:34 +00:00
require_stack() {
if [ -z "$STACK_NAME" ]; then
error "no stack_name, export \$STACK_NAME=my_cool_app or add it to abra.yml"
fi
}
require_stack_dir() {
if [ -z "$ABRA_STACK_DIR" ] || [ ! -d "$ABRA_STACK_DIR" ]; then
error "can't find \$ABRA_STACK_DIR '$ABRA_STACK_DIR'"
fi
}
2020-09-11 10:58:11 +00:00
if [ -z "$ABRA_ENV" ] && [ -f .envrc ] && type direnv > /dev/null 2>&1 && ! direnv status | grep -q 'Found RC allowed true'; then
error "direnv is blocked, run direnv allow"
2020-09-07 21:29:29 +00:00
fi
2020-09-08 06:49:27 +00:00
###### Custom commands
if [ -f abra-commands.sh ]; then
2020-09-13 07:31:43 +00:00
# shellcheck disable=SC1091
source abra-commands.sh
fi
if [ -f "$ABRA_STACK_DIR/abra-commands.sh" ]; then
# shellcheck disable=SC1090
source "$ABRA_STACK_DIR/abra-commands.sh"
fi
###### Subcommand `secret`
sub_secret_insert() {
2020-09-23 09:53:34 +00:00
require_stack
load_context
2020-09-07 21:29:29 +00:00
SECRET=$1
VERSION=$2
PW=$3
2020-09-07 21:29:29 +00:00
if [ -z "$SECRET" ] || [ -z "$VERSION" ] || [ -z "$PW" ]; then
error "Required arguments missing"
echo
echo "Usage: $PROGRAM_NAME secret insert SECRET VERSION PW"
2020-09-07 21:29:29 +00:00
exit
fi
echo "$PW" | docker secret create "${STACK_NAME}_${SECRET}_${VERSION}" - > /dev/null
echo "$PW" | pass insert "hosts/$DOCKER_CONTEXT/${STACK_NAME}/${SECRET}" -m > /dev/null
}
sub_secret_generate(){
SECRET=$1
VERSION=$2
PWGEN=${3:-pwqgen}
if [ -z "$SECRET" ] || [ -z "$VERSION" ]; then
error "Required arguments missing"
echo
echo "Usage: $PROGRAM_NAME secret generate SECRET VERSION [PW]"
exit
fi
PW=$($PWGEN)
success "Password: $PW"
sub_secret_insert "$SECRET" "$VERSION" "$PW"
2020-09-07 21:29:29 +00:00
}
sub_secret() {
SUBCOMMAND=$1
shift
# shellcheck disable=SC2068
parse_subcommand "$SUBCOMMAND" "secret" $@
}
###### Subcommand `run`
sub_run(){
2020-09-23 09:53:34 +00:00
require_stack
if [ "$1" == "-u" ]; then
RUN_USER="-u $2"
shift 2
fi
2020-09-07 21:29:29 +00:00
SERVICE=$1
shift
2020-09-08 06:49:27 +00:00
if [ -z "$SERVICE" ]; then
echo "Usage: $PROGRAM_NAME run [-u USER] SERVICE [CMD]"
exit
fi
2020-09-07 21:29:29 +00:00
CONTAINER=$(docker container ls --format "table {{.ID}},{{.Names}}" \
| grep "${STACK_NAME}_${SERVICE}" | head -n1 | cut -d',' -f1)
2020-09-07 21:29:29 +00:00
2020-09-08 06:58:49 +00:00
if [ -z "$CONTAINER" ]; then
2020-09-23 09:53:34 +00:00
error "Can't find a container for ${STACK_NAME}_${SERVICE}"
2020-09-07 21:29:29 +00:00
exit
fi
# shellcheck disable=SC2086
docker exec $RUN_USER -it "$CONTAINER" "$@"
return
2020-09-07 21:29:29 +00:00
}
###### Subcommand `deploy`
2020-09-07 21:29:29 +00:00
sub_deploy (){
2020-09-23 09:53:34 +00:00
require_stack
require_stack_dir
load_context
2020-09-07 21:29:29 +00:00
echo "About to deploy:"
2020-09-23 09:53:34 +00:00
echo " Context: $(tput setaf 4)${DOCKER_CONTEXT}$(tput sgr0)"
if [ "${COMPOSE_FILE/:/}" == "${COMPOSE_FILE}" ]; then
echo " Compose: $(tput setaf 3)${ABRA_STACK_DIR}/${COMPOSE_FILE}$(tput sgr0)"
else
echo " Compose: $(tput setaf 3)${ABRA_STACK_DIR}/"
IFS=':' read -ra COMPOSE_FILES <<< "$COMPOSE_FILE"
for COMPOSE in "${COMPOSE_FILES[@]}"; do
echo " - ${COMPOSE}"
done
tput sgr0
fi
if [ -n "$DOMAIN" ]; then
echo " Domain: $(tput setaf 2)${DOMAIN}$(tput sgr0)"
fi
echo " Stack: $(tput setaf 1)${STACK_NAME}$(tput sgr0)"
2020-09-07 21:29:29 +00:00
2020-09-08 06:58:49 +00:00
read -rp "Continue? (y/[n])? " choice
2020-09-07 21:29:29 +00:00
case "$choice" in
y|Y ) ;;
n|N ) return;;
* ) return;;
esac
(
cd "$ABRA_STACK_DIR" || error "\$ABRA_STACK_DIR '$ABRA_STACK_DIR' not found"
# shellcheck disable=SC2086
if docker stack deploy -c ${COMPOSE_FILE/:/ -c } "$STACK_NAME"; then
if [ -n "$DOMAIN" ]; then
success "Yay! App should be available at https://${DOMAIN}"
else
success "Yay! That worked. No \$DOMAIN defined, check logs."
fi
else
error "Oh no! Something went wrong 😕 Check errors above"
fi
)
2020-09-07 21:29:29 +00:00
}
###### Subcommand `logs`
2020-09-24 22:48:46 +00:00
# Inspired by https://github.com/moby/moby/issues/31458#issuecomment-475411564
2020-09-24 22:36:23 +00:00
sub_multilogs() {
require_stack
require_multitail
# Get a list of the service names
SERVICES=$(docker stack services --format "{{.Name}}" "${STACK_NAME}")
# Sort the service names
SERVICES=$(echo "${SERVICES}" | sort)
# Create the command to run
COMMAND='multitail --mergeall'
for SERVICE in ${SERVICES}; do
COMMAND="${COMMAND} -L 'docker service logs --tail 20 -f ${SERVICE}'"
done
# Run the command
bash -c "${COMMAND}"
}
2020-09-08 07:10:37 +00:00
sub_logs (){
2020-09-23 09:53:34 +00:00
require_stack
2020-09-08 07:10:37 +00:00
SERVICE=$1
2020-09-24 22:36:23 +00:00
if [ -z "$SERVICE" ]; then
warning "No \$SERVICE provided, running multilogs"
sub_multilogs
fi
2020-09-12 12:00:28 +00:00
shift
2020-09-13 07:31:43 +00:00
2020-09-12 12:00:28 +00:00
if [ $# -eq 0 ]; then
LOGS_ARGS="\
2020-09-08 07:10:37 +00:00
--follow \
--no-trunc \
--details \
2020-09-12 12:00:28 +00:00
--timestamps"
else
2020-09-13 07:31:43 +00:00
# shellcheck disable=SC2124
LOGS_ARGS=$@
2020-09-12 12:00:28 +00:00
fi
# shellcheck disable=SC2086
docker service logs "${STACK_NAME}_${SERVICE}" $LOGS_ARGS
2020-09-08 07:10:37 +00:00
}
###### Subcommand `cp`
sub_cp() {
2020-09-23 09:53:34 +00:00
require_stack
SOURCE=$1
DEST=$2
SERVICE=$(echo "$SOURCE" | grep -o '^[^:]\+:' || echo "$DEST" | grep -o '^[^:]\+:')
2020-09-19 10:02:55 +00:00
SERVICE=$(echo "$SERVICE" | tr -d ':')
2020-09-19 10:02:55 +00:00
if [ -z "$SERVICE" ]; then
echo "Usage: $PROGRAM_NAME cp SERVICE:SRC_PATH DEST_PATH"
echo " $PROGRAM_NAME cp SRC_PATH SERVICE:DEST_PATH"
echo ""
error "Can't find SERVICE in either SRC or DEST"
fi
CONTAINER=$(docker container ls --format "table {{.ID}},{{.Names}}" \
| grep "${STACK_NAME}_${SERVICE}" | cut -d',' -f1)
2020-09-19 10:02:55 +00:00
if [ -z "$CONTAINER" ]; then
2020-09-23 09:53:34 +00:00
error "Can't find a container for ${STACK_NAME}_${SERVICE}"
exit
fi
CP_ARGS=$(echo "$SOURCE $DEST" | sed "s/$SERVICE:/$CONTAINER:/")
# shellcheck disable=SC2086
docker cp ${CP_ARGS}
}
###### Subcommand `context`
2020-10-23 03:02:39 +00:00
sub_server_init() {
load_context
docker swarm init || true
docker network create --driver=overlay proxy --scope swarm || true
}
2020-10-23 03:02:39 +00:00
sub_server_add() {
HOST="$1"
USERNAME="$2"
PORT="$3"
if [ -n "$PORT" ]; then
PORT=":$PORT"
fi
if [ -n "$USERNAME" ]; then
USERNAME="$USERNAME@"
fi
docker context create "$HOST" \
--docker "host=ssh://$USERNAME$HOST$PORT"
}
2020-10-23 03:02:39 +00:00
sub_server_rm() {
HOST="$1"
docker context rm "$HOST"
}
sub_server_use() {
docker context use "$1"
}
2020-10-23 03:02:39 +00:00
sub_server() {
SUBCOMMAND2=$1
shift
# shellcheck disable=SC2068
2020-10-23 03:02:39 +00:00
parse_subcommand "$SUBCOMMAND2" "server" $@
}
2020-09-23 09:53:34 +00:00
###### Subcommand `upgrade`
sub_upgrade() {
curl -fsSL https://install.abra.autonomic.zone | bash
}
###### Docker alias subcommands
sub_stack() {
# shellcheck disable=SC2068
docker stack $@
}
sub_volume() {
# shellcheck disable=SC2068
docker volume $@
}
###### Main
SUBCOMMAND=$1
shift
# shellcheck disable=SC2086,SC2068
parse_subcommand $SUBCOMMAND "" $@