Refines the shared environment template

TL;DR
-----

Improves the shared environment template based on recent lab work

Details
-------

Updates the shared environment template based on recurring lifecycle
script needs.

* Assures all challenges have the minimal lifecycle scripts for each
  stage and host
* Uses `/usr/bin/env bash` as the shebang for all lifecycle scripts
* Sets `KUBECONFIG` or `HOME_DIR` variables  at the start of each
  lifecycle script
* Sets the most used agent variables in the track setup scripts
* Adds `get_app_slug` to the header and refines it to use the
  application name instead of assuming the first app is the right one

instruqt/shared-env-template/01-getting-to-know-the-template/check-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/01-getting-to-know-the-template/check-shell

@@ -2,6 +2,8 @@
 
 # This set line ensures that all failures will cause the script to error and exit
 set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
 
 # save the entire session to check user inputs and outputs
 tmux capture-pane -t shell -S -

instruqt/shared-env-template/01-getting-to-know-the-template/cleanup-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/01-getting-to-know-the-template/cleanup-shell

@@ -2,6 +2,8 @@
 
 # This set line ensures that all failures will cause the script to error and exit
 set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
 
 # clear the tmux pane and scrollback to look like a fresh shell
 tmux clear-history -t shell 

instruqt/shared-env-template/01-getting-to-know-the-template/setup-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/01-getting-to-know-the-template/setup-shell

@@ -2,23 +2,23 @@
 
 # This set line ensures that all failures will cause the script to error and exit
 set -euxo pipefail
-
 HOME_DIR=/home/replicant
+source /etc/profile.d/header.sh
+
+### Assure the tmux session exists
+#
+# In a test scenario Instuqt does not run the user shell for the
+# challenge, which means the tmux session is never established. We
+# need to session for the solve scripts for other challenges to 
+# succeed, so let's create it here.
+#
+if ! tmux has-session -t shell ; then
+  tmux new-session -d -s shell su - replicant
+fi
 
 # Wait for Instruqt bootstrap to be complete
 while [ ! -f /opt/instruqt/bootstrap/host-bootstrap-completed ]
 do
   echo "Waiting for Instruqt to finish booting the VM"
   sleep 1
 done
-
-# Display PARTICIPANT_ID info for Vendor Portal
-cat<<SCRIPT >> ${HOME_DIR}/.bashrc
-show_credentials () {
-  echo Credentials for https://vendor.replicated.com
-  echo Username: $INSTRUQT_PARTICIPANT_ID@replicated-labs.com
-  echo Password: $INSTRUQT_PARTICIPANT_ID
-}
-
-show_credentials
-SCRIPT

instruqt/shared-env-template/01-getting-to-know-the-template/solve-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/01-getting-to-know-the-template/solve-shell

@@ -2,17 +2,8 @@
 
 # This set line ensures that all failures will cause the script to error and exit
 set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
 
-### Assure the tmux session exists
-#
-# In a test scenario Instuqt does not run the user shell for the
-# challenge, which means the tmux session is never established. We
-# need to session for the solve scripts for other challenges to 
-# succeed, so let's create it here.
-#
-
-if ! tmux has-session -t shell ; then
-  tmux new-session -d -s shell su - replicant
-fi
-
+# set the variable into the shell
 tmux send-keys -t shell export SPACE 'THIS="the way"' ENTER

instruqt/shared-env-template/02-using-the-template/check-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/02-using-the-template/check-shell

@@ -2,12 +2,14 @@
 
 # This set line ensures that all failures will cause the script to error and exit
 set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
 
 # save the entire session to check user inputs and outputs
 tmux capture-pane -t shell -S -
 SESSION=$(tmux save-buffer -)
 
-# check for disconnection
+# check that the variable has been set
 if ! grep -qE 'echo' <(echo ${SESSION}) ; then
   fail-message 'Please make sure you can still access `$THIS`'
   exit 1

instruqt/shared-env-template/02-using-the-template/cleanup-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/02-using-the-template/cleanup-shell

@@ -1,11 +1,11 @@
-#!/bin/sh
-#
-# This script runs when the platform cleanup the challenge.
-#
-# The platform determines if the script was successful using the exit code of this
-# script. If the exit code is not 0, the script fails. 
-#
+#!/usr/bin/env bash
 
-echo "This is the cleanup script"
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+HOME_DIR=/home/replicant
+#
+# clear the tmux pane and scrollback to look like a fresh shell
+tmux clear-history -t shell 
+tmux send-keys -t shell clear ENTER
 
 exit 0

