Rename "db" to "hub" in preparation for score-pull vs. score-push

Author: ryapric

Makefile

@@ -20,7 +20,7 @@ connect-aws:
 
 provision-local:
 # Don't re-provision DB at the same time, since it throws off team server tests
-	@vagrant provision db
+	@vagrant provision hub
 	@vagrant provision $(local_team_servers)
 
 provision-aws:

Vagrantfile

@@ -22,26 +22,26 @@ Vagrant.configure("2") do |config|
     config.vbguest.auto_update = false
   end
 
-  # DB server static IP
-  db_addr = "10.0.1.10"
-  ip_bytes = db_addr.split(".")
+  # hub server static IP
+  hub_addr = "10.0.1.10"
+  ip_bytes = hub_addr.split(".")
 
-  config.vm.define "db" do |db|
-    db.vm.box = box
+  config.vm.define "hub" do |hub|
+    hub.vm.box = box
 
-    db.vm.network "private_network", ip: db_addr
-    db.vm.network "forwarded_port", guest: 5432, host: 5432, protocol: "tcp" # DB
-    db.vm.network "forwarded_port", guest: 8000, host: 8000, protocol: "tcp" # Dummy web app
-    db.vm.network "forwarded_port", guest: 8080, host: 8080, protocol: "tcp" # Score dashboard
+    hub.vm.network "private_network", ip: hub_addr
+    hub.vm.network "forwarded_port", guest: 5432, host: 5432, protocol: "tcp" # hub
+    hub.vm.network "forwarded_port", guest: 8000, host: 8000, protocol: "tcp" # Dummy web app
+    hub.vm.network "forwarded_port", guest: 8080, host: 8080, protocol: "tcp" # Score dashboard
 
-    db.vm.synced_folder ".", "/vagrant", disabled: true
+    hub.vm.synced_folder ".", "/vagrant", disabled: true
 
-    db.vm.provision "file", source: "./scripts", destination: "/tmp/scripts"
-    db.vm.provision "file", source: "./services", destination: "/tmp/services"
-    db.vm.provision "file", source: "./score-server", destination: "/tmp/score-server"
-    db.vm.provision "file", source: "./dummy-web-app", destination: "/tmp/dummy-web-app"
+    hub.vm.provision "file", source: "./scripts", destination: "/tmp/scripts"
+    hub.vm.provision "file", source: "./services", destination: "/tmp/services"
+    hub.vm.provision "file", source: "./score-server", destination: "/tmp/score-server"
+    hub.vm.provision "file", source: "./dummy-web-app", destination: "/tmp/dummy-web-app"
 
-    db.vm.provision "shell",
+    hub.vm.provision "shell",
       inline: <<-SCRIPT
         #!/usr/bin/env bash
         set -euo pipefail
@@ -52,7 +52,7 @@ Vagrant.configure("2") do |config|
 
         rm -rf /root/{score-server,services,dummy-web-app}
         sudo cp -r /tmp/{score-server,services,dummy-web-app} /root/
-        bash /tmp/scripts/init-db.sh
+        bash /tmp/scripts/init-hub.sh
       SCRIPT
   end
 
@@ -81,7 +81,7 @@ Vagrant.configure("2") do |config|
           sudo systemctl restart ssh
 
           export team_name="Team-#{i}"
-          export db_addr='#{db_addr}'
+          export hub_addr='#{hub_addr}'
           bash /tmp/scripts/init.sh
           bats -F pretty /.ws/scripts/test.bats
         SCRIPT

scripts/init-db.sh scripts/init-hub.shscripts/init-db.sh renamed to scripts/init-hub.sh

@@ -18,8 +18,8 @@ if [[ -z "${team_name}" ]]; then
   log-fatal 'Env var "team_name" not set at runtime'
 fi
 
-if [[ -z "${db_addr}" ]]; then
-  log-fatal 'Env var "db_addr" not set at runtime'
+if [[ -z "${hub_addr}" ]]; then
+  log-fatal 'Env var "hub_addr" not set at runtime'
 fi
 
 ###
@@ -84,13 +84,13 @@ ufw default allow incoming
 ufw default allow outgoing
 ufw deny out 8000
 log-info 'Adding file for teams to know which IP to use for one of the networking challenges'
-printf '%s\n' "${db_addr}" > /home/appuser/.remote-ip.txt
+printf '%s\n' "${hub_addr}" > /home/appuser/.remote-ip.txt
 
 ###
 log-info 'Writing out vars to env file(s) for systemd services'
 rm -f "${wsroot}"/env && touch "${wsroot}"/env
 {
-  printf 'db_addr=%s\n' "${db_addr}"
+  printf 'hub_addr=%s\n' "${hub_addr}"
   printf 'team_name=%s\n' "$(hostname)"
 } >> "${wsroot}"/env
 
@@ -103,24 +103,24 @@ systemctl enable linux-workshop-admin.timer
 systemctl start linux-workshop-admin.timer
 
 ###
