Install, Configure, and Upgrade

This article provides introductory information about how to install, configure, and upgrade aan.
This article provides introductory information about how to install, configure, and upgrade API Portal.
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.
In this article:
 
Installation
This topic contains information about doing fresh installs of 
 
. For upgrade instructions, see Upgrade API Developer Portal instead.
The recommended installation workflows are as follows: 
Docker Swarm Installation Workflow
portal installation workflow
Services Installed
Portal installation deploys the following services:
  • CA API Developer Portal
  • PostgreSQL Database
     
     
     stores all persistent data for the Portal in a database. PostgreSQL is provided as an out-of-the box database to enable customers to quickly get a demonstration environment running, however, it is NOT supported in production. See Production Configuration.
  • 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
Configure the following to use 
 
 in a production environment:
  • Keys and Certificates
     
    The installation process creates keys and unsigned certificates that are used for testing only. Certificates must be created and signed for production.
  • External Database
     
    A PostgreSQL database is provided with API Portal for a test environment. For a production environment, configure an external database.
  • Jarvis Analytics
     
    CA Jarvis is an analytics engine that supports the real-time analytics data. API Portal uses Jarvis as the data store and as the analytics platform to store the log data.
    Jarvis service has been externalized as of API Developer Portal 4.3. Any existing Jarvis data must be migrated before upgrading to version 4.3. See Configure External Jarvis Service.
  • (Optional) External Mail Server
     
    A mail server is required for sending notification emails from 
     
    . CA provides a mail server in the deployment, but you can use an external, corporate email server.
Scale API Portal
API Portal is scalable to meet your business needs. For more information, see Scale API Portal.
Upgrade API Portal
You can upgrade from an existing instance running version of 
 
.For more information about how to upgrade, see Upgrade API Developer Portal.