Uso de Config Sync para replicar datos de catálogo

Editar en línea

Utilice la utilidad API Connect Config Sync para replicar los datos del lado del consumidor desde un catálogo de origen en un clúster API Connect a un catálogo de destino en un clúster API Connect diferente, de modo que las llamadas a la API puedan ser atendidas por cualquiera de los clústeres API Connect indistintamente para permitir despliegues híbridos y escenarios de estilo de alta disponibilidad.

API Connect Config Sync (apic-configsync) se puede ejecutar como un binario independiente con un cronjob de Kubernetes, para facilitar la replicación unidireccional de los datos del lado del consumidor (organizaciones de consumidores, miembros, aplicaciones, suscripciones, credenciales) y Producto y API de un catálogo en un clúster API Connect de origen a un catálogo correspondiente en un clúster API Connect de destino separado.

La imagen siguiente muestra cómo puede utilizar Config Sync para replicar datos del lado del consumidor de un despliegue de origen en un despliegue de destino:


Replicación de datos con sincronización de configuración

La sincronización de configuración se puede ejecutar con la frecuencia que sea necesaria y detecta las diferencias entre los tipos de recursos replicados en los catálogos de origen y de destino para que sólo replique de forma eficiente los cambios nuevos que se han realizado en la instancia de origen.

Los cambios realizados en un catálogo de destino pueden sincronizarse con el de origen intercambiando la configuración, de modo que el catálogo de origen original sea el de destino designado y el de destino original sea el de origen designado. Este proceso se conoce como sincronización inversa.

Tal como se muestra en la imagen siguiente, Config Sync ayuda a habilitar un rango de topologías de API de nube híbrida como:
  • Instancias de recuperación tras desastre independientes
  • Escenarios híbridos de software y SaaS
  • Geo-réplica
  • Actualización de versión en paralelo

Escenarios en los que puede utilizar la sincronización de configuración

Requisitos

Para que API Connect Config Sync se ejecute correctamente, se deben cumplir los siguientes requisitos:

Configuración del clúster de destino
El clúster API Connect de destino debe estar configurado correctamente, incluyendo:
  • Configuración de la topología
  • Creación de una organización de proveedores
  • Creación de catálogos
Replicar API y productos

Si desactiva la sincronización de productos y API mediante la variable de entorno SyncProductsAndAPIs , deberá replicar manualmente las API y los productos desde el catálogo de origen al catálogo de destino, ya sea mediante procedimientos manuales o pipelines CI/CD. Para obtener más información sobre cómo desactivar la sincronización de API y Productos, consulte la SyncProductsAndAPIs sección

Nota: Si necesita utilizar la función de sincronización de productos y API, asegúrese de que tanto el clúster de origen como el de destino API Connect ejecutan la versión 10.0.8.3 o posterior.
Configuración del catálogo de destino
La configuración del catálogo de destino debe coincidir con la configuración del catálogo de origen, incluyendo:
  • Registros de usuario
  • Proveedores de OAuth
  • Perfiles de cliente TLS
  • Aprobaciones de ciclo de vida
  • Ciclo de vida de aplicaciones
  • Otros ajustes relevantes del catálogo

Si la sincronización de productos y APIs está activada, debe establecer la propiedad catalog_settings.config_sync_target_catalog en true en el catálogo de destino. Esto puede hacerse utilizando el kit de herramientas o la API REST.

Para actualizar la configuración del catálogo mediante el kit de herramientas, ejecute el siguiente comando:
./apic catalog-settings:update -s <server_url> -o <org_name> -c <catalog_name> <catalog_setting_file>
Por ejemplo:
./apic catalog-settings:update -s https://api.example.com -o test_org -c test_catalog catalog_setting_file.txt
El documento catalog_setting_file.txt debe contener lo siguiente:

  config_sync_target_catalog: true
Nota: Inicie sesión en target cluster y ejecute el comando allí, no en la fuente.
Registros de usuarios y proveedores de servicios de « OAuth »
  • Los registros de usuarios de onboarding compatibles deben configurarse en el catálogo de destino con el mismo nombre y tipo que en el catálogo de origen. Asegúrese de que el destino configurado debe ser el mismo que el origen.
  • Si esto no es posible, utilice la variable USER_REGISTRY_NAME_MAPPING.
  • Todos los proveedores de « OAuth » deben configurarse en el catálogo y los espacios de destino.
  • Todos los registros de usuarios de API deben estar configurados en el catálogo y los espacios de destino.
  • Todos los perfiles de cliente de « TLS » deben configurarse en el catálogo y los espacios de destino.
