Commit e5e54f18 authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Deploy scripts: 

- enabled support to drop QuestDB tables during deploy
- renamed variable QDB_TABLE to QDB_TABLE_MONITORING_KPIS
- renamed default table name tfs_monitoring to tfs_monitoring_kpis
- renamed secret attribute METRICSDB_TABLE to METRICSDB_TABLE_MONITORING_KPIS
- improved log messages of tfs.sh
- updated deploy scripts accordingly
- removed unused variables and commands
- corrected documentation of some variables
parent cfd8a206

deploy/all.sh

+14 −26
Original line number Diff line number Diff line
@@ -25,14 +25,14 @@ 
# By default, assume internal MicroK8s registry is used.

export TFS_REGISTRY_IMAGES=${TFS_REGISTRY_IMAGES:-"http://localhost:32000/tfs/"}



# If not already set, set the list of components you want to build images for, and deploy.

# If not already set, set the list of components, separated by spaces, you want to build images for, and deploy.

# By default, only basic components are deployed

export TFS_COMPONENTS=${TFS_COMPONENTS:-"context device monitoring service compute webui"}

export TFS_COMPONENTS=${TFS_COMPONENTS:-"context device automation monitoring pathcomp service slice compute webui load_generator"}



# If not already set, set the tag you want to use for your images.

export TFS_IMAGE_TAG=${TFS_IMAGE_TAG:-"dev"}



# If not already set, set the name of the Kubernetes namespace to deploy to.

# If not already set, set the name of the Kubernetes namespace to deploy TFS to.

export TFS_K8S_NAMESPACE=${TFS_K8S_NAMESPACE:-"tfs"}



# If not already set, set additional manifest files to be applied after the deployment
@@ -41,7 +41,7 @@ export TFS_EXTRA_MANIFESTS=${TFS_EXTRA_MANIFESTS:-""} 
# If not already set, set the new Grafana admin password

export TFS_GRAFANA_PASSWORD=${TFS_GRAFANA_PASSWORD:-"admin123+"}



# If not already set, disable skip-build flag.

# If not already set, disable skip-build flag to rebuild the Docker images.

# If TFS_SKIP_BUILD is "YES", the containers are not rebuilt-retagged-repushed and existing ones are used.

export TFS_SKIP_BUILD=${TFS_SKIP_BUILD:-""}
@@ -60,12 +60,6 @@ export CRDB_PASSWORD=${CRDB_PASSWORD:-"tfs123"} 
# If not already set, set the database name to be used by Context.

export CRDB_DATABASE=${CRDB_DATABASE:-"tfs"}



# If not already set, set the name of the secret where CockroachDB data and credentials will be stored.

export CRDB_SECRET_NAME=${CRDB_SECRET_NAME:-"crdb-data"}



# If not already set, set the namespace where the secret containing CockroachDB data and credentials will be stored.

export CRDB_SECRET_NAMESPACE=${CRDB_SECRET_NAMESPACE:-${TFS_K8S_NAMESPACE}}



# If not already set, set CockroachDB installation mode. Accepted values are: 'single' and 'cluster'.

# "YES", the database pointed by variable CRDB_NAMESPACE will be dropped while

# checking/deploying CockroachDB.
@@ -78,7 +72,7 @@ export CRDB_SECRET_NAMESPACE=${CRDB_SECRET_NAMESPACE:-${TFS_K8S_NAMESPACE}} 
#   Ref: https://www.cockroachlabs.com/docs/stable/recommended-production-settings.html

export CRDB_DEPLOY_MODE=${CRDB_DEPLOY_MODE:-"single"}



# If not already set, disable flag for dropping database if exists.

# If not already set, disable flag for dropping database, if it exists.

# WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE DATABASE INFORMATION!

# If CRDB_DROP_DATABASE_IF_EXISTS is "YES", the database pointed by variable CRDB_NAMESPACE will be dropped while

