Deploying Savings Pot Microservice on Docker

This section explains how to deploy the Savings pot microservice on Docker. To deploy, you must perform the following tasks:

• Deployment Artefacts
• Deploying Savings Pot Microservice on Docker
• Undeployment

Deployment Artefacts 

Savings Pot Microservices for docker deployment is available as single release bundle ms-savingspot-package-docker-<release_number>.zip.

Deploying Savings Pot Microservice on Docker

Prerequisite

Before deploying the microservice, ensure you have the following:

• Install Docker Engine in the deployment environment. Refer to https://docs.docker.com/install/overview/.
• Turn on Linux containers in Docker.

To deploy Savings Pot microservice on Docker package, follow these steps:

1. Extract the ms-savingspot-package-docker-<release_number>.zip folder.

   

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

   

3. Navigate from the command prompt to the directory where the .bat and .sh files are available and execute the following command which creates an image and docker container for the image.
   • For Windows: ms-savingspot.bat up --build -d                                    
   • For Linux: ms-savingspot.sh up --build -d

   Script	Description
   ms-savingspot.bat/ms-savingspot.sh	To deploy all the necessary components for a microservice including streaming services will be deployed, in order to run the microservice independently.

4. After the Savings Pot microservice is up and running in docker, check the APIs in the package.

   The URL of APIs follows the following structure:

   • Base Path: http://<IP_ADDRESS>:<PORT>/<context-root>/api/<version>/.
   • For Example: http://localhost:8090/ms-savingspot-api/api/v1.0.0.
   • The resource path of the endpoint can be found in the APIs.
   • A sample endpoint of savingspot can be http://localhost:8090/ms-savingspot-api/api/v1.0.0/holdings/savingPots.

   Alternatively, the status of microservice can be obtained through the health check API.

Undeployment

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

• For Windows: ms-savingspot.bat down
• For Linux: ms-savingspot.sh down