From 7e7401a668987c44863c403548ba3dbf91c701da Mon Sep 17 00:00:00 2001
From: Chad Whitacre <chadwhitacre@sentry.io>
Date: Tue, 30 Mar 2021 10:21:05 -0400
Subject: [PATCH] Refactor most of the rest (#903)

---
 install.sh                            | 148 +++-----------------------
 install/_lib.sh                       |  60 ++++++-----
 install/bootstrap-snuba.sh            |   6 ++
 install/build-docker-images.sh        |   8 ++
 install/create-kafka-topics.sh        |  14 +++
 install/ensure-files-from-examples.sh |   8 ++
 install/generate-secret-key.sh        |  12 +++
 install/replace-tsdb.sh               |  46 ++++++++
 install/set-up-zookeeper.sh           |  14 +++
 install/turn-things-off.sh            |  14 +++
 install/update-docker-images.sh       |  13 +++
 11 files changed, 178 insertions(+), 165 deletions(-)
 create mode 100644 install/bootstrap-snuba.sh
 create mode 100644 install/build-docker-images.sh
 create mode 100644 install/create-kafka-topics.sh
 create mode 100644 install/ensure-files-from-examples.sh
 create mode 100644 install/generate-secret-key.sh
 create mode 100644 install/replace-tsdb.sh
 create mode 100644 install/set-up-zookeeper.sh
 create mode 100644 install/turn-things-off.sh
 create mode 100644 install/update-docker-images.sh

diff --git a/install.sh b/install.sh
index 331fd9a..ba02bf6 100755
--- a/install.sh
+++ b/install.sh
@@ -19,17 +19,6 @@ MIN_RAM_HARD=3800 # MB
 MIN_RAM_SOFT=7800 # MB
 MIN_CPU_HARD=2
 MIN_CPU_SOFT=4
-
-# Increase the default 10 second SIGTERM timeout
-# to ensure celery queues are properly drained
-# between upgrades as task signatures may change across
-# versions
-STOP_TIMEOUT=60 # seconds
-SENTRY_CONFIG_PY='sentry/sentry.conf.py'
-SENTRY_CONFIG_YML='sentry/config.yml'
-SYMBOLICATOR_CONFIG_YML='symbolicator/config.yml'
-SENTRY_EXTRA_REQUIREMENTS='sentry/requirements.txt'
-MINIMIZE_DOWNTIME=
 echo $_endgroup
 
 echo "${_group}Parsing command line ..."
@@ -48,6 +37,9 @@ Options:
 EOF
 }
 
