Install, Configure, and Upgrade

This article provides introductory information about how to install, configure, and upgrade
Layer7 API Developer Portal
(
API Portal
).
This article provides introductory information about how to install, configure, and upgrade
Layer7 API Developer Portal
(
API Portal
). The tasks in this section are performed by a Portal Admin.
You can deploy, scale, and manage Portal services in two ways:
  • By deploying
    API Portal
    in a
    Docker
    Swarm cluster, or
  • By configuring and deploying Portal in a
    Kubernetes
    cluster using a Portal helm chart.
In this article:
Installation
This topic contains information about doing fresh installs of
Layer7 API Developer Portal
. For upgrade instructions, see Upgrade API Developer Portal instead.
The recommended installation workflows are as follows:
Docker Swarm Installation
portal installation workflow
For more information, see Install Portal on Docker Swarm.
Kubernetes Installation (with Portal Helm Chart)
portal installation workflow
For more information, see Install Portal on Kubernetes.
Services Installed
Portal installation deploys the following services:
  • Layer7 API Developer Portal
  • Postfix Mail Server
    A mail server is required for sending notification emails from Portal. API Portal provides a mail server in the deployment. You can use an external mail server instead of the internal mail server.
  • Druid Analytics Engine
    An internal Druid cluster ingests analytics data from Kafka and stores it in MinIO for reporting and visualization.
Production Configuration
Configure the following to use
API Portal
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
    For a production environment, configure an external database.
  • (Optional) External Mail Server
    A mail server is required for sending notification emails from
    API Portal
    . API Portal 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.
High Availability for Analytics is supported only in Kubernetes and it is not supported in Docker Swarm.
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.