# checking/deploying CockroachDB.
@@ -96,12 +90,6 @@ export CRDB_REDEPLOY=${CRDB_REDEPLOY:-""} 
# If not already set, set the namespace where NATS will be deployed.

export NATS_NAMESPACE=${NATS_NAMESPACE:-"nats"}



# If not already set, set the name of the secret where NATS data and credentials will be stored.

export NATS_SECRET_NAME=${NATS_SECRET_NAME:-"nats-data"}



# If not already set, set the namespace where the secret containing NATS data and credentials will be stored.

export NATS_SECRET_NAMESPACE=${NATS_SECRET_NAMESPACE:-${TFS_K8S_NAMESPACE}}



# If not already set, disable flag for re-deploying NATS from scratch.

# WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE MESSAGE BROKER INFORMATION!

# If NATS_REDEPLOY is "YES", the message broker will be dropped while checking/deploying NATS.
@@ -113,20 +101,20 @@ export NATS_REDEPLOY=${NATS_REDEPLOY:-""} 
# If not already set, set the namespace where QuestDB will be deployed.

export QDB_NAMESPACE=${QDB_NAMESPACE:-"qdb"}



# If not already set, set the database username to be used by Monitoring.

# If not already set, set the database username to be used for QuestDB.

export QDB_USERNAME=${QDB_USERNAME:-"admin"}



# If not already set, set the database user's password to be used by Monitoring.

# If not already set, set the database user's password to be used for QuestDB.

export QDB_PASSWORD=${QDB_PASSWORD:-"quest"}



# If not already set, set the table name to be used by Monitoring.

export QDB_TABLE=${QDB_TABLE:-"tfs_monitoring"}

# If not already set, set the table name to be used by Monitoring for KPIs.

export QDB_TABLE_MONITORING_KPIS=${QDB_TABLE_MONITORING_KPIS:-"tfs_monitoring_kpis"}



## If not already set, disable flag for dropping table if exists.

## WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE TABLE INFORMATION!

## If QDB_DROP_TABLE_IF_EXISTS is "YES", the table pointed by variable QDB_TABLE will be dropped while

## checking/deploying QuestDB.

#export QDB_DROP_TABLE_IF_EXISTS=${QDB_DROP_TABLE_IF_EXISTS:-""}

# If not already set, disable flag for dropping tables if they exist.

# WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE TABLE INFORMATION!

# If QDB_DROP_TABLES_IF_EXIST is "YES", the table pointed by variable

# QDB_TABLE_MONITORING_KPIS will be dropped while checking/deploying QuestDB.

export QDB_DROP_TABLES_IF_EXIST=${QDB_DROP_TABLES_IF_EXIST:-""}



# If not already set, disable flag for re-deploying QuestDB from scratch.

# WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE DATABASE INFORMATION!

deploy/crdb.sh

+0 −3
Original line number Diff line number Diff line
@@ -66,9 +66,6 @@ CRDB_MANIFESTS_PATH="manifests/cockroachdb" 
# Create a tmp folder for files modified during the deployment

TMP_MANIFESTS_FOLDER="$TMP_FOLDER/manifests"

mkdir -p $TMP_MANIFESTS_FOLDER

TMP_LOGS_FOLDER="$TMP_FOLDER/logs"

mkdir -p $TMP_LOGS_FOLDER

CRDB_LOG_FILE="$TMP_LOGS_FOLDER/crdb_deploy.log"



