Surveiller les ressources personnalisées de l'opérateur Kubernetes AlloyDB Omni

Sélectionnez une version de la documentation :

Cette page explique comment surveiller l'état des ressources personnalisées de l'opérateur AlloyDB Omni Kubernetes à l'aide de kube-state-metrics (KSM).

L'exécution de KSM avec l'opérateur Kubernetes vous permet d'effectuer les opérations suivantes :

  • Surveillez l'état des ressources personnalisées en temps réel dans votre pile d'observabilité compatible avec Prometheus, ainsi que les métriques AlloyDB Omni.
  • Créez des tableaux de bord et des alertes basés sur les métriques de ressources personnalisées pour une meilleure visibilité opérationnelle et une détection proactive des problèmes.

Pour en savoir plus sur kube-state-metrics, consultez la présentation. Pour savoir comment kube-state-metrics surveille les ressources personnalisées Kubernetes, consultez Métriques d'état des ressources personnalisées.

Fonctionnement des ressources personnalisées de l'opérateur Kubernetes AlloyDB Omni

Par défaut, les métriques de ressources personnalisées ne sont pas activées. Vous pouvez activer les métriques de ressources personnalisées à l'aide du chart Helm de l'opérateur AlloyDB Omni Kubernetes. Lorsque vous activez les métriques de ressources personnalisées, un déploiement KSM est créé avec un configmap qui définit les métriques de ressources personnalisées et un service de type ClusterIP pour exposer le point de terminaison des métriques du déploiement KSM. Votre collecteur Prometheus peut collecter les métriques, et vous pouvez les visualiser avec d'autres métriques AlloyDB Omni. Pour en savoir plus, consultez Métriques des ressources personnalisées pour l'opérateur Kubernetes AlloyDB Omni.

Avant de commencer

Assurez-vous de disposer des éléments suivants :

  • Un scraper de métriques compatible avec Prometheus s'exécutant dans votre cluster Kubernetes.
  • Accès à l'image kube-state-metrics hébergée sur registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0. Vous pouvez pré-extraire l'image vers votre registre privé.
  • Le gestionnaire de paquets helm. Vous exécutez les commandes Helm dans un terminal Linux en ligne de commande.

Installer l'opérateur Kubernetes avec les métriques de ressources personnalisées activées

Vous utilisez les variables suivantes dans le graphique Helm de l'opérateur AlloyDB Omni Kubernetes pour contrôler l'installation et la suppression des métriques de ressources personnalisées :

Variable Type Description Par défaut

crdMetrics.enabled

Booléen (vrai/faux) Active et désactive les métriques de ressources personnalisées false (désactiver)

crdMetrics.ksmImage

Chaîne Chemin complet de ksmImage

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

Si vous n'avez pas encore installé le chart Helm de l'opérateur, définissez les variables lorsque vous exécutez l'installation Helm.

Pour installer l'opérateur Kubernetes avec les métriques de ressources personnalisées activées, procédez comme suit :

  1. Ouvrez un terminal de ligne de commande Linux.

  2. Définissez les variables d'environnement suivantes en exécutant les commandes suivantes :

    export GCS_BUCKET=alloydb-omni-operator
export HELM_PATH=$(gcloud storage cat gs://$GCS_BUCKET/latest)
export OPERATOR_VERSION="${HELM_PATH%%/*}"

  3. Téléchargez l'opérateur Kubernetes AlloyDB Omni :

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

  4. Si vous pré-extrait l'image KSM publique à l'adresse registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 vers votre registre privé, ignorez cette étape et passez à la suivante. Sinon, installez l'opérateur AlloyDB Omni Kubernetes avec des métriques de ressources personnalisées, puis passez à la dernière étape de cette procédure.

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

  5. Exportez la variable d'environnement :

    export KSM_IMAGE=<full path to your KSM image>

  6. Pour installer l'opérateur AlloyDB Omni Kubernetes avec des métriques de ressources personnalisées et votre propre emplacement d'image KSM, exécutez la commande suivante :

    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

    Si l'installation aboutit, la sortie suivante devrait s'afficher :

    NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

  7. Nettoyez l'installation en supprimant le fichier d'installation de l'opérateur Kubernetes AlloyDB Omni téléchargé. Le fichier est nommé alloydbomni-operator-VERSION_NUMBER.tgz et se trouve dans votre répertoire de travail actuel.

Activer les métriques de ressources personnalisées sur un opérateur Kubernetes existant

Si vous avez déjà installé la version 1.3.0 (ou ultérieure) de l'opérateur Kubernetes AlloyDB Omni, vous pouvez activer les métriques de ressources personnalisées en mettant à niveau l'opérateur existant.

  1. Ouvrez un terminal de ligne de commande Linux.

  2. Recherchez la version actuelle de l'opérateur Kubernetes AlloyDB Omni et définissez les variables d'environnement en exécutant les commandes suivantes :

    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

    La sortie correspond à la version de l'opérateur Kubernetes AlloyDB Omni que vous avez installée (par exemple, 1.3.0).

  3. Téléchargez l'opérateur de la version spécifiée :

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

  4. Mettez à niveau l'opérateur Kubernetes AlloyDB Omni en exécutant les commandes suivantes, puis passez à la dernière étape de cette procédure. Si vous pré-extrait l'image KSM publique à l'adresse registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 vers votre registre privé, ignorez cette étape et passez directement à la suivante.

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

  5. Exportez la variable d'environnement :

    export KSM_IMAGE=<full path to your KSM image>

  6. Pour effectuer la mise à niveau, exécutez la commande suivante :

    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

    Si la mise à niveau aboutit, le résultat suivant s'affiche :

    NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 2
TEST SUITE: None

Désactiver les métriques de ressources personnalisées sur un opérateur Kubernetes existant

  1. Ouvrez un terminal de ligne de commande Linux.

  2. Exécutez la commande suivante :

    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. Pour désactiver les métriques de ressources personnalisées, exécutez la commande suivante :

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

Afficher les métriques à l'aide de l'API Prometheus

Pour afficher vos métriques, consultez Afficher les métriques à l'aide de l'API Prometheus.

Étapes suivantes