Wenn Sie KSM mit dem Kubernetes-Operator ausführen, haben Sie folgende Möglichkeiten:
Sie können den Status benutzerdefinierter Ressourcen in Echtzeit in Ihrem Prometheus-kompatiblen Observability-Stack zusammen mit AlloyDB Omni-Messwerten überwachen.
Erstellen Sie Dashboards und Benachrichtigungen auf Grundlage der benutzerdefinierten Ressourcenmesswerte, um die operative Transparenz zu verbessern und Probleme proaktiv zu erkennen.
Funktionsweise benutzerdefinierter Ressourcen des AlloyDB Omni Kubernetes-Operators
Standardmäßig sind benutzerdefinierte Ressourcenmesswerte nicht aktiviert. Sie können benutzerdefinierte Ressourcenmesswerte mit dem Helm-Diagramm des AlloyDB Omni Kubernetes-Operators aktivieren. Wenn Sie benutzerdefinierte Ressourcenmesswerte aktivieren, wird eine KSM-Bereitstellung mit einem configmap erstellt, das die benutzerdefinierten Ressourcenmesswerte definiert, und ein Dienst vom Typ „ClusterIP“, um den Messwertendpunkt der KSM-Bereitstellung verfügbar zu machen. Ihr Prometheus-Collector kann die Messwerte erfassen und Sie können diese Messwerte mit anderen AlloyDB Omni-Messwerten visualisieren. Weitere Informationen finden Sie unter Messwerte für benutzerdefinierte Ressourcen für den AlloyDB Omni Kubernetes-Operator.
Hinweise
Folgende Voraussetzungen müssen erfüllt sein:
Ein Prometheus-kompatibler Messwert-Scraper, der in Ihrem Kubernetes-Cluster ausgeführt wird.
Zugriff auf das Kube-State-Metrics-Image, das unter registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 gehostet wird. Sie können das Image vorab in Ihre private Registry herunterladen.
Der Paketmanager helm
Helm-Befehle werden in einem Linux-Befehlszeilenterminal ausgeführt.
Kubernetes-Operator mit aktivierten benutzerdefinierten Ressourcenmesswerten installieren
Mit den folgenden Variablen im Helm-Diagramm des AlloyDB Omni Kubernetes-Operators können Sie die Installation und Entfernung von Messwerten für benutzerdefinierte Ressourcen steuern:
Variable
Typ
Beschreibung
Default
crdMetrics.enabled
Boolesch (true/false)
Aktiviert und deaktiviert benutzerdefinierte Ressourcenmesswerte
Wenn Sie das öffentliche KSM-Image unter registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 in Ihre private Registry vorab abgerufen haben, überspringen Sie diesen Schritt und fahren Sie mit dem nächsten Schritt fort. Andernfalls installieren Sie den AlloyDB Omni Kubernetes-Operator mit benutzerdefinierten Ressourcenmesswerten und fahren dann mit dem letzten Schritt in dieser Anleitung fort.
Führen Sie den folgenden Befehl aus, um den AlloyDB Omni Kubernetes-Operator mit benutzerdefinierten Ressourcenmesswerten und Ihrem eigenen KSM-Image-Speicherort zu installieren:
Bei einer erfolgreichen Installation wird die folgende Ausgabe zurückgegeben:
NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 1
TEST SUITE: None
Bereinigen Sie die Installation, indem Sie die heruntergeladene Installationsdatei des AlloyDB Omni Kubernetes-Operators löschen. Die Datei hat den Namen alloydbomni-operator-VERSION_NUMBER.tgz und befindet sich in Ihrem aktuellen Arbeitsverzeichnis.
Messwerte für benutzerdefinierte Ressourcen für einen vorhandenen Kubernetes-Operator aktivieren
Wenn Sie bereits den AlloyDB Omni Kubernetes-Operator in Version 1.3.0 oder höher installiert haben, können Sie benutzerdefinierte Ressourcenmesswerte aktivieren, indem Sie den vorhandenen Operator aktualisieren.
Öffnen Sie ein Linux-Befehlszeilenterminal.
Ermitteln Sie Ihre aktuelle AlloyDB Omni Kubernetes-Operatorversion und definieren Sie die Umgebungsvariablen, indem Sie die folgenden Befehle ausführen:
Aktualisieren Sie den AlloyDB Omni Kubernetes-Operator mit den folgenden Befehlen und fahren Sie dann mit dem letzten Schritt in dieser Anleitung fort. Wenn Sie das öffentliche KSM-Image unter registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 vorab in Ihre private Registry heruntergeladen haben, überspringen Sie diesen Schritt und fahren Sie direkt mit dem nächsten Schritt fort.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-08-17 (UTC)."],[],[],null,["# Monitor AlloyDB Omni Kubernetes operator custom resources\n\nSelect a documentation version: 15.12.0keyboard_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/15.12.0/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/15.12.0/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/15.12.0/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/15.12.0/docs/manage#kubernetes).\n\nWhat's next\n-----------\n\n- Learn about [custom resources definition metrics for the AlloyDB Omni Kubernetes operator](/alloydb/omni/15.12.0/docs/reference/custom-resource-metrics-kubernetes-operator)."]]
