Reading and writing Yandex Managed Service for Kubernetes cluster metrics with the Prometheus Operator

Prometheus Operator with Yandex Monitoring support makes it easy to install and manage the Yandex Managed Service for Prometheus® monitoring system. You can use it to collect, store, and read metrics from your containers, applications, and infrastructure. The system uses the Prometheus data model and the PromQL query language. This allows you to work with dashboards existing in Grafana.

Getting startedGetting started

1. Make sure that the security groups for the Managed Service for Kubernetes cluster and its node groups are configured correctly. If any rule is missing, add it.

   Warning

   The configuration of security groups determines the performance and availability of the cluster and the services and applications running in it.

2. Create a service account with the monitoring.editor role.

3. Create an API key for the service account:

   • If you want to install Prometheus Operator using Yandex Cloud Marketplace, create an API key in JSON format and save it to the sa-key.json file:

     yc iam api-key create \
        --service-account-name=<service_account_name> \
        --format=json > sa-key.json
     

   • If you want to install Prometheus Operator using a Helm chart, run the following command and save the secret key you get:

     yc iam api-key create --service-account-name=<service_account_name>
     

4. Install kubectl and configure it to work with the created cluster.

Installation using Yandex Cloud MarketplaceInstallation using Yandex Cloud Marketplace

1. Go to the folder page and select Managed Service for Kubernetes.
2. Click the name of the Kubernetes cluster you need and select the Marketplace tab.
3. Under Application available for installation, select Prometheus Operator with Yandex Monitoring support and click Go to install.
4. Configure the application:
   • Namespace: Select a namespace or create a new one.
   • Application name: Specify the app name.
   • Prometheus Workspace: Select the required Prometheus workspace.
   • API key: Specify the contents of the sa-key.json file you got earlier.
5. Click Install.
6. Wait for the application to change its status to Deployed.

Installation using a Helm chartInstallation using a Helm chart

1. Install Helm v3.8.0 or higher.

2. Get the Prometheus workspace ID, you will need it for further setup:

   1. On the Yandex Monitoring home page, select Prometheus in the left-hand panel.
   2. Go to the page of the required workspace. The page displays its ID.

3. To install a Helm chart with Prometheus Operator, run the following command:

   helm pull oci://cr.yandex/yc-marketplace/yandex-cloud/prometheus/kube-prometheus-stack \
     --version 57.2.0-1 \
     --untar && \
   helm install \
     --namespace <namespace_for_Prometheus_Operator> \
     --create-namespace \
     --set prometheusWorkspaceId=<Prometheus_workspace_ID> \
     --set iam_api_key_value_generated.secretAccessKey=<secret_part_of_API_key> \
     prometheus ./kube-prometheus-stack/
   

   The command will also create a new namespace required for Prometheus Operator.

   Note

   If you are using a Helm version below 3.8.0, append the export HELM_EXPERIMENTAL_OCI=1 && \ string to the command to enable Open Container Initiative (OCI) support in the Helm client.

4. Make sure the Prometheus Operator pods have changed their status to Running:

   kubectl get pods --namespace=<namespace_for_Prometheus_Operator> \
      -l "release=prometheus"
   

Connecting to a Grafana dashboardConnecting to a Grafana dashboard

To connect to a Grafana dashboard:

1. Get the name of the pod with the running Grafana application:

   kubectl get pods --namespace=<namespace_for_Prometheus_Operator> \
     | grep grafana
   

2. Configure grafana port forwarding to the local computer:

   kubectl port-forward --namespace=<namespace_for_Prometheus_Operator> \
     <Grafana_pod_name> 8080:3000
   

   Note

   If you close the terminal window or abort the command, port forwarding will be stopped.

3. In your browser, open the Grafana dashboard at http://localhost:8080.

4. Sign in using the admin username and prom-operator password.

See alsoSee also

• Yandex Managed Service for Kubernetes

© 2024 Linux Foundation. All rights reserved. The Linux Foundation owns and uses registered trademarks. For a list of Linux Foundation trademarks, see Trademark Usage.