Auf dieser Seite wird beschrieben, wie Sie den Status der benutzerdefinierten Ressourcen des AlloyDB Omni Kubernetes-Betriebs mithilfe von kube-state-metrics (KSM) überwachen.
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 Betriebsübersicht zu verbessern und Probleme proaktiv zu erkennen.
Weitere Informationen zu kube-state-metrics finden Sie unter Übersicht. Informationen dazu, wie kube-state-metrics benutzerdefinierte Kubernetes-Ressourcen überwacht, finden Sie unter Messwerte zum Status benutzerdefinierter Ressourcen.
Funktionsweise benutzerdefinierter Ressourcen des AlloyDB Omni Kubernetes-Operators
Benutzerdefinierte Ressourcenmesswerte sind standardmäßig 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 einer configmap
erstellt, die die benutzerdefinierten Ressourcenmesswerte und einen Dienst vom Typ „ClusterIP“ definiert, um den Messwertendpunkt der KSM-Bereitstellung freizugeben. Der Prometheus-Collector kann die Messwerte erfassen und Sie können sie mit anderen AlloyDB Omni-Messwerten visualisieren. Weitere Informationen finden Sie unter Benutzerdefinierte Ressourcenmesswerte für den AlloyDB Omni Kubernetes-Operator.
Hinweise
Du benötigst Folgendes:
- Ein Prometheus-kompatibler Messwert-Scrapper, der in Ihrem Kubernetes-Cluster ausgeführt wird.
- Zugriff auf das Image „kube-state-metrics“, das auf
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0
gehostet wird. Sie können das Image vorab in Ihre private Registry abrufen. - Der Paketmanager
helm
Sie führen Helm-Befehle in einem Linux-Befehlszeilenterminal aus.
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 benutzerdefinierten Ressourcenmesswerten steuern:
Variable | Typ | Beschreibung | Default |
---|---|---|---|
|
Boolesch (wahr/falsch) | Benutzerdefinierte Ressourcenmesswerte aktivieren und deaktivieren | false (deaktivieren) |
|
String | Vollständiger Pfad der ksmImage |
|
Wenn Sie das Helm-Diagramm des Operators noch nicht installiert haben, legen Sie die Variablen fest, wenn Sie die Helm-Installation ausführen.
So installieren Sie den Kubernetes-Operator mit aktivierten benutzerdefinierten Ressourcenmesswerten:
- Öffnen Sie ein Linux-Terminal.
Legen Sie die folgenden Umgebungsvariablen fest, indem Sie die folgenden Befehle ausführen:
export GCS_BUCKET=alloydb-omni-operator export HELM_PATH=$(gcloud storage cat gs://$GCS_BUCKET/latest) export OPERATOR_VERSION="${HELM_PATH%%/*}"
Laden Sie den AlloyDB Omni Kubernetes-Operator herunter:
gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive
Wenn Sie das öffentliche KSM-Image unter
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0
bereits in Ihre private Registry gezogen haben, überspringen Sie diesen Schritt und fahren Sie mit dem nächsten fort. Andernfalls installieren Sie den AlloyDB Omni Kubernetes-Operator mit benutzerdefinierten Ressourcenmesswerten und fahren Sie mit dem letzten Schritt dieser Anleitung fort.helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \ --create-namespace \ --namespace alloydb-omni-system \ --set crdMetrics.enabled=true \ --atomic \ --timeout 5m
Exportieren Sie die Umgebungsvariable:
export KSM_IMAGE=<full path to your KSM image>
Führen Sie den folgenden Befehl aus, um den AlloyDB Omni Kubernetes-Operator mit benutzerdefinierten Ressourcenmesswerten und Ihrem eigenen KSM-Image-Speicherort zu installieren:
helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \ --create-namespace \ --namespace alloydb-omni-system \ --set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \ --atomic \ --timeout 5m
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.
Benutzerdefinierte Ressourcenmesswerte für einen vorhandenen Kubernetes-Operator aktivieren
Wenn Sie bereits die AlloyDB Omni Kubernetes-Operatorversion 1.3.0 oder höher installiert haben, können Sie benutzerdefinierte Ressourcenmesswerte aktivieren, indem Sie den vorhandenen Operator aktualisieren.
- Öffnen Sie ein Linux-Terminal.
Ermitteln Sie die aktuelle Version des AlloyDB Omni Kubernetes-Operators und definieren Sie die Umgebungsvariablen. Führen Sie dazu die folgenden Befehle aus:
export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system -o json | jq -r 'map(select(.name == "alloydbomni-operator") | .chart)| .[0]') OPERATOR_VERSION=${OPERATOR_VERSION#"alloydbomni-operator-"} echo $OPERATOR_VERSION export GCS_BUCKET=alloydb-omni-operator export HELM_PATH=$OPERATOR_VERSION/alloydbomni-operator-$OPERATOR_VERSION.tgz
Die Ausgabe ist die installierte Version des AlloyDB Omni Kubernetes-Operators, z. B.
1.3.0
.Laden Sie den Operator der angegebenen Version herunter:
gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive
Führen Sie die folgenden Befehle aus, um den AlloyDB Omni Kubernetes-Operator zu aktualisieren, und fahren Sie dann mit dem letzten Schritt 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 abgerufen haben, überspringen Sie diesen Schritt und fahren Sie direkt mit dem nächsten fort.helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \ --namespace alloydb-omni-system \ --reuse-values \ --set crdMetrics.enabled=true \ --atomic \ --timeout 5m
Exportieren Sie die Umgebungsvariable:
export KSM_IMAGE=<full path to your KSM image>
Führen Sie den folgenden Befehl aus, um das Upgrade durchzuführen:
helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \ --namespace alloydb-omni-system \ --reuse-values \ --set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \ --atomic \ --timeout 5m
Bei einer erfolgreichen Umstellung wird die folgende Ausgabe zurückgegeben:
NAME: alloydbomni-operator LAST DEPLOYED: CURRENT_TIMESTAMP NAMESPACE: alloydb-omni-system STATUS: deployed REVISION: 2 TEST SUITE: None
Benutzerdefinierte Ressourcenmesswerte für einen vorhandenen Kubernetes-Operator deaktivieren
- Öffnen Sie ein Linux-Terminal.
Führen Sie dazu diesen Befehl aus:
export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system -o json | jq -r 'map(select(.name == "alloydbomni-operator") | .chart)| .[0]') OPERATOR_VERSION=${OPERATOR_VERSION#"alloydbomni-operator-"}
Führen Sie den folgenden Befehl aus, um Messwerte für benutzerdefinierte Ressourcen zu deaktivieren:
helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \ --namespace alloydb-omni-system \ --reuse-values \ --set crdMetrics.enabled=false \ --atomic \ --timeout 5m
Messwerte mit der Prometheus API ansehen
Informationen zum Aufrufen Ihrer Messwerte finden Sie unter Messwerte mit der Prometheus API ansehen.