Benutzerdefinierte Ressourcen des AlloyDB Omni Kubernetes-Operators überwachen

Wählen Sie eine Dokumentationsversion aus:

Auf dieser Seite wird beschrieben, wie Sie den Status benutzerdefinierter Ressourcen des AlloyDB Omni Kubernetes-Operators mit 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 betriebliche Transparenz zu verbessern und Probleme proaktiv zu erkennen.

Weitere Informationen zu kube-state-metrics finden Sie in der Übersicht. Informationen dazu, wie kube-state-metrics benutzerdefinierte Kubernetes-Ressourcen überwacht, finden Sie unter Messwerte für den Status benutzerdefinierter Ressourcen.

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 false (deaktivieren)

crdMetrics.ksmImage

String Vollständiger Pfad von ksmImage

registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0

Wenn Sie das Operator-Helm-Diagramm noch nicht installiert haben, legen Sie die Variablen fest, wenn Sie die Helm-Installation ausführen.

So installieren Sie den Kubernetes-Operator mit aktivierten Messwerten für benutzerdefinierte Ressourcen:

  1. Öffnen Sie ein Linux-Befehlszeilenterminal.

  2. Definieren Sie die folgenden Umgebungsvariablen, 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%%/*}"

  3. Laden Sie den AlloyDB Omni Kubernetes-Operator herunter:

    gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive

  4. 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 Sie dann mit dem letzten Schritt in 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

  5. Exportieren Sie die Umgebungsvariable:

    export KSM_IMAGE=<full path to your KSM image>

  6. 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

  7. 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 Version 1.3.0 (oder höher) installiert haben, können Sie benutzerdefinierte Ressourcenmesswerte aktivieren, indem Sie den vorhandenen Operator aktualisieren.

  1. Öffnen Sie ein Linux-Befehlszeilenterminal.

  2. Ermitteln Sie Ihre aktuelle AlloyDB Omni Kubernetes-Operatorversion und definieren Sie die Umgebungsvariablen, indem Sie die folgenden Befehle ausführen:

    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.

  3. Laden Sie den angegebenen Versionsoperator herunter:

    gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive

  4. Aktualisieren Sie den AlloyDB Omni Kubernetes-Operator, indem Sie die folgenden Befehle ausführen, 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.

    helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--namespace alloydb-omni-system \
--reuse-values \
--set crdMetrics.enabled=true \
--atomic \
--timeout 5m

  5. Exportieren Sie die Umgebungsvariable:

    export KSM_IMAGE=<full path to your KSM image>

  6. 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

Messwerte für benutzerdefinierte Ressourcen in einem vorhandenen Kubernetes-Operator deaktivieren

  1. Öffnen Sie ein Linux-Befehlszeilenterminal.

  2. 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-"}

  3. Führen Sie den folgenden Befehl aus, um benutzerdefinierte Ressourcenmesswerte 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.

Nächste Schritte