Versions Compared

Old Version 6

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

compared with

New Version Current

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WINSTALLATION and version 24.0

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameapi_installation_deprecated
DisableCachingtrue
PageWithExcerptINTERNAL:_installation_excerpts

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 NameDescriptionDefault port
api-mgmt/gatewayThis 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/uiThis 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/keycloakThis 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/devportalThis 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
elasticseachThis container contains an official version of Elasticsearch. API Management stores all metrics information and configuration in Elasticsearch.
mysqlThis container contains an official version of MySQL. Keycloak uses MySQL to store users and configurations.
kibanaThis container contains an official version of Kibana. Kibana can be used to create advanced and detailed analyses on API Management Metrics
keycloak-gatekeeperThis 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

System Requirements

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...

  • 2GB 2 GB for Tomcat
  • 1GB 1 GB for the Gateway
  • 2GB 2 GB for Keycloak and MySQL
  • 2GB 2 GB 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.
    Info
    Multiexcerpt
    MultiExcerptNameelasticsearch_memory

    2 GB for Elasticsearch is the default value. Please refer to the official Elasticsearch documentation for more information on memory usage and how to determine the needs for your setup (see Install Elasticsearch with Docker > Notes for production use and defaults and Setting the heap size).


    You do not need to edit the docker-compose.yml to adjust this as we provide a variable in the .env file to configure this (see Installing API Management > Configure the Installation Settings).

    Prerequisites

    Please consider the following prerequisites regarding Scheer PAS API Management.

    Multiexcerpt include
    MultiExcerptNameprerequisites_docker
    PageWithExcerptINTERNAL:_installation_excerpts

    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:

    1. Download and Extract the Software
      API Management uses Docker to provide a simple setup which is easy to update and scalable if necessary.  Th
      Multiexcerpt include
      MultiExcerptNamedownload
      PageWithExcerptInstalling API Management
    2. Configure the Installation Settings
      Configure the installation settings in the Docker configuration file.
    3. 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.
      Multiexcerpt include
      MultiExcerptNamecertificate
      PageWithExcerptInstalling API Management
    4. Configure the 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.
      Multiexcerpt include
      MultiExcerptNamekeycloak
      PageWithExcerptInstalling API Management

      Before you can start API Management, you need to 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 Managementin the Docker configuration file.
    5. Start All Services
             To start API Management, you will have to start all Docker containers.
      For a description on how to start all services, refer to Setting up API Management.
    6. Login to API Management
      Finally you can log in to Scheer PAS API Management and test the connections.
      Further information about the default login credentials can be found on page Setting up API Management.
    Panel
    titleOn this Page:

    Table of Contents

    Panel
    titleRelated Pages:

    Children Display

    Panel
    titleRelated Documentation:

    Elasticsearch:

    Otp
    Floatingfalse

    Rp

    Children Display

    Rde