Usar el panel de control de Config Sync

En esta página se explica cómo usar el panel de control de Config Sync.

Este panel de control te ofrece una visión general de los paquetes que gestiona Config Sync y del estado de los recursos de estos paquetes.

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

Antes de empezar

Permisos de gestión de identidades y accesos

Para acceder al panel de control de Config Sync, se necesitan los siguientes roles de gestión de identidades y accesos 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 conceder a los usuarios permisos amplios, 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 control de Config Sync.

config-sync-dashboard-reader ClusterRole concede al usuario los permisos get y list en los recursos que necesita el panel de control.

1. Para crear el config-sync-dashboard-reader ClusterRole 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.

Acceder al panel de control

1. En la Google Cloud consola, ve a la página Configuración de la sección Funciones.

   Ve a Configuración

2. Selecciona el proyecto que quieras ver.

Consultar el panel de control

La pestaña Panel de control te ofrece un resumen del estado de tus instalaciones de Config Sync:

• Estado de conciliación: muestra cuántos paquetes se han conciliado. Un paquete se reconcilia si se ha alcanzado el estado que quieres, tal como se expresa en los recursos del paquete.

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

  • Actual: el estado real del paquete coincide con el estado que quieres. El proceso de conciliación se considera completado hasta que se producen cambios en el estado que quieres o en el estado real.
  • En curso: el estado real del paquete aún no ha alcanzado el estado que quieres (expresado por los recursos del paquete). Los paquetes recién creados suelen tener este estado.
  • Error: se ha producido un error en el proceso de conciliación del estado real con el estado que quieres o no se ha avanzado lo suficiente.
  • Desconocido: Config Sync no ha podido determinar el estado de conciliación de un paquete.

• El estado de sincronización muestra cuántos paquetes se han sincronizado. Un paquete se sincroniza cuando el estado más reciente 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 ha sincronizado con un clúster.
  • Pendiente: el paquete está pendiente de sincronización.
  • Reconciliando: se está reconciliando la implementación que sincroniza un paquete.
  • Detenido: el Deployment que sincroniza un paquete está detenido.
  • Error: se ha producido un error en el paquete durante la sincronización.
  • Desconocido: Config Sync no ha podido determinar el estado de sincronización de un paquete.

• En Estado de Config Sync se muestra el estado de instalación de Config Sync en tus clústeres.

  Tus clústeres pueden tener los siguientes estados relacionados con Config Sync:

  • Habilitado: clústeres en los que Config Sync está habilitado.
  • No habilitado: clústeres que no tienen habilitado Config Sync.
  • Pendiente: clústeres que tienen habilitado Config Sync, pero que están experimentando cambios. Este estado suele producirse durante la configuración inicial o al actualizar a una versión nueva.
  • Error: clústeres en los que Config Sync está habilitado, pero hay un problema y Config Sync no funciona.
  • Desconocido: no se puede determinar el estado de Config Sync.

En otras tablas se muestran los problemas agrupados por paquete y clúster, se proporcionan enlaces para instalar Config Sync y ver los ajustes, así como recursos para empezar.

Ver el estado del paquete

La pestaña Paquetes te permite ver información detallada sobre paquetes y clústeres concretos. Usa esta pestaña para conocer mejor las posibles causas de los errores de sincronización y los recursos no saludables.

Editar un paquete

También puede usar la pestaña Paquetes para editar las configuraciones de sus paquetes.

Para editar un paquete, sigue estos pasos:

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

3. En la sección Origen, haz lo siguiente:

   • En el caso de las fuentes alojadas en un repositorio de Git, introduce los siguientes campos:

     1. Introduce la URL del repositorio de Git que estés usando como fuente de información principal en el campo URL del repositorio.
     2. Opcional: Actualiza el campo Revisión para comprobar si no estás usando el valor predeterminado HEAD.
     3. Opcional: Actualiza el campo Ruta si no quieres sincronizar desde el repositorio raíz.
     4. Opcional: Actualiza el campo Rama si no usas la rama main predeterminada.

   • En el caso de las fuentes alojadas en una imagen de OCI, introduce los siguientes campos:

     1. Introduce la URL de la imagen OCI que estés usando como fuente de información principal en el campo Imagen.
     2. Introduce la ruta del directorio desde el que se va a sincronizar, relativa al directorio raíz, en el campo Directorio.

4. (Opcional): Despliega 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 se usa ninguna autenticación.
      • SSH usa un par de claves SSH.
      • Cookiefile: usa un cookiefile.
      • Token: usa un token.
      • Repositorio de Google Cloud: usa una cuenta de servicio de Google para acceder a un repositorio de Cloud Source Repositories. Selecciona esta opción solo si la federación de identidades de carga de trabajo para 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. Introduce un número en segundos para definir el Tiempo de espera de sincronización, que determina cuánto tiempo espera Config Sync entre sincronizaciones desde la fuente de información veraz.

   3. Introduce una URL de proxy de Git para el proxy HTTPS que se usará al comunicarse con la fuente de información principal.

   4. Elige Jerarquía para cambiar el Formato de origen.

      En la mayoría de los casos, se recomienda usar el valor predeterminado Sin estructura, ya que te permite organizar tu fuente de información como quieras.

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

   Se te redirigirá a la página Paquetes de Config Sync. Al cabo de unos minutos, debería aparecer el estado Sincronizado en la columna Estado de sincronización del paquete que haya configurado.

Ver configuración

En la pestaña Configuración se muestra una lista de clústeres, junto con información sobre sus ajustes de Config Sync y de flota.

También puede usar esta pestaña para actualizar Config Sync en un clúster:

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

Para obtener información sobre los ajustes de Config Sync, consulta Configurar Config Sync.

Siguientes pasos

• Consulta información sobre cómo usar la CLI de Google Cloud para monitorizar Config Sync.
• Consulta información sobre cómo usar la herramienta de línea de comandos nomos para monitorizar Config Sync.
• Consulta cómo monitorizar Config Sync con métricas.