Initial implementation of the metrics collection framework

Carlos Natalinorequested to merge
feat/mcs into develop

This MR makes the following changes:

  1. Introduces the linkerd service mesh in the deploy/tfs.sh script.
  2. Introduces the use of the Grafana instance installed by the monitoring MicroK8s addon, removing the standalone one that was used before. Make necessary changes to the deploy/tfs.sh script.

Merge request reports

deploy/all.sh

+12 −0
Changes for deploy/all.sh: 12 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -147,6 +147,15 @@ export QDB_DROP_TABLES_IF_EXIST=${QDB_DROP_TABLES_IF_EXIST:-""} 
export QDB_REDEPLOY=${QDB_REDEPLOY:-""}





# ----- K8s Observability ------------------------------------------------------



# If not already set, set the external port Prometheus Mgmt HTTP GUI interface will be exposed to.

export PROM_EXT_PORT_HTTP=${PROM_EXT_PORT_HTTP:-"9090"}



# If not already set, set the external port Grafana HTTP Dashboards will be exposed to.

export GRAF_EXT_PORT_HTTP=${GRAF_EXT_PORT_HTTP:-"3000"}





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

# Automated steps start here

########################################################################################################################
@@ -160,6 +169,9 @@ export QDB_REDEPLOY=${QDB_REDEPLOY:-""} 
# Deploy QuestDB

./deploy/qdb.sh



# Expose Dashboard

./deploy/expose_dashboard.sh



# Deploy TeraFlowSDN

./deploy/tfs.sh

deploy/expose_dashboard.sh

0 → 100755
+58 −0
Changes for deploy/expose_dashboard.sh: 58 added lines, 0 removed lines.
Original line number Diff line number Diff line 
#!/bin/bash

# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (https://tfs.etsi.org/)

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#      http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.





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

# Read deployment settings

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



# If not already set, set the external port Prometheus Mgmt HTTP GUI interface will be exposed to.

export PROM_EXT_PORT_HTTP=${PROM_EXT_PORT_HTTP:-"9090"}



# If not already set, set the external port Grafana HTTP Dashboards will be exposed to.

export GRAF_EXT_PORT_HTTP=${GRAF_EXT_PORT_HTTP:-"3000"}





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

# Automated steps start here

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



function expose_dashboard() {

    echo "Prometheus Port Mapping"

    echo ">>> Expose Prometheus HTTP Mgmt GUI port (9090->${PROM_EXT_PORT_HTTP})"

    PROM_PORT_HTTP=$(kubectl --namespace monitoring get service prometheus-k8s -o 'jsonpath={.spec.ports[?(@.name=="web")].port}')

    PATCH='{"data": {"'${PROM_EXT_PORT_HTTP}'": "monitoring/prometheus-k8s:'${PROM_PORT_HTTP}'"}}'

    kubectl patch configmap nginx-ingress-tcp-microk8s-conf --namespace ingress --patch "${PATCH}"



    PORT_MAP='{"containerPort": '${PROM_EXT_PORT_HTTP}', "hostPort": '${PROM_EXT_PORT_HTTP}'}'

    CONTAINER='{"name": "nginx-ingress-microk8s", "ports": ['${PORT_MAP}']}'

    PATCH='{"spec": {"template": {"spec": {"containers": ['${CONTAINER}']}}}}'

    kubectl patch daemonset nginx-ingress-microk8s-controller --namespace ingress --patch "${PATCH}"

    echo



    echo "Grafana Port Mapping"

    echo ">>> Expose Grafana HTTP Mgmt GUI port (3000->${GRAF_EXT_PORT_HTTP})"

    GRAF_PORT_HTTP=$(kubectl --namespace monitoring get service grafana -o 'jsonpath={.spec.ports[?(@.name=="http")].port}')

    PATCH='{"data": {"'${GRAF_EXT_PORT_HTTP}'": "monitoring/grafana:'${GRAF_PORT_HTTP}'"}}'

    kubectl patch configmap nginx-ingress-tcp-microk8s-conf --namespace ingress --patch "${PATCH}"



    PORT_MAP='{"containerPort": '${GRAF_EXT_PORT_HTTP}', "hostPort": '${GRAF_EXT_PORT_HTTP}'}'

    CONTAINER='{"name": "nginx-ingress-microk8s", "ports": ['${PORT_MAP}']}'

    PATCH='{"spec": {"template": {"spec": {"containers": ['${CONTAINER}']}}}}'

    kubectl patch daemonset nginx-ingress-microk8s-controller --namespace ingress --patch "${PATCH}"

    echo

}



expose_dashboard

deploy/tfs.sh