+SKIP_USER_PROMPT="${SKIP_USER_PROMPT:-}"
+MINIMIZE_DOWNTIME="${MINIMIZE_DOWNTIME:-}"
+
 while (( $# )); do
   case "$1" in
     -h | --help) show_help; exit;;
@@ -140,131 +132,15 @@ fi
 echo "${_endgroup}"
 
 source ./install/create-docker-volumes.sh
-
-echo "${_group}Ensuring files from examples ..."
-ensure_file_from_example $SENTRY_CONFIG_PY
-ensure_file_from_example $SENTRY_CONFIG_YML
-ensure_file_from_example $SENTRY_EXTRA_REQUIREMENTS
-ensure_file_from_example $SYMBOLICATOR_CONFIG_YML
-echo "${_endgroup}"
-
-echo "${_group}Generating secret key ..."
-if grep -xq "system.secret-key: '!!changeme!!'" $SENTRY_CONFIG_YML ; then
-  # This is to escape the secret key to be used in sed below
-  # Note the need to set LC_ALL=C due to BSD tr and sed always trying to decode
-  # whatever is passed to them. Kudos to https://stackoverflow.com/a/23584470/90297
-  SECRET_KEY=$(export LC_ALL=C; head /dev/urandom | tr -dc "a-z0-9@#%^&*(-_=+)" | head -c 50 | sed -e 's/[\/&]/\\&/g')
-  sed -i -e 's/^system.secret-key:.*$/system.secret-key: '"'$SECRET_KEY'"'/' $SENTRY_CONFIG_YML
-  echo "Secret key written to $SENTRY_CONFIG_YML"
-fi
-echo "${_endgroup}"
-
-echo "${_group}Replacing TSDB ..."
-replace_tsdb() {
-  if (
-    [[ -f "$SENTRY_CONFIG_PY" ]] &&
-    ! grep -xq 'SENTRY_TSDB = "sentry.tsdb.redissnuba.RedisSnubaTSDB"' "$SENTRY_CONFIG_PY"
-  ); then
-    # Do NOT indent the following string as it would be reflected in the end result,
-    # breaking the final config file. See getsentry/onpremise#624.
-    tsdb_settings="\
-SENTRY_TSDB = \"sentry.tsdb.redissnuba.RedisSnubaTSDB\"
-
-# Automatic switchover 90 days after $(date). Can be removed afterwards.
-SENTRY_TSDB_OPTIONS = {\"switchover_timestamp\": $(date +%s) + (90 * 24 * 3600)}\
-"
-
-    if grep -q 'SENTRY_TSDB_OPTIONS = ' "$SENTRY_CONFIG_PY"; then
-      echo "Not attempting automatic TSDB migration due to presence of SENTRY_TSDB_OPTIONS"
-    else
-      echo "Attempting to automatically migrate to new TSDB"
-      # Escape newlines for sed
-      tsdb_settings="${tsdb_settings//$'\n'/\\n}"
-      cp "$SENTRY_CONFIG_PY" "$SENTRY_CONFIG_PY.bak"
-      sed -i -e "s/^SENTRY_TSDB = .*$/${tsdb_settings}/g" "$SENTRY_CONFIG_PY" || true
-
-      if grep -xq 'SENTRY_TSDB = "sentry.tsdb.redissnuba.RedisSnubaTSDB"' "$SENTRY_CONFIG_PY"; then
-        echo "Migrated TSDB to Snuba. Old configuration file backed up to $SENTRY_CONFIG_PY.bak"
-        return
-      fi
-
-      echo "Failed to automatically migrate TSDB. Reverting..."
-      mv "$SENTRY_CONFIG_PY.bak" "$SENTRY_CONFIG_PY"
-      echo "$SENTRY_CONFIG_PY restored from backup."
-    fi
-
-    echo "WARN: Your Sentry configuration uses a legacy data store for time-series data. Remove the options SENTRY_TSDB and SENTRY_TSDB_OPTIONS from $SENTRY_CONFIG_PY and add:"
-    echo ""
-    echo "$tsdb_settings"
-    echo ""
-    echo "For more information please refer to https://github.com/getsentry/onpremise/pull/430"
-  fi
-}
-
-replace_tsdb
-echo "${_endgroup}"
-
-echo "${_group}Fetching and updating Docker images ..."
-# We tag locally built images with an '-onpremise-local' suffix. docker-compose pull tries to pull these too and
-# shows a 404 error on the console which is confusing and unnecessary. To overcome this, we add the stderr>stdout
-# redirection below and pass it through grep, ignoring all lines having this '-onpremise-local' suffix.
-$dc pull -q --ignore-pull-failures 2>&1 | grep -v -- -onpremise-local || true
-
-# We may not have the set image on the repo (local images) so allow fails
-docker pull ${SENTRY_IMAGE} || true;
-echo "${_endgroup}"
-
-echo "${_group}Building and tagging Docker images ..."
-echo ""
-$dc build --force-rm
-echo ""
-echo "Docker images built."
-echo "${_endgroup}"
-
-echo "${_group}Turning things off ..."
-if [[ -n "$MINIMIZE_DOWNTIME" ]]; then
-  # Stop everything but relay and nginx
-  $dc rm -fsv $($dc config --services | grep -v -E '^(nginx|relay)$')
-else
-  # Clean up old stuff and ensure nothing is working while we install/update
-  # This is for older versions of on-premise:
-  $dc -p onpremise down -t $STOP_TIMEOUT --rmi local --remove-orphans
-  # This is for newer versions
-  $dc down -t $STOP_TIMEOUT --rmi local --remove-orphans
-fi
-echo "${_endgroup}"
-
-echo "${_group}Setting up Zookeeper ..."
-ZOOKEEPER_SNAPSHOT_FOLDER_EXISTS=$($dcr zookeeper bash -c 'ls 2>/dev/null -Ubad1 -- /var/lib/zookeeper/data/version-2 | wc -l | tr -d '[:space:]'')
-if [[ "$ZOOKEEPER_SNAPSHOT_FOLDER_EXISTS" -eq 1 ]]; then
-  ZOOKEEPER_LOG_FILE_COUNT=$($dcr zookeeper bash -c 'ls 2>/dev/null -Ubad1 -- /var/lib/zookeeper/log/version-2/* | wc -l | tr -d '[:space:]'')
-  ZOOKEEPER_SNAPSHOT_FILE_COUNT=$($dcr zookeeper bash -c 'ls 2>/dev/null -Ubad1 -- /var/lib/zookeeper/data/version-2/* | wc -l | tr -d '[:space:]'')
-  # This is a workaround for a ZK upgrade bug: https://issues.apache.org/jira/browse/ZOOKEEPER-3056
-  if [[ "$ZOOKEEPER_LOG_FILE_COUNT" -gt 0 ]] && [[ "$ZOOKEEPER_SNAPSHOT_FILE_COUNT" -eq 0 ]]; then
-    $dcr -v $(pwd)/zookeeper:/temp zookeeper bash -c 'cp /temp/snapshot.0 /var/lib/zookeeper/data/version-2/snapshot.0'
-    $dc run -d -e ZOOKEEPER_SNAPSHOT_TRUST_EMPTY=true zookeeper
-  fi
-fi
-echo "${_endgroup}"
-
-echo "${_group}Bootstrapping and migrating Snuba ..."
-$dcr snuba-api bootstrap --no-migrate --force
-$dcr snuba-api migrations migrate --force
-echo "${_endgroup}"
-
-echo "${_group}Creating additional Kafka topics ..."
-# NOTE: This step relies on `kafka` being available from the previous `snuba-api bootstrap` step
-# XXX(BYK): We cannot use auto.create.topics as Confluence and Apache hates it now (and makes it very hard to enable)
-EXISTING_KAFKA_TOPICS=$($dcr kafka kafka-topics --list --bootstrap-server kafka:9092 2>/dev/null)
-NEEDED_KAFKA_TOPICS="ingest-attachments ingest-transactions ingest-events"
-for topic in $NEEDED_KAFKA_TOPICS; do
-  if ! echo "$EXISTING_KAFKA_TOPICS" | grep -wq $topic; then
-    $dcr kafka kafka-topics --create --topic $topic --bootstrap-server kafka:9092
-    echo ""
-  fi
-done
-echo "${_endgroup}"
-
+source ./install/ensure-files-from-examples.sh
+source ./install/generate-secret-key.sh
+source ./install/replace-tsdb.sh
+source ./install/update-docker-images.sh
+source ./install/build-docker-images.sh
+source ./install/turn-things-off.sh
+source ./install/set-up-zookeeper.sh
+source ./install/bootstrap-snuba.sh
+source ./install/create-kafka-topics.sh
 source ./install/upgrade-postgres.sh
 source ./install/set-up-and-migrate-database.sh
 source ./install/migrate-file-storage.sh
diff --git a/install/_lib.sh b/install/_lib.sh
index d0fad96..9c636fd 100644
--- a/install/_lib.sh
+++ b/install/_lib.sh
@@ -11,34 +11,36 @@ if [[ ! -d 'install' ]]; then echo 'Where are you?'; exit 1; fi
 
 _ENV="$(realpath .env)"
 
-define_stuff() {
-  # Read .env for default values with a tip o' the hat to https://stackoverflow.com/a/59831605/90297
-  t=$(mktemp) && export -p > "$t" && set -a && . $_ENV && set +a && . "$t" && rm "$t" && unset t
+# Read .env for default values with a tip o' the hat to https://stackoverflow.com/a/59831605/90297
+t=$(mktemp) && export -p > "$t" && set -a && . $_ENV && set +a && . "$t" && rm "$t" && unset t
 
-  if [ "${GITHUB_ACTIONS:-}" = "true" ]; then
-    _group="::group::"
-    _endgroup="::endgroup::"
-  else
-    _group="▶ "
-    _endgroup=""
-  fi
-
-  dc="docker-compose --no-ansi"
-  dcr="$dc run --rm"
-
-  function ensure_file_from_example {
-    if [[ -f "$1" ]]; then
-      echo "$1 already exists, skipped creation."
-    else
-      echo "Creating $1..."
-      cp -n $(echo "$1" | sed 's/\.[^.]*$/.example&/') "$1"
-      # sed from https://stackoverflow.com/a/25123013/90297
-    fi
-  }
-
-  stuff_defined="yes"
-}
-
-if [ "${stuff_defined:-''}" != "" ]; then
-  define_stuff
+if [ "${GITHUB_ACTIONS:-}" = "true" ]; then
+  _group="::group::"
+  _endgroup="::endgroup::"
+else
+  _group="▶ "
+  _endgroup=""
 fi
+
+dc="docker-compose --no-ansi"
+dcr="$dc run --rm"
+
+# A couple of the config files are referenced from other subscripts, so they
+# get vars, while multiple subscripts call ensure_file_from_example.
+function ensure_file_from_example {
+  if [[ -f "$1" ]]; then
+    echo "$1 already exists, skipped creation."
+  else
+    echo "Creating $1..."
+    cp -n $(echo "$1" | sed 's/\.[^.]*$/.example&/') "$1"
+    # sed from https://stackoverflow.com/a/25123013/90297
+  fi
+}
+SENTRY_CONFIG_PY='sentry/sentry.conf.py'
+SENTRY_CONFIG_YML='sentry/config.yml'
+
+# Increase the default 10 second SIGTERM timeout
+# to ensure celery queues are properly drained
+# between upgrades as task signatures may change across
+# versions
+STOP_TIMEOUT=60 # seconds
diff --git a/install/bootstrap-snuba.sh b/install/bootstrap-snuba.sh
new file mode 100644
index 0000000..2952ed0
--- /dev/null
+++ b/install/bootstrap-snuba.sh
@@ -0,0 +1,6 @@
+echo "${_group}Bootstrapping and migrating Snuba ..."
+
+$dcr snuba-api bootstrap --no-migrate --force
+$dcr snuba-api migrations migrate --force
+
+echo "${_endgroup}"
diff --git a/install/build-docker-images.sh b/install/build-docker-images.sh
new file mode 100644
index 0000000..4bb96b5
--- /dev/null
+++ b/install/build-docker-images.sh
@@ -0,0 +1,8 @@
+echo "${_group}Building and tagging Docker images ..."
+
+echo ""
+$dc build --force-rm
+echo ""
+echo "Docker images built."
+
+echo "${_endgroup}"
diff --git a/install/create-kafka-topics.sh b/install/create-kafka-topics.sh
new file mode 100644
index 0000000..a542cb5
--- /dev/null
+++ b/install/create-kafka-topics.sh
@@ -0,0 +1,14 @@
+echo "${_group}Creating additional Kafka topics ..."
+
+# NOTE: This step relies on `kafka` being available from the previous `snuba-api bootstrap` step
+# XXX(BYK): We cannot use auto.create.topics as Confluence and Apache hates it now (and makes it very hard to enable)
+EXISTING_KAFKA_TOPICS=$($dcr kafka kafka-topics --list --bootstrap-server kafka:9092 2>/dev/null)
+NEEDED_KAFKA_TOPICS="ingest-attachments ingest-transactions ingest-events"
+for topic in $NEEDED_KAFKA_TOPICS; do
+  if ! echo "$EXISTING_KAFKA_TOPICS" | grep -wq $topic; then
+    $dcr kafka kafka-topics --create --topic $topic --bootstrap-server kafka:9092
+    echo ""
+  fi
+done
+
+echo "${_endgroup}"
diff --git a/install/ensure-files-from-examples.sh b/install/ensure-files-from-examples.sh
new file mode 100644
index 0000000..0a507d6
--- /dev/null
+++ b/install/ensure-files-from-examples.sh
@@ -0,0 +1,8 @@
+echo "${_group}Ensuring files from examples ..."
+
+ensure_file_from_example $SENTRY_CONFIG_PY
+ensure_file_from_example $SENTRY_CONFIG_YML
+ensure_file_from_example 'symbolicator/config.yml'
+ensure_file_from_example 'sentry/requirements.txt'
+
+echo "${_endgroup}"
diff --git a/install/generate-secret-key.sh b/install/generate-secret-key.sh
new file mode 100644
index 0000000..de2afba
--- /dev/null
+++ b/install/generate-secret-key.sh
@@ -0,0 +1,12 @@
+echo "${_group}Generating secret key ..."
+
+if grep -xq "system.secret-key: '!!changeme!!'" $SENTRY_CONFIG_YML ; then
+  # This is to escape the secret key to be used in sed below
+  # Note the need to set LC_ALL=C due to BSD tr and sed always trying to decode
+  # whatever is passed to them. Kudos to https://stackoverflow.com/a/23584470/90297
+  SECRET_KEY=$(export LC_ALL=C; head /dev/urandom | tr -dc "a-z0-9@#%^&*(-_=+)" | head -c 50 | sed -e 's/[\/&]/\\&/g')
+  sed -i -e 's/^system.secret-key:.*$/system.secret-key: '"'$SECRET_KEY'"'/' $SENTRY_CONFIG_YML
+  echo "Secret key written to $SENTRY_CONFIG_YML"
+fi
+
+echo "${_endgroup}"
diff --git a/install/replace-tsdb.sh b/install/replace-tsdb.sh
new file mode 100644
index 0000000..0716bc1
--- /dev/null
+++ b/install/replace-tsdb.sh
@@ -0,0 +1,46 @@
+echo "${_group}Replacing TSDB ..."
+
+replace_tsdb() {
+  if (
+    [[ -f "$SENTRY_CONFIG_PY" ]] &&
+    ! grep -xq 'SENTRY_TSDB = "sentry.tsdb.redissnuba.RedisSnubaTSDB"' "$SENTRY_CONFIG_PY"
+  ); then
+    # Do NOT indent the following string as it would be reflected in the end result,
+    # breaking the final config file. See getsentry/onpremise#624.
+    tsdb_settings="\
+SENTRY_TSDB = \"sentry.tsdb.redissnuba.RedisSnubaTSDB\"
+
+# Automatic switchover 90 days after $(date). Can be removed afterwards.
+SENTRY_TSDB_OPTIONS = {\"switchover_timestamp\": $(date +%s) + (90 * 24 * 3600)}\
+"
+
+    if grep -q 'SENTRY_TSDB_OPTIONS = ' "$SENTRY_CONFIG_PY"; then
+      echo "Not attempting automatic TSDB migration due to presence of SENTRY_TSDB_OPTIONS"
+    else
+      echo "Attempting to automatically migrate to new TSDB"
+      # Escape newlines for sed
+      tsdb_settings="${tsdb_settings//$'\n'/\\n}"
+      cp "$SENTRY_CONFIG_PY" "$SENTRY_CONFIG_PY.bak"
+      sed -i -e "s/^SENTRY_TSDB = .*$/${tsdb_settings}/g" "$SENTRY_CONFIG_PY" || true
+
+      if grep -xq 'SENTRY_TSDB = "sentry.tsdb.redissnuba.RedisSnubaTSDB"' "$SENTRY_CONFIG_PY"; then
+        echo "Migrated TSDB to Snuba. Old configuration file backed up to $SENTRY_CONFIG_PY.bak"
+        return
+      fi
+
+      echo "Failed to automatically migrate TSDB. Reverting..."
+      mv "$SENTRY_CONFIG_PY.bak" "$SENTRY_CONFIG_PY"
+      echo "$SENTRY_CONFIG_PY restored from backup."
+    fi
+
+    echo "WARN: Your Sentry configuration uses a legacy data store for time-series data. Remove the options SENTRY_TSDB and SENTRY_TSDB_OPTIONS from $SENTRY_CONFIG_PY and add:"
+    echo ""
+    echo "$tsdb_settings"
+    echo ""
+    echo "For more information please refer to https://github.com/getsentry/onpremise/pull/430"
+  fi
+}
+
+replace_tsdb
+
+echo "${_endgroup}"
diff --git a/install/set-up-zookeeper.sh b/install/set-up-zookeeper.sh
new file mode 100644
index 0000000..00b633d
--- /dev/null
+++ b/install/set-up-zookeeper.sh
@@ -0,0 +1,14 @@
+echo "${_group}Setting up Zookeeper ..."
+
+ZOOKEEPER_SNAPSHOT_FOLDER_EXISTS=$($dcr zookeeper bash -c 'ls 2>/dev/null -Ubad1 -- /var/lib/zookeeper/data/version-2 | wc -l | tr -d '[:space:]'')
+if [[ "$ZOOKEEPER_SNAPSHOT_FOLDER_EXISTS" -eq 1 ]]; then
+  ZOOKEEPER_LOG_FILE_COUNT=$($dcr zookeeper bash -c 'ls 2>/dev/null -Ubad1 -- /var/lib/zookeeper/log/version-2/* | wc -l | tr -d '[:space:]'')
+  ZOOKEEPER_SNAPSHOT_FILE_COUNT=$($dcr zookeeper bash -c 'ls 2>/dev/null -Ubad1 -- /var/lib/zookeeper/data/version-2/* | wc -l | tr -d '[:space:]'')
+  # This is a workaround for a ZK upgrade bug: https://issues.apache.org/jira/browse/ZOOKEEPER-3056
+  if [[ "$ZOOKEEPER_LOG_FILE_COUNT" -gt 0 ]] && [[ "$ZOOKEEPER_SNAPSHOT_FILE_COUNT" -eq 0 ]]; then
+    $dcr -v $(pwd)/zookeeper:/temp zookeeper bash -c 'cp /temp/snapshot.0 /var/lib/zookeeper/data/version-2/snapshot.0'
+    $dc run -d -e ZOOKEEPER_SNAPSHOT_TRUST_EMPTY=true zookeeper
+  fi
+fi
+
+echo "${_endgroup}"
diff --git a/install/turn-things-off.sh b/install/turn-things-off.sh
new file mode 100644
index 0000000..090dc8d
--- /dev/null
+++ b/install/turn-things-off.sh
@@ -0,0 +1,14 @@
+echo "${_group}Turning things off ..."
+
+if [[ -n "$MINIMIZE_DOWNTIME" ]]; then
+  # Stop everything but relay and nginx
+  $dc rm -fsv $($dc config --services | grep -v -E '^(nginx|relay)$')
+else
+  # Clean up old stuff and ensure nothing is working while we install/update
+  # This is for older versions of on-premise:
+  $dc -p onpremise down -t $STOP_TIMEOUT --rmi local --remove-orphans
+  # This is for newer versions
+  $dc down -t $STOP_TIMEOUT --rmi local --remove-orphans
+fi
+
+echo "${_endgroup}"
diff --git a/install/update-docker-images.sh b/install/update-docker-images.sh
new file mode 100644
index 0000000..e6d232c
--- /dev/null
+++ b/install/update-docker-images.sh
@@ -0,0 +1,13 @@
+echo "${_group}Fetching and updating Docker images ..."
+
+# We tag locally built images with an '-onpremise-local' suffix. docker-compose
+# pull tries to pull these too and shows a 404 error on the console which is
+# confusing and unnecessary. To overcome this, we add the stderr>stdout
+# redirection below and pass it through grep, ignoring all lines having this
+# '-onpremise-local' suffix.
+$dc pull -q --ignore-pull-failures 2>&1 | grep -v -- -onpremise-local || true
+
+# We may not have the set image on the repo (local images) so allow fails
+docker pull ${SENTRY_IMAGE} || true;
+
+echo "${_endgroup}"