Administra y supervisa AlloyDB Omni

Selecciona una versión de la documentación:

En esta página, se describe cómo administrar los roles de usuario de AlloyDB Omni, supervisar la actividad de tu servidor de AlloyDB Omni y actualizar o quitar tu instalación de AlloyDB Omni.

Administra los roles de los usuarios

AlloyDB Omni usa el mismo conjunto de roles de usuario predefinidos de PostgreSQL que incluye AlloyDB para PostgreSQL, con las siguientes diferencias:

  • AlloyDB Omni incluye un rol de superusuario llamado alloydbadmin y un rol de no superusuario llamado alloydbmetadata.

  • El usuario postgres predeterminado tiene un rol de superusuario.

  • Todos los demás roles de usuario predefinidos no tienen privilegios. Están reservadas para posibles usos en el futuro.

Configura una base de datos de AlloyDB Omni

Al igual que con AlloyDB para PostgreSQL, es una práctica recomendada seguir estos pasos cuando configures una base de datos:

  1. Define o importa tus bases de datos con el rol de usuario postgres. En una instalación nueva, este rol tiene privilegios de superusuario y no requiere contraseña.

  2. Crea roles de usuario nuevos que tengan el nivel de acceso correcto a las tablas de tu aplicación, nuevamente con el rol de usuario postgres.

  3. Configura tu aplicación para que se conecte a la base de datos con estos nuevos roles de acceso limitado.

Puedes crear y definir tantos roles de usuario nuevos como necesites. No modifiques ni borres ninguno de los roles de usuario con los que se entrega AlloyDB Omni.

Para obtener más información, consulta Cómo administrar usuarios y roles de AlloyDB Omni.

Supervisa AlloyDB Omni

El monitoreo de la instalación de AlloyDB Omni incluye la lectura y el análisis de los archivos de registro de AlloyDB Omni.

AlloyDB Omni que se ejecuta en Kubernetes proporciona un conjunto de métricas básicas disponibles como extremos de Prometheus. Para obtener una lista de las métricas disponibles, consulta Métricas de AlloyDB Omni.

Además, AlloyDB Omni que se ejecuta en Kubernetes expone métricas de recursos personalizados que aprovechan kube-state-metrics (KSM). Para habilitar las métricas de recursos personalizados, consulta Supervisa los recursos personalizados del operador de Kubernetes de AlloyDB Omni.

Un solo servidor

De forma predeterminada, para recuperar los registros de AlloyDB Omni, ejecuta el siguiente comando:

Docker

  docker logs CONTAINER_NAME

Reemplaza CONTAINER_NAME por el nombre de tu contenedor de AlloyDB Omni.

Para configurar el comportamiento de registro de AlloyDB Omni, consulta Cómo personalizar la instalación de AlloyDB Omni.

Podman

  podman logs CONTAINER_NAME

Reemplaza CONTAINER_NAME por el nombre de tu contenedor de AlloyDB Omni.

Para configurar el comportamiento de registro de AlloyDB Omni, consulta Cómo personalizar la instalación de AlloyDB Omni.

Kubernetes

Cómo encontrar los archivos de registro de tu clúster de base de datos

Los archivos postgresql.audit y postgresql.log se encuentran en el sistema de archivos del Pod de la base de datos. postgresql.audit solo está presente si habilitaste pgaudit.

Para acceder a estos archivos, sigue estos pasos:

  1. Define una variable de entorno que contenga el nombre del pod de la base de datos.

    export DB_POD=`kubectl get pod -l alloydbomni.internal.dbadmin.goog/dbcluster=DB_CLUSTER_NAME,alloydbomni.internal.dbadmin.goog/task-type=database -o jsonpath='{.items[0].metadata.name}'`

    Reemplaza DB_CLUSTER_NAME por el nombre de tu clúster de base de datos. Es el mismo nombre del clúster de base de datos que declaraste cuando lo creaste.

  2. Ejecuta una shell en el pod de la base de datos como administrador.

    kubectl exec ${DB_POD} -it -- /bin/bash
  3. Busca los archivos de registro en el directorio /obs/diagnostic/:

    • /obs/diagnostic/postgresql.audit
    • /obs/diagnostic/postgresql.log

