Configuring the gateway-peering manager

The gateway-peering manager defines which gateway-peering instances that the cluster of API gateway services uses.

About this task

When the API Connect gateway service is not in V5 compatible mode, you can use the default gateway-peering manager. By default, the default gateway-peering manager is not enabled.

The gateway-peering manager sets the gateway-peering instances to use for the following purposes.
  • The gateway-peering instance for the API Connect gateway service that synchronizes distributed state and configuration data across peer group members.
  • The gateway-peering instance for API rate limits that manages count limits, rate limits, and burst limits. The API collection, API plans, API operation rate limits, and rate limit assembly actions define these limits.
  • The gateway-peering instance for API subscriptions that manages subscribers.
  • The gateway-peering instance for the GatewayScript rate limits that manages keys for rate thresholds, counters, and concurrent transactions. These keys are defined with APIs in the GatewayScript ratelimit module and are used in GatewayScript assembly action calls.
  • The gateway-peering instance for the API probe that manages the captured transaction data for the API gateway. This property is deprecated.
With the gateway-peering manager, you cannot configure the instances for OAuth token data or the instance for probe transaction data.
Internal token store for the API security token manager
This gateway-peering instance manages and stores internal OAuth token data across peer group members. This instance is part of the configuration for the API security token manager. For more information, see Defining the API security token manager.
External token store for the API security token manager
This gateway-peering instance stores and manages the responses from external OAuth token management services across a peer group. The external store includes OAuth token data for local tokens that an external token management service manages. This instance is part of the configuration for the API security token manager. For more information, see Defining the API security token manager.
API probe
This gateway-peering instance synchronizes distributed API probe data across peer group members. This instance is part of the configuration for probe settings. For more information, see Configuring probe settings.

Procedure

  1. In the search field, enter peering.
  2. From the search results, click Gateway-peering manager.
  3. Define the basic properties: Administrative state and descriptive summary.
  4. From the API Connect gateway service list, select the gateway-peering instance for the API Connect gateway service.
  5. From the API rate limits list, select the gateway-peering instance for API rate limits.
  6. From the API subscriber list, select the gateway-peering instance for API subscriptions.
  7. From the GatewayScript ratelimit module keys list, select the gateway-peering instance for GatewayScript rate limits.
  8. From the API probe (deprecated) list, select the gateway-peering instance for the API probe.
  9. Click Apply to save changes to the running configuration.
  10. Click Save to save changes to the persisted configuration.