+21 −6
Changes for deploy/tfs.sh: 21 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -106,6 +106,15 @@ export QDB_TABLE_MONITORING_KPIS=${QDB_TABLE_MONITORING_KPIS:-"tfs_monitoring_kp 
export QDB_TABLE_SLICE_GROUPS=${QDB_TABLE_SLICE_GROUPS:-"tfs_slice_groups"}





# ----- K8s Observability ------------------------------------------------------



# If not already set, set the external port Prometheus Mgmt HTTP GUI interface will be exposed to.

export PROM_EXT_PORT_HTTP=${PROM_EXT_PORT_HTTP:-"9090"}



# If not already set, set the external port Grafana HTTP Dashboards will be exposed to.

export GRAF_EXT_PORT_HTTP=${GRAF_EXT_PORT_HTTP:-"3000"}





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

# Automated steps start here

########################################################################################################################
@@ -241,7 +250,8 @@ for COMPONENT in $TFS_COMPONENTS; do 


    echo "  Adapting '$COMPONENT' manifest file..."

    MANIFEST="$TMP_MANIFESTS_FOLDER/${COMPONENT}service.yaml"

    cp ./manifests/"${COMPONENT}"service.yaml "$MANIFEST"

    # cp ./manifests/"${COMPONENT}"service.yaml "$MANIFEST"

    cat ./manifests/"${COMPONENT}"service.yaml | linkerd inject - --proxy-cpu-request "10m" --proxy-cpu-limit "1" --proxy-memory-request "64Mi" --proxy-memory-limit "256Mi" > "$MANIFEST"



    if [ "$COMPONENT" == "pathcomp" ]; then

        IMAGE_URL=$(echo "$TFS_REGISTRY_IMAGES/$COMPONENT-frontend:$TFS_IMAGE_TAG" | sed 's,//,/,g' | sed 's,http:/,,g')
@@ -328,14 +338,19 @@ if [[ "$TFS_COMPONENTS" == *"webui"* ]]; then 
    echo "Configuring WebUI DataStores and Dashboards..."

    sleep 5



    INGRESS_CTRL_NAME=$(echo "${TFS_K8S_NAMESPACE}" | sed "s/tfs/nginx-ingress-microk8s-controller/g")

    EXT_HTTP_PORT=$(kubectl get daemonsets.apps --namespace ingress ${INGRESS_CTRL_NAME} \

        -o 'jsonpath={.spec.template.spec.containers[?(@.name=="nginx-ingress-microk8s")].ports[?(@.name=="http")].hostPort}')

    # INGRESS_CTRL_NAME=$(echo "${TFS_K8S_NAMESPACE}" | sed "s/tfs/nginx-ingress-microk8s-controller/g")

    # EXT_HTTP_PORT=$(kubectl get daemonsets.apps --namespace ingress ${INGRESS_CTRL_NAME} \

    #     -o 'jsonpath={.spec.template.spec.containers[?(@.name=="nginx-ingress-microk8s")].ports[?(@.name=="http")].hostPort}')

    

    # get IP and port of grafana in the `monitoring` namespace

    GRAFANA_IP=$(kubectl get service/grafana -n monitoring -o jsonpath='{.spec.clusterIP}')

    #GRAFANA_PORT=3000 #$(kubectl get service webuiservice --namespace $TFS_K8S_NAMESPACE -o 'jsonpath={.spec.ports[?(@.port==3000)].nodePort}')



    # Exposed through the ingress controller "tfs-ingress"

    GRAFANA_URL="127.0.0.1:${EXT_HTTP_PORT}/grafana"

    # GRAFANA_URL="127.0.0.1:${EXT_HTTP_PORT}/grafana"

    GRAFANA_URL="${GRAFANA_IP}:${GRAF_EXT_PORT_HTTP}"



    # Default Grafana credentials

    # Default Grafana credentials when installed with the `monitoring` addon

    GRAFANA_USERNAME="admin"

    GRAFANA_PASSWORD="admin"

manifests/webuiservice.yaml

+0 −37
Changes for manifests/webuiservice.yaml: 0 added lines, 37 removed lines.
Original line number Diff line number Diff line
@@ -61,43 +61,6 @@ spec: 
          limits:

            cpu: 500m

            memory: 512Mi

      - name: grafana

        image: grafana/grafana:8.5.11

        imagePullPolicy: IfNotPresent

        ports:

          - containerPort: 3000

            name: http-grafana

            protocol: TCP

        env:

        - name: GF_SERVER_ROOT_URL

          value: "http://0.0.0.0:3000/grafana/"

        - name: GF_SERVER_SERVE_FROM_SUB_PATH

          value: "true"

        readinessProbe:

          failureThreshold: 3

          httpGet:

            path: /robots.txt

            port: 3000

            scheme: HTTP

          initialDelaySeconds: 10

          periodSeconds: 30

          successThreshold: 1

          timeoutSeconds: 2

        livenessProbe:

          failureThreshold: 3

          initialDelaySeconds: 30

          periodSeconds: 10

          successThreshold: 1

          tcpSocket:

            port: 3000

          timeoutSeconds: 1

        resources:

          requests:

            cpu: 150m

            memory: 512Mi

          limits:

            cpu: 500m

            memory: 1024Mi

---

apiVersion: v1

kind: Service

scripts/old/open_dashboard.sh

100755 → 100644
+1 −3
Changes for scripts/old/open_dashboard.sh: 1 added line, 3 removed lines.
Original line number Diff line number Diff line
@@ -16,9 +16,7 @@ 


# this script opens the dashboard



K8S_NAMESPACE=${K8S_NAMESPACE:-'tfs'}



GRAFANA_IP=$(kubectl get service/webuiservice -n ${TFS_K8S_NAMESPACE} -o jsonpath='{.spec.clusterIP}')

GRAFANA_IP=$(kubectl get service/grafana -n monitoring -o jsonpath='{.spec.clusterIP}')

GRAFANA_PORT=3000 #$(kubectl get service webuiservice --namespace $TFS_K8S_NAMESPACE -o 'jsonpath={.spec.ports[?(@.port==3000)].nodePort}')

URL=http://${GRAFANA_IP}:${GRAFANA_PORT}