Enumera los servicios de supervisión

v1.0

Cuando creas un clúster de base de datos, AlloyDB Omni crea el siguiente servicio de supervisión para cada CR de instancia del clúster de base de datos en el mismo espacio de nombres:

al-INSTANCE_NAME-monitoring-system

Para enumerar los servicios de supervisión, ejecuta el siguiente comando.

kubectl get svc -n NAMESPACE | grep monitoring

Reemplaza NAMESPACE por un espacio de nombres al que pertenece tu clúster.

En el siguiente ejemplo de respuesta, se muestran los servicios al-1060-dbc-monitoring-system, al-3de6-dbc-monitoring-system y al-4bc0-dbc-monitoring-system. Cada servicio corresponde a una instancia.

al-1060-dbc-monitoring-system   ClusterIP   10.0.15.227   <none>        9187/TCP   7d20h
al-3de6-dbc-monitoring-system   ClusterIP   10.0.5.205    <none>        9187/TCP   7d19h
al-4bc0-dbc-monitoring-system   ClusterIP   10.0.15.92    <none>        9187/TCP   7d19h

Versión < 1.0

Cuando creas un clúster de base de datos, AlloyDB Omni crea los siguientes servicios de supervisión en el mismo espacio de nombres que el clúster de base de datos:

  • DB_CLUSTER-monitoring-db

  • DB_CLUSTER-monitoring-system

Para enumerar los servicios de supervisión, ejecuta el siguiente comando.

kubectl get svc -n NAMESPACE | grep monitoring

Reemplaza NAMESPACE por un espacio de nombres al que pertenece tu clúster.

En la siguiente respuesta de ejemplo, se muestran el servicio al-2953-dbcluster-foo7-monitoring-system y el servicio al-2953-dbcluster-foo7-monitoring-db.

al-2953-dbcluster-foo7-monitoring-db           ClusterIP   10.36.3.243    <none>        9187/TCP   44m
al-2953-dbcluster-foo7-monitoring-system       ClusterIP   10.36.7.72     <none>        9187/TCP   44m

Visualiza las métricas de Prometheus desde la línea de comandos

El puerto 9187 se denomina metricsalloydbomni para todos los servicios de supervisión.

  1. Configura la redirección de puertos desde tu entorno local al servicio de supervisión.

    kubectl port-forward service/MONITORING_SERVICE -n NAMESPACE MONITORING_METRICS_PORT:metricsalloydbomni
    

    Reemplaza lo siguiente:

    • MONITORING_SERVICE: Es el nombre del servicio de supervisión que deseas reenviar, por ejemplo, al-1060-dbc-monitoring-system.

    • NAMESPACE: Es el espacio de nombres al que pertenece tu clúster.

    • MONITORING_METRICS_PORT: Es un puerto TCP local disponible.

    La siguiente respuesta muestra que los servicios se reenvían.

    Forwarding from 127.0.0.1:9187 -> 9187
    Forwarding from [::1]:9187 -> 9187
    
  2. Mientras se ejecuta el comando anterior, puedes acceder a las métricas de supervisión a través de HTTP en el puerto que especificaste. Por ejemplo, puedes usar curl para ver todas las métricas como texto sin formato:

    curl http://localhost:MONITORING_METRICS_PORT/metrics
    

Visualiza métricas con la API de Prometheus

La clave de la etiqueta alloydbomni.internal.dbadmin.goog/task-type y el puerto metricsalloydbomni están disponibles de forma predeterminada para todos los servicios de supervisión en AlloyDB Omni. Puedes usarlos junto con un solo recurso personalizado serviceMonitor para seleccionar todos los servicios de todos los espacios de nombres en tu clúster de base de datos.

Para obtener más información sobre el uso de la API de Prometheus, consulta la documentación del operador de Prometheus.

