Deploy API Gateway configuration

Contents

Overview
Create a package in Policy Studio
Configure package properties in Policy Studio
Deploy packages in Policy Studio
Deploy a factory configuration in Policy Studio
Deploy currently loaded configuration in Policy Studio
Push configuration to a group in Policy Studio
View deployment results in Policy Studio
Deploy on the command line
Deploy packages in API Gateway Manager

Overview

You can edit API Gateway configuration offline, and then deploy later to a specified API Gateway instance using API Gateway configuration packages. A deployment package is a .fed file that contains all API Gateway configuration. This includes policies, listeners, external connections, users, certificates, and environment settings. A policy package is a .pol file that contains policies, listeners, external connections, and environment settings. While an environment package is an .env file that contains users, certificates, and environment settings. The content of the .fed file is equivalent to the combined contents of the .pol and .env files.

A package property is a name-value pair that applies to a specific configuration package (.fed, .pol, or .env). Specifying a property associates metadata with the configuration in that package. For example, the Name property with a value of Default Factory Configuration is associated with a default installation. For more details on configuration packages and properties, see the API Gateway Deployment and Promotion Guide.

You can use Policy Studio to create packages (.fed, .pol, or .env). You can also use Policy Studio to deploy an existing package or factory configuration on selected API Gateway instances, or to deploy a currently loaded configuration. You can use the API Gateway Manager console to deploy a package in a browser. Alternatively, you can use the managedomain script to create and deploy deployment packages (.fed files) on the command line.

Create a package in Policy Studio

You can create an API Gateway configuration package for a currently loaded configuration, or for a selected server instance in the Group / API Gateway topology view.

Currently loaded configuration

To create a package (.fed, .pol, or .env) for a currently loaded API Gateway configuration, perform the following steps:

  1. In the main menu, select File > Save followed by the appropriate option:

    • Deployment Package

    • Policy Package

    • Environment Package

  2. Enter a filename, and click Save.

Group / API Gateway view

