Arquitectura del Sincronizador de configuración

En esta página, se presenta la arquitectura del Sincronizador de configuración. Aprender sobre los componentes que crea el Sincronizador de configuración puede ayudarte a comprenderlo mejor y a depurar y corregir los problemas que encuentres.

En el siguiente diagrama, se muestra la arquitectura del Sincronizador de configuración y sus recursos relacionados en un clúster de Google Kubernetes Engine (GKE) edición Enterprise:

Diagrama que muestra la relación entre los objetos y los recursos de Sincronizador de configuración

En este diagrama, el usuario crea una fuente de información y instala el Sincronizador de configuración con el Administrador de funciones.

Existen varios pasos para instalar el Sincronizador de configuración, y cada uno de ellos implementa componentes adicionales en tu clúster:

  1. Cuando habilitas el Sincronizador de configuración en tu clúster, se agregan los siguientes componentes:

    • El operador de ConfigManagement en una implementación llamada config-management-operator
    • La definición de recurso personalizado (CRD) ConfigManagement y el objeto llamado config-management
    • El administrador de conciliadores en una implementación llamada reconciler-manager
    • El controlador de ResourceGroup en una implementación llamada resource-group-controller-manager
    • El recopilador de OpenTelemetry en una implementación llamada otel-collector
    • Opcional: El webhook de admisión de Sincronizador de configuración en una implementación llamada admission-webhook

    La mayoría de estos recursos y objetos se crean automáticamente cuando se instala el Sincronizador de configuración, y no es necesario que los modifiques.

  2. La creación de objetos RootSync y RepoSync agrega los siguientes componentes:

    • Para cada RootSync, un objeto Deployment de reconciliador llamado root-reconciler-ROOTSYNC_NAME
    • Para cada RepoSync, un objeto Deployment de reconciliador llamado ns-reconciler-REPOSYNC_NAMESPACE-REPOSYNC_NAME-REPOSYNC_NAME_LENGTH

Implementaciones, pods y contenedores del Sincronizador de configuración

En la siguiente tabla, se proporciona más información sobre la implementación, los pods y los contenedores del Sincronizador de configuración:

