Running a Single API Gateway and an Elasticsearch Container

You can run a single webMethods API Gateway and an Elasticsearch container using Docker Compose. In this deployment scenario you can use the sample Docker Compose file apigw-elasticsearch-no-cluster.yml.

The following figure depicts an webMethods API Gateway container with an externalized Elasticsearch where Kibana is included in the webMethods API Gateway container.

API Gateway container with an externalized Elasticsearch

To deploy a single webMethods API Gateway and an Elasticsearch container

  1. Set the environment variables to define the image for the webMethods API Gateway container as follows:
    export APIGW_DOCKER_IMAGE_NAME=image name or filepath location of an existing image
    
    The composite file requires an webMethods API Gateway Docker image. You can create the referenced image through webMethods API Gateway scripting. The Docker Compose file references the Elasticsearch 8.2.3 image: https://www.docker.elastic.co/r/elasticsearch/elasticsearch:8.2.3.

    Specify the webMethods API Gateway image by changing the .env file. webMethods API Gateway uses the .env file when the working directory is .../samples/docker-compose, else you must specify the environment variables.

  2. Run the following command to start the webMethods API Gateway Docker container and the Elasticsearch container using the Docker Compose sample file:
    cd InstallDir/IntegrationServer/instances/default/packages/WmAPIGateway/resources/
    samples/docker-compose
    docker-compose -f apigw-elasticsearch-no-cluster.yml up

    In the Docker Compose sample file apigw-elasticsearch-no-cluster.yml ensure that you have specified the required information such as image name, name and port of the Elasticsearch host, server port, and UI port. This creates and starts the containers. Run the docker ps command to view the details of the containers created.

    To run it in the detached mode, append -d in the docker-compose command.

Note: You can stop the webMethods API Gateway Docker container and the Elasticsearch container using the Docker Compose sample file with the following command:
docker-compose -f apigw-elasticsearch-no-cluster.yml down