| This guide explains how to install and configure the Scheer PAS API Management. |
Overview on the Docker Setup of API Management
Have a look at the figure below to get a technical overview on the Docker setup of Scheer PAS API Management.
Overview on the Installation Containers
| Container Name | Description | Default port |
|---|---|---|
| api-mgmt/gateway | This container contains the engine of Scheer PAS API Management. It handles all incoming client requests, applies the policies and forwards the requests to the API endpoint. The gateway is powered by Eclipse Vert.x which can handle a lot of concurrency using a small number of kernel threads. Vert.x lets your app scale with minimal hardware. | 8444 |
| api-mgmt/ui | This container provides the UI to manage all your APIs and gateways. It also allows you to view corresponding metrics. The UI is powered by Apache Tomcat. | 8443 |
| api-mgmt/keycloak | This container contains the authentication provider Keycloak. Keycloak is used to authenticate users of the API Management UI and users of the Keycloak OAuth policy. Keycloak runs on JBoss WildFly. | 8445 |
| elasticseach | This container contains an official version of Elasticsearch. API Management stores all metrics information and configuration in Elasticsearch. | |
| mysql | This container contains an official version of MySQL. Keycloak uses MySQL to store users and configurations. |
System Requirements
For API Management, you have to consider that there are several components running on the same host (see Overview on the Installation Containers above). For a lean setup, you should have at least 8 GB of memory available on your API Management host.
Consider around...
- 2GB for Tomcat
- 1GB for the Gateway
- 2GB for Keycloak and MySQL
- 2GB for Elasticsearch
Prerequisites
API Management uses Docker to run the software.
- The Docker Community Editon (CE) is sufficient to run API Management. The provided Docker containers for API Management are Linux containers.
- As Docker host, Linux or Windows are supported.
- The Docker tool docker-compose must be installed.
Overview on the Installation Process
To install the Scheer PAS API Management, you need to got through the following steps:
- Download and Extract the Software
API Management uses Docker to provide a simple setup which is easy to update and scalable if necessary. Th - Configure the Installation Settings
- Prepare the Certificate
You need a certificate to establish secure connections between client and API Management as well as between the different components of API Management itself. - Start Authentication Service (Keycloak)
Keycloak is an open source identity and access management solution and is used to create and manage the users of API Management and OAuth2 secured APIs.
For a description on the setup of the Keycloak user and SSL, refer to Setting up API Management.
An overview of the values that have to be configured is shown on page Configuring API Management. - Configure Clients of the Authentication Service
You have to create the Keycloak administration user and change some of the Keycloak settings.
For a description on how to create the Keycloak administration user, refer to Setting up API Management.
An overview of the values that have to be configured is shown on page Configuring API Management. - Start All Services
To start API Management, you will have to start all containers.
For a description on how to start all services, refer to Setting up API Management.
- Login to API Management
Finally you can log in to Scheer PAS API Management.
Further information about the default login credentials can be found on page Setting up API Management.
Overview
Content Tools