Compare commits

..

4 Commits

Author SHA1 Message Date
3wc
66013f6ddb Further tidy-up (+ add warning()) 2020-09-23 11:53:34 +02:00
3wc
3d3d6b9b67 Merge branch 'main' into monorepo 2020-09-22 16:15:33 +02:00
3wc
eec1dcb0b2 Update README and tweak default STACK_DIR 2020-09-22 16:13:18 +02:00
3wc
1d52c0f5ed Add -e, -c and ABRA_STACK_DIR options..
..and tidy up a little
2020-09-22 16:04:28 +02:00
6 changed files with 24 additions and 107 deletions

View File

@ -7,7 +7,7 @@ steps:
commands:
- apt update
- apt install -y shellcheck
- shellcheck abra script.d/*
- shellcheck abra installer
trigger:
branch:
- main

View File

@ -1,16 +1,3 @@
# abra 0.3.1 (2020-09-27)
- Fix installer version
# abra 0.3.0 (2020-09-27)
- Add multilogs stack logs implementation ([#8](https://git.autonomic.zone/compose-stacks/abra/issues/8)
- Add beginnings of "monorepo" functionality
# abra 0.2.0 (2020-09-24)
- Prepare for swarm install script using script.d ([#12](https://git.autonomic.zone/compose-stacks/planning/issues/12))
# abra 0.1.2 (2020-09-22)
- Add upgrade command ([#10](https://git.autonomic.zone/autonomic-cooperative/abra/issues/10))

View File

@ -24,7 +24,7 @@ cd abra
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 bump the version in [abra-installer](./script.d/abra-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.
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
@ -35,7 +35,7 @@ You can use `abra` in one of 2 ways:
2. "Monorepo mode": keep all your `compose-stack`s in one directory and all your `env` files in
another, e.g.:
```
$ tree
$ tree
.
├── apps
│   ├── mediawiki.demo.autonomic.zone.env
@ -48,8 +48,8 @@ You can use `abra` in one of 2 ways:
├── swarmpit
├── traefik
└── wordpress
$ abra -e apps/mediawiki.demo.autonomic.zone.env deploy
```
$ abra -e apps/mediawiki.demo.autonomic.zone.env deploy
```
## Examples

90
abra
View File

@ -7,6 +7,10 @@ PROGRAM_NAME=$(basename "$0")
yml_pattern_exists() {
PATTERN=$1
if ! type yq > /dev/null 2>&1; then
error "yq program is not installed"
fi
if [ -f "$ABRA_CONFIG" ]; then
RESULT=$(yq read "$ABRA_CONFIG" "$PATTERN")
@ -53,10 +57,6 @@ warning() {
echo "$(tput setaf 3)WARNING: $*$(tput sgr0)"
}
success() {
echo "$(tput setaf 2)$*$(tput sgr0)"
}
###### Top-level arguments
ABRA_CONFIG=abra.yml
@ -78,8 +78,6 @@ fi
###### Load config
if [ -f "$ABRA_CONFIG" ]; then
require_yq
if yml_pattern_exists stack_name; then
STACK_NAME=$(yq read "$ABRA_CONFIG" stack_name)
fi
@ -88,7 +86,7 @@ fi
if [ -n "$ABRA_ENV" ]; then
# shellcheck disable=SC1090
source "$ABRA_ENV" || error "Unable to load env from '$ABRA_ENV'"
source "$ABRA_ENV"
fi
###### Default settings
@ -104,26 +102,12 @@ fi
load_context() {
if [ -z "$DOCKER_CONTEXT" ]; then
warning "\$DOCKER_CONTEXT not set, (slowly) looking it up"
# shellcheck disable=SC2063
DOCKER_CONTEXT=$(docker context ls | grep '*' | cut -d' ' -f1)
# FIXME 3wc: make sure grep doesn't parse this, we're want a literal '*'
fi
}
###### Safety checks
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
}
require_stack() {
if [ -z "$STACK_NAME" ]; then
error "no stack_name, export \$STACK_NAME=my_cool_app or add it to abra.yml"
@ -157,7 +141,6 @@ sub_help() {
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 " multilogs tail logs from a whole stackk"
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 [--help] [SUBCOMMAND] manage secrets"
@ -172,42 +155,28 @@ sub_help() {
###### Subcommand `secret`
sub_secret_help() {
echo "Usage: $PROGRAM_NAME [global opts] secret <subcommand> [sub opts]"
echo "Usage: $PROGRAM_NAME [-a STACK_NAME] secret <subcommand> [options]"
echo ""
echo "Subcommands:"
echo " generate SECRET VERSION [PWGEN] generate & store secret"
echo " insert SECRET VERSION PW save PW in docker and pass"
echo " generate SECRET VERSION [PW] generate & store secret"
}
sub_secret_insert() {
sub_secret_generate(){
require_stack
load_context
SECRET=$1
VERSION=$2
PW=$3
PW=${3:-pwqgen}
if [ -z "$SECRET" ] || [ -z "$VERSION" ] || [ -z "$PW" ]; then
echo "Usage: $PROGRAM_NAME secret insert SECRET VERSION PW"
if [ -z "$SECRET" ] || [ -z "$VERSION" ]; then
echo "Usage: $PROGRAM_NAME secret_generate SECRET VERSION"
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}
PW=$($PWGEN)
success "Password: $PW"
echo "sub_secret_insert \"$SECRET\" \"$VERSION\" \"$PW\""
exit
sub_secret_insert "$SECRET" "$VERSION" "$PW"
$PW | tee \
>(docker secret create "${STACK_NAME}_${SECRET}_${VERSION}" -) \
>(pass insert "hosts/$DOCKER_CONTEXT/${STACK_NAME}/${SECRET}" -m)
}
sub_secret() {
@ -228,7 +197,7 @@ sub_run_args(){
shift 2
if [ -z "$SERVICE" ]; then
echo "Usage: $PROGRAM_NAME run SERVICE DOCKER_ARGS [CMD]"
echo "Usage: $PROGRAM_NAME run SERVICE [CMD]"
exit
fi
@ -282,9 +251,9 @@ sub_deploy (){
# 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}"
echo "$(tput setaf 2)Yay! App should be available at https://${DOMAIN}$(tput sgr0)"
else
success "Yay! That worked. No \$DOMAIN defined, check logs."
echo "$(tput setaf 2)Yay! That worked. No \$DOMAIN defined, check logs.(tput sgr0)"
fi
else
error "Oh no! Something went wrong 😕 Check errors above"
@ -294,34 +263,11 @@ sub_deploy (){
###### Subcommand `logs`
# Inspired by https://github.com/moby/moby/issues/31458#issuecomment-475411564
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}"
}
sub_logs (){
require_stack
SERVICE=$1
if [ -z "$SERVICE" ]; then
warning "No \$SERVICE provided, running multilogs"
sub_multilogs
fi
shift
if [ $# -eq 0 ]; then
@ -374,7 +320,7 @@ sub_cp() {
###### Subcommand `context`
sub_context_help() {
echo "Usage: $PROGRAM_NAME [global opts] context <subcommand> [sub opts]"
echo "Usage: $PROGRAM_NAME [-a STACK_NAME] context <subcommand> [options]"
echo ""
echo "Subcommands:"
echo " init HOST [USER] [PORT] set up remote Docker context"

View File

@ -1,6 +1,6 @@
#!/bin/bash
ABRA_VERSION="0.3.1"
ABRA_VERSION="0.1.2"
ABRA_SRC="https://git.autonomic.zone/autonomic-cooperative/abra/raw/tag/$ABRA_VERSION/abra"
function install_abra {

View File

@ -1,16 +0,0 @@
#!/bin/sh
install_docker() {
echo "install_docker: TODO"
}
init_swarm() {
echo "init_swarm: TODO"
}
run_installation() {
install_docker
init_swarm
}
run_installation
exit 0