🔧 Add scripts to easily port-forward non k8s services

ministryofjustice · Sep 2, 2024 · 34d734a · 34d734a
1 parent 5543837
commit 34d734a
Show file tree

Hide file tree

Showing 3 changed files with 176 additions and 0 deletions.
diff --git a/tools/scripts/amq-connect.sh b/tools/scripts/amq-connect.sh
@@ -0,0 +1,62 @@
+#!/bin/bash#!/bin/bash
+
+# trap ctrl-c and call ctrl_c()
+trap ctrl_c INT
+# trap fail and call fail()
+trap fail ERR
+
+main() {        
+    env=$1
+    if [ "$env" == "poc" ]; then
+        namespace="hmpps-delius-alfrsco-${env}"
+    else 
+        namespace="hmpps-delius-alfresco-${env}"
+    fi
+    echo "Connecting to AMQ Console in namespace $namespace"
+
+    # get amq connection url
+    URL=$(kubectl get secrets amazon-mq-broker-secret --namespace ${namespace} -o json | jq -r ".data.BROKER_CONSOLE_URL | @base64d")
+    # extract host and port
+    HOST=$(echo $URL | cut -d '/' -f 3 | cut -d ':' -f 1)
+    # extract protocol
+    PROTOCOL=$(echo $URL | awk -F'://' '{print $1}')
+    # extract remote port
+    REMOTE_PORT=$(echo $URL | cut -d '/' -f 3 | cut -d ':' -f 2)
+    # if custom local port not provided, use remote port
+    if [ -z "$2" ]; then
+        LOCAL_PORT=$REMOTE_PORT
+    else
+        LOCAL_PORT=$2
+    fi
+    # generate random hex string
+    RANDOM_HEX=$(openssl rand -hex 4)
+    # start port forwarding
+    kubectl run port-forward-pod-${RANDOM_HEX} --image=ghcr.io/ministryofjustice/hmpps-delius-alfresco-port-forward-pod:latest --port ${LOCAL_PORT} --env="REMOTE_HOST=$HOST" --env="LOCAL_PORT=$LOCAL_PORT" --env="REMOTE_PORT=$REMOTE_PORT" --namespace ${namespace};
+    # wait for pod to start
+    kubectl wait --for=condition=ready pod/port-forward-pod-${RANDOM_HEX} --timeout=30s --namespace ${namespace}
+    printf "\nPort forwarding started, connecting to $HOST:$REMOTE_PORT \n"
+    printf "\n****************************************************\n"
+    printf "Connect to ${PROTOCOL}://localhost:$LOCAL_PORT locally\n"
+    printf "Press Ctrl+C to stop port forwarding \n"
+    printf "****************************************************\n\n"
+    # start the local port forwarding session
+    kubectl port-forward --namespace ${namespace} port-forward-pod-${RANDOM_HEX} $LOCAL_PORT:$LOCAL_PORT;
+}
+
+fail() {
+    echo "\n\nPort forwarding failed"
+    kubectl delete pod port-forward-pod-${RANDOM_HEX} --force --grace-period=0  --namespace ${namespace}
+    exit 1
+}
+ctrl_c() {
+    echo "\n\nStopping port forwarding"
+    kubectl delete pod port-forward-pod-${RANDOM_HEX} --force --grace-period=0  --namespace ${namespace}
+    exit 0
+}
+
+if [ -z "$1" ]; then
+    echo "env not provided"
+    echo "Usage: amq-connect.sh <env>"
+    exit 1
+fi
+main $1 $2
diff --git a/tools/scripts/opensearch-connect.sh b/tools/scripts/opensearch-connect.sh
@@ -0,0 +1,48 @@
+#!/bin/bash#!/bin/bash
+
+# trap ctrl-c and call ctrl_c()
+trap ctrl_c INT
+# trap fail and call fail()
+trap fail ERR
+
+main() {        
+    env=$1
+
+    if [ "$env" == "poc" ]; then
+        namespace="hmpps-delius-alfrsco-${env}"
+    else 
+        namespace="hmpps-delius-alfresco-${env}"
+    fi
+    echo "Connecting to Opensearch in namespace $namespace"
+
+    if [ -z "$2" ]; then
+        PORT=8080
+    else
+        PORT=$2
+    fi
+
+    # get opensearch proxy pod name
+    OPENSEARCH_PROXY_POD=$(kubectl get pods | grep 'opensearch-proxy-cloud-platform' | awk '{print $1}')
+    printf "\n****************************************************\n"
+    printf "Connect to http://localhost:$PORT locally\n"
+    printf "Press Ctrl+C to stop port forwarding \n"
+    printf "****************************************************\n\n"
+    # start the local port forwarding session
+    kubectl port-forward $OPENSEARCH_PROXY_POD $PORT:8080 --namespace ${namespace}
+}
+
+fail() {
+    echo "\n\nPort forwarding failed"
+    exit 1
+}
+ctrl_c() {
+    echo "\n\nStopping port forwarding"
+    exit 0
+}
+
+if [ -z "$1" ]; then
+    echo "env not provided"
+    echo "Usage: opensearch-connect.sh <env>"
+    exit 1
+fi
+main $1 $2
diff --git a/tools/scripts/rds-connect.sh b/tools/scripts/rds-connect.sh
@@ -0,0 +1,66 @@
+#!/bin/bash#!/bin/bash
+
+# trap ctrl-c and call ctrl_c()
+trap ctrl_c INT
+# trap fail and call fail()
+trap fail ERR
+
+main() {
+    env=$1
+
+    if [ "$env" == "poc" ]; then
+        namespace="hmpps-delius-alfrsco-${env}"
+    else 
+        namespace="hmpps-delius-alfresco-${env}"
+    fi
+    echo "Connecting to RDS in namespace $namespace"
+
+    # get RDS connection url
+    URL=$(kubectl get secrets rds-instance-output --namespace ${namespace} -o json | jq -r ".data.RDS_JDBC_URL | @base64d")
+    # extract host and port
+    HOST=$(echo $URL | cut -d '/' -f 3 | cut -d ':' -f 1)
+    # extract database name
+    DATABASE_NAME=$(echo "$URL" | awk -F'/' '{print $NF}')
+    # extract protocol/jdbc
+    PROTOCOL=$(echo $URL | awk -F'://' '{print $1}')
+    # extract remote port
+    REMOTE_PORT=$(echo $URL | cut -d '/' -f 3 | cut -d ':' -f 2)
+    # if custom local port not provided, use remote port
+    if [ -z "$2" ]; then
+        LOCAL_PORT=$REMOTE_PORT
+    else
+        LOCAL_PORT=$2
+    fi
+    # generate random hex string
+    RANDOM_HEX=$(openssl rand -hex 4)
+    # start port forwarding
+    kubectl run port-forward-pod-${RANDOM_HEX} --image=ghcr.io/ministryofjustice/hmpps-delius-alfresco-port-forward-pod:latest --port ${LOCAL_PORT} --env="REMOTE_HOST=$HOST" --env="LOCAL_PORT=$LOCAL_PORT" --env="REMOTE_PORT=$REMOTE_PORT" --namespace ${namespace}; 
+    # wait for pod to start
+    kubectl wait --for=condition=ready pod/port-forward-pod-${RANDOM_HEX} --timeout=30s --namespace ${namespace}
+    printf "\nPort forwarding started, connecting to $HOST:$REMOTE_PORT \n"
+    printf "\n****************************************************\n"
+    printf "Connect to ${PROTOCOL}://localhost:$LOCAL_PORT/$DATABASE_NAME locally\n"
+    printf "Press Ctrl+C to stop port forwarding \n"
+    printf "****************************************************\n\n"
+    # start the local port forwarding session
+    kubectl port-forward --namespace ${namespace} port-forward-pod-${RANDOM_HEX} $LOCAL_PORT:$LOCAL_PORT;
+}
+
+fail() {
+    echo "\n\nPort forwarding failed"
+    kubectl delete pod port-forward-pod-${RANDOM_HEX} --force --grace-period=0 --namespace ${namespace}
+    exit 1
+}
+
+ctrl_c() {
+    echo "\n\nStopping port forwarding"
+    kubectl delete pod port-forward-pod-${RANDOM_HEX} --force --grace-period=0  --namespace ${namespace}
+    exit 0
+}
+
+if [ -z "$1" ]; then
+    echo "env not provided"
+    echo "Usage: rds-connect.sh <env>"
+    exit 1
+fi
+main $1 $2