Running KSM with the Kubernetes operator lets you do the following:
Monitor custom resource status in real time on your
Prometheus-compatible observability stack, together with
AlloyDB Omni metrics.
Build dashboards and alerts on top of the custom resource metrics for
better operational visibility and proactive issue detection.
For more information about kube-state-metrics, see
Overview.
To learn how kube-state-metrics monitors Kubernetes custom resources, see
Custom Resource State Metrics.
How AlloyDB Omni Kubernetes operator custom resources work
By default, custom resource metrics aren't enabled. You can
enable custom resource metrics using the AlloyDB Omni Kubernetes operator Helm chart. When you
enable custom resource metrics, a KSM deployment is created with a configmap that defines
the custom resource metrics and a service of type ClusterIP to expose the metrics endpoint
of the KSM deployment. Your
Prometheus
collector can collect the metrics, and you can visualize these metrics with
other AlloyDB Omni metrics. For more information, see
Custom resources metrics for the AlloyDB Omni Kubernetes operator.
Before you begin
Make sure that you have the following:
A Prometheus-compatible metrics scraper running
in your Kubernetes cluster.
Access to the kube-state-metrics image hosted at
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0. You can
pre-pull the image to your private registry.
If you pre-pull the public KSM image at
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 to your
private registry, skip this step and proceed to the next step. Otherwise,
install the AlloyDB Omni Kubernetes operator with custom resource metrics, and then proceed
to the final step in this procedure.
A successful installation returns the following output:
NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 1
TEST SUITE: None
Clean up the installation by deleting the downloaded
AlloyDB Omni Kubernetes operator installation file. The file is named
alloydbomni-operator-VERSION_NUMBER.tgz, and is located in your current
working directory.
Enable custom resource metrics on an existing Kubernetes operator
If you already have the AlloyDB Omni Kubernetes operator version 1.3.0 (or later)
installed, you can enable custom resource metrics by upgrading the existing operator.
Open a Linux command-line terminal.
Find your current AlloyDB Omni Kubernetes operator version and define the
environment variables by running the following commands:
Upgrade the AlloyDB Omni Kubernetes operator by running the following
commands, and then go to the final step in this procedure. If you pre-pull
the public KSM image at
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 to your
private registry, then skip this step and proceed directly to the next step.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis guide explains how to monitor AlloyDB Omni Kubernetes operator custom resources using kube-state-metrics (KSM), which is available from operator version 1.3.0 onwards.\u003c/p\u003e\n"],["\u003cp\u003eEnabling custom resource metrics with the AlloyDB Omni Kubernetes operator Helm chart allows real-time monitoring on a Prometheus-compatible stack, and enables building dashboards and alerts for enhanced operational visibility.\u003c/p\u003e\n"],["\u003cp\u003eCustom resource metrics are not enabled by default, and they can be enabled during initial operator installation or by upgrading an existing operator.\u003c/p\u003e\n"],["\u003cp\u003eTo install or upgrade with custom resource metrics enabled, users must set the \u003ccode\u003ecrdMetrics.enabled\u003c/code\u003e variable to \u003ccode\u003etrue\u003c/code\u003e in the Helm chart, and optionally specify the \u003ccode\u003ecrdMetrics.ksmImage\u003c/code\u003e variable if using a private KSM image.\u003c/p\u003e\n"],["\u003cp\u003eCustom resource metrics can be disabled at any time by setting the \u003ccode\u003ecrdMetrics.enabled\u003c/code\u003e variable to \u003ccode\u003efalse\u003c/code\u003e during a Helm chart upgrade.\u003c/p\u003e\n"]]],[],null,["# Monitor AlloyDB Omni Kubernetes operator custom resources\n\nSelect a documentation version: Current (16.8.0)keyboard_arrow_down\n\n- [Current (16.8.0)](/alloydb/omni/current/docs/monitor-kubernetes-operator-custom-resources)\n- [16.8.0](/alloydb/omni/16.8.0/docs/monitor-kubernetes-operator-custom-resources)\n- [16.3.0](/alloydb/omni/16.3.0/docs/monitor-kubernetes-operator-custom-resources)\n- [15.12.0](/alloydb/omni/15.12.0/docs/monitor-kubernetes-operator-custom-resources)\n- [15.7.1](/alloydb/omni/15.7.1/docs/monitor-kubernetes-operator-custom-resources)\n- [15.7.0](/alloydb/omni/15.7.0/docs/monitor-kubernetes-operator-custom-resources)\n\n\u003cbr /\u003e\n\nThis page describes how to monitor the status of AlloyDB Omni Kubernetes operator custom resources using [kube-state-metrics](https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/) (KSM).\n\n\u003cbr /\u003e\n\n| **Note:** These metrics are only available on AlloyDB Omni Kubernetes operator version 1.3.0 and later.\n\nRunning KSM with the Kubernetes operator lets you do the following:\n\n- Monitor custom resource status in real time on your Prometheus-compatible observability stack, together with [AlloyDB Omni metrics](/alloydb/omni/current/docs/reference/omni-metrics).\n- Build dashboards and alerts on top of the custom resource metrics for better operational visibility and proactive issue detection.\n\nFor more information about kube-state-metrics, see\n[Overview](https://github.com/kubernetes/kube-state-metrics/tree/main?tab=readme-ov-file#overview).\nTo learn how kube-state-metrics monitors Kubernetes custom resources, see\n[Custom Resource State Metrics](https://github.com/kubernetes/kube-state-metrics/blob/main/docs/metrics/extend/customresourcestate-metrics.md#custom-resource-state-metrics).\n\nHow AlloyDB Omni Kubernetes operator custom resources work\n----------------------------------------------------------\n\nBy default, custom resource metrics aren't enabled. You can\nenable custom resource metrics using the AlloyDB Omni Kubernetes operator Helm chart. When you\nenable custom resource metrics, a KSM deployment is created with a `configmap` that defines\nthe custom resource metrics and a service of type ClusterIP to expose the metrics endpoint\nof the KSM deployment. Your\n[Prometheus](https://prometheus.io/)\ncollector can collect the metrics, and you can visualize these metrics with\nother AlloyDB Omni metrics. For more information, see\n[Custom resources metrics for the AlloyDB Omni Kubernetes operator](/alloydb/omni/current/docs/reference/custom-resource-metrics-kubernetes-operator).\n\nBefore you begin\n----------------\n\nMake sure that you have the following:\n\n- A [Prometheus](https://prometheus.io/)-compatible metrics scraper running in your Kubernetes cluster.\n- Access to the kube-state-metrics image hosted at `registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0`. You can pre-pull the image to your private registry.\n- [The `helm` package manager](https://helm.sh/docs/intro/install/). You run Helm commands in a Linux command-line terminal.\n\nInstall the Kubernetes operator with custom resource metrics enabled\n--------------------------------------------------------------------\n\nYou use the following variables in the AlloyDB Omni Kubernetes operator Helm chart\nto control the installation and removal of custom resource metrics:\n\nIf you haven't installed the operator Helm chart yet, set the variables when\nyou run the Helm install.\n\nTo install Kubernetes operator with custom resource metrics enabled,\nfollow these steps:\n\n1. Open a Linux command-line terminal.\n2. Define the following environment variables by running the following\n commands:\n\n export GCS_BUCKET=alloydb-omni-operator\n export HELM_PATH=$(gcloud storage cat gs://$GCS_BUCKET/latest)\n export OPERATOR_VERSION=\"${HELM_PATH%%/*}\"\n\n3. Download the AlloyDB Omni Kubernetes operator:\n\n gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive\n\n4. If you pre-pull the public KSM image at\n `registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0` to your\n private registry, skip this step and proceed to the next step. Otherwise,\n install the AlloyDB Omni Kubernetes operator with custom resource metrics, and then proceed\n to the final step in this procedure.\n\n helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \\\n --create-namespace \\\n --namespace alloydb-omni-system \\\n --set crdMetrics.enabled=true \\\n --atomic \\\n --timeout 5m\n\n5. Export the environment variable:\n\n export KSM_IMAGE=\u003cfull path to your KSM image\u003e\n\n6. To install the AlloyDB Omni Kubernetes operator with custom resource metrics and your\n own KSM image location, run the following command:\n\n helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \\\n --create-namespace \\\n --namespace alloydb-omni-system \\\n --set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \\\n --atomic \\\n --timeout 5m\n\n A successful installation returns the following output: \n\n ```\n NAME: alloydbomni-operator\n LAST DEPLOYED: CURRENT_TIMESTAMP\n NAMESPACE: alloydb-omni-system\n STATUS: deployed\n REVISION: 1\n TEST SUITE: None\n ```\n | **Note:** If you use Red Hat OpenShift 4.12 or later, then after you install the AlloyDB Omni Kubernetes operator you must perform the [Red Hat OpenShift reconciliation steps](/alloydb/omni/current/docs/deploy-kubernetes#rhel-openshift).\n7. Clean up the installation by deleting the downloaded\n AlloyDB Omni Kubernetes operator installation file. The file is named\n `alloydbomni-operator-VERSION_NUMBER.tgz`, and is located in your current\n working directory.\n\nEnable custom resource metrics on an existing Kubernetes operator\n-----------------------------------------------------------------\n\nIf you already have the AlloyDB Omni Kubernetes operator version 1.3.0 (or later)\ninstalled, you can enable custom resource metrics by upgrading the existing operator.\n\n1. Open a Linux command-line terminal.\n2. Find your current AlloyDB Omni Kubernetes operator version and define the\n environment variables by running the following commands:\n\n export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system -o json | jq -r 'map(select(.name == \"alloydbomni-operator\") | .chart)| .[0]')\n\n OPERATOR_VERSION=${OPERATOR_VERSION#\"alloydbomni-operator-\"}\n\n echo $OPERATOR_VERSION\n\n export GCS_BUCKET=alloydb-omni-operator\n\n export HELM_PATH=$OPERATOR_VERSION/alloydbomni-operator-$OPERATOR_VERSION.tgz\n\n The output is your installed AlloyDB Omni Kubernetes operator version,\n for example, `1.3.0`.\n3. Download the specified version operator:\n\n gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive\n\n4. Upgrade the AlloyDB Omni Kubernetes operator by running the following\n commands, and then go to the final step in this procedure. If you pre-pull\n the public KSM image at\n `registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0` to your\n private registry, then skip this step and proceed directly to the next step.\n\n helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \\\n --namespace alloydb-omni-system \\\n --reuse-values \\\n --set crdMetrics.enabled=true \\\n --atomic \\\n --timeout 5m\n\n5. Export the environment variable:\n\n export KSM_IMAGE=\u003cfull path to your KSM image\u003e\n\n6. To perform the upgrade, run the following command:\n\n helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \\\n --namespace alloydb-omni-system \\\n --reuse-values \\\n --set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \\\n --atomic \\\n --timeout 5m\n\n | **Note:** Performing this upgrade doesn't cause a database restart.\n\n A successful upgrade returns the following output: \n\n ```\n NAME: alloydbomni-operator\n LAST DEPLOYED: CURRENT_TIMESTAMP\n NAMESPACE: alloydb-omni-system\n STATUS: deployed\n REVISION: 2\n TEST SUITE: None\n ```\n\nDisable custom resource metrics on an existing Kubernetes operator\n------------------------------------------------------------------\n\n1. Open a Linux command-line terminal.\n2. Run the following command:\n\n export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system -o json | jq -r 'map(select(.name == \"alloydbomni-operator\") | .chart)| .[0]')\n\n OPERATOR_VERSION=${OPERATOR_VERSION#\"alloydbomni-operator-\"}\n\n3. To disable custom resource metrics, run the following command:\n\n helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \\\n --namespace alloydb-omni-system \\\n --reuse-values \\\n --set crdMetrics.enabled=false \\\n --atomic \\\n --timeout 5m\n\nView metrics using the Prometheus API\n-------------------------------------\n\nTo view your metrics, see [View metrics using the Prometheus API](/alloydb/omni/current/docs/manage#kubernetes).\n\nWhat's next\n-----------\n\n- Learn about [custom resources definition metrics for the AlloyDB Omni Kubernetes operator](/alloydb/omni/current/docs/reference/custom-resource-metrics-kubernetes-operator)."]]
