Synchronize Services between Gateway Groups

Synchronizing particular service versions between gateway groups is helpful in different situations. For example:

1. When using gateway groups to separate environments, like test and production, you can synchronize a service version to production from test after running tests.
2. Otherwise, if you are using gateway groups to segment regions or teams, synchronizing a service can help distribute it across them.

note

Synchronizing keeps the service version the same between gateway groups, while publishing creates a new service version each time.

You can only synchronize the currently running service versions, not the older ones.

Prerequisites

1. Install API7 Enterprise and complete the Publish APIs by Service tutorial.
2. Create a new gateway group, name it Production Group, and configure the network. Production Group will be the API Gateway for your test environment.
3. Have at least one gateway instance in the Production Group.

Synchronize Service to Production Group

Dashboard

You can publish a service by either configuring upstream nodes or by using service discovery mechanisms.

Using Upstream Nodes

1. Select Services from the side navigation bar, then click version 1.0.0 under service httpbin API.
2. Click Sync to Other Gateway Group from the Actions list.
3. In the Gateway Group field, choose Production Group, and then click Next.
4. In the How to find the upstream field, choose Use Nodes.
5. From the Nodes table, edit the Host and Port fields, enter your backend node address in the production environment or the mock server address.
6. Click Sync.

Using Service Discovery

1. Select Services from the side navigation bar, then click version 1.0.0 under service httpbin API.
2. Click Sync to Other Gateway Group from the Actions list.
3. In the Gateway Group field, choose Production Group, and then click Next.
4. In the How to find the upstream field, choose Use Service Discovery.
5. In the Service Registry field, choose Registry for Test, as well as the Namespace and service name in the Registry.
6. Click Sync.

ADC

To sync the configuration to Production Group with ADC, run:

adc sync -f adc.yaml --gateway-group "Production Group"

Validate the APIs in Production Group

Send a request to validate the API:

# Replace with your production group address.
curl "http://127.0.0.1:9080/headers"

You should see the following response:

{
 "headers": {
   "Accept": "*/*",
   "Host": "httpbin.org",
   "User-Agent": "curl/7.74.0",
   "X-Amzn-Trace-Id": "Root=1-6650ab7e-32c90eba787abbeb4e3dbb0c",
   "X-Forwarded-Host": "127.0.0.1"
 }
}