Deploy prometheus

Makefile

@@ -146,10 +146,17 @@ export OLM_CATALOG_IMG
 MINIMAL_VERTICA_IMG ?=
 # Name of the helm release that we will install/uninstall
 HELM_RELEASE_NAME?=vdb-op
+PROMETHEUS_HELM_NAME?=prometheus
+PROMETHEUS_INTERVAL?=5s
+DB_USER?=dbadmin
+DB_PASSWORD?=
+VDB_NAME?=verticadb-sample
+VDB_NAMESPACE?=default
 # Can be used to specify additional overrides when doing the helm install.
 # For example to specify a custom webhook tls cert when deploying use this command:
 #   HELM_OVERRIDES="--set webhook.tlsSecret=custom-cert" make deploy-operator
 HELM_OVERRIDES?=
+PROMETHEUS_HELM_OVERRIDES?=
 # Maximum number of tests to run at once. (default 2)
 # Set it to any value not greater than 8 to override the default one
 E2E_PARALLELISM?=2
@@ -246,6 +253,8 @@ DEPLOY_WAIT?=--wait
 OLM_TEST_CATALOG_SOURCE=e2e-test-catalog
 # Name of the namespace to deploy the operator in
 NAMESPACE?=verticadb-operator
+# Name of the namespace to deploy prometheus 
+PROMETHEUS_NAMESPACE?=prometheus
 
 # The Go version that we will build the operator with
 GO_VERSION?=1.23.2
@@ -255,6 +264,7 @@ HELM_UNITTEST_VERSION?=3.9.3-0.2.11
 KUTTL_PLUGIN_INSTALLED:=$(shell kubectl krew list 2>/dev/null | grep -c '^kuttl')
 STERN_PLUGIN_INSTALLED:=$(shell kubectl krew list 2>/dev/null | grep -c '^stern')
 OPERATOR_CHART = $(shell pwd)/helm-charts/verticadb-operator
+PROMETHEUS_CHART=prometheus-community/kube-prometheus-stack
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -634,12 +644,30 @@ endif
 
 deploy-webhook: manifests kustomize ## Using helm, deploy just the webhook in the k8s cluster
 ifeq ($(DEPLOY_WITH), helm)
-	helm install $(DEPLOY_WAIT) -n $(NAMESPACE) --create-namespace $(HELM_RELEASE_NAME) $(OPERATOR_CHART) --set image.repo=null --set image.name=${OPERATOR_IMG} --set image.pullPolicy=$(HELM_IMAGE_PULL_POLICY) --set imagePullSecrets[0].name=priv-reg-cred $(HELM_OVERRIDES) --set webhook.enable=true,controllers.enable=false
+	helm install $(DEPLOY_WAIT) -n $(NAMESPACE) --create-namespace $(HELM_RELEASE_NAME) $(OPERATOR_CHART) --set image.repo=null --set image.name=${OPERATOR_IMG} --set image.pullPolicy=$(HELM_IMAGE_PULL_POLICY) --set imagePullSecrets[0].name=priv-reg-cred --set webhook.enable=true,controllers.enable=false $(HELM_OVERRIDES)
 	scripts/wait-for-webhook.sh -n $(NAMESPACE) -t 60
 else
 	$(error Unsupported deployment method for webhook only: $(DEPLOY_WITH))
 endif
 
+.PHONY: deploy-prometheus
+deploy-prometheus:
+	helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
+	helm repo update
+	helm install $(DEPLOY_WAIT) -n $(PROMETHEUS_NAMESPACE) --create-namespace $(PROMETHEUS_HELM_NAME) $(PROMETHEUS_CHART) --values helm-charts/prometheus/values.yaml $(PROMETHEUS_HELM_OVERRIDES)
+
+.PHONY: undeploy-prometheus
+undeploy-prometheus:
+	helm uninstall $(PROMETHEUS_HELM_NAME) -n $(PROMETHEUS_NAMESPACE)
+
+.PHONY: deploy-prometheus-service-monitor
+deploy-prometheus-service-monitor:
+	scripts/deploy-prometheus.sh -n $(VDB_NAMESPACE) -l $(PROMETHEUS_HELM_NAME) -i $(PROMETHEUS_INTERVAL) -a deploy -u $(DB_USER) -p '$(DB_PASSWORD)' -d $(VDB_NAME)
+
+.PHONY: undeploy-prometheus-service-monitor
+undeploy-prometheus-service-monitor:
+	scripts/deploy-prometheus.sh -n $(VDB_NAMESPACE) -l $(PROMETHEUS_HELM_NAME) -i $(PROMETHEUS_INTERVAL) -a undeploy -u $(DB_USER) -p '$(DB_PASSWORD)' -d $(VDB_NAME)
+
 .PHONY: undeploy-operator
 undeploy-operator: ## Undeploy operator that was previously deployed
 	scripts/undeploy.sh $(if $(filter false,$(ignore-not-found)),,-i)

helm-charts/prometheus/values.yaml

@@ -0,0 +1,24 @@
+defaultRules:
+  create: false
+alertmanager:
+  enabled: true
+grafana:
+  enabled: false
+kubeApiServer:
+  enabled: true
+kubelet:
+  enabled: false
+kubeControllerManager:
+  enabled: true
+coreDns:
+  enabled: false
+kubeEtcd:
+  enabled: false
+kubeScheduler:
+  enabled: false
+kubeStateMetrics:
+  enabled: true
+nodeExporter:
+  enabled: true
+prometheus:
+  enabled: true

