Install, Configure, and Upgrade

You can deploy, scale, and manage the Portal services by deploying aan in a Docker Swarm cluster. aan uses the placement constraint feature of Docker Swarm. Because API Portal is Docker native, you can install API Portal on a CentOS or RHEL host that is capable of running Docker.
apip42
You can deploy, scale, and manage the Portal services by deploying 
API Portal
 in a Docker Swarm cluster.
API Portal
 uses the placement constraint feature of Docker Swarm. Because API Portal is Docker native, you can install API Portal on a CentOS or RHEL host that is capable of running Docker.
 For more information about Docker Swarm, see the Docker documentation
This article provides introductory information about how to install, configure, and upgrade
API Portal
.
In this article:
2
Installation
The installation workflow is as follows: 
portal installation workflow
portal installation workflow
Services Installed
Portal supports installation with or without internet access. The installation for both methods deploys the following services:
  • CA API Developer Portal
  • CA Jarvis 
    An analytics engine that supports the real-time analytics data.
    API Portal
     uses CA Jarvis as the data store and as the analytics platform to store the log data. 
  • PostgreSQL Database
    API Portal
     stores all persistent data for the Portal in a database. PostgreSQL is provided as an out-of-the box database to allow customers to quickly get a demonstration environment running, however, it is NOT supported in production. For production purposes, you must use an external MySQL 5.5 or later database.
  • Postfix Mail Server
    A mail server is required for sending notification emails from Portal. CA provides a mail server in the deployment. You can use an external mail server instead of the internal mail server.
Production Configuration
You can configure the following options for 
API Portal
:
Upgrade API Portal
You can upgrade from an existing instance running version of 
API Portal
.
For more information about how to upgrade, see Upgrade API Developer Portal.