To create a deployment package (.fed) in the API Gateway Group / API Gateway topology view, perform the following steps:

  1. Right-click a server instance in the tree, and select Save Deployment Package.

  2. Browse to a directory in the dialog.

  3. Click OK. The file is saved to the specified directory (for example,

    c:\temp\5c3b2a3c-23a5-4261-87cb-eca150f0a037.fed.

  4. Click OK.

Configure package properties in Policy Studio

You can view or modify API Gateway configuration package properties for a currently loaded configuration, or for a selected server instance in the Group / API Gateway topology view.

Currently loaded configuration

To view and modify configuration properties for a currently loaded API Gateway configuration, perform the following steps:

  1. In the Policy Studio tree, and select Package Properties > Policy or Environment.

  2. Enter values for the appropriate configuration properties (for example, Name, Description, or Version).

  3. If you wish to create any additional properties (for example, Department), click the green (+) button on the right, and enter a property value (for example, Engineering).

  4. If you wish to remove a property, click the red (x) button on the right of the property.

  5. Click Save on the top right of the screen.

Group / API Gateway view

To view and modify configuration properties for a selected server instance in the API Gateway Group / API Gateway topology view, perform the following steps:

  1. Right-click a server in the tree, and select View/Modify Properties.

  2. Select the Policy Properties or Environment Properties tab.

  3. Enter values for the appropriate configuration properties (Name, Description, and Version).

  4. If you wish to create any additional properties (for example, Department), click the green (+) button on the right, and enter a property value (for example, Engineering).

  5. If you wish to remove a property, click the red (x) button on the right of the property.

  6. Click Update Configuration Properties.

  7. Click OK.

For details on customizing the default package properties displayed, see the Topology Screen settings in the API Gateway User Guide.

Deploy packages in Policy Studio

You can use the Policy Studio to deploy configuration packages to selected API Gateway instances in the Group / API Gateway topology view.

Deploy a deployment package

To deploy an existing deployment package (.fed file) in the Group / API Gateway view, perform the following steps:

  1. Click the Deploy button in the toolbar.

  2. In the Select the servers(s) you wish to deploy to section, select a server group from the Group list, and select the server instance(s) in the box below.

  3. In the Select the configuration you wish to deploy section, select I wish to deploy configuration contained in a single Deployment Package.

  4. In the Deployment Package field, click Browse for .fed, and select the .fed file.

  5. Click Deploy to upload the package to the Admin Node Manager and deploy to the selected server(s).

  6. When the package has deployed, click Finish.

Deploy policy and environment packages

To deploy an existing policy package (.pol file) and environment package (.env file) in the Group / API Gateway view, perform the following steps:

  1. Click the Deploy button in the toolbar.

  2. In the Select the servers(s) you wish to deploy to section, select a server group from the Group list, and select the server instance(s) in the box below.

  3. In the Select the configuration you wish to deploy section, select I wish to deploy configuration contained in Policy Package and Environment Package.

  4. In the Policy Package field, click Browse for .pol, and select the .pol file.

  5. In the Environment Package field, click Browse for .env, and select the .env file.

  6. Click Deploy to upload these packages to the Admin Node Manager and deploy to the selected server(s).

  7. When the package has deployed, click Finish.

Deploy a factory configuration in Policy Studio

To deploy a default factory configuration in the Group / API Gateway view, perform the following steps:

  1. Click the Deploy button in the toolbar.

  2. In the Select the servers(s) you wish to deploy to section, select a server group from the Group list, and select the server instance(s) in the box below.

  3. In the Select the configuration you wish to deploy section, select I wish to deploy a factory configuration.

  4. Click Deploy to deploy the configuration to the selected server(s).

Deploy currently loaded configuration in Policy Studio

You can also deploy updates to a currently loaded configuration in Policy Studio when editing the configuration. To deploy a currently loaded configuration, perform the following steps:

  1. Click the Deploy button on the right in the toolbar.

  2. In the Select the servers(s) you wish to deploy to section, select a server group from the Group list, and select the server instance(s) in the box below.

  3. Click Deploy, and wait for the deployment to complete.

  4. Click Finish.

Push configuration to a group in Policy Studio

When there is more than one API Gateway instance in a group, and configuration becomes out of sync between instances, you can select which configuration to push to the group. Perform the following steps in Policy Studio:

  1. In the Group / API Gateway topology view, right-click the API Gateway instance configuration that you want to deploy to other instances in the group.

  2. Select Push this API Gateway's configuration to the group.

  3. In the wizard, select the API Gateway instances in the group that you wish to deploy to.

  4. Click Deploy to deploy to the selected instances in the group.

  5. Click Finish.

View deployment results in Policy Studio

When you click Deploy, the Deployment Results screen is displayed, and deployment to each server occurs sequentially. Feedback is provided using icons in the Task column, and text in the Status column. When the configuration has deployed, click Finish.

Cancel deployments

You can cancel deployments by clicking the Cancel button. Feedback is provided in the Status column. You cannot cancel a deployment when it has started. The wizard performs the cancellation at the end of the current deployment, with all remaining deployments being cancelled.

Deployment errors

Client-side and server-side errors can occur. Client-side errors are displayed in the System Trace in the Console view. If any server-side deployment errors occur during the deployment process, you can review these in the Deployment Error Log view. This is displayed at the bottom of the screen when you click Finish, and lists any errors that occur for each instance. The corresponding Console Deployment Log is also available in the Console view.

Redeploy

When you have deployed a configuration to one or more instances, you can click back through the wizard to change your selections and redeploy, without needing to exit and relaunch the wizard.

Deploy on the command line

You can create and deploy a deployment package (.fed) using the managedomain script in the following directory:

Windows INSTALL_DIR\Win32\bin
UNIX/Linux INSTALL_DIR/posix/bin


The deployment options in the managedomain script are as follows: 

18) Deploy to a group
  19) List deployment information
  20) Create deployment archive
  21) Download deployment archive
  22) Update deployment archive properties

Deploy packages in API Gateway Manager

You can also use the API Gateway Manager web console to deploy configuration packages to a group of API Gateway instances. This functionality is available on the default Dashboard tab. For more details, see Manage domain topology in API Gateway Manager.

Prev  Up  Next
  Home