Usa el panel del Sincronizador de configuración

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

En este panel, se proporciona una descripción general completa de los paquetes que administra el Sincronizador de configuración y el estado de los recursos en estos paquetes.

Antes de comenzar

Permisos de IAM

Para acceder al panel del 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 relevantes de Kubernetes en cada clúster. Si no deseas otorgar a los usuarios permisos amplios, como los del administrador del clúster, puedes crear una función de RBAC personalizada que incluya los permisos mínimos necesarios para usar el panel del Sincronizador de configuración.

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

  1. Para crear el ClusterRole 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 funciones en los clústeres de Google Kubernetes Engine (GKE) Enterprise a fin de configurar el ClusterRoleBinding.

Accede al panel

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

    Ir a Configuración

  2. Selecciona el proyecto que quieres 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 cuántos paquetes se conciliaron. Un paquete se concilia si el estado que deseas, como se expresa en los recursos del paquete, se materializa.

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

    • Current: 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 expresa en los recursos del paquete). Los paquetes recién creados suelen comenzar con este estado.
    • Con errores: El proceso de conciliar el estado real con el estado que deseas encontró un error o tuvo un progreso insuficiente.
    • Desconocido: el Sincronizador de configuración no pudo determinar el estado de conciliación de un paquete.
  • En Estado de sincronización, se muestra cuántos paquetes se sincronizaron. 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 está sincronizado con un clúster.
    • Pendiente: La sincronización del paquete está pendiente.
    • Conciliando: la Deployment que sincroniza un paquete se está conciliando.
    • Detenida: La Deployment que sincroniza un paquete se detiene.
    • 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 el siguiente estado relacionado 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 se están realizando cambios. Por lo general, este estado ocurre durante la primera configuración 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 el Sincronizador de configuración y ver la configuración, y los recursos para comenzar.

Ver el estado del paquete

La pestaña Paquetes te permite ver detalles detallados sobre paquetes y clústeres individuales. Utiliza 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 las configuraciones de tus paquetes.

Para editar un paquete, completa los siguientes pasos:

  1. Junto al nombre del paquete que deseas editar, selecciona en la columna Edit package.
  2. En la sección Detalles del paquete de 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 verificar si no usas el HEAD predeterminado.
      3. Opcional: Actualiza el campo Path si no deseas realizar la sincronización desde el repositorio raíz.
      4. Actualiza el campo Rama si no usas la rama main predeterminada (opcional).
    • Para las fuentes alojadas en una imagen OCI, ingresa los siguientes campos:

      1. Ingresa la URL de la imagen de OCI que usas como fuente de información como la imagen.
      2. Ingresa la ruta de acceso del directorio desde el que deseas sincronizar, en relación con el directorio raíz, como Directory.
  4. (Opcional): Expande la sección Configuración avanzada para completar las siguientes acciones:

    1. Selecciona un tipo de 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 Workload Identity no está habilitado en el 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 configurar el tiempo de espera de la sincronización, que determina cuánto tiempo espera el Sincronizador de configuración entre la sincronización de la fuente de información.

    3. Ingresa una URL de proxy de Git para que el proxy HTTPS se use cuando se comunique con la fuente de información.

    4. Elige Jerarquía 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 información de la manera que desees.

  5. Cuando termines de editar tu paquete, haz clic en Save.

    Se te redireccionará a la página Paquetes del Sincronizador de configuración. Después de unos minutos, deberías ver Synced 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 la configuración del Sincronizador de configuración y la configuración 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, selecciona Edit Config.

Para obtener orientación sobre los parámetros de configuración del Sincronizador de configuración, consulta Configura el Sincronizador de configuración.

¿Qué sigue?