instruqt/shared-env-template/02-using-the-template/setup-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/02-using-the-template/setup-shell

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
+
+### Assure the tmux session exists
+#
+# In a test scenario Instuqt does not run the user shell for the
+# challenge, which means the tmux session is never established. We
+# need to session for the solve scripts for other challenges to 
+# succeed, so let's create it here.
+#
+if ! tmux has-session -t shell ; then
+  tmux new-session -d -s shell su - replicant
+fi
+
+exit 0

instruqt/shared-env-template/02-using-the-template/solve-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/02-using-the-template/solve-shell

@@ -2,17 +2,8 @@
 
 # This set line ensures that all failures will cause the script to error and exit
 set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
 
-### Assure the tmux session exists
-#
-# In a test scenario Instuqt does not run the user shell for the
-# challenge, which means the tmux session is never established. We
-# need to session for the solve scripts for other challenges to 
-# succeed, so let's create it here.
-#
-
-if ! tmux has-session -t shell ; then
-  tmux new-session -d -s shell su - replicant
-fi
-
+# show the variable in the shell
 tmux send-keys -t shell echo SPACE '$THIS' ENTER

instruqt/shared-env-template/03-tips-and-tricks/check-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/03-tips-and-tricks/check-shell

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
+
+exit 0

instruqt/shared-env-template/03-tips-and-tricks/cleanup-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/03-tips-and-tricks/cleanup-shell

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
+
+exit 0
+

instruqt/shared-env-template/03-tips-and-tricks/setup-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/03-tips-and-tricks/setup-shell

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
+
+### Assure the tmux session exists
+#
+# In a test scenario Instuqt does not run the user shell for the
+# challenge, which means the tmux session is never established. We
+# need to session for the solve scripts for other challenges to 
+# succeed, so let's create it here.
+#
+if ! tmux has-session -t shell ; then
+  tmux new-session -d -s shell su - replicant
+fi
+
+exit 0

instruqt/shared-env-template/03-tips-and-tricks/solve-cluster

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+source /etc/profile/header.sh
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+
+exit 0

instruqt/shared-env-template/03-tips-and-tricks/solve-shell

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# This set line ensures that all failures will cause the script to error and exit
+set -euxo pipefail
+HOME_DIR=/home/replicant
+source /etc/profile/header.sh
+
+exit 0

instruqt/shared-env-template/track_scripts/setup-cluster

@@ -5,6 +5,7 @@ set -euxo pipefail
 
 # use our shared libary in setup scripts
 curl -s -o /etc/profile.d/header.sh https://raw.githubusercontent.com/replicatedhq/kots-field-labs/main/libs/header.sh
+source /etc/profile.d/header.sh
 
 # simple SSH client setup so we can SSH to/from the shell
 cat <<EOF >> "$HOME/.ssh/config"

instruqt/shared-env-template/track_scripts/setup-shell

@@ -6,6 +6,7 @@ HOME_DIR=/home/replicant
 
 # use our shared libary in setup scripts
 curl -s -o /etc/profile.d/header.sh https://raw.githubusercontent.com/replicatedhq/kots-field-labs/main/libs/header.sh
+source /etc/profile.d/header.sh
 
 # simple SSH client setup so we can SSH to/from the shell
 cat <<EOF >> "$HOME/.ssh/config"
@@ -20,3 +21,14 @@ ssh-keygen -t rsa -f /etc/dropbear/dropbear_rsa_host_key -N ''
 # change the cluster URI
 yq -i '.clusters[0].cluster.server = "https://cluster:6443"' ${HOME_DIR}/.kube/config
 chown -R replicant ${HOME_DIR}/.kube
+
+# set up some variables that are needed in most labs
+
+# there's only one app created by the automation, so just grab the first in the list
+access_token=$(get_api_token)
+app_slug=$(get_app_slug)
+
+agent variable set USERNAME $(get_username)
+agent variable set PASSWORD $(get_password)
+agent variable set REPLICATED_API_TOKEN ${access_token}
+agent variable set REPLICATED_APP ${app_slug}

libs/header.sh

@@ -42,3 +42,9 @@ get_api_token () {
 
   echo ${access_token}
 }
+
+get_app_slug () {
+  application=${1:-"Slackernews"}
+  access_token=$(get_api_token)
+  app_slug=$(curl --header 'Accept: application/json' --header "Authorization: ${access_token}" https://api.replicated.com/vendor/v3/apps | jq -r '| jq -r --arg application ${application} '.apps[] | select( .name == $application ) | .slug')
+}