Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
66013f6ddb | ||
|
|
3d3d6b9b67 | ||
|
|
eec1dcb0b2 | ||
|
|
1d52c0f5ed |
25
README.md
25
README.md
@ -26,6 +26,31 @@ make dev_install
|
||||
|
||||
See [autonomic-cooperative/installer-scripts](https://git.autonomic.zone/autonomic-cooperative/installer-scripts) for the installer script deployment. To make a release, just add an entry to [CHANGELOG.md](./CHANGELOG.md) and the [installer](./installer) (following [semver](https://semver.org/) please) and then `git tag x.x.x && git push origin main --tags`. If you want the [installer-scripts](https://git.autonomic.zone/autonomic-cooperative/installer-scripts) deployment to pick that up, you'll need to change the version number in the [Makefile](https://git.autonomic.zone/autonomic-cooperative/installer-scripts/src/branch/main/Makefile) and run `make` in that repository and push the changes.
|
||||
|
||||
## Specify what to deploy where
|
||||
|
||||
You can use `abra` in one of 2 ways:
|
||||
|
||||
1. Clone a `compose-stack`, create an `.envrc` in it, and run `abra` in that
|
||||
directory. Be sure to set `ABRA_STACK_DIR=.`
|
||||
2. "Monorepo mode": keep all your `compose-stack`s in one directory and all your `env` files in
|
||||
another, e.g.:
|
||||
```
|
||||
$ tree
|
||||
.
|
||||
├── apps
|
||||
│ ├── mediawiki.demo.autonomic.zone.env
|
||||
│ ├── wordpress.demo.autonomic.zone.env
|
||||
└── stacks
|
||||
├── gitea
|
||||
├── matrix-synapse
|
||||
├── mediawiki
|
||||
├── nextcloud
|
||||
├── swarmpit
|
||||
├── traefik
|
||||
└── wordpress
|
||||
$ abra -e apps/mediawiki.demo.autonomic.zone.env deploy
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
- `abra run mariadb mysqldump gitea -p'GdIbMeS09SURRktBnm3jcTufsL5z0MPd' | gzip > ../git.autonomic.zone_mariadb_`date +%F`.sql.gz`
|
||||
|
||||
200
abra
200
abra
@ -1,22 +1,18 @@
|
||||
#!/bin/bash
|
||||
|
||||
PROGRAM_NAME=$(basename "$0")
|
||||
ABRA_CONFIG=abra.yml
|
||||
|
||||
if [ -z "$COMPOSE_FILE" ]; then
|
||||
COMPOSE_FILE="compose.yml"
|
||||
fi
|
||||
###### Utility functions
|
||||
|
||||
yml_pattern_exists() {
|
||||
PATTERN=$1
|
||||
|
||||
if ! type yq > /dev/null 2>&1; then
|
||||
echo "$(tput setaf 1)ERROR: yq program is not installed$(tput sgr0)"
|
||||
exit
|
||||
error "yq program is not installed"
|
||||
fi
|
||||
|
||||
if [ -f $ABRA_CONFIG ]; then
|
||||
RESULT=$(yq read $ABRA_CONFIG "$PATTERN")
|
||||
if [ -f "$ABRA_CONFIG" ]; then
|
||||
RESULT=$(yq read "$ABRA_CONFIG" "$PATTERN")
|
||||
|
||||
if [ "$RESULT" != 0 ]; then
|
||||
return 0
|
||||
@ -26,58 +22,149 @@ yml_pattern_exists() {
|
||||
return 1
|
||||
}
|
||||
|
||||
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)"
|
||||
exit 1
|
||||
}
|
||||
|
||||
warning() {
|
||||
echo "$(tput setaf 3)WARNING: $*$(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
|
||||
|
||||
if [ "$1" == "-a" ]; then
|
||||
STACK_NAME=$2
|
||||
shift 2
|
||||
fi
|
||||
|
||||
if [ -f abra.yml ]; then
|
||||
###### Load config
|
||||
|
||||
if [ -f "$ABRA_CONFIG" ]; then
|
||||
if yml_pattern_exists stack_name; then
|
||||
STACK_NAME=$(yq read abra.yml stack_name)
|
||||
STACK_NAME=$(yq read "$ABRA_CONFIG" stack_name)
|
||||
fi
|
||||
# FIXME load other variables somehow
|
||||
fi
|
||||
|
||||
if [ -n "$ABRA_ENV" ]; then
|
||||
# shellcheck disable=SC1090
|
||||
source "$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"
|
||||
fi
|
||||
|
||||
load_context() {
|
||||
if [ -z "$DOCKER_CONTEXT" ]; then
|
||||
warning "\$DOCKER_CONTEXT not set, (slowly) looking it up"
|
||||
DOCKER_CONTEXT=$(docker context ls | grep '*' | cut -d' ' -f1)
|
||||
fi
|
||||
}
|
||||
|
||||
###### Safety checks
|
||||
|
||||
require_stack() {
|
||||
if [ -z "$STACK_NAME" ]; then
|
||||
echo "$(tput setaf 1)ERROR: \$STACK_NAME must be set (e.g. export STACK_NAME=my_cool_app)$(tput sgr0 )"
|
||||
exit
|
||||
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
|
||||
}
|
||||
|
||||
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"
|
||||
fi
|
||||
|
||||
if type direnv > /dev/null 2>&1 && ! direnv status | grep -q 'Found RC allowed true'; then
|
||||
echo "$(tput setaf 1)ERROR: direnv is blocked, run direnv allow$(tput sgr0)"
|
||||
exit
|
||||
fi
|
||||
###### Custom commands
|
||||
|
||||
if [ -f abra-commands.sh ]; then
|
||||
# shellcheck disable=SC1091
|
||||
. abra-commands.sh
|
||||
source abra-commands.sh
|
||||
fi
|
||||
|
||||
###### Global help
|
||||
|
||||
sub_help() {
|
||||
echo "Usage: $PROGRAM_NAME [-a STACK_NAME] <subcommand> [options]"
|
||||
echo "Usage: $PROGRAM_NAME [-a STACK_NAME] [-c CONFIG] [-e ENV_FILE] <subcommand> [options]"
|
||||
echo ""
|
||||
echo "Subcommands:"
|
||||
echo " context [--help] [SUBCOMMAND] manage remote swarm contexts"
|
||||
echo " cp SRC_PATH SERVICE:DEST_PATH copy files to a container"
|
||||
echo " deploy let 'em rip"
|
||||
echo " logs SERVICE [ARGS] tail logs from a deployed service"
|
||||
echo " run SERVICE CMD run a command in the specified service's container"
|
||||
echo " run_args SERVICE ARGS CMD run, passing extra args to docker exec"
|
||||
echo " secret_generate SECRET VERSION [CMD] generate a secret, store it in pass & as a Docker secret"
|
||||
echo " secret [--help] [SUBCOMMAND] manage secrets"
|
||||
echo " upgrade upgrade to the latest version"
|
||||
echo " ... (custom commands)"
|
||||
echo ""
|
||||
echo "Make sure \$STACK_NAME is set using direnv or -a"
|
||||
echo "Make sure \$STACK_NAME is set using direnv, -a, -e or -c"
|
||||
echo ""
|
||||
echo "Runs compose.yml by default, set e.g. COMPOSE_FILE=\"compose.yml:compose2.yml\" to override"
|
||||
}
|
||||
|
||||
###### Subcommand `secret`
|
||||
|
||||
sub_secret_help() {
|
||||
echo "Usage: $PROGRAM_NAME [-a STACK_NAME] secret <subcommand> [options]"
|
||||
echo ""
|
||||
echo "Subcommands:"
|
||||
echo " generate [PW] generate & store secret"
|
||||
echo " generate SECRET VERSION [PW] generate & store secret"
|
||||
}
|
||||
|
||||
sub_secret_generate(){
|
||||
require_stack
|
||||
load_context
|
||||
|
||||
SECRET=$1
|
||||
VERSION=$2
|
||||
PW=${3:-pwqgen}
|
||||
@ -89,7 +176,7 @@ sub_secret_generate(){
|
||||
|
||||
$PW | tee \
|
||||
>(docker secret create "${STACK_NAME}_${SECRET}_${VERSION}" -) \
|
||||
>(pass insert "hosts/autonomic-swarm/${STACK_NAME}/${SECRET}" -m)
|
||||
>(pass insert "hosts/$DOCKER_CONTEXT/${STACK_NAME}/${SECRET}" -m)
|
||||
}
|
||||
|
||||
sub_secret() {
|
||||
@ -99,7 +186,11 @@ sub_secret() {
|
||||
parse_subcommand "$SUBCOMMAND" "secret" $@
|
||||
}
|
||||
|
||||
###### Subcommand `run`
|
||||
|
||||
sub_run_args(){
|
||||
require_stack
|
||||
|
||||
SERVICE=$1
|
||||
DOCKER_ARGS=$2
|
||||
|
||||
@ -114,7 +205,7 @@ sub_run_args(){
|
||||
| grep "${STACK_NAME}_${SERVICE}" | cut -d',' -f1)
|
||||
|
||||
if [ -z "$CONTAINER" ]; then
|
||||
echo "Container not found! 🚨"
|
||||
error "Can't find a container for ${STACK_NAME}_${SERVICE}"
|
||||
exit
|
||||
fi
|
||||
|
||||
@ -132,9 +223,16 @@ sub_run(){
|
||||
sub_run_args "$SERVICE" "" "$@"
|
||||
}
|
||||
|
||||
###### Subcommand `deploy`
|
||||
|
||||
sub_deploy (){
|
||||
require_stack
|
||||
require_stack_dir
|
||||
load_context
|
||||
|
||||
echo "About to deploy:"
|
||||
echo " Compose: $(tput setaf 3)${PWD}/${COMPOSE_FILE}$(tput sgr0)"
|
||||
echo " Context: $(tput setaf 4)${DOCKER_CONTEXT}$(tput sgr0)"
|
||||
echo " Compose: $(tput setaf 3)${ABRA_STACK_DIR}/${COMPOSE_FILE}$(tput sgr0)"
|
||||
if [ -n "$DOMAIN" ]; then
|
||||
echo " Domain: $(tput setaf 2)${DOMAIN}$(tput sgr0)"
|
||||
fi
|
||||
@ -148,6 +246,8 @@ sub_deploy (){
|
||||
* ) 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
|
||||
@ -156,11 +256,16 @@ sub_deploy (){
|
||||
echo "$(tput setaf 2)Yay! That worked. No \$DOMAIN defined, check logs.(tput sgr0)"
|
||||
fi
|
||||
else
|
||||
echo "$(tput setaf 1)Oh no! Something went wrong 😕 Check errors above$(tput sgr0)"
|
||||
error "Oh no! Something went wrong 😕 Check errors above"
|
||||
fi
|
||||
)
|
||||
}
|
||||
|
||||
###### Subcommand `logs`
|
||||
|
||||
sub_logs (){
|
||||
require_stack
|
||||
|
||||
SERVICE=$1
|
||||
|
||||
shift
|
||||
@ -180,7 +285,11 @@ sub_logs (){
|
||||
docker service logs "${STACK_NAME}_${SERVICE}" $LOGS_ARGS
|
||||
}
|
||||
|
||||
###### Subcommand `cp`
|
||||
|
||||
sub_cp() {
|
||||
require_stack
|
||||
|
||||
SOURCE=$1
|
||||
DEST=$2
|
||||
|
||||
@ -188,18 +297,17 @@ sub_cp() {
|
||||
SERVICE=$(echo "$SERVICE" | tr -d ':')
|
||||
|
||||
if [ -z "$SERVICE" ]; then
|
||||
echo "$(tput setaf 1)ERROR: Can't find SERVICE in either SRC or DEST$(tput sgr0)"
|
||||
echo ""
|
||||
echo "Usage: $PROGRAM_NAME cp SERVICE:SRC_PATH DEST_PATH"
|
||||
echo " $PROGRAM_NAME cp SRC_PATH SERVICE:DEST_PATH"
|
||||
exit
|
||||
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)
|
||||
|
||||
if [ -z "$CONTAINER" ]; then
|
||||
echo "$(tput setaf 1)ERROR: Can't find a ${STACK_NAME}_${SERVICE}$(tput sgr0)"
|
||||
error "Can't find a container for ${STACK_NAME}_${SERVICE}"
|
||||
exit
|
||||
fi
|
||||
|
||||
@ -209,6 +317,8 @@ sub_cp() {
|
||||
docker cp $CP_ARGS
|
||||
}
|
||||
|
||||
###### Subcommand `context`
|
||||
|
||||
sub_context_help() {
|
||||
echo "Usage: $PROGRAM_NAME [-a STACK_NAME] context <subcommand> [options]"
|
||||
echo ""
|
||||
@ -238,10 +348,6 @@ sub_context_use() {
|
||||
docker context use "$1"
|
||||
}
|
||||
|
||||
sub_upgrade() {
|
||||
curl -fsSL https://install.abra.autonomic.zone | bash
|
||||
}
|
||||
|
||||
sub_context() {
|
||||
SUBCOMMAND2=$1
|
||||
shift
|
||||
@ -249,34 +355,16 @@ sub_context() {
|
||||
parse_subcommand "$SUBCOMMAND2" "context" $@
|
||||
}
|
||||
|
||||
parse_subcommand() {
|
||||
SUBCOMMAND="$1"
|
||||
PREFIX=$2
|
||||
|
||||
if [ -n "$PREFIX" ]; then
|
||||
PPREFIX="_$2"
|
||||
SPREFIX="$2 "
|
||||
SSPREFIX=" $2"
|
||||
fi
|
||||
###### Subcommand `upgrade`
|
||||
|
||||
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
|
||||
sub_upgrade() {
|
||||
curl -fsSL https://install.abra.autonomic.zone | bash
|
||||
}
|
||||
|
||||
###### Main
|
||||
|
||||
SUBCOMMAND=$1
|
||||
shift
|
||||
|
||||
# shellcheck disable=SC2086,SC2068
|
||||
parse_subcommand $SUBCOMMAND "" $@
|
||||
|
||||
Loading…
Reference in New Issue
Block a user