Deployment Patterns for Developer Portal

Learn how to support various deployment patterns for Developer Portal.


This documentation applies to NGINX Management Suite API Connectivity Manager 1.2.0 and later.

Overview

The Developer Portal application is a combination of a portal application (Developer Portal UI) and a backend API service (Developer Portal API service) to support the appilcation.

The following deployment patterns are supported:

  • Developer Portal UI and API service deployed on a single host (default).
  • Load-balanced backend API using multiple IP addresses. Developer Portal UI and API service deployed on different hosts.
  • Load-balanced backend API using a single hostname. Developer Portal UI and API service deployed on different hosts using a single hostname and frontend by a load balancer.

Before You Begin

Complete the following prerequisites before proceeding with this guide:

  • ACM is installed, licensed, and running.
  • You have one or more Environments with a Developer Portal cluster.
  • You have verified that you can access the Developer Portal using the configured hostname.

How to Access the User Interface

This guide contains instructions for completing tasks by using the NGINX Management Suite API Connectivity Manager user interface (UI).

To access the UI, navigate to the FQDN for your NGINX Management Suite host and log in. Then, select “API Connectivity Manager” on the Launchpad menu.

Single Host Installation

With the localhost installation, which is the default setup, both the backend and UI Developer Portal binaries are installed on the same machine. The backend API service is on the localhost, port 8080, by default.

localinstall

Multi-Host Installation for High Availability

The Developer Portal backend API service can be scaled for high availability by installing the backend binaries on multiple hosts. The Developer Portal front-end load balances the requests between multiple backend services using an IP address or an internal DNS name.

multipleip

Configure Developer Portal Backend

When creating a Develoepr Portal cluster in an environment, you can set multiple serviceTargets to match any of the deployment patterns above.

  1. In the ACM user interface, go select Workspaces > Environments > <your environment>, where “your environment” is the Environment that contains the Developer Portal cluster.
  2. Select Edit Advanced Config from the Actions menu for the desired Developer Portal cluster.
  3. On the Backend tab, select the default backend service, then select Edit Backend from the Actions menu.
  4. Add/Update desired service target.