function crdb_deploy_single() {

    echo "CockroachDB Namespace"

deploy/nats.sh

+0 −8
Original line number Diff line number Diff line
@@ -31,14 +31,6 @@ export NATS_REDEPLOY=${NATS_REDEPLOY:-""} 
# Automated steps start here

########################################################################################################################



# Constants

TMP_FOLDER="./tmp"

NATS_MANIFESTS_PATH="manifests/nats"



# Create a tmp folder for files modified during the deployment

TMP_MANIFESTS_FOLDER="$TMP_FOLDER/manifests"

mkdir -p $TMP_MANIFESTS_FOLDER



function nats_deploy_single() {

    echo "NATS Namespace"

    echo ">>> Create NATS Namespace (if missing)"

deploy/qdb.sh

+19 −23
Original line number Diff line number Diff line
@@ -21,20 +21,20 @@ 
# If not already set, set the namespace where QuestDB will be deployed.

export QDB_NAMESPACE=${QDB_NAMESPACE:-"qdb"}



# If not already set, set the database username to be used by Monitoring.

# If not already set, set the database username to be used for QuestDB.

export QDB_USERNAME=${QDB_USERNAME:-"admin"}



# If not already set, set the database user's password to be used by Monitoring.

# If not already set, set the database user's password to be used for QuestDB.

export QDB_PASSWORD=${QDB_PASSWORD:-"quest"}



# If not already set, set the table name to be used by Monitoring.

export QDB_TABLE=${QDB_TABLE:-"tfs_monitoring"}

# If not already set, set the table name to be used by Monitoring for KPIs.

export QDB_TABLE_MONITORING_KPIS=${QDB_TABLE_MONITORING_KPIS:-"tfs_monitoring_kpis"}



## If not already set, disable flag for dropping table if exists.

## WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE TABLE INFORMATION!

## If QDB_DROP_TABLE_IF_EXISTS is "YES", the table pointed by variable QDB_TABLE will be dropped while

## checking/deploying QuestDB.

#export QDB_DROP_TABLE_IF_EXISTS=${QDB_DROP_TABLE_IF_EXISTS:-""}

# If not already set, disable flag for dropping tables if they exist.

# WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE TABLE INFORMATION!

# If QDB_DROP_TABLES_IF_EXIST is "YES", the table pointed by variable

# QDB_TABLE_MONITORING_KPIS will be dropped while checking/deploying QuestDB.

export QDB_DROP_TABLES_IF_EXIST=${QDB_DROP_TABLES_IF_EXIST:-""}



# If not already set, disable flag for re-deploying QuestDB from scratch.

# WARNING: ACTIVATING THIS FLAG IMPLIES LOOSING THE DATABASE INFORMATION!
@@ -52,9 +52,6 @@ QDB_MANIFESTS_PATH="manifests/questdb" 


# Create a tmp folder for files modified during the deployment

TMP_MANIFESTS_FOLDER="$TMP_FOLDER/manifests"

TMP_LOGS_FOLDER="$TMP_FOLDER/logs"

QDB_LOG_FILE="$TMP_LOGS_FOLDER/qdb_deploy.log"

mkdir -p $TMP_LOGS_FOLDER



function qdb_deploy() {

    echo "QuestDB Namespace"
@@ -147,19 +144,18 @@ function qdb_undeploy() { 
    echo

}



# TODO: implement method to drop table

#function qdb_drop_table() {

#    echo "Drop table if exists"

#    QDB_CLIENT_URL="postgresql://${QDB_USERNAME}:${QDB_PASSWORD}@questdb-0:${QDB_SQL_PORT}/defaultdb?sslmode=require"

#    kubectl exec -it --namespace ${QDB_NAMESPACE} questdb-0 -- \

#        ./qdb sql --certs-dir=/qdb/qdb-certs --url=${QDB_CLIENT_URL} \

#        --execute "DROP TABLE IF EXISTS ${QDB_TABLE};"

#    echo

#}

function qdb_drop_tables() {

    QDB_HOST=$(kubectl --namespace ${QDB_NAMESPACE} get service questdb-public -o 'jsonpath={.spec.clusterIP}')

    QDB_PORT=$(kubectl --namespace ${QDB_NAMESPACE} get service questdb-public -o 'jsonpath={.spec.ports[?(@.name=="http")].port}')



    echo "Drop tables, if exist"

    curl "http://${QDB_HOST}:${QDB_PORT}/exec?fmt=json&query=DROP+TABLE+IF+EXISTS+${QDB_TABLE_MONITORING_KPIS}+;"

    echo

}



if [ "$QDB_REDEPLOY" == "YES" ]; then

    qdb_undeploy

#elif [ "$QDB_DROP_TABLE_IF_EXISTS" == "YES" ]; then

#    qdb_drop_table

elif [ "$QDB_DROP_TABLES_IF_EXIST" == "YES" ]; then

    qdb_drop_tables

fi

qdb_deploy

deploy/tfs.sh

+31 −18
Original line number Diff line number Diff line
@@ -18,18 +18,21 @@ 
# Read deployment settings

########################################################################################################################





# ----- TeraFlowSDN ------------------------------------------------------------



# If not already set, set the URL of the Docker registry where the images will be uploaded to.

# By default, assume internal MicroK8s registry is used.

export TFS_REGISTRY_IMAGES=${TFS_REGISTRY_IMAGES:-"http://localhost:32000/tfs/"}



# If not already set, set the list of components you want to build images for, and deploy.

# If not already set, set the list of components, separated by spaces, you want to build images for, and deploy.

# By default, only basic components are deployed

export TFS_COMPONENTS=${TFS_COMPONENTS:-"context device monitoring service compute webui"}

export TFS_COMPONENTS=${TFS_COMPONENTS:-"context device automation monitoring pathcomp service slice compute webui load_generator"}



# If not already set, set the tag you want to use for your images.

export TFS_IMAGE_TAG=${TFS_IMAGE_TAG:-"dev"}



# If not already set, set the name of the Kubernetes namespace to deploy to.

# If not already set, set the name of the Kubernetes namespace to deploy TFS to.

export TFS_K8S_NAMESPACE=${TFS_K8S_NAMESPACE:-"tfs"}



# If not already set, set additional manifest files to be applied after the deployment
@@ -38,10 +41,13 @@ export TFS_EXTRA_MANIFESTS=${TFS_EXTRA_MANIFESTS:-""} 
# If not already set, set the new Grafana admin password

export TFS_GRAFANA_PASSWORD=${TFS_GRAFANA_PASSWORD:-"admin123+"}



# If not already set, disable skip-build flag.

# If not already set, disable skip-build flag to rebuild the Docker images.

# If TFS_SKIP_BUILD is "YES", the containers are not rebuilt-retagged-repushed and existing ones are used.

export TFS_SKIP_BUILD=${TFS_SKIP_BUILD:-""}





# ----- CockroachDB ------------------------------------------------------------



# If not already set, set the namespace where CockroackDB will be deployed.

export CRDB_NAMESPACE=${CRDB_NAMESPACE:-"crdb"}
@@ -54,20 +60,26 @@ export CRDB_PASSWORD=${CRDB_PASSWORD:-"tfs123"} 
# If not already set, set the database name to be used by Context.

export CRDB_DATABASE=${CRDB_DATABASE:-"tfs"}





# ----- NATS -------------------------------------------------------------------



# If not already set, set the namespace where NATS will be deployed.

export NATS_NAMESPACE=${NATS_NAMESPACE:-"nats"}





# ----- QuestDB ----------------------------------------------------------------



# If not already set, set the namespace where QuestDB will be deployed.

export QDB_NAMESPACE=${QDB_NAMESPACE:-"qdb"}



# If not already set, set the database username to be used by Monitoring.

# If not already set, set the database username to be used for QuestDB.

export QDB_USERNAME=${QDB_USERNAME:-"admin"}



# If not already set, set the database user's password to be used by Monitoring.

# If not already set, set the database user's password to be used for QuestDB.

export QDB_PASSWORD=${QDB_PASSWORD:-"quest"}



# If not already set, set the table name to be used by Monitoring.

export QDB_TABLE=${QDB_TABLE:-"tfs_monitoring"}

# If not already set, set the table name to be used by Monitoring for KPIs.

export QDB_TABLE_MONITORING_KPIS=${QDB_TABLE_MONITORING_KPIS:-"tfs_monitoring_kpis"}





########################################################################################################################
@@ -118,7 +130,7 @@ kubectl create secret generic qdb-data --namespace ${TFS_K8S_NAMESPACE} --type=' 
    --from-literal=METRICSDB_REST_PORT=${QDB_HTTP_PORT} \

    --from-literal=METRICSDB_ILP_PORT=${QDB_ILP_PORT} \

    --from-literal=METRICSDB_SQL_PORT=${QDB_SQL_PORT} \

    --from-literal=METRICSDB_TABLE=${QDB_TABLE} \

    --from-literal=METRICSDB_TABLE_MONITORING_KPIS=${QDB_TABLE_MONITORING_KPIS} \

    --from-literal=METRICSDB_USERNAME=${QDB_USERNAME} \

    --from-literal=METRICSDB_PASSWORD=${QDB_PASSWORD}

printf "\n"
@@ -301,7 +313,8 @@ if [[ "$TFS_COMPONENTS" == *"webui"* ]] && [[ "$TFS_COMPONENTS" == *"monitoring" 
    # Configure Grafana Admin Password

    # Ref: https://grafana.com/docs/grafana/latest/http_api/user/#change-password

    GRAFANA_URL_DEFAULT="http://${GRAFANA_USERNAME}:${GRAFANA_PASSWORD}@${GRAFANA_URL}"

    echo "Connecting to grafana at URL: ${GRAFANA_URL_DEFAULT}..."



    echo ">> Updating Grafana 'admin' password..."

    curl -X PUT -H "Content-Type: application/json" -d '{

        "oldPassword": "'${GRAFANA_PASSWORD}'",

        "newPassword": "'${TFS_GRAFANA_PASSWORD}'",
@@ -314,15 +327,14 @@ if [[ "$TFS_COMPONENTS" == *"webui"* ]] && [[ "$TFS_COMPONENTS" == *"monitoring" 
    echo "export GRAFANA_URL_UPDATED=${GRAFANA_URL_UPDATED}" >> $ENV_VARS_SCRIPT



    # Ref: https://grafana.com/docs/grafana/latest/http_api/data_source/

    # TODO: replace user, password and database by variables to be saved

    QDB_HOST_PORT="${METRICSDB_HOSTNAME}:${QDB_SQL_PORT}"

    echo "Creating a datasource..."

    echo ">> Creating datasources..."

    curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{

        "access"   : "proxy",

        "type"     : "postgres",

        "name"     : "questdb",

        "name"     : "questdb-mon-kpi",

        "url"      : "'${QDB_HOST_PORT}'",

        "database" : "'${QDB_TABLE}'",

        "database" : "'${QDB_TABLE_MONITORING_KPIS}'",

        "user"     : "'${QDB_USERNAME}'",

        "basicAuth": false,

        "isDefault": true,
@@ -342,16 +354,17 @@ if [[ "$TFS_COMPONENTS" == *"webui"* ]] && [[ "$TFS_COMPONENTS" == *"monitoring" 
    }' ${GRAFANA_URL_UPDATED}/api/datasources

    echo



    # Create Monitoring Dashboard

    echo ">> Creating dashboards..."

    # Ref: https://grafana.com/docs/grafana/latest/http_api/dashboard/

    curl -X POST -H "Content-Type: application/json" \

        -d '@src/webui/grafana_dashboard_psql.json' \

    curl -X POST -H "Content-Type: application/json" -d '@src/webui/grafana_db_mon_kpis_psql.json' \

        ${GRAFANA_URL_UPDATED}/api/dashboards/db

    echo



    DASHBOARD_URL="${GRAFANA_URL_UPDATED}/api/dashboards/uid/tf-l3-monit"

    echo ">> Staring dashboards..."

    DASHBOARD_URL="${GRAFANA_URL_UPDATED}/api/dashboards/uid/tfs-l3-monit"

    DASHBOARD_ID=$(curl -s "${DASHBOARD_URL}" | jq '.dashboard.id')

    curl -X POST ${GRAFANA_URL_UPDATED}/api/user/stars/dashboard/${DASHBOARD_ID}

    echo



    printf "\n\n"

fi