This guide explains how to install and configure the Scheer PAS API Management. |
Have a look at the figure below to get a technical overview on the Docker setup of Scheer PAS API Management.
Container Name | Description | Default port |
---|---|---|
api-mgmt/gateway | This container contains the engine of 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 |
api-mgmt/devportal | This container contains the Developer Portal. Using the Developer Portal, you can give clients a consolidated access to the APIs they need in a separate view. It uses Keycloak to authenticate users, and accesses Elasticsearch via the API Management UI container. | 8447 |
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. | |
kibana | This container contains an official version of Kibana. Kibana can be used to create advanced and detailed analyses on API Management Metrics | |
keycloak-gatekeeper | This container contains an official version of Keycloak Gatekeeper. API Management uses this container to provide a proxy server in front of Kibana. This way, Kibana access can be granted or restricted for API Management users. | 8446 |
For Scheer PAS 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...
|
Please consider the following prerequisites regarding Scheer PAS API Management.
To install the Scheer PAS API Management, you need to got through the following steps: