Installing Marketing Catalog Microservice on Docker

This section helps you to install the Marketing Catalog Microservice on Docker (On-Premise).

Procedure:

1. Unzip the ms-marketingcatalog-package-docker-<release_number>.zip file.

   

2. Extracted package contains the configuration files for the docker and the respective bat and sh files.

   

Mongo DB

1. Follow these steps to enable authorization and authentication for Marketing Catalog micro service:
   1. To enable the internal authentication in addition to the API key, perform the JWT Authentication in ms-marketingcatalog-mongo.yml or ms-marketingcatalog-mongo-pit.yml
   2. To enable security policies and access rights to the APIs, p erform the XACML configurations in ms-marketingcatalog-mongo.yml and ms-marketingcatalog-mongo-pit.yml
   3. To enable third-party authentication, perform Keycloak configuration in ingester container of ms-marketingcatalog-mongo.yml or ms-marketingcatalog-mongo-pit.yml.

      Following is the list of containers with CPU limit:

      Containers	CPU Limit
      API	812 M
      Ingester	1 G

2. From the command prompt, go to the directory where the .bat and .sh files are available and execute the following command, which creates an image and docker container for that image.

   	MongoDB
   Windows	ms-marketingcatalog-mongo.bat/ms-marketingcatalog-mongo-pit.bat up --build -d
   Linux	ms-marketingcatalog-mongo.sh/ms-marketingcatalog-mongo-pit.sh up --build -d

   MongoDB Script	Description
   ms-marketingcatalog-mongo.bat / ms-marketingcatalog-mongo.sh	To deploy all the necessary components for a Microservice including streaming services will be deployed, in order to run the Microservice independently.
   ms-marketingcatalog-mongo-pit.bat / ms-marketingcatalog-mongo-pit.sh	To deploy only the components necessary for Microservice. Data Event Streaming (DES) is presumed to deployed and running already. The streaming services will not be deployed.

3. After the successful deployment database, collections and the reference data (master data) are loaded into the mongo database for Marketing Catalog Microservice.
4. Once the marketing catalog Microservice is up and running in docker, check the APIs in the package.

   Alternatively, the status of Microservice can be obtained through the Health Check -MC.

The format of API's URL is given below:

• Base Path

  http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/

  For Example: http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/

• Resource path of the endpoint can be found in the APIs document. A sample endpoint of Marketing Catalog is http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/products/marketingCatalogue.
5. For the BackOffice Ingestion, change it to respective IP address of HTTP_BASE_PATH URL provided in ms-marketingcatalog-mongo.yml/ms-marketingcatalog-mongo-pit.yml.For more configurations, refer to Ingestion.

PostgreSQL DB

1. Follow these steps to enable authorization and authentication for marketing catalog micro service:
   1. To enable the internal authentication in addition to the API key, perform the JWT Authentication in ms-marketingcatalog-postgresql.yml and ms-marketingcatalog-postgresql-pit.yml
   2. To enable security policies and access rights to the APIs, p erform the XACML configurations in ms-marketingcatalog-postgresql.yml and ms-marketingcatalog-postgresql-pit.yml
   3. To enable third-party authentication, perform Keycloak configuration in ingester container of ms-marketingcatalog-postgresql.yml or ms-marketingcatalog-postgresql-pit.yml.
2. From the command prompt, go to the directory where the .bat and .sh files are available and execute the following command, which creates an image and docker container for that image.

   	Postgresql
   Windows	ms-marketingcatalog-postgresql.bat/ms-marketingcatalog-postgresql-pit.bat up --build -d
   Linux	ms-marketingcatalog-postgresql.sh/ms-marketingcatalog-postgresql-pit.sh up --build -d

   Postgresql Script	Description
   ms-marketingcatalog-postgresql.bat / ms-marketingcatalog-postgresql.sh	To deploy all the necessary components for a Microservice including streaming services will be deployed, in order to run the Microservice independently.
   ms-marketingcatalog-postgresql-pit.bat / ms-marketingcatalog-postgresql-pit.sh	To deploy only the components necessary for Microservice. Data Event Streaming (DES) is presumed to deployed and running already. The streaming services will not be deployed.

3. After the successful deployment database, collections and the reference data (master data) are loaded into the mongo database for Marketing Catalog Microservice.
4. Once the marketing catalog Microservice is up and running in docker, check the APIs in the package.

   Alternatively, the status of Microservice can be obtained through the Health Check -MC.

The format of API's URL is given below:

• Base Path

  http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/

  For Example: http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/

• Resource path of the endpoint can be found in the APIs document. A sample endpoint of Marketing Catalog is http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/product/products/marketingCatalogue.
5. For the BackOffice Ingestion, change it to respective IP address of HTTP_BASE_PATH URL provided in ms-marketingcatalog-mongo.yml/ms-marketingcatalog-mongo-pit.yml.For more configurations, refer to Ingestion.

Undeploying Microservices

To stop and remove the existing container, execute the following command from the location where the marketing catalog docker is started.

• For Windows : ms-marketingcatalog.bat/ms-marketingcatalog-pit.bat down
• For Linux : ms-marketingcatalog.sh/ms-marketingcatalog-pit.sh down