Supervisa los recursos personalizados del operador de Kubernetes de AlloyDB Omni

En esta página, se describe cómo supervisar el estado de los recursos personalizados del operador de Kubernetes de AlloyDB Omni con kube-state-metrics (KSM).

Ejecutar KSM con el operador de Kubernetes te permite hacer lo siguiente:

  • Supervisa el estado de los recursos personalizados en tiempo real en tu pila de observabilidad compatible con Prometheus, junto con las métricas de AlloyDB Omni.
  • Compila paneles y alertas en función de las métricas de recursos personalizados para obtener una mejor visibilidad operativa y una detección proactiva de problemas.

Para obtener más información sobre kube-state-metrics, consulta Descripción general. Para obtener información sobre cómo kube-state-metrics supervisa los recursos personalizados de Kubernetes, consulta Métricas de estado de recursos personalizados.

Cómo funcionan los recursos personalizados del operador de Kubernetes de AlloyDB Omni

De forma predeterminada, las métricas de recursos personalizados no están habilitadas. Puedes habilitar las métricas de recursos personalizados con el gráfico de Helm del operador de Kubernetes de AlloyDB Omni. Cuando habilitas las métricas de recursos personalizados, se crea una implementación de KSM con un configmap que define las métricas de recursos personalizados y un servicio de tipo ClusterIP para exponer el extremo de métricas de la implementación de KSM. Tu recopilador de Prometheus puede recopilar las métricas, y puedes visualizarlas con otras métricas de AlloyDB Omni. Para obtener más información, consulta Métricas de recursos personalizados para el operador de Kubernetes de AlloyDB Omni.

Antes de comenzar

Asegúrate de tener lo siguiente:

  • Un rastreador de métricas compatible con Prometheus que se ejecuta en tu clúster de Kubernetes
  • Acceso a la imagen de kube-state-metrics alojada en registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 Puedes extraer la imagen previamente en tu registro privado.
  • El administrador de paquetes helm Ejecuta los comandos de Helm en una terminal de línea de comandos de Linux.

Instala el operador de Kubernetes con las métricas de recursos personalizados habilitadas

Usa las siguientes variables en el gráfico de Helm del operador de Kubernetes de AlloyDB Omni para controlar la instalación y la eliminación de métricas de recursos personalizados:

Variable Tipo Descripción Valor predeterminado

crdMetrics.enabled

Booleano (verdadero o falso) Habilita o inhabilita las métricas de recursos personalizadas false (inhabilitar)

crdMetrics.ksmImage

String Ruta de acceso completa de ksmImage

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

Si aún no instalaste el gráfico de Helm del operador, configura las variables cuando ejecutes la instalación de Helm.

Para instalar el operador de Kubernetes con las métricas de recursos personalizadas habilitadas, sigue estos pasos:

  1. Abre una terminal de línea de comandos de Linux.

  2. Ejecuta los siguientes comandos para definir las siguientes variables de entorno:

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

  3. Descarga el operador de Kubernetes de AlloyDB Omni:

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

  4. Si extraes previamente la imagen pública de KSM en registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 a tu registro privado, omite este paso y continúa con el siguiente. De lo contrario, instala el operador de Kubernetes de AlloyDB Omni con métricas de recursos personalizadas y, luego, continúa con el paso final de este procedimiento.

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

  5. Exporta la variable de entorno:

    export KSM_IMAGE=<full path to your KSM image>

  6. Para instalar el operador de Kubernetes de AlloyDB Omni con métricas de recursos personalizados y tu propia ubicación de imagen de KSM, ejecuta el siguiente comando:

    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

    Una instalación correcta muestra el siguiente resultado:

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

  7. Para limpiar la instalación, borra el archivo de instalación del operador de Kubernetes de AlloyDB Omni que descargaste. El archivo se llama alloydbomni-operator-VERSION_NUMBER.tgz y se encuentra en tu directorio de trabajo actual.

Habilita las métricas de recursos personalizados en un operador de Kubernetes existente

Si ya tienes instalada la versión 1.3.0 (o una posterior) del operador de Kubernetes de AlloyDB Omni, puedes habilitar las métricas de recursos personalizadas actualizando el operador existente.

  1. Abre una terminal de línea de comandos de Linux.

  2. Ejecuta los siguientes comandos para encontrar la versión actual del operador de Kubernetes de AlloyDB Omni y definir las variables de entorno:

    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

    El resultado es la versión instalada del operador de Kubernetes de AlloyDB Omni, por ejemplo, 1.3.0.

  3. Descarga el operador de versión especificado:

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

  4. Ejecuta los siguientes comandos para actualizar el operador de Kubernetes de AlloyDB Omni y, luego, ve al paso final de este procedimiento. Si extraes previamente la imagen pública de KSM en registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 a tu registro privado, omite este paso y continúa directamente con el siguiente.

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

  5. Exporta la variable de entorno:

    export KSM_IMAGE=<full path to your KSM image>

  6. Para realizar la actualización, ejecuta el siguiente comando:

    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

    Una actualización correcta muestra el siguiente resultado:

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

Inhabilita las métricas de recursos personalizados en un operador de Kubernetes existente

  1. Abre una terminal de línea de comandos de Linux.

  2. Ejecuta el siguiente comando:

    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. Para inhabilitar las métricas de recursos personalizados, ejecuta el siguiente comando:

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

Visualiza métricas con la API de Prometheus

Para ver tus métricas, consulta Cómo ver métricas con la API de Prometheus.

¿Qué sigue?