Installing Arrangement Microservice in Docker
This section helps you to install the Arrangement Microservice in Docker.
Prerequisites
- Ensure to install Docker Engine in the deployment environment and turn on Linux containers in Docker.
Procedure:
- Copy the zip file into the installation directory.
- Unzip the ms-arrangement-package-docker-<release.xxx>.zip. The extracted package contains the configuration files for the docker and the respective bat and sh files.
- Depending on the data ingestion type, ensure that you modify the following:
- For Transact Ingestion, modify the IP where DES/Transact is running in the arrangement.yml from the extracted zip as mentioned below:
For Transact Ingestion, configure the Transact DES Setup in Feature - Arrangements → Ingestion - Arrangements → AMS Transact Ingestion → Configuration DES - AMS (Kafka - Docker/J2EE) & HMS RR.PARAM and ILP Configuration
- For Generic External Ingestion, modify the IP and Kafka where Account Aggregation Kafka is running in the arrangement.yml as mentioned below:
Ensure that the Account Aggregation Kafka setup is configured. For more information, refer to Deployment - Account Aggregation (Docker).
- For Event Processor External Ingestion, Change the IP and Kafka where Standalone Kafka is running in the arrangement.yml as mentioned below:
Ensure that the Kafka is running in some port in any system.
- For Transact Ingestion, modify the IP where DES/Transact is running in the arrangement.yml from the extracted zip as mentioned below:
Deployment of Arrangement Microservice in Docker
Follow the steps below to deploy the Arrangement Catalog in docker:
MySQL Database
- Unzip the ms-arrangement-package-docker-<release_number>.zip.
- The extracted package contains the configuration files for the docker and the respective bat and sh files.
- To get your Microservice up and running, execute the below command which creates an image and docker container for the image:
- For Windows – arrangement.bat up --build –d
- For Linux – arrangement.sh up --build –d
Configuring JOLT Spec
The sample JOLT spec files are available in the following path of the docker package. In the extracted folder, there will be a schemas folder and in the path schemas\avro, we can find the jolt specs.
On executing the last line in arrangement.bat the jolt specs will be automatically copied to your ingester container.
The format of API's URL is given below:
- Base Path
http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/
For Example: http://localhost:8300/ms-arrangement-api/api/v1.0.0/
- Resource path of the endpoint can be found in the APIs document. A sample endpoint of Arrangement is http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/parties/GB0010001-100100/bulkarrangements
Undeploying Microservices
To stop and remove the existing container, execute the following command from the location where the marketing catalog docker is started.
MySQL Database
- For Windows : arrangement.bat down
- For Linux : arrangement.sh down
Deployment of Arrangement Microservice in Docker
Follow the steps below to deploy the Arrangement Catalog in docker:
MSSQL Database
- Unzip the ms-arrangement-package-docker-<release_number>.zip.
- The extracted package contains the configuration files for the docker and the respective bat and sh files.
- To get your Microservice up and running, execute the below command which creates an image and docker container for the image:
- For Windows – arrangement-mssql.bat up --build -d
- For Linux – arrangement-mssql.sh up --build –d
Configuring JOLT Spec
The sample JOLT spec files are available in the following path of the docker package. In the extracted folder, there will be a schemas folder and in the path schemas\avro, we can find the jolt specs.
On executing the last line in arrangement.bat the jolt specs will be automatically copied to your ingester container.
The format of API's URL is given below:
- Base Path
http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/
For Example: http://localhost:8300/ms-arrangement-api/api/v1.0.0/
- Resource path of the endpoint can be found in the APIs document. A sample endpoint of the marketing catalog can be http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/parties/GB0010001-100100/bulkarrangements.
Undeploying Microservices
To stop and remove the existing container, execute the following command from the location where the marketing catalog docker is started.
MSSQL Database
- For Windows : arrangement-mssql.bat down
- For Linux : arrangement-mssql.sh down
Oracle Database
- Unzip the ms-arrangement-package-docker-<release_number>.zip.
- The extracted package contains the configuration files for the docker and the respective bat and sh files.
- Build docker image for oracle db by following the steps in Oracle Database Creation - Docker Image.
- Add the Database properties in arrangement-oracle.yml file. Host can be host.docker.internal or the host_Ip.
- Example – jdbc:oracle:thin:@host.docker.internal:51521/ORCLPDB1
- jdbc:oracle:thin:@//10.94.2.28:51521/ORCLPDB1
- To get your Microservice up and running, execute the below command which creates an image and docker container for the image:
- For Windows – arrangement-mssql.bat up --build -d
- For Linux – arrangement-mssql.sh up --build –d
or,
Configuring JOLT Spec
The sample JOLT spec files are available in the below path of the docker package. In the extracted folder, there will be a schemas folder and in the path schemas\avro, we can find the jolt specs.
On executing the last line in arrangement.bat the jolt specs will be automatically copied to your ingester container.
The format of API's URL is given below:
- Base Path
http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/
For Example: http://localhost:8300/ms-arrangement-api/api/v1.0.0/
- The resource path of the endpoint can be found in the swagger document.
- A sample endpoint of the marketing catalog can be http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/parties/GB0010001-100100/bulkarrangements.
Once the arrangement microservice is up and running in docker, check the APIs in the package by running the below command.
Use “docker ps –a” to check if the containers are running,
The format of API's URL is given below:
- Base Path
http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/
For Example: http://localhost:8300/ms-arrangement-api/api/v1.0.0/
- The resource path of the endpoint can be found in the swagger document.
- AA sample endpoint of the arrangement can be http://localhost:8300/ms-arrangement-api/api/v3.0.0/holdings/arrangements/.
Undeploying Microservices
To stop and remove the existing container, execute the following command from the location where the marketing catalog docker is started.
Oracle Database
- For Windows : arrangement-oracle.bat down
- For Linux : arrangement-oracle.sh down
PostgreSQL Database
- Unzip the ms-arrangement-package-docker-<release number>.zip.
- The extracted package contains the configuration files for the docker and the respective bat and sh files.
- To get your Microservice up and running, execute the below command which creates an image and docker container for the image:
- For Windows – arrangement-postgresql.bat up --build -d
- For Linux – arrangement-postgresql.sh up --build –d
Once the arrangement Microservice is up and running in docker, check the APIs in the package by running the below command.
Use “docker ps –a” to check if the containers are running,
The format of API's URL is given below:
- Base Path
http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/
For Example: http://localhost:8300/ms-arrangement-api/api/v1.0.0/
- The resource path of the endpoint can be found in the swagger document.
- AA sample endpoint of the arrangement can be http://localhost:8300/ms-arrangement-api/api/v3.0.0/holdings/arrangements/.
Undeploying Microservices
To stop and remove the existing container, execute the following command from the location where the marketing catalog docker is started.
PostgreSQLDatabase
- For Windows : arrangement-postgresql.bat down
- For Linux : arrangement-postgresql.sh down
In this topic