Usa el panel del Sincronizador de configuración

En esta página, se explica cómo usar el panel del Sincronizador de configuración.

Este panel te proporciona una descripción general completa de los paquetes que administra el Sincronizador de configuración y el estado de los recursos en esos paquetes.

Término clave: Un paquete es un conjunto de manifiestos de recursos de Kubernetes que se administran en conjunto en una fuente de información y que el Sincronizador de configuración sincroniza con un clúster. Cada paquete se define con un objeto RootSync o RepoSync en el clúster. Para obtener más información sobre estos objetos, consulta Arquitectura de Config Sync. Puedes tener varios paquetes por clúster, por ejemplo, de diferentes fuentes.

Antes de comenzar

Permisos de IAM

Para acceder al panel de Sincronizador de configuración, se requieren los siguientes roles de IAM en el proyecto:

• roles/container.clusterViewer
• roles/gkehub.viewer

Control de acceso basado en roles

El usuario también necesita los permisos de Kubernetes pertinentes en cada clúster. Si no quieres otorgarles a los usuarios permisos extensos, como los del administrador del clúster, puedes crear un rol de RBAC personalizado que incluya los permisos mínimos necesarios para usar el panel de Sincronizador de configuración.

El permiso config-sync-dashboard-reader ClusterRole otorga al usuario permisos get y list sobre los recursos que necesita el panel.

1. Para crear el ClusterRole de config-sync-dashboard-reader y aplicarlo al clúster, ejecuta el siguiente comando:

   cat <<EOF > config-sync-dashboard-reader.yaml
   kind: ClusterRole
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     name: config-sync-dashboard-reader
   rules:
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
     verbs: ["get", "list"]
   - apiGroups: ["configmanagement.gke.io"]
     resources: ["configmanagements"]
     verbs: ["get", "list"]
   - apiGroups: ["configsync.gke.io"]
     resources: ["rootsyncs", "reposyncs"]
     verbs: ["get", "list"]
   - apiGroups: ["kpt.dev"]
     resources: ["resourcegroups"]
     verbs: ["get", "list"]
   - apiGroups: ["apps"]
     resources: ["deployments"]
     verbs: ["get", "list"]
   - apiGroups: [""]
     resources: ["pods", "services"]
     verbs: ["get", "list"]
   - apiGroups: ["anthos.cloud.google.com"]
     resources: ["canonicalservices"]
     verbs: ["get", "list"]
   - apiGroups: ["networking.istio.io"]
     resources: ["virtualservices"]
     verbs: ["get", "list"]
   
   EOF
   kubectl apply -f config-sync-dashboard-reader.yaml
   

2. Sigue las instrucciones para configurar el control de acceso basado en roles en los clústeres de Google Kubernetes Engine para configurar el ClusterRoleBinding.

Accede al panel

1. En la Google Cloud consola, ve a la página Config en la sección Features.

   Ir a Configuración

2. Selecciona el proyecto que deseas ver.

Visualiza el panel

En la pestaña Panel, se proporciona una descripción general del estado de tus instalaciones del Sincronizador de configuración:

• En Estado de conciliación, se muestra la cantidad de paquetes conciliados. Un paquete se concilia si se aplicó el estado que deseas, tal como se indica en los recursos del paquete.

  Tus paquetes pueden tener los siguientes estados de conciliación:

  • Actual: El estado real del paquete coincide con el estado que deseas. El proceso de conciliación se considera completo hasta que haya cambios en el estado que deseas o en el estado real.
  • En curso: El estado real del paquete aún no alcanzó el estado que deseas (como se indica en los recursos del paquete). Los paquetes recién creados suelen comenzar con este estado.
  • Falló: El proceso de conciliar el estado real con el estado que deseas encontró un error o realizó un progreso insuficiente.
  • Desconocido: El Sincronizador de configuración no pudo determinar el estado de reconciliación de un paquete.

• En Estado de sincronización, se muestra la cantidad de paquetes sincronizados. Un paquete se sincroniza cuando el último estado observado del paquete en la fuente (por ejemplo, un repositorio de Git) se refleja en el clúster.

  Tus paquetes pueden tener los siguientes estados de sincronización:

  • Sincronizado: El paquete se sincronizó con un clúster.
  • Pendiente: El paquete está pendiente de sincronización.
  • Reconciling: Se está conciliando la Deployment que sincroniza un paquete.
  • Detenida: Se detuvo la Deployment que sincroniza un paquete.
  • Error: El paquete encontró un error durante la sincronización.
  • Desconocido: El Sincronizador de configuración no pudo determinar el estado de sincronización de un paquete.

