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:
The recommended installation workflows are as follows:
Portal installation deploys the following services:
- CA API Developer Portal
- PostgreSQL Database
- Postfix Mail ServerA 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.
Configure the following to use
- Keys and CertificatesThe installation process creates keys and unsigned certificates that are used for testing only. Certificates must be created and signed for production.
- External DatabaseA PostgreSQL database is provided with API Portal for a test environment. For a production environment, configure an external database.
- Jarvis AnalyticsCA 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 ServerA mail server is required for sending notification emails from
API Portal is scalable to meet your business needs. For more information, see Scale API Portal.
Scale API Portal
You can upgrade from an existing instance running version of
Upgrade API Portal