Nombre de la implementación Espacio de nombres de la implementación Descripción de la implementación Recuento de réplicas Expresión regular del nombre del pod Cantidad de contenedores Nombres de los contenedores
config-management-operator config-management-system El operador de ConfigManagement se ejecuta en todos los clústeres con el Sincronizador de configuración instalado. Supervisa el objeto ConfigManagement y administra los componentes del Sincronizador de configuración, como el Administrador de reconciliadores y el recopilador de OpenTelemetry. 1 config-management-operator-.* 1
  • manager
  • reconciler-manager config-management-system El Administrador de reconciliadores se ejecuta en todos los clústeres con el Sincronizador de configuración habilitado en el objeto ConfigManagement. Supervisa los objetos RootSync y RepoSync, y administra una implementación de conciliador para cada uno. 1 reconciler-manager-.* 2
  • reconciler-manager
  • otel-agent
  • root-reconciler config-management-system Se crea una implementación de reconciliador raíz para cada objeto RootSync. 1 root-reconciler-.* 3 - 51
  • reconciler
  • otel-agent
  • git-sync
  • helm-sync
  • oci-sync
  • gcenode-askpass-sidecar
  • hydration-controller
  • ns-reconciler config-management-system Se crea una implementación de un conciliador de espacios de nombres para cada objeto RepoSync. 1 ns-reconciler-.* 3 - 51
  • reconciler
  • otel-agent
  • git-sync
  • helm-sync
  • oci-sync
  • gcenode-askpass-sidecar
  • hydration-controller
  • otel-collector config-management-monitoring El recopilador de OpenTelemetry se ejecuta en todos los clústeres con el Sincronizador de configuración habilitado en el objeto ConfigManagement. Recopila métricas de los componentes del Sincronizador de configuración que se ejecutan en los espacios de nombres config-management-system y resource-group-system, y las exporta a Prometheus y Cloud Monitoring. 1 otel-collector-.* 1
  • otel-collector
  • resource-group-controller-manager resource-group-system El controlador de grupos de recursos se ejecuta en todos los clústeres con el Sincronizador de configuración habilitado en el objeto ConfigManagement. Supervisa los objetos ResourceGroup y los actualiza con el estado de conciliación actual de cada objeto en su inventario. Se crea un objeto ResourceGroup para cada objeto RootSync y RepoSync para inventariar la lista de objetos que aplica el agente de conciliación desde la fuente de la verdad. 1 resource-group-controller-manager-.* 2
  • reconciler-manager
  • otel-agent
  • admission-webhook config-management-system El webhook de admisión del Sincronizador de configuración se ejecuta en cada clúster con la prevención de desvíos habilitada en el objeto ConfigManagement. Supervisa las solicitudes a la API de Kubernetes y evita la modificación o eliminación de recursos administrados por el Sincronizador de configuración. El webhook de admisión del Sincronizador de configuración está inhabilitado de forma predeterminada. 2 admission-webhook-.* 1
  • admission-webhook
  • 1 Para obtener detalles sobre cuándo se crean estos contenedores, consulta Contenedores de Reconciler.

    Componentes clave

    En las siguientes secciones, se exploran los componentes importantes del Sincronizador de configuración con mayor detalle.

    Operador y objeto de ConfigManagement

    El operador de ConfigManagement supervisa el objeto ConfigManagement y crea y administra otros componentes necesarios para que funcione el Sincronizador de configuración:

    Accionamiento del operador

    Debido a que el operador de ConfigManagement instala algunos componentes que requieren permisos cluster-admin, el operador de ConfigManagement también requiere permisos cluster-admin.

    Administrador de reconciliadores y reconciliadores

    El Administrador de reconciliadores es responsable de crear y administrar los reconciliadores individuales que garantizan que la configuración de tu clúster permanezca sincronizada.

    El administrador de conciliadores crea un conciliador raíz para cada objeto RootSync y un conciliador de espacio de nombres para cada objeto RepoSync. El Sincronizador de configuración usa este diseño en lugar de compartir un solo reconciliador monolítico porque mejora la confiabilidad, ya que reduce los puntos únicos de fallo y permite que los reconciliadores individuales se escalen de forma independiente.

    Los reconciliadores de raíz y espacio de nombres recuperan automáticamente la configuración de tu fuente de verdad y la aplican para aplicar el estado que deseas dentro de tu clúster.

    En los siguientes diagramas, se muestra cómo el administrador de conciliadores controla el ciclo de vida de cada conciliador raíz y conciliador de espacio de nombres:

    Diagrama que muestra cómo el Administrador de reconciliadores controla el reconciliador raíz Diagrama que muestra cómo el Administrador de reconciliadores controla el conciliador de espacio de nombres

    Contenedores de Reconciler

    Los contenedores específicos que se implementan en los Pods del reconciliador dependen de las opciones de configuración que elijas. En la siguiente tabla, se explica con más detalle lo que hace cada uno de estos contenedores de reconciliador y la condición que hace que el Sincronizador de configuración los cree:

    Nombre del contenedor Descripción Afección
    reconciler Controla la sincronización y la corrección de la deriva. Siempre están habilitados.
    otel-agent Recibe métricas de los otros contenedores de reconciliador y las envía al recopilador de OpenTelemetry. Siempre están habilitados.
    git-sync Extrae los archivos de configuración de tu repositorio de Git a un directorio local que el contenedor del conciliador puede leer. Se habilita cuando spec.sourceType es git.
    helm-sync Extrae y renderiza gráficos de Helm de tu repositorio de gráficos a un directorio local que el contenedor del conciliador puede leer. Se habilita cuando spec.sourceType es helm.
    oci-sync Extrae imágenes de OCI que contienen tus parámetros de configuración de tu registro de contenedores a un directorio local que el contenedor del conciliador puede leer. Se habilita cuando spec.sourceType es oci.
    gcenode-askpass-sidecar Almacena en caché las credenciales de Git del servicio de metadatos de GKE para que las use el contenedor git-sync. Se habilita cuando spec.sourceType es git y spec.git.auth es gcenode o gcpserviceaccount.
    hydration-controller Controla la compilación de configuraciones de Kustomize en un directorio local que el contenedor del conciliador puede leer. Se habilita cuando la fuente incluye un archivo kustomize.yaml.

    Como se muestra en la tabla anterior, por lo general, puedes esperar un recuento de contenedores de tres a cinco en cada Pod de reconciliador. Los contenedores reconciler y otel-agent siempre están presentes. Especificar un tipo para tu fuente de información determina qué contenedor de sincronización se agrega. Además, se crean los contenedores hydration-controller y gcenode-askpass-sidecar si realizaste los cambios de configuración que se mencionan en la tabla.

    Controlador de ResourceGroup y objetos ResourceGroup

    Los reconciliadores de raíz y espacio de nombres crean un objeto de inventario ResourceGroup para cada objeto RootSync y RepoSync que configures. Cada objeto ResourceGroup contiene una lista de objetos sincronizados con el clúster desde la fuente de información por el agente de conciliación de ese objeto RootSync o RepoSync. Luego, el controlador de ResourceGroup supervisa todos los objetos del objeto ResourceGroup y actualiza el estado del objeto ResourceGroup con el estado de conciliación actual de los objetos sincronizados. Esto te permite comprobar el estado del objeto ResourceGroup para obtener una descripción general del estado de sincronización, en lugar de tener que consultar el estado de cada objeto individual por tu cuenta.

    Los objetos ResourceGroup tienen el mismo nombre y espacio de nombres que su objeto RootSync o RepoSync correspondiente. Por ejemplo, para el objeto RootSync con el nombre root-sync en el espacio de nombres config-management-system, el objeto ResourceGroup correspondiente también se llama root-sync en el espacio de nombres config-management-system.

    No crees ni modifiques objetos ResourceGroup, ya que esto puede interferir con el funcionamiento del Sincronizador de configuración.

    Webhook de admisión

    El webhook de admisión del Sincronizador de configuración se crea cuando habilitas la prevención de desvíos. La prevención de desvíos intercepta de forma proactiva las solicitudes de modificación para garantizar que se alineen con la fuente de información antes de permitir los cambios.

    Si no habilitas la prevención de desvíos, el Sincronizador de configuración seguirá usando un mecanismo de autorecuperación para revertir el desvío de configuración. Con la autorreparación, el Sincronizador de configuración supervisa de forma continua los objetos administrados y revierte automáticamente cualquier cambio que se desvíe del estado previsto.

    Objetos RootSync y RepoSync

    Los objetos RootSync configuran el Sincronizador de configuración para crear un conciliador raíz que supervise la fuente de información especificada y aplique objetos de esa fuente al clúster. De forma predeterminada, el conciliador raíz de cada objeto RootSync tiene permiso cluster-admin. Con este permiso predeterminado, los conciliadores raíz pueden sincronizar recursos con permiso de clúster y con permiso de espacio de nombres. Si es necesario, puedes cambiar estos permisos configurando los campos spec.override.roleRefs. Los objetos RootSync están diseñados para que los usen los administradores de clústeres.

    Los objetos RepoSync configuran el Sincronizador de configuración para crear un conciliador de espacio de nombres que supervise la fuente especificada y aplique objetos de esa fuente a un espacio de nombres específico en el clúster. Los reconciliadores de espacios de nombres pueden sincronizar cualquier recurso con alcance de espacio de nombres en ese espacio de nombres con permisos personalizados especificados por el usuario. Los objetos RepoSync están diseñados para que los usen los usuarios del espacio de nombres.

    Cómo el servicio de flota administra los objetos RootSync

    Cuando instalas el Sincronizador de configuración con la consola de Google Cloud, Google Cloud CLI, Config Connector o Terraform, el servicio de flota lo administra, según tus entradas a la API de Google Cloud.

    Cuando el servicio de Fleet administra tu instalación de Sincronizador de configuración, puedes hacer que también administre tu objeto RootSync inicial, llamado root-sync. Esto te permite iniciar GitOps en tu clúster sin necesidad de aplicar nada directamente al clúster de forma manual. Si decides no permitir que el servicio de Fleet administre tu objeto RootSync inicial, puedes aplicar los objetos RootSync y RepoSync que desees directamente al clúster.

    El objeto RootSync llamado root-sync se crea en función de las entradas que proporcionas a la API de Google Cloud, específicamente, la sección spec.configSync de la API de config-management apply. Debido a que esta API solo expone un subconjunto de los campos RootSync, esos campos se consideran administrados en root-sync, mientras que los otros campos se consideran no administrados. Los campos administrados solo se pueden editar con la API de Google Cloud. Los campos no administrados se pueden editar con kubectl o cualquier otro cliente de Kubernetes.

    Objetos RootSync y RepoSync adicionales

    Para crear objetos RootSync o RepoSync adicionales, puedes usar la herramienta de línea de comandos kubectl o cualquier otro cliente de Kubernetes. También puedes usar el objeto root-sync inicial para administrar objetos RootSync o RepoSync adicionales con GitOps. Para ello, agrega sus manifiestos YAML a la fuente de información desde la que se configuró root-sync para sincronizarse. No se puede usar este método para administrar la configuración del root-sync inicial, ya que el servicio de flota administra algunos de sus campos. Para administrar el objeto root-sync con GitOps, usa Config Connector o Terraform. Para obtener más información sobre cómo crear objetos RootSync y RepoSync adicionales, consulta Configura la sincronización desde más de una fuente de información.

    ¿Qué sigue?