-_db_init() {
+_hub_init() {
   # shellcheck disable=SC1091
   source /usr/local/share/ezlog/src/main.sh
   log-info 'Waiting for DB to be reachable...'
-  until timeout 2s psql -U postgres -h "${db_addr}" -c 'SELECT NOW();' > /dev/null ; do
+  until timeout 2s psql -U postgres -h "${hub_addr}" -c 'SELECT NOW();' > /dev/null ; do
     log-info 'Still waiting for DB to be reachable...'
     sleep 5
   done
   log-info 'Successfully reached DB, trying to initialize with base values so team appears on dashboard...'
   # until-loop because DB can be reachable before schema is made
-  until psql -U postgres -h "${db_addr}" -c "INSERT INTO scoring (timestamp, team_name, last_challenge_completed, score) VALUES (NOW(), '$(hostname)', 0, 0);" > /dev/null ; do
+  until psql -U postgres -h "${hub_addr}" -c "INSERT INTO scoring (timestamp, team_name, last_challenge_completed, score) VALUES (NOW(), '$(hostname)', 0, 0);" > /dev/null ; do
     log-info 'Issue with setting base values; trying again...'
     sleep 1
   done
   log-info 'Successfully initialized with base values'
 }
-export -f _db_init
-timeout 180s bash -c _db_init
+export -f _hub_init
+timeout 180s bash -c _hub_init
 
 ###
 log-info 'Dumping the first instruction(s) to the appuser homedir'

scripts/init.sh

@@ -67,7 +67,7 @@ _get-last-challenge-completed() {
 # _accrue-points adds monotonically-increasing point values, the rate of which
 # will increase over time at aggregate since this is called per-challenge.
 _accrue-points() {
-  psql -U postgres -h "${db_addr:-NOT_SET}" -c "
+  psql -U postgres -h "${hub_addr:-NOT_SET}" -c "
     INSERT INTO scoring (
       timestamp,
       team_name,
@@ -131,7 +131,7 @@ _check-debfile-service-running() {
 }
 
 _check-webapp-reachable() {
-  if timeout 1s curl -fsSL "${db_addr:-NOT_SET}:8000" > /dev/null ; then
+  if timeout 1s curl -fsSL "${hub_addr:-NOT_SET}:8000" > /dev/null ; then
     _score-for-challenge 5
   else
     log-error "web app is not reachable"

scripts/linux-workshop-admin.sh

@@ -18,8 +18,8 @@ source "${HOME}/.local/ezlog/src/main.sh"
 
 server_num="${1:-NOT_SET}"
 
-if [[ -z "${db_priv_ip:-NOT_SET}" ]] ; then
-  log-fatal 'db_priv_ip not provided to team server provisioning script'
+if [[ -z "${hub_priv_ip:-NOT_SET}" ]] ; then
+  log-fatal 'hub_priv_ip not provided to team server provisioning script'
 fi
 if [[ -z "${team_server_ips:-NOT_SET}" ]] ; then
   log-fatal 'team_server_ips not provided to team server provisioning script'
@@ -32,7 +32,7 @@ log-info "Adding files to Team server ${server_num} at ${server_ip}..."
 scp -P 2332 -r -o StrictHostKeyChecking=accept-new ../scripts ../services ../instructions ../dummy-app-src admin@"${server_ip}":/tmp
 
 log-info "Running init on Team server ${server_num} at ${server_ip}..."
-ssh -p 2332 admin@"${server_ip}" "export team_name=Team-${server_num} && export db_addr=${db_priv_ip} && sudo -E bash /tmp/scripts/init.sh"
+ssh -p 2332 admin@"${server_ip}" "export team_name=Team-${server_num} && export hub_addr=${hub_priv_ip} && sudo -E bash /tmp/scripts/init.sh"
 
 log-info "Running tests on Team server ${server_num} at ${server_ip}..."
 ssh -p 2332 admin@"${server_ip}" "sudo -E bats /.ws/scripts/test.bats"

scripts/provision-ec2-team-parallelizer.sh

@@ -4,7 +4,7 @@ set -euo pipefail
 ################################################################################
 # Root script to provision AWS EC2 instances for the workshop.
 #
-# The DB server is provisioned first, and then each team server is provisioned
+# The Hub server is provisioned first, and then each team server is provisioned
 # in parallel by the neighbor script.
 ################################################################################
 
@@ -31,25 +31,25 @@ log-info 'Getting Terraform outputs...'
 (cd ../terraform && terraform output -json) > "${outputs_file}"
 
 log-info 'Determining IP addresses of DB server...'
-db_pub_ip="$(jq -rc '.db_pub_ip.value' ${outputs_file})"
-db_priv_ip="$(jq -rc '.db_priv_ip.value' ${outputs_file})"
-log-info "DB IPs: Public ${db_pub_ip}, Private ${db_priv_ip}"
+hub_pub_ip="$(jq -rc '.hub_pub_ip.value' ${outputs_file})"
+hub_priv_ip="$(jq -rc '.hub_priv_ip.value' ${outputs_file})"
+log-info "Hub IPs: Public ${hub_pub_ip}, Private ${hub_priv_ip}"
 
 log-info 'Determining IP addresses of Team servers...'
 num_teams="$(jq '[.instance_ips.value[]] | length' ${outputs_file})"
 team_server_ips="$(jq -c '[.instance_ips.value[]]' ${outputs_file})"
 log-info "${num_teams} teams, with IPs of: ${team_server_ips}"
 
-# Provision the DB server first, so that if it fails we know we're about to have
+# Provision the Hub server first, so that if it fails we know we're about to have
 # a bad time overall
-log-info 'Adding DB server init script...'
-scp -P 2332 -o StrictHostKeyChecking=accept-new -r ../{scripts,services,score-server,dummy-web-app} "admin@${db_pub_ip}":/tmp
-ssh -p 2332 admin@"${db_pub_ip}" -- 'sudo cp -r /tmp/{score-server,services,dummy-web-app} /root/'
-log-info 'Running DB server init script...'
-ssh -p 2332 admin@"${db_pub_ip}" 'sudo bash /tmp/scripts/init-db.sh'
+log-info 'Adding Hub server init script...'
+scp -P 2332 -o StrictHostKeyChecking=accept-new -r ../{scripts,services,score-server,dummy-web-app} "admin@${hub_pub_ip}":/tmp
+ssh -p 2332 admin@"${hub_pub_ip}" -- 'sudo cp -r /tmp/{score-server,services,dummy-web-app} /root/'
+log-info 'Running Hub server init script...'
+ssh -p 2332 admin@"${hub_pub_ip}" 'sudo bash /tmp/scripts/init-hub.sh'
 
 # Export needed vars so the subscript can see them
-export db_priv_ip
+export hub_priv_ip
 export team_server_ips
 
 # Parallelize provisioning of the team servers

scripts/provision-ec2.sh

@@ -20,7 +20,7 @@ fi
 # This file should have been populated on init
 # shellcheck disable=SC1091
 source "${wsroot}"/env || exit 1
-[[ -n "${db_addr:-}" ]] || exit 1
+[[ -n "${hub_addr:-}" ]] || exit 1
 
 # setup* and teardown* are bats-specifically-named pre-/post-test hook
 # functions. <setup|teardown>_file run once, period, and <setup|teardown> run
@@ -89,7 +89,7 @@ teardown_file() {
 }
 
 _reset-score() {
-  psql -U postgres -h "${db_addr}" -c "
+  psql -U postgres -h "${hub_addr}" -c "
     DELETE FROM scoring WHERE team_name = '$(hostname)';
     INSERT INTO scoring (timestamp, team_name, last_challenge_completed, score) VALUES (NOW(), '$(hostname)', 0, 0);
   "
@@ -101,7 +101,7 @@ _get-score() {
   # Need to stop again becaue starting the .service restarts the timer because
   # of its 'Want' directive
   systemctl stop linux-workshop-admin.timer
-  local score="$(psql -U postgres -h "${db_addr}" -tAc 'SELECT SUM(score) FROM scoring;')"
+  local score="$(psql -U postgres -h "${hub_addr}" -tAc 'SELECT SUM(score) FROM scoring;')"
   printf '%s' "${score}"
 }
 
@@ -288,7 +288,7 @@ _solve-challenge-7() {
   sleep 1
   printf 'DEBUG: Score from challenge 5: %s\n' "${score}"
   counter=0
-  until timeout 1s curl -fsSL "${db_addr}:8000" ; do
+  until timeout 1s curl -fsSL "${hub_addr}:8000" ; do
     printf 'Web app not reachable, trying again...\n' >&2
     counter="$((counter + 1))"
     if [[ "${counter}" -ge 30 ]] ; then

scripts/test.bats

@@ -5,7 +5,7 @@ provider "aws" {
 }
 
 locals {
-  db_ip   = "10.0.1.10"
+  hub_ip  = "10.0.1.10"
   region  = var.aws_region
   name    = "${var.event_name}-osc-workshop-linux"
   my_cidr = "${chomp(data.http.my_ip.response_body)}/32"
@@ -89,11 +89,11 @@ module "security_group" {
   tags = local.tags
 }
 
-module "db" {
+module "hub" {
   source  = "terraform-aws-modules/ec2-instance/aws"
   version = "~> 4.0"
 
-  name = "${local.name}-db"
+  name = "${local.name}-hub"
 
   ami                         = data.aws_ami.latest.id
   instance_type               = "t3a.micro"

terraform/main.tf

@@ -2,14 +2,14 @@ output "instance_ips" {
   value = { for instance in module.team_servers : instance.tags_all["Name"] => instance.public_ip }
 }
 
-output "db_pub_ip" {
-  value = module.db.public_ip
+output "hub_pub_ip" {
+  value = module.hub.public_ip
 }
 
-output "db_pub_endpoint" {
-  value = "http://${module.db.public_ip}:8080"
+output "hub_pub_endpoint" {
+  value = "http://${module.hub.public_ip}:8080"
 }
 
-output "db_priv_ip" {
-  value = module.db.private_ip
+output "hub_priv_ip" {
+  value = module.hub.private_ip
 }