• En Estado del Sincronizador de configuración, se muestra el estado de instalación del Sincronizador de configuración en tus clústeres.

  Tus clústeres pueden tener los siguientes estados relacionados con el Sincronizador de configuración:

  • Habilitado: Clústeres que tienen habilitado el Sincronizador de configuración.
  • No habilitado: Clústeres que no tienen habilitado el Sincronizador de configuración.
  • Pendiente: Clústeres que tienen habilitado el Sincronizador de configuración, pero están en proceso de cambio. Este estado suele ocurrir durante la configuración inicial o cuando se actualiza a una versión nueva.
  • Error: Clústeres que tienen habilitado el Sincronizador de configuración, pero hay un problema y el Sincronizador de configuración no funciona.
  • Desconocido: No se puede determinar el estado del Sincronizador de configuración.

En las tablas adicionales, se muestran los problemas agrupados por paquete y clúster, se proporcionan vínculos para instalar Sincronizador de configuración y ver la configuración, y se incluyen recursos para comenzar.

Cómo ver el estado del paquete

La pestaña Paquetes te permite ver detalles exhaustivos sobre paquetes y clústeres individuales. Usa esta pestaña para comprender mejor las posibles causas de los errores de sincronización y los recursos en mal estado.

Edita un paquete

También puedes usar la pestaña Packages para editar la configuración de tus paquetes.

Para editar un paquete, completa los siguientes pasos:

1. Junto al nombre del paquete que deseas editar, selecciona en la columna Editar paquete.
2. En la sección Detalles del paquete, en la lista desplegable Tipo de fuente, selecciona tu tipo de fuente.

3. En la sección Fuente, completa lo siguiente:

   • Para las fuentes alojadas en un repositorio de Git, ingresa los siguientes campos:

     1. Ingresa la URL del repositorio de Git que usas como fuente de información como la URL del repositorio.
     2. Opcional: Actualiza el campo Revisión para confirmar si no usas el HEAD predeterminado.
     3. Opcional: Actualiza el campo Ruta de acceso si no deseas sincronizar desde el repositorio raíz.
     4. Opcional: Actualiza el campo Rama si no usas la rama main predeterminada.

   • Para las fuentes alojadas en una imagen de OCI, ingresa los siguientes campos:

     1. Ingresa la URL de la imagen de OCI que usas como fuente de confianza como Imagen.
     2. Ingresa la ruta del directorio desde el que se realiza la sincronización en relación con el directorio raíz como el Directorio.

4. (Opcional): Expande la sección Configuración avanzada para completar lo siguiente:

   1. Selecciona un Tipo de autenticación:

      Nota: En el caso de OCI, solo puedes seleccionar Workload Identity para la autenticación.
      • Ninguna: No usa autenticación.
      • SSH: Usa un par de claves SSH.
      • Cookiefile: Usa un cookiefile.
      • Token: Usa un token.
      • Google Cloud Repository: Usa una cuenta de servicio de Google para acceder a un Cloud Source Repositories. Selecciona esta opción solo si la Workload Identity Federation for GKE no está habilitada en tu clúster.
      • Workload Identity: Usa una cuenta de servicio de Google para acceder a un repositorio de Cloud Source Repositories.

   2. Ingresa un número en segundos para establecer el Tiempo de espera de la sincronización, que determina cuánto tiempo espera el Sincronizador de configuración entre las sincronizaciones desde la fuente de información.

   3. Ingresa una URL de proxy de Git para el proxy HTTPS que se usará durante la comunicación con la fuente de verdad.

   4. Elige Hierarchy para cambiar el Formato de origen.

      En la mayoría de los casos, se recomienda el valor predeterminado No estructurado, ya que te permite organizar tu fuente de verdad como quieras.

5. Cuando termines de editar el paquete, haz clic en Guardar.

   Se te redireccionará a la página Packages del Sincronizador de configuración. Después de unos minutos, deberías ver Sincronizado en la columna Estado de sincronización del paquete que configuraste.

Ver configuración

En la pestaña Configuración, se muestra una lista de clústeres, junto con información sobre su configuración del Sincronizador de configuración y de la flota.

También puedes usar esta pestaña para actualizar el Sincronizador de configuración en un clúster:

• Junto al nombre del clúster que deseas actualizar, selecciona el menú contextual y, luego, Editar configuración.

Para obtener orientación sobre la configuración del Sincronizador de configuración, consulta Configura el Sincronizador de configuración.

¿Qué sigue?

• Obtén información para usar Google Cloud CLI para supervisar el Sincronizador de configuración.
• Obtén información para usar la herramienta de línea de comandos de nomos para supervisar el Sincronizador de configuración.
• Obtén más información para supervisar el Sincronizador de configuración con métricas.