scripts/deploy-prometheus.sh

@@ -0,0 +1,196 @@
+#!/bin/bash
+
+# (c) Copyright [2021-2024] Open Text.
+# 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.
+
+# A script that will deploy the prometheus service monitor and secret. It assumes the prometheus operator is deployed.
+
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+REPO_DIR=$(dirname $SCRIPT_DIR)
+LABEL=''
+ACTION=''
+NAMESPACE=''
+USERNAME=''
+PASSWORD=''
+DBNAME=''
+INTERVAL='5s'
+
+function usage() {
+    echo "usage: $(basename $0) [-n <namespace>] [-l <label>] [-a <action>] [-u <username>] [-p <password>] [-d <dbname>] [-i <interval>]"
+    echo
+    echo "Options:"
+    echo "  -n <namespace>  The namespace used for prometheus service."
+    echo "  -l <label>      The label monitored by prometheus service."
+    echo "  -a <action>     The action to run in this script, deploy or undeploy."
+    echo "  -u <username>   The database username, should have access to the Vertica server metrics."
+    echo "  -p <password>   The database user password."
+    echo "  -d <dbname>     The database name."
+    echo "  -i <interval>   The scraping interval of prometheus update for metrics."
+    echo "  -h <usage>      Print help message."
+    exit 1
+}
+
+while getopts "n:l:a:u:p:d:i:h" opt
+do
+    case $opt in
+        n)
+            NAMESPACE=$OPTARG
+            ;;
+        l)
+            LABEL=$OPTARG
+            ;;
+        a)
+            ACTION=$OPTARG
+            ;;
+        u)
+            USERNAME=$OPTARG
+            ;;
+        p)
+            PASSWORD=$OPTARG
+            ;;
+        d)
+            DBNAME=$OPTARG
+            ;;
+        i)
+            INTERVAL=$OPTARG
+            ;;
+        h) 
+            usage
+            exit 0
+            ;;
+        \?)
+            echo "ERROR: unrecognized option: -$opt"
+            usage
+            exit 0
+            ;;
+    esac
+done
+
+if [ -z "$NAMESPACE" ]
+then
+  NAMESPACE=default
+fi
+
+
+function deploy(){
+  # Create an secret to store prometheus service monitor database username and password.
+  cat <<EOF | kubectl apply -f -
+apiVersion: v1
+kind: Secret
+metadata:
+  namespace: $NAMESPACE
+  name: prometheus-$DBNAME
+data:
+  username: '$(echo -n $USERNAME | base64)'
+  password: '$(echo -n $PASSWORD | base64)'
+type: Opaque
+EOF
+
+  # Create a service monitor to allow prometheus to discover vertica pods
+  cat <<EOF | kubectl apply -f -
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: k8s-vertica-prometheus-$DBNAME
+  namespace: $NAMESPACE
+  labels:
+    release: $LABEL
+spec:
+  selector:
+    matchLabels:
+      app.kubernetes.io/instance: $DBNAME
+  namespaceSelector:
+    matchNames:
+      - $NAMESPACE
+  endpoints:
+    - basicAuth:
+        password:
+          key: password
+          name: prometheus-$DBNAME
+        username: 
+          key: username
+          name: prometheus-$DBNAME
+          optional: true
+      interval: $INTERVAL
+      path: /v1/metrics
+      port: vertica-http
+      scheme: https
+      tlsConfig:
+        insecureSkipVerify: true
+EOF
+}
+
+function undeploy(){
+  # Delete the service monitor for prometheus service monitor.
+  cat <<EOF | kubectl delete -f -
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: k8s-vertica-prometheus-$DBNAME
+  namespace: $NAMESPACE
+  labels:
+    release: $LABEL
+spec:
+  selector:
+    matchLabels:
+      app.kubernetes.io/instance: $DBNAME
+  namespaceSelector:
+    matchNames:
+      - $NAMESPACE
+  endpoints:
+    - basicAuth:
+        password:
+          key: password
+          name: prometheus-$DBNAME
+        username: 
+          key: username
+          name: prometheus-$DBNAME
+          optional: true
+      interval: $INTERVAL
+      path: /v1/metrics
+      port: vertica-http
+      scheme: https
+      tlsConfig:
+        insecureSkipVerify: true
+EOF
+
+  # delete secret for prometheus service monitor.
+  cat <<EOF | kubectl delete -f -
+apiVersion: v1
+kind: Secret
+metadata:
+  namespace: $NAMESPACE
+  name: prometheus-$DBNAME
+data:
+  username: '$(echo -n $USERNAME | base64)'
+  password: '$(echo -n $PASSWORD | base64)'
+type: Opaque
+EOF
+}
+
+ # ACTION deploy and undeploy
+case $ACTION in
+    deploy) 
+        echo "Running task: $ACTION"
+        deploy
+        ;;
+    undeploy) 
+        echo "Running task: $ACTION"
+        undeploy
+        ;;
+    *) 
+        echo "Invalid action: '$ACTION'"
+        usage
+        ;;
+esac