Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Backup/restore scripts #2029

Merged
merged 3 commits into from
Mar 17, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ pip-log.txt
pip-delete-this-directory.txt
sentry_install_log*.txt
sentry_clean_log*.txt
sentry_restore_log*.txt
sentry_backup_log*.txt

# Unit test / coverage reports
htmlcov/
Expand Down
5 changes: 5 additions & 0 deletions utilities/backup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env bash
cmd=backup
source utilities/set-up-error-reporting-for-scripts.sh
source utilities/helpers.sh
$cmd
5 changes: 3 additions & 2 deletions utilities/clean.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env bash
log_name=clean
cmd=clean

source utilities/set-up-error-reporting-for-scripts.sh
source utilities/docker-cleanup.sh
source utilities/helpers.sh
$cmd
57 changes: 0 additions & 57 deletions utilities/docker-cleanup.sh

This file was deleted.

69 changes: 69 additions & 0 deletions utilities/helpers.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
#!/usr/bin/env bash

# The purpose of this script is to make it easy to reset a local self-hosted
# install to a clean state, optionally targeting a particular version.

if [ -n "${DEBUG:-}" ]; then
set -x
fi

function confirm() {
read -p "$1 [y/n] " confirmation
if [ "$confirmation" != "y" ]; then
echo "Canceled. 😅"
exit
fi
}

function clean() {
# If we have a version given, validate it.
# ----------------------------------------
# Note that arbitrary git refs won't work, because the *_IMAGE variables in
# .env will almost certainly point to :latest. Tagged releases are generally
# the only refs where these component versions are pinned, so enforce that
# we're targeting a valid tag here. Do this early in order to fail fast.
if [ -n "$version" ]; then
set +e
git rev-parse --verify --quiet "refs/tags/$version" >/dev/null
if [ $? -gt 0 ]; then
echo "Bad version: $version"
exit
fi
set -e
fi

false "noooo"

# Make sure they mean it.
if [ "${FORCE_CLEAN:-}" == "1" ]; then
echo "☠️ Seeing FORCE=1, forcing cleanup."
echo
else
confirm "☠️ Warning! 😳 This is highly destructive! 😱 Are you sure you wish to proceed?"
echo "Okay ... good luck! 😰"
fi

# Hit the reset button.
$dc down --volumes --remove-orphans --rmi local

# Remove any remaining (likely external) volumes with name matching 'sentry-.*'.
for volume in $(docker volume list --format '{{ .Name }}' | grep '^sentry-'); do
docker volume remove $volume >/dev/null &&
echo "Removed volume: $volume" ||
echo "Skipped volume: $volume"
done

# If we have a version given, switch to it.
if [ -n "$version" ]; then
git checkout "$version"
fi
}

function backup() {
chmod +w $(pwd)/sentry
docker-compose run -v $(pwd)/sentry:/sentry-data/backup --rm -T -e SENTRY_LOG_LEVEL=CRITICAL web export /sentry-data/backup/backup.json
}

function restore() {
docker-compose run --rm -T web import /etc/sentry/backup.json
}
5 changes: 5 additions & 0 deletions utilities/restore.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env bash
cmd=restore
source utilities/set-up-error-reporting-for-scripts.sh
source utilities/helpers.sh
$cmd
4 changes: 2 additions & 2 deletions utilities/set-up-error-reporting-for-scripts.sh
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#!/usr/bin/env bash
set -euo pipefail
set -eEuo pipefail
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why we're not including the -E flag generally? If an error is thrown in a function, our cleanup function actually doesn't catch it properly and treats it as the EXIT trap code instead of ERR. Found that out in this PR

https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why we're not including the -E flag generally?

No good one that I know of. :)


# Needed variables to source error-handling script
MINIMIZE_DOWNTIME="${MINIMIZE_DOWNTIME:-}"
STOP_TIMEOUT=60

# Save logs in order to send envelope to Sentry
log_file=sentry_"$log_name"_log-$(date +'%Y-%m-%d_%H-%M-%S').txt
log_file=sentry_"$cmd"_log-$(date +'%Y-%m-%d_%H-%M-%S').txt
exec &> >(tee -a "$log_file")
version=""

Expand Down