Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Additionally, should you choose to use the metrics data to configure auto-scaling for EC Deployments, you need to install a Prometheus adapter along with your Prometheus server.

If you have not installed the Prometheus server, proceed with the steps from prerequisites until the very end.

If you have already installed the Prometheus server, you can skip ahead to the steps for installing the Prometheus adapter here https://infozone.atlassian.net/wiki/spaces/UEPE4D/pages/edit-v2/303827024#Install-Prometheus-Adapter .

For more information about EC Deployments, refer to see Execution Context Deployments (ECDs) (4.3.0).

...

Note!

Only one instance of Prometheus is required in a Kubernetes cluster. This single Prometheus server will monitor and scrape for metrics from all the different namespaces in your Kubernetes cluster.

Prerequisite

You will need to install Helm3 first before installing Prometheus following the examples listed below. If you already have helm installed from when you installed Usage Engine, then you can skip this step.

...

The following steps show how to install the Prometheus server without the use of persistence. Be aware that your metrics data will not be retained should your deployment be brought down. We do not recommend deploying Prometheus without persistence into a production environment.

  1. Add the helm repo for Prometheus.

    Code Block
    helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
  2. Install Prometheus using the helm install command. For this example, we opted to install the Prometheus server in its own namespace called prometheus.  Enter the value of the port you want the Prometheus server node port to be configured with

    Code Block
    helm install -n <namespace> prometheus prometheus-community/prometheus \
      --set server.persistentVolume.enabled=false \
      --set server.service.type=NodePort \
      --set server.service.nodePort=<port> \
      --set alertmanager.persistentVolume.enabled=false
Info

...

Example

...

- helm install Prometheus

Code Block
helm install -n prometheus prometheus prometheus-community/prometheus \
  --set server.persistentVolume.enabled=false \
  --set server.service.type=NodePort \
  --set server.service.nodePort=31010 \
  --set alertmanager.persistentVolume.enabled=false

Installing Prometheus with Persistence

The following steps show how to install the Prometheus server with the use of persistence volumes on your Kubernetes cluster.

  1. Create a yaml file and describe the Persistent Volume and Persistent Volume Claim for your Prometheus server. The example used here creates the persistent volume on an NFS file server that is mounted onto the cluster. The value set in nfs.path is the directory on the NFS file server that stores the metrics data.

Info

...

Example

...

- Persistence for Prometheus

Code Block
apiVersion: v1
kind: PersistentVolume
metadata:
  name: prometheus
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 10Gi
  nfs:
    path: /export/snap/metrics/prometheus
    server: 192.154.14.120
  persistentVolumeReclaimPolicy: Retain
  storageClassName: prometheus-persistent
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: prometheus-persistent
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 10Gi
  storageClassName: prometheus-persistent
  1. After creating the yaml file, run this command:

    Code Block
    kubectl apply -f <persistent volume yaml> -n <namespace>
  2. Add the helm repo for Prometheus.

    Code Block
    helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
  3. Install Prometheus using the helm install command. For this example, we opted to install the Prometheus server in its own namespace called prometheus.  Enter the value of the port you want the Prometheus server node port to be configured with and set the name of the Persistent Volume Claim that you have created in the steps before.

    Code Block
    helm install -n <namespace> prometheus prometheus-community/prometheus \
      --set server.persistentVolume.enabled=true \
      --set server.persistentVolume.accessModes=ReadWriteMany \
      --set server.persistentVolume.existingClaim="prometheus-persistent" \
      --set server.service.type=NodePort \
      --set server.service.nodePort=<port> \
      --set alertmanager.persistentVolume.enabled=false
Info

...

Example

...

- helm install Prometheus - with

...

Persistence

Code Block
helm install -n prometheus prometheus prometheus-community/prometheus \
  --set server.persistentVolume.enabled=true \
  --set server.persistentVolume.accessModes=ReadWriteMany \
  --set server.persistentVolume.existingClaim="prometheus-persistent" \
  --set server.service.type=NodePort \
  --set server.service.nodePort=31010 \
  --set alertmanager.persistentVolume.enabled=false

Verify the Prometheus Installation

This step will have you check that your Prometheus is deployed correctly.

  1. After installing the Prometheus server, you will be given an export command to use to acquire the URL and the Port for the Prometheus server. The command can look something like this:

    Code Block
    export NODE_PORT=$(kubectl get --namespace <namespace> -o jsonpath="{.spec.ports[0].nodePort}" services prometheus-server)
    export NODE_IP=$(kubectl get nodes --namespace <namespace> -o jsonpath="{.items[0].status.addresses[0].address}")
Info

...

Example

...

- Exporting the

...

Value for Prometheus Node IP and Node Port

Code Block
$ export NODE_PORT=$(kubectl get --namespace prometheus -o jsonpath="{.spec.ports[0].nodePort}" services prometheus-server)
$ export NODE_IP=$(kubectl get nodes --namespace prometheus -o jsonpath="{.items[0].status.addresses[0].address}")
  1. To generate the URL from the result of the two export commands above, use this echo command. Then copy the result to your browser.

    Code Block
    echo http://$NODE_IP:$NODE_PORT
Info

...

Example

...

- Url for Prometheus GUI

Code Block
http://192.168.52.26:31010

Install Prometheus Adapter

...

prom-adapterprom-adapterThe Prometheus adapter functions as a gatekeeper, where it retrieves the metrics from a Prometheus server and then publishes these metrics to Kubernetes metrics API. The adapter uses a configuration file to set the rules that determine what metrics the adapter will publish. You can also configure your own custom metrics using the configuration file. For examples of how to configure your own custom metrics, refer to Creating Custom Metrics on Prometheus Adapter(4.3).

...

For simplicity, there is a sample configuration file called prom-adapter-values.yaml. This file is configured with the rule to make all com.digitalroute related metrics available in Kubernetes. To find the url and port, you can use the export NODE_PORT command as shown on the verify the Prometheus installation steps above.

...

Note!

If you have installed your Prometheus server in its own namespace, make sure that the Prometheus adapter has access to your Prometheus server.

...

prom-adapter-values.yaml

Code Block
prometheus:
  url: http://192.168.52.26
  port: 31010
logLevel: 6
rules:
  custom:
  - seriesQuery: '{__name__=~"^com_digitalroute.*"}'
    resources:
      overrides:
        namespace: {resource: "namespace"}
        pod: {resource: "pod"}
    name:
      matches: ^(.*)
      as: ""
    metricsQuery: sum(<<.Series>>{<<.LabelMatchers>>}) by (<<.GroupBy>>)

...

Code Block
helm install -n <namespace> prometheus-adapter prometheus-community/prometheus-adapter -f <Prometheus adapter configuration file>
: adapter
Info
title

Example

- helm install Prometheus

Adapter

Code Block
helm install -n mznamespace prometheus-adapter prometheus-community/prometheus-adapter -f prom-adapter-values.yaml

...