Skip to content

Latest commit

 

History

History
232 lines (169 loc) · 8.07 KB

custom-install-with-docker-compose.md

File metadata and controls

232 lines (169 loc) · 8.07 KB
Raw

Custom Install Gravitee API Management with Docker Compose

When you install Gravitee API Management (APIM) with Docker Compose, you can install custom plugins and control the location of the persistent data.

Before you begin

  • You must install Docker. For more information about installing Docker, go to Install Docker Engine.
  • If you are deploying the Enterprise Edition of Gravitee, ensure that you have your license key. For more information about license keys, see Gravitee Platform Pricing.

Installing Gravitee APIM

  1. Create the directory structure, and then download the docker compose file. Once you create the directory, verify that the directory has the following structure:

    {% code overflow="wrap" %}

    /gravitee
 ├── apim-gateway
 │    ├── logs
 │    └── plugins
 ├── apim-management-api
 │    ├── logs
 │    └── plugins
 ├── apim-management-ui
 │    └── logs
 ├── apim-portal-ui
 │    └── logs
 ├── elasticsearch
 │    └── data
 └── mongodb
     └── data

    {% endcode %}

  2. To ensure that the docker-compose-apim.yml uses the /graviteedirectory structure, follow the following sub-steps:

a. In a text editor, open docker-compose-apim.yml

b. Remove the following lines of code:

{% code overflow="wrap" %}

volumes:
  data-elasticsearch:
  data-mongo:

{% endcode %}

c. Change $services.mongodb.volumes to the following code:

{% code overflow="wrap" %}

volumes:
  - ./mongodb/data:/data/db
# Access the MongoDB container logs with: docker logs gio_apim_mongodb

{% endcode %}

d. Change $services.gateway.volumes to the following code:

{% code overflow="wrap" %}

volumes:
  - ./elasticsearch/data:/var/lib/elasticsearch/data
# Access the Elasticsearch container logs with: docker logs gio_apim_elasticsearch

{% endcode %}

e. Navigate to $services.gateway.environment, and then add the following lines of code:

{% code overflow="wrap" %}

volumes:
  - ./apim-gateway/logs:/opt/graviteeio-gateway/logs
  - ./apim-gateway/plugins:/opt/graviteeio-gateway/plugins-ext

{% endcode %}

f. Remove $services.management_api.links.

g. Change $services.management_ui.volumes to the following lines of code:

volumes:
  - ./apim-management-api/logs:/opt/graviteeio-management-api/logs
  - ./apim-management-api/plugins:/opt/graviteeio-management-api/plugins-ext

h. Add the following lines to $services.management_api.environment:

{% code overflow="wrap" %}

- gravitee_plugins_path_0=/opt/graviteeio-management-api/plugins
- gravitee_plugins_path_1=/opt/graviteeio-management-api/plugins-ext

{% endcode %}

i. Change $services.management_ui.volumesto the following lines of code:

volumes:
  - ./apim-management-ui/logs:/var/log/nginx

j. Change $services.portal_ui.volumes to the following lines of code:

volumes:
  - ./apim-portal-ui/logs:/var/log/nginx
  1. (Optional) If you are using the Enterprise Edition (EE) of Gravitee APIM, add your license key by following the following steps:

a. Copy your license key to /gravitee/license.key.

b. In a text editor, open the docker-compose-apim.yml file.

c. Navigate to $services.gateway.volumes, and then add the following line of code:

- ./license.key:/opt/graviteeio-gateway/license/license.key

d. Navigate to $services.management_api.volumes, and then add the following line of code:

- ./license.key:/opt/graviteeio-management-api/license/license.key
  1. Run docker composeusing the following command:
docker compose -f docker-compose-apim.yml up -d
  1. To open the Console and the Developer portal, complete the following steps:
  • To open the console, go to http://localhost:8084.
  • To open the Developer Portal, go to http://localhost:8085.

{% hint style="info" %}

  • The default username for the Console and the Developer Portal is admin.
  • The default password for the Developer Portal is admin. {% endhint %}

{% hint style="success" %} Congratulations! Now that APIM is up and running, check out the Quickstart Guide for your next steps. {% endhint %}

Enable Federation

Federation is a new capability that was released with Gravitee 4.4.

Federation is disabled by default and must be explicitly activated for it to work.

To enable federation, follow the first guide below to enable federation with Docker Compose.

If in addition you are running multiple replicas of APIM for high availability, you'll also need to ensure that cluster mode is set up.

Enable Federation with Docker Compose

To enable federation, define the following environment variable and set its value to true (default is false):

GRAVITEE_INTEGRATION_ENABLED = true

Set up cluster mode

For cases where APIM is running with high availability, you'll need to setup cluster mode.

The following parameters and values need to be added to the root of the gravitee.yaml configuration file:

GRAVITEE_CLUSTER_TYPE = hazelcast
GRAVITEE_CLUSTER_HAZELCAST_CONFIGPATH = ${gravitee.home}/config/hazelcast.xml
GRAVITEE_CACHE_TYPE = hazelcast
GRAVITEE_CACHE_HAZELCAST_CONFIGPATH = ${gravitee.home}/config/hazelcast.xml

In addition, you'll need to mount a volume with the hazelcast.xml configuration file. This is used to configure Hazelcast that will run as a library inside the APIM container.

An example hazelcast.xml configuration file will be included in the distribution, but you may need to change certain parts (those emphasized below):

<?xml version="1.0" encoding="UTF-8"?>
<hazelcast xmlns="http://www.hazelcast.com/schema/config"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.hazelcast.com/schema/config
          http://www.hazelcast.com/schema/config/hazelcast-config-5.3.xsd">
   <cluster-name>graviteeio-api-cluster</cluster-name>
   <properties>
       <property name="hazelcast.discovery.enabled">true</property>
       <property name="hazelcast.max.wait.seconds.before.join">3</property>
       <property name="hazelcast.member.list.publish.interval.seconds">5</property>
       <property name="hazelcast.socket.client.bind.any">false</property>
       <property name="hazelcast.logging.type">slf4j</property>
   </properties>


   <queue name="integration-cluster-command-*">
       <backup-count>0</backup-count>
       <async-backup-count>1</async-backup-count>
   </queue>


   <map name="integration-controller-primary-channel-candidate">
       <backup-count>0</backup-count>
       <async-backup-count>1</async-backup-count>
   </map>


   <cp-subsystem>
       <cp-member-count>0</cp-member-count>
   </cp-subsystem>


   <network>
       <!-- CUSTOMIZE THIS JOIN SECTION --> 
       <join>
            <auto-detection/>
            <multicast enabled="false"/>
            <tcp-ip enabled="true">
                <interface>127.0.0.1</interface>
            </tcp-ip>
       </join>
   </network>
</hazelcast>

You will also need to add two new plugins to APIM that aren’t included by default:

\