A continuación, se muestra un ejemplo del campo spec del recurso personalizado serviceMonitor que incluye la clave de etiqueta alloydbomni.internal.dbadmin.gdc.goog/task-type y el puerto metricsalloydbomni. El recurso personalizado serviceMonitor supervisa y recopila todos los servicios de Kubernetes en todos los espacios de nombres.

Para obtener más información sobre la definición completa de ServiceMonitor, consulta la definición de recurso personalizado de ServiceMonitor .

v1.0

    spec:
      selector:
        matchLabels:
          alloydbomni.internal.dbadmin.goog/task-type: monitoring
      namespaceSelector:
        any: true
      endpoints:
        - port: metricsalloydbomni

Versión < 1.0

    spec:
      selector:
        matchExpressions:
        - key: alloydbomni.internal.dbadmin.gdc.goog/task-type
          operator: Exists
          values: []
      namespaceSelector:
        any: true
      endpoints:
      - port: metricsalloydbomni

Visualiza métricas con Grafana

Para obtener una representación visual de las métricas en AlloyDB Omni en Kubernetes, usa el panel de supervisión. El panel de supervisión se basa en una pila de observabilidad básica que consta de Prometheus y Grafana. Para configurar el panel de supervisión de modo que recopile métricas de AlloyDB Omni, sigue estos pasos:

  1. Para descargar el panel de Grafana, usa el comando wget:

    wget https://raw.githubusercontent.com/GoogleCloudPlatform/alloydb-omni-samples/refs/heads/main/monitoring-dashboards/grafana/alloydbomni_dashboard.yaml
    
  2. Debes descargar e instalar grafana-operator antes de implementar Grafana en Kubernetes. Para obtener instrucciones detalladas, consulta Instalación.

  3. Agrega la etiqueta monitoring.dashboard/product=alloydb-omni a la instancia de Grafana en la que instalas el panel:

    kubectl label grafana/GRAFANA_INSTANCE_NAME monitoring.dashboard/product=alloydb-omni -n NAMESPACE
    

    Reemplaza lo siguiente:

    • GRAFANA_INSTANCE_NAME: Es el nombre de la instancia de Grafana en la que colocaste el panel.
    • NAMESPACE: Es el espacio de nombres en el que implementaste el operador de Grafana.
  4. Para aplicar la configuración del panel de Grafana a tu clúster de AlloyDB Omni en Kubernetes, usa el siguiente comando:

    kubectl apply -f alloydbomni_dashboard.yaml -n NAMESPACE
    

    Consulta la documentación del operador de Grafana para obtener información sobre cómo usarlo.

  5. Para configurar Grafana para que use Prometheus como fuente de datos, consulta Fuentes de datos.

  6. Para verificar que Grafana esté configurado correctamente, realiza una de las siguientes acciones:

    • Visualiza la colección de paneles de Grafana en el panel de AlloyDB Omni.
    • Recupera información sobre el panel de Grafana en un clúster de Kubernetes:

      kubectl get grafanadashboard alloydb-omni-dashboard -n NAMESPACE -o jsonpath='{.status.conditions[?(@.type=="DashboardSynchronized")].status}'
      

      Si el comando devuelve True, significa que alloydb-omni-dashboard se implementó correctamente en la instancia de Grafana.

Actualiza AlloyDB Omni

Para actualizar de AlloyDB Omni 15.5.2 o una versión anterior a la 15.5.4, sigue las instrucciones en Migra de una versión anterior de AlloyDB Omni a la versión más reciente.

Para actualizar desde la versión 15.5.4 y versiones posteriores, haz lo siguiente:

  1. Reinicia AlloyDB Omni con una nueva versión de imagen.

  2. Asegúrate de especificar tu directorio de datos para que coincida con la misma ruta de acceso que se usó en versiones anteriores de AlloyDB Omni.

Cómo desinstalar AlloyDB Omni

Un solo servidor

Para desinstalar AlloyDB Omni, detén y borra el contenedor de AlloyDB Omni con el siguiente comando:

Docker

 docker container stop CONTAINER_NAME
   docker container rm CONTAINER_NAME

Reemplaza CONTAINER_NAME por el nombre de tu contenedor de AlloyDB Omni.

