Manage domain topology in API Gateway Manager

Contents

Overview
Manage API Gateway groups
Manage API Gateway instances
Deploy API Gateway configuration

Overview

This topic describes how to use the topology view in the web-based API Gateway Manager tool to manage an existing API Gateway domain. For example, you can perform tasks such as the following:

  • Create and delete API Gateway groups

  • Lock and unlock API Gateway groups

  • Create and delete API Gateway instances

  • Start and stop API Gateway instances

  • Create and edit API Gateway configuration tags

  • Deploy API Gateway configuration

[Note] Note

When using API Gateway Manager to manage an existing domain, you must ensure that the host was first registered in the domain using the managedomain script. For more details, see Configure an API Gateway domain.

The API Gateway Manager web console is available from the following URL: 

https://HOST:8090/

For more details, see Start the API Gateway tools.

Manage API Gateway groups

Create an API Gateway group
Delete an API Gateway group
Lock an API Gateway group

You can use the topology view in API Gateway Manager tool to create, delete, and lock API Gateway groups. The following example shows the options available at the group level:

Manage API Gateway groups in API Gateway Manager

Create an API Gateway group

To use the API Gateway Manager to create an API Gateway group, perform the following steps:

  1. Click the Menu button in the topology view on the Dashboard tab.

  2. Select Create New Group.

  3. Enter a group name (for example, Engineering).

  4. Click OK.

Delete an API Gateway group

To delete a group, perform the following steps:

  1. Ensure that the API Gateway instances in the group have been stopped.

  2. Hover over the group in the topology view, and click the edit button on the right.

  3. Select Delete Group.

  4. Click OK.

Lock an API Gateway group

To lock a group and prevent other users from editing its configuration, perform the following steps:

  1. Hover over the group in the topology view, and click the edit button on the right.

  2. Select Lock Group.

  3. Click OK.

Similarly to unlock an API Gateway group, select Unlock Group. Only admin users can unlock groups locked by other users.

[Tip] Tip
You can also use Policy Studio to delete or lock an API Gateway group. In the Policy Studio topology view, right-click the API Gateway group, and select Remove Group or Lock Group Access.

Manage API Gateway instances

Create API Gateway instances
Delete API Gateway instances
Start API Gateway instances
Stop API Gateway instances
Edit API Gateway tags

You can use the topology view in API Gateway Manager to create, delete, start, and stop API Gateway instances.

Create API Gateway instances

To use the API Gateway Manager to create an API Gateway instance, perform the following steps:

  1. Hover over the API Gateway group in the topology view, and click the edit button on the right.

  2. Select New API Gateway.

  3. Configure the following fields:

    • Name: API Gateway instance name (for example, Server2).

    • Management Port: Local management port (for example, 8086).

    • Services Port: External traffic port (for example, 8081).

    • Host: Host address (for example, 127.0.0.1).

    • Domain CA Passphrase: The passphrase for the domain SSL certificate authority.

  4. Click OK.

Delete API Gateway instances

To delete an API Gateway instance, perform the following steps:

  1. Ensure that the API Gateway instance has been stopped.

  2. Hover over the API Gateway instance in the topology view, and click the edit button on the right.

  3. Select Delete Server.

  4. Click OK.

[Tip] Tip
You can also use Policy Studio to create or delete an API Gateway instance. In the Policy Studio topology view, right-click the API Gateway group, and select Create API Gateway. Or right-click an existing API Gateway instance, and select Remove API Gateway.

Start API Gateway instances

To start an API Gateway instance, perform the following steps:

  1. Ensure that the API Gateway instance has been stopped.

  2. Hover over the API Gateway instance in the topology view, and click the edit button on the right.

  3. Select Start.

  4. Click OK.

The following example shows how to start a stopped API Gateway instance:

Start API Gateway instance in API Gateway Manager

Stop API Gateway instances

To stop an API Gateway instance, perform the following steps:

  1. Ensure that the API Gateway instance has been started.

  2. Hover over the API Gateway instance in the topology view, and click the edit button on the right.

  3. Select Stop.

  4. Click OK.

Edit API Gateway tags

API Gateway tags are name-value pairs that you can add to API Gateway instances, which then enable you to filter for API Gateway instances by tag in the API Gateway Manager Dashboard. To add an API Gateway tag, perform the following steps:

  1. Hover over the API Gateway instance in the topology view, and click the edit button on the right.

  2. In the dialog, click the green plus icon to add a tag.

  3. Enter a Tag name (for example, Department), and a Value (for example, Engineering).

  4. Click Apply.

To view the newly created tag in the in the API Gateway Manager topology view, click View as > Grid. To filter this view, enter a tag name or value in the Filter field.

Deploy API Gateway configuration

Deploy a deployment package
Deploy policy and environment packages

You can use the API Gateway Manager web console to deploy API Gateway configuration packages to a group of API Gateway instances. This includes the following configuration packages:

  • deployment package (.fed)

  • policy package (.pol)

  • environment package (.env)

For more details on configuration packages, see the API Gateway Promotion and Deployment Guide.

Deploy a deployment package

To deploy an existing deployment package to a group of API Gateways, perform the following steps:

  1. In the TOPOLOGY view, right-click the API Gateway group to which to deploy the package, and select Deploy Configuration.
  2. Select I wish to deploy configuration contained in a single Deployment Package.
  3. Click Browse for .fed, and select the .fed file in the dialog.
  4. Click Next.
  5. Select Deploy in the wizard, and the deployment package is deployed to the API Gateway group.
  6. Click Finish.

Deploy API Gateway configuration in API Gateway Manager

Deploy policy and environment packages

To deploy existing policy and environment packages to a group of API Gateways, perform the following steps:

  1. In the TOPOLOGY view, right-click the API Gateway group to which to deploy the packages, and select Deploy Configuration.
  2. Select I wish to deploy configuration contained in Policy Package and Environment Package.
  3. Click Browse for .pol, and select the .pol file in the dialog.
  4. Click Browse for .env, and select the .env file in the dialog.
  5. Click Next.
  6. Select Deploy in the wizard, and the packages are deployed to the API Gateway group.
  7. Click Finish.

[Tip] Tip
You can also use Policy Studio to deploy API Gateway configuration. For details, see Deploy API Gateway configuration.
Prev  Up  Next
  Home