Deploying Configuration

Contents

Overview
Creating a Deployment Archive in the Policy Studio
Deploying a Deployment Archive in the Policy Studio
Deploying a Factory Configuration in the Policy Studio
Deploying a Currently Loaded Configuration in the Policy Studio
Deployment Summary in the Policy Studio
Deploying an Archive in API Gateway Manager
Deploying on the Command Line

Overview

A deployment archive is a .fed file that contains API Gateway configuration. For example, this includes a Certificate Store, User Store, Core Configuration, External Connections and Listeners. Such a collection of configuration is also known as a configuration assembly. Using a deployment archive to deploy an assembly enables you to edit configuration offline, and then deploy elsewhere later on a specified process. For more details, see the section called “Creating a Deployment Archive in the Policy Studio”.

A configuration property is a name-value pair that identifies a specific configuration assembly. Specifying a property associates metadata with the corresponding configuration profiles in that assembly. For example, the Name property with a value of Default Factory Configuration associated with a default installation. Assigning properties to an configuration also enables you to edit configuration offline, and deploy later on a specified process.

You can use the Policy Studio to create deployment archives. You can also use the Policy Studio to deploy an existing deployment archive, factory configuration, or working configuration on selected API Gateway instances. You can also use the API Gateway Manager to deploy a deployment archive in your Web browser. Alternatively you can use the managedomain script to create and deploy deployment archives on the command line.

Creating a Deployment Archive in the Policy Studio

Currently Loaded Configuration

To create a deployment archive (.fed file) for a currently loaded API Gateway configuration, perform the following steps:

  1. In the main menu, select File -> Save Deployment Archive.

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

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

  4. Click OK.

  5. Enter a filename for the .fed file, and click Save.

API Gateway Group View

To create a deployment archive in the API Gateway Group view, perform the following steps:

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

  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.

To view and modify configuration properties in the API Gateway Group view, perform the following steps:

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

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

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

  4. Click Update Configuration Properties.

  5. Click OK.

Deploying a Deployment Archive in the Policy Studio

To deploy an existing deployment archive (.fed file) in the API Gateway Group 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 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 an existing archive.

  4. In the Location of Archive field, click Browse, and select the .fed file.

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

  6. When the archive has deployed, click Finish.

Deploying a Factory Configuration in the Policy Studio

To deploy a default factory configuration in the API Gateway Group 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 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).

Deploying a Currently Loaded Configuration in the Policy Studio

To deploy a currently loaded configuration in the Policy Studio, 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 list, and select the server instance(s) in the box below.

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

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

  5. Click Deploy.

Deployment Summary in the Policy Studio

When the Deployment Results screen is displayed, the deployment starts, 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.

Canceling 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 process. The corresponding Console Deployment Log is also available in the Console view.

Redeploying

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

Deploying an Archive in API Gateway Manager

You can use the API Gateway Manager in a Web browser to deploy an existing deployment archive to a group of API Gateways. Perform the following steps:

  1. In the Topology view, right-click the API Gateway, and select Deploy.
  2. Browse to the deployment archive to be deployed.
  3. Choose the Group and API Gateways to which you wish to deploy the archive.
  4. Select Deploy in the wizard, and the deployment archive is deployed to the selected API Gateways.

Deploying on the Command Line

You can create and deploy a deployment archive 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

Prev  Up  Next
  Home