Deploy API Manager or OAuth in Docker containers

Deploy API Manager or OAuth services in your API Gateway containers.

3 minute read

These steps are optional and only for users who wish to use API Manager or OAuth in a containerized environment.

Deploy API Manager

To deploy API Manager in a Docker container, follow these steps.

Configure API Manager in Policy Studio

Follow these steps:

  1. Open Policy Studio and open or create a new project.

  2. Select File > Configure API Manager.

  3. If you do not have any Cassandra hosts configured, you must add a Cassandra host before you can continue:

    • Enter a name for the Cassandra server (for example, container_cassandra).
    • Enter the name of the Cassandra container as the host name (for example, cassandra228).
    • Enter the port of the Cassandra container (for example, 9042).
  4. Click Next.

  5. Enter the appropriate API Manager settings. For full details, see Enable API Manager.

  6. Click Finish.

  7. Configure additional API Manager settings under Server Settings > API Manager. For example, you can specify custom policies that are called as traffic passes through API Manager.

  8. Select File > Export and select a package to export the configuration as a package (fed, pol, or env).

Deploy API Manager enabled API Gateway container

Follow the steps in Create and start API Gateway Docker container. When creating the API Gateway Docker image using build_gw_image.py, specify the deployment package you exported from Policy Studio. For an example, see Create an API Manager or OAuth enabled API Gateway image.

Deploy OAuth services

To deploy OAuth services in a Docker container, follow these steps.

Configure OAuth in Policy Studio

Follow these steps:

  1. Open Policy Studio and open or create a new project.
  2. Select File > Configure OAuth.
  3. If you do not have any Cassandra hosts configured, you must add a Cassandra host before you can continue:
    • Enter a name for the Cassandra server (for example, container_cassandra).
    • Enter the name of the Cassandra container as the host name (for example, cassandra228).
    • Enter the port of the Cassandra container (for example, 9042).
  4. Click Next.
  5. Select the OAuth deployment type. For full details, see Deploy OAuth configuration.
  6. Click Finish.
  7. Select File > Export and select a package to export the configuration as a package (fed, pol, or env).

Deploy OAuth-enabled API Gateway container

Follow the steps in in Create and start API Gateway Docker container. When creating the API Gateway Docker image using build_gw_image.py, specify the deployment package you exported from Policy Studio. For an example, see Create an API Manager or OAuth enabled API Gateway image.


Last modified December 16, 2019: fix links in container guide (45029751)