Manage API Gateway deployments

Overview

You can use Policy Studio to deploy configuration to API Gateway instances running in groups in an API Gateway domain. Policy Studio enables you to edit API Gateway configuration and then deploy it to the server instance, where it can be reloaded later. You can deploy modified configuration to multiple API Gateway instances in a group managed by an Admin Node Manager.

The API Gateway Manager web console also enables you to deploy configuration packages to API Gateway instances running in groups in a domain, to create groups and API Gateway instances, and to manage administrator users. In this way, Policy Studio and the API Gateway Manager enable policy developers and administrators to centrally manage the policies that are enforced at all nodes throughout the network.

In addition, Policy Studio enables you to compare and merge differences between versions of the same policy. Policies can be merged, and deployed to any running instance that is managed by Policy Studio. One of the most powerful uses of this centralized management capability is in transitioning from a staging environment to a production environment. For example, policies can be developed and tested on the staging environment, and when ready, they can be deployed to all instances deployed in the production environment.

Create a project in Policy Studio

Note   Before starting Policy Studio, you should first ensure that the Admin Node Manager and the server instance that you wish to deploy to have been started.

To create a new Policy Studio project, select File > New Project, and follow the steps in the wizard. For more details, see Create a Policy Studio project.

Alternatively, if a project has already been created, select File > Open Project in the main menu, or click Open Project on the landing page. For more details, see Manage API Gateway connections.

Edit a project configuration in Policy Studio

When you create or open a Policy Studio project and make a server connection, this loads the project configuration and displays it in the following format:

ProjectName [ServerInstanceType]

For example:

MyDevProject [API Gateway]

When a project configuration is loaded, its services are displayed in the Policy Studio tree on the left. Expand one of the top-level nodes in the tree to display additional details (for example, APIs, Policies, Resources, or Environment Configuration).

When editing a project configuration, you can deploy updates using the Deploy button in the toolbar (alternatively, press F6). For more details, see Deploy API Gateway configuration.

Deploy to a server in Policy Studio

To deploy to a running API Gateway instance in a group, click Deploy in the toolbar, and follow the steps in the wizard. For more details, see Deploy API Gateway configuration.

Tip   You must connect to the Admin Node Manager server to deploy API Gateway configuration or manage multiple API Gateway instances in your network.

Manage deployments in API Gateway Manager

In the web-based API Gateway Manager tool, the TOPOLOGY section on the Dashboard tab enables you to create API Gateway groups and instances, and to deploy configuration packages to running servers in API Gateway groups.

For details on how to access the API Gateway Manager, see Start the API Gateway tools.

Compare and merge configurations in Policy Studio

You can compare and merge differences between the currently loaded API Gateway configuration with a configuration stored in a deployment package (.fed file). Click the Compare button on the Policy Studio toolbar to select a .fed file to compare the current configuration against. The results are displayed in the Compare/Merge tab.

For example, you can view the differences made to particular fields in an Authentication filter that occurs in both configurations. When a difference is located, you can merge the differences, and thereby update the fields in the Authentication filter in the current configuration with the field values for the same Authentication filter in the deployment package.

For more details, see Compare and merge API Gateway configurations.

Manage administrator users in API Gateway Manager

You can add new administrator users to enable role-based access to the API Gateway configuration managed by Policy Studio and API Gateway Manager. The default administrator user has access to all API Gateway features in Policy Studio and API Gateway Manager, and can view and modify all API Gateway configurations.

To add or remove administrator users, click the Settings > Admin Users tab in the API Gateway Manager. For more details, see Manage admin users.

For more details on role-based access, see the API Gateway Administrator Guide.

Configure policies in Policy Studio

You can use Policy Studio to manage the configuration of your policies, which can then be deployed to running instances of Axway API Gateways.

For details on configuring the full range of message filters (for example, for Authentication, Authorization, or Content Filtering), see the other sections in this guide.

Related Links