Conectividad y permisos
La utilidad Config Sync utiliza la API REST del proveedor API Connect, por lo que debe tener conectividad con los clústeres de origen y destino con suficientes permisos de usuario de la organización del proveedor.
Clave de metadatos reservada
La clave metadata.source_id está reservada a Config Sync
Correlación de recursos

Config Sync utiliza el campo metadata de un recurso para rastrear qué recursos del catálogo de origen se asignan a qué recursos del catálogo de destino. Además de utilizar el campo metadata , API Connect Config Sync también utiliza el campo name de algunos recursos para determinar una coincidencia. Esto suele hacerse para los recursos que no sincroniza la utilidad pero que son necesarios en el catálogo de destino para que la sincronización se realice correctamente. Algunos ejemplos de estos recursos son:

  • Registros de usuarios
  • Organizaciones de consumidores
  • Funciones
  • Productos publicados (donde se utilizan los campos name y version para la correspondencia de productos)

Al utilizar una combinación de los campos metadata y name , Config Sync puede asignar con precisión los recursos entre los catálogos de origen y destino, garantizando una sincronización correcta.

Seguimiento de las asignaciones de recursos

Para realizar un seguimiento de qué recursos del catálogo de origen se correlacionan con qué recursos del catálogo de destino, Config Sync utiliza el campo metadata de un recurso determinado. En concreto, cuando se crea un nuevo recurso en el catálogo de destino, el campo metadata de dicho recurso se configura para que contenga una clave denominada source_id con un valor igual al ID del recurso correspondiente en el catálogo de origen que se está sincronizando.

Este proceso permite a Config Sync mantener un registro de las relaciones entre los recursos de los catálogos de origen y de destino, lo que garantiza que los cambios se propaguen con precisión y que los recursos se correspondan correctamente entre los catálogos.

Nota: La primera vez que se ejecuta la sincronización de configuración, puede tardar más tiempo en completarse de lo que requieren las ejecuciones posteriores (en función del número de recursos que se deben sincronizar). La primera ejecución de la utilidad crea todos los recursos nuevos en el clúster de destino; las ejecuciones posteriores sólo realizan la sincronización de cualquier dato que se haya añadido, actualizado o eliminado desde la última ejecución de la utilidad.

Limitaciones

API Connect Config Sync tiene las limitaciones siguientes:

  • Config Sync no realiza una copia de seguridad de los datos; simplemente replica el contenido de un catálogo de origen en un catálogo de destino. Debes seguir haciendo copias de seguridad periódicas para garantizar la seguridad de tus datos.
  • Sólo se puede realizar una sincronización inversa si el clúster de origen original y el clúster de destino original se encuentran en el mismo nivel VRMVersion.Release.Milestone). Por ejemplo, ' API Connect 10.0.8.1 y ' API Connect 10.0.8.0 están en el mismo nivel VRM aunque estén en diferentes niveles de fix pack. No se da soporte a una sincronización inversa con una versión, release o hito diferente.
  • Los despliegues de origen y de destino funcionan independientemente entre sí:
    • La limitación de la tasa API en los Planes se contabiliza independientemente en el catálogo de origen y en el catálogo de destino.
    • Las señales OIDC no se replican. Los tokens OIDC generados en el clúster de origen no son válidos en el clúster de destino.
    • Los datos de análisis se rastrean de forma independiente en el clúster de origen y el clúster de destino. Los datos de análisis no se replican ni se agregan entre clústeres.
  • La sincronización de configuración funciona en un único par de catálogo de origen-destino a la vez.

    Si desea sincronizar varios pares de catálogo de origen-destino diferentes, cree un trabajo cron independiente para cada par.

Versiones soportadas de API Connect

La sincronización de configuración puede sincronizar recursos del lado del consumidor en distintas versiones de clústeres de API Connect . La versión del clúster de destino debe ser siempre mayor o igual que la versión del clúster de origen.

Informes de consumo
Draft comment: iainsoed@uk.ibm.com
do not copy to 10.0.5 nor 10.0.7, 10.0.8.1 only

El subsistema de análisis registra el número de recursos que se procesan durante una sincronización de configuración. En el panel de consumo de la interfaz de usuario de API Manager se puede consultar el número total de recursos que se han procesado para una sincronización de configuración, tanto a nivel de la organización del proveedor como del catálogo.

Para los usuarios con licencia por volumen de llamadas, la cantidad de datos que se sincroniza se convierte en llamadas API y se incluye en su licencia por volumen de llamadas.