Podman

 podman container stop CONTAINER_NAME
   podman container rm CONTAINER_NAME

Reemplaza CONTAINER_NAME por el nombre de tu contenedor de AlloyDB Omni.

Podman

 podman container stop CONTAINER_NAME
   podman container rm CONTAINER_NAME

Reemplaza CONTAINER_NAME por el nombre de tu contenedor de AlloyDB Omni.

Puedes mover, archivar o borrar un directorio de datos externos según si quieres conservar tus datos después de desinstalar AlloyDB Omni y cómo quieres hacerlo.

Kubernetes

Borra tu clúster de base de datos

Para borrar tu clúster de base de datos, configura isDeleted como true en su manifiesto. Puedes hacerlo con el siguiente comando.

kubectl patch dbclusters.alloydbomni.dbadmin.goog DB_CLUSTER_NAME -p '{"spec":{"isDeleted":true}}' --type=merge

Reemplaza DB_CLUSTER_NAME por el nombre de tu clúster de base de datos. Es el mismo nombre del clúster de base de datos que declaraste cuando lo creaste.

Desinstala el operador de AlloyDB Omni

Para desinstalar el operador de Kubernetes de AlloyDB Omni de tu clúster de Kubernetes, sigue estos pasos:

  1. Borra todos tus clústeres de bases de datos:

    for ns in $(kubectl get dbclusters.alloydbomni.dbadmin.goog --all-namespaces -o=jsonpath='{range .items[*]}{.metadata.namespace}{"\n"}{end}'); do
    for cr in $(kubectl get dbclusters.alloydbomni.dbadmin.goog -n $ns -o=jsonpath='{range .items[*]}{.metadata.name}{"\n"}{end}'); do
    kubectl patch dbclusters.alloydbomni.dbadmin.goog $cr -n $ns --type=merge -p '{"spec":{"isDeleted":true}}'
    done
    done
  2. Espera a que el operador de Kubernetes de AlloyDB Omni borre todos tus clústeres de bases de datos. Usa el siguiente comando para verificar si quedan recursos de la base de datos:

    kubectl get dbclusters.alloydbomni.dbadmin.goog --all-namespaces
  3. Borra otros recursos que creó el operador de Kubernetes de AlloyDB Omni:

    kubectl delete failovers.alloydbomni.dbadmin.goog --all --all-namespaces
    kubectl delete restores.alloydbomni.dbadmin.goog --all --all-namespaces
    kubectl delete switchovers.alloydbomni.dbadmin.goog --all --all-namespaces
  4. Desinstala el operador de Kubernetes de AlloyDB Omni:

    helm uninstall alloydbomni-operator --namespace alloydb-omni-system
  5. Limpia los secretos, las descripciones de recursos personalizados y los espacios de nombres relacionados con el operador de Kubernetes de AlloyDB Omni:

    kubectl delete certificate -n alloydb-omni-system --all
    kubectl get secrets --all-namespaces -o custom-columns=NAMESPACE:.metadata.namespace,NAME:.metadata.name,ANNOTATION:.metadata.annotations.cert-manager\.io/issuer-name | grep -E 'alloydbomni|dbs-al' | awk '{print $1 " " $2}' | xargs -n 2 kubectl delete secret -n
    kubectl delete crd -l alloydb-omni=true
    kubectl delete ns alloydb-omni-system

Cómo cambiar el tamaño de tu clúster de bases de datos basado en Kubernetes

Para cambiar el tamaño de la CPU, la memoria o el almacenamiento de tu clúster de base de datos basado en Kubernetes, actualiza el campo resources de los manifiestos que definen su pod. El operador de AlloyDB Omni aplica las nuevas especificaciones a tu pod de base de datos de inmediato.

Para obtener más información sobre la sintaxis del manifiesto del operador de AlloyDB Omni, consulta Crea un clúster de base de datos.

Se aplican las siguientes restricciones a la modificación de los recursos de un clúster de bases de datos en ejecución:

  • Solo puedes aumentar el tamaño de un disco si el storageClass especificado admite la expansión de volumen.
  • No puedes disminuir el tamaño de un disco.