About this guide

This guide describes how to promote and deploy API Gateway configuration. This involves moving API Gateway configuration from one environment to another (for example, from development to testing to production), and configuring environment-specific values so that the configuration can be deployed in each environment.

It also describes how a team of policy developers can develop APIs and policies to be deployed as a single API Gateway configuration using a Source Code Management (SCM) system.

Note   For a recommended DevOps approach to zero downtime upgrade, see the API Gateway Upgrade Guide.

Who should read this guide

The intended audience for this guide is policy developers and system integrators who are responsible for promoting and deploying API Gateway configuration from a development environment to a production environment.

Before deploying API Gateway configuration in a production environment you should consult the API Gateway Administrator Guide for information on planning and managing an API Gateway system in production. You should also understand exactly what message filters are, and how they are chained together to create a message policy. These concepts are documented in detail in the API Gateway Policy Developer Guide.

Others who might find parts of this guide useful include network or systems administrators and other technical or business users.

How to use this guide

This guide should be used in conjunction with the other guides in the API Gateway documentation set.

Before you begin promoting and deploying API Gateway configuration, review this guide thoroughly. The following is a brief description of the contents of each chapter:

Introduction to API Gateway deployment and promotion – Describes promotion and deployment concepts, including API Gateway domains and configuration packages.

API Gateway deployment and promotion tasks – Describes the tasks involved in promoting API Gateway configuration, such as environmentalizing configuration, and deploying policy and environment packages.

Configure package properties – Describes how to configure package properties in Policy Studio and Configuration Studio.

Example: Promote from development to testing environment – Provides a detailed example of the steps involved in promoting API Gateway configuration from a development environment to a production environment.

Sample promotion and deployment scripts – Describes sample scripts that you can use to environmentalize configuration and promote configuration between environments.

Externalize API Gateway instance configuration – Describes how to externalize API Gateway instance configuration using environment variables in the envSettings.props file.

Introduction to API Gateway team development – Describes how policy developer teams can develop APIs and policies to be deployed as a single API Gateway configuration using a Source Code Management (SCM) system.

Team development best practices – Describes the best practices for team development.

Manage API Gateway project dependencies – Describes how to manage dependencies between team development projects.

Automate processes for continuous integration – Describes how to use command-line tools to automate processes for continuous integration.

Manage X.509 certificates and keys – Describes how to manage API Gateway certificates and keys.

Manage API Gateway users – Describes how to manage API Gateway users.

Related topics

Related documentation

Related Links