Deploy API Manager or OAuth in Docker containers

This topic describes how to deploy API Manager or OAuth services in your API Gateway containers.

Tip   To deploy API Manager or OAuth services in a classic deployment (non-containerized), see the following:

Deploy API Manager

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

Step 1 – 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 in the API Manager User Guide.
  6. Note   The default API administrator user name and password set in Policy Studio are used only when creating the administrator account in Apache Cassandra. After the account has been created in Cassandra, you cannot change the credentials in Policy Studio. You must use API Manager to change the administrator credentials. You can also reset the administrator password by running the setup-apimanager script with the option --resetPassword inside the Admin Node Manager container. For details, see Reset the default API administrator password.
  7. Click Finish.
  8. 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.
  9. Select File > Export and select a package to export the configuration as a package (fed, pol, or env).

Step 2 – Deploy API Manager enabled API Gateway container

Follow the steps in Deploy API Gateway in Docker containers. 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:

Step 1 – 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 in the API Gateway OAuth User Guide.
  6. Click Finish.
  7. Select File > Export and select a package to export the configuration as a package (fed, pol, or env).
Note   When you configure OAuth in Policy Studio, this does not register the sample client applications in the Client Application Registry. You must import the sample client applications manually, as detailed in Import sample client applications in the API Gateway OAuth User Guide.

Step 2 – Deploy OAuth-enabled API Gateway container

Follow the steps in Deploy API Gateway in Docker containers. 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.

Related Links