Introducción a la solución de problemas

Si tienes dificultades con el Sincronizador de configuración, en esta página, se presentan algunas herramientas y procedimientos comunes que pueden ayudarte a identificar y resolver los problemas que experimentas.

Actualizar a una versión compatible

Considera actualizar el Sincronizador de configuración a una versión compatible. La actualización suele resolver problemas comunes y te brinda acceso a las funciones más actuales. Para asegurarte de utilizar siempre una versión compatible, puedes habilitar la actualización automática (Versión preliminar).

Usa la herramienta de línea de comandos de nomos

La herramienta de línea de comandos de nomos proporciona estadísticas esenciales sobre la configuración del Sincronizador de configuración. Los comandos que se describen en las siguientes secciones son particularmente útiles para determinar el origen del problema o cuando debes trabajar con la Atención al cliente de Cloud.

Consulta el estado del Sincronizador de configuración

El comando nomos status te proporciona datos y errores agregados para ayudarte a comprender qué sucede con la instalación del Sincronizador de configuración. La siguiente información está disponible con nomos status:

  • Estado de la instalación por clúster
  • Errores de sincronización (lectura de Git y conciliación de los cambios)

Crea un informe de errores

Si tienes un problema con el Sincronizador de configuración que requiere ayuda de Atención al cliente de Cloud, puedes proporcionarle información valiosa de depuración mediante el comando nomos bugreport.

Este comando genera un archivo ZIP con marca de tiempo que contiene información sobre el conjunto de clústeres de Kubernetes en tu contexto kubectl. El archivo contiene registros de los pods del Sincronizador de configuración. No contiene información de los recursos sincronizados con el Sincronizador de configuración.

Cómo ver el panel de descripción general

El panel del Sincronizador de configuración te proporciona una descripción general del estado de los paquetes que administra el Sincronizador de configuración y el estado de los recursos en estos paquetes. Explorar este panel puede ayudarte a obtener una descripción general rápida del estado de la instalación del Sincronizador de configuración y descubrir cualquier paquete que tenga problemas.

  • Para acceder al panel, en la consola de Google Cloud, ve a la página Configuración en la sección Funciones:

    Ir a Configuración

Usa la supervisión y el análisis de registros

Supervisar el Sincronizador de configuración y explorar sus registros puede ayudarte a determinar la fuente de los errores y a comprender mejor cualquier comportamiento inesperado.

Comprende las métricas del Sincronizador de configuración

Usa las métricas del Sincronizador de configuración para obtener visibilidad del estado del Sincronizador de configuración.

Supervisa objetos RootSync y RepoSync

Cuando instalas el Sincronizador de configuración con la consola de Google Cloud o Google Cloud CLI, el Sincronizador de configuración crea automáticamente un objeto RootSync. Cuando configuras la sincronización desde varios repositorios, puedes crear objetos RepoSync que contengan información de configuración sobre los repositorios de espacios de nombres.

La supervisión de estos objetos puede revelar información valiosa sobre el estado del Sincronizador de configuración. Para obtener más información, consulta Supervisa los objetos RepoSync y RootSync.

Usar indicadores de nivel de servicio (SLI)

Para recibir notificaciones cuando el Sincronizador de configuración no funciona según lo previsto, usa los SLI del Sincronizador de configuración.

Registros de consultas

Puedes usar el Explorador de registros para recuperar, ver y analizar datos de registro del Sincronizador de configuración. Estos registros pueden contener datos históricos valiosos que nomos bugreport no captura cuando se reinician el operador o los Pods del conciliador. Para ver ejemplos de consultas que pueden ayudarte a diagnosticar el problema, revisa los registros del Sincronizador de configuración de consultas.

Examina recursos con la herramienta de línea de comandos de kubectl

El Sincronizador de configuración se compone de varios recursos personalizados que puedes consultar mediante los comandos kubectl. Estos comandos te ayudan a comprender el estado de cada uno de los objetos del Sincronizador de configuración.

Debes conocer la siguiente información sobre los recursos de Kubernetes que administra el Sincronizador de configuración:

  • config-management-system es el espacio de nombres que usamos para ejecutar todos los componentes principales del sistema del Sincronizador de configuración.
  • configmanagement.gke.io y configsync.gke.io son los grupos de API que usamos para todos los recursos personalizados.

Ejemplos

En las siguientes secciones, se muestra cómo puedes usar los comandos de kubectl para examinar el Sincronizador de configuración.

Enumera recursos personalizados

  • Para obtener una lista completa de los recursos personalizados, ejecuta el siguiente comando:

    kubectl api-resources | grep -E "configmanagement.gke.io|configsync.gke.io"

  • Los recursos personalizados individuales se pueden consumir si ejecutas el siguiente comando:

    kubectl get RESOURCE -o yaml.

    Reemplaza RESOURCE por el nombre del recurso que deseas consultar.

    Por ejemplo, el resultado del siguiente comando te permite verificar el estado de un objeto RootSync:

    kubectl get rootsync -n config-management-system -o yaml

Comprueba la anotación de token de un objeto

Es posible que desees saber cuándo el Sincronizador de configuración actualizó por última vez un objeto de Kubernetes administrado. Cada objeto administrado tiene anotaciones con el hash de la confirmación de Git cuando se modificó por última vez y con la ruta de acceso a la configuración que contenía la modificación.

Por ejemplo, para obtener la anotación de un ClusterRoleBinding llamada namespace-readers, ejecuta el siguiente comando:

kubectl get clusterrolebinding namespace-readers

El resultado es similar al siguiente:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  annotations:
    configmanagement.gke.io/source-path: cluster/namespace-reader-clusterrolebinding.yaml
    configmanagement.gke.io/token: bbb6a1e2f3db692b17201da028daff0d38797771
  name: namespace-readers
...

Para obtener más información, consulta Etiquetas y anotaciones.

Consulta la documentación adicional sobre la solución de problemas

Si los problemas persisten, los siguientes recursos podrían resultarte útiles:

  • Si recibiste un mensaje de error, consulta la página de referencia de errores para obtener consejos sobre cómo resolverlo.

  • Comprueba si el problema que tienes se debe a un problema conocido.

  • Si tienes problemas con un área específica, una de las guías de solución de problemas objetivo que se enumeran en la sección Cómo solucionar problemas por tipo de problema del índice podría ayudarte.

¿Qué sigue?