Installing Aggregation Microservice in Kubernetes (K8)

This section helps you to install the Account Aggregation Microservice in Kubernetes (K8).

Prerequisite

Ensure to install Docker Engine in the deployment environment and turn on Linux containers in Docker.

Enable Kubernetes

Kubernetes must be enable after the docker is installed. Here are the steps:

1. Open the Docker Desktop app.
2. In the Settings section, select the Enable Kubernetes checkbox.



3. Navigate to Docker Settings > Resources. Increase the CPU and Memory as required.

   

   Kubernetes requires a minimum of 6 CPUs to run smoothly.
   

4. Install Helm and set helm path as an environment variable on the system.

Deployment of Account Aggregation Microservice in Kubernetes Runtime

K8 Images

1. In this deployment approach, use the ms-accountaggregate-helm-sql-pack-<release_number>.zip to load the docker images and then deploy the service in kubernetes cluster.

Prerequisites

Before executing the k8 startup (start_accountaggregate.sh/start_accountaggregate.bat) script, make sure the database scripts are executed and the database is up and running.

An active Kafka instance that need to be configured for generic ingestion (communicating with Arrangements and Holdings).

MySQL Datatbase

Install a standalone MySQL server manually.

Follow the steps to deploy the helm pack:

1. Extract the archive file ms-accountaggregate-helm-sql-pack-<release_number>.zip, it will contain the images, create-namespace, start-accountaggregate and stop-accountaggregate scripts.



2. Navigate to the images folder where the service and ingester images are available and load the docker images using the following docker command:
3. • docker load --input ms-accountaggregate-<image_name>-<release_number>.tar

   For instance, docker load --input ms-accountaggregate-service-DEV.0.0-SNAPSHOT.tar

   

   Ensure that the image loaded with the same tag as mentioned in the startup script (start_accountaggregate.sh).

   To start the service, execute create-namespace file by using the command create_namespace.bat/bash create_namespace.sh for creating the respective namespace.
4. Open the start_accountaggregate.bat/start_accountaggregate.sh by navigating to the folder where service startup scripts are available and configure DB and Kafka connection parameters as per the setup done as part of prerequisite step.
5. Now, run the respective start-up script as required.

For MySQL:

• For Windows : start_accountaggregation-mysql.bat
• For Linux : start_accountaggregation-mysql.sh

For MSSQL:

• For Windows : start_accountaggregation-mssql.bat
• For Linux : start_accountaggregation-mssql.sh

For Oracle:

• For Windows : start_accountaggregation-oracle.bat
• For Linux : start_accountaggregation-oracle.sh

6. 

   Once the services are up and running, perform kubectl get all -n accountaggregation to see all the resources for the Account Aggregation Microservice. 



7. Once the deployment is successful, the APIs can be tested.

URL of API's follows the below structure:

Undeployment of Account Aggregation Microservice

Execute the files to stop the service.

MSSQL Database

Install a standalone MSSQL server manually.

Follow the steps to deploy the helm pack:

1. Extract the archive file ms-accountaggregate-helm-sql-pack-<release_number>.zip, it will contain the images, create-namespace, start-accountaggregate and stop-accountaggregate scripts.



2. Navigate to the images folder where the service and ingester images are available and load the docker images using the following docker command:
3. • docker load --input ms-accountaggregate-<image_name>-<release_number>.tar

   For instance, docker load --input ms-accountaggregate-service-DEV.0.0-SNAPSHOT.tar

   

   Ensure that the image loaded with the same tag as mentioned in the startup script (start_accountaggregate.sh).

   To start the service, execute create-namespace file by using the command create_namespace.bat/bash create_namespace.sh for creating the respective namespace.
4. Open the start_accountaggregate.bat/start_accountaggregate.sh by navigating to the folder where service startup scripts are available and configure DB and Kafka connection parameters as per the setup done as part of prerequisite step.
5. Now, run the respective start-up script as required.

For MySQL:

• For Windows : start_accountaggregation-mysql.bat
• For Linux : start_accountaggregation-mysql.sh

For MSSQL:

• For Windows : start_accountaggregation-mssql.bat
• For Linux : start_accountaggregation-mssql.sh

For Oracle:

• For Windows : start_accountaggregation-oracle.bat
• For Linux : start_accountaggregation-oracle.sh

6. 

   Once the services are up and running, perform kubectl get all -n accountaggregation to see all the resources for the Account Aggregation Microservice. 



7. Once the deployment is successful, the APIs can be tested.

URL of API's follows the below structure:

Undeployment of Account Aggregation Microservice

Execute the files to stop the service.

Oracle Database

Install a standaloneOracle server manually, or,

Follow the the steps given in the page Oracle Database Creation - Docker Image.

• Navigate to the extracted accountaggregation-helm-sql-pack-<release_number>.zip file : accountaggregation-helm-sql-pack-<release_number>\accountaggregation.
• Edit the DB related properties in the start script.

Follow the steps to deploy the helm pack:

1. Extract the archive file ms-accountaggregate-helm-sql-pack-<release_number>.zip, it will contain the images, create-namespace, start-accountaggregate and stop-accountaggregate scripts.



2. Navigate to the images folder where the service and ingester images are available and load the docker images using the following docker command:
3. • docker load --input ms-accountaggregate-<image_name>-<release_number>.tar

   For instance, docker load --input ms-accountaggregate-service-DEV.0.0-SNAPSHOT.tar

   

   Ensure that the image loaded with the same tag as mentioned in the startup script (start_accountaggregate.sh).

   To start the service, execute create-namespace file by using the command create_namespace.bat/bash create_namespace.sh for creating the respective namespace.
4. Open the start_accountaggregate.bat/start_accountaggregate.sh by navigating to the folder where service startup scripts are available and configure DB and Kafka connection parameters as per the setup done as part of prerequisite step.
5. Now, run the respective start-up script as required.

For MySQL:

• For Windows : start_accountaggregation-mysql.bat
• For Linux : start_accountaggregation-mysql.sh

For MSSQL:

• For Windows : start_accountaggregation-mssql.bat
• For Linux : start_accountaggregation-mssql.sh

For Oracle:

• For Windows : start_accountaggregation-oracle.bat
• For Linux : start_accountaggregation-oracle.sh

6. 

   Once the services are up and running, perform kubectl get all -n accountaggregation to see all the resources for the Account Aggregation Microservice. 



7. Once the deployment is successful, the APIs can be tested.

URL of API's follows the below structure:

Undeployment of Account Aggregation Microservice

Execute the files to stop the service.

PostgreSQL Database

Follow the steps to deploy the helm pack:

1. Extract the archive file ms-accountaggregate-helm-sql-pack-<release_number>.zip, it will contain the images, create-namespace, start-accountaggregate and stop-accountaggregate scripts



2. Navigate to the images folder where the service and ingester images are available and load the docker images using the following docker command:
3. • docker load --input ms-accountaggregate-<image_name>-<release_number>.tar

   For instance, docker load --input ms-accountaggregate-service-DEV.0.0-SNAPSHOT.tar

   

   Ensure that the image loaded with the same tag as mentioned in the startup script (start_accountaggregate.sh).

   To start the service, execute create-namespace file by using the command create_namespace.bat/bash create_namespace.sh for creating the respective namespace.
4. Navigate to the folder where service startup scripts are available and configure DB and Kafka connection parameters as per the setup done as part of the prerequisite step.
5. Now, run the respective start-up script as required.

For MySQL:

• For Windows : start_accountaggregation-mysql.bat
• For Linux : start_accountaggregation-mysql.sh

For MSSQL:

• For Windows : start_accountaggregation-mssql.bat
• For Linux : start_accountaggregation-mssql.sh

For Oracle:

• For Windows : start_accountaggregation-oracle.bat
• For Linux : start_accountaggregation-oracle.sh

For PostgreSQL:

• For Windows : start_accountaggregation-postgresql.bat
• For Linux : start_accountaggregation-postgresql.sh

6. 

   Once the services are up and running, perform kubectl get all -n accountaggregation to see all the resources for the Account Aggregation Microservice. 



7. Once the deployment is successful, the APIs can be tested.

URL of API's follows the below structure:

Undeployment of Account Aggregation Microservice

Execute the files to stop the service.

K8 Ingress

This deployment approach exposes the Account Aggregation MS APIs through the domain name "accountaggregation.com" and is implemented based on the nginx ingress controller service in K8 pack.

Follow the below steps (prior to deployment of the K8 packs) to configure and access the MS APIs through the domain name.

1. Set the domain name ("127.0.0.1 accountaggregation.com") in the hosts file of Windows by navigating to C:\Windows\System32\drivers\etc



2. Restart the system for the changes to come in effect.
3. Navigate to operator folder and execute start-ingress-controller.bat/start-ingress-controller.sh file to start the ingress controller.

4. 

   Now, deploy the K8 (Helm images) packs by following the respective deployment instructions mentioned on the other tabs.
5. Execute start-ingress.bat/start-ingress.sh to start the ingress services by navigating to samples folder in K8 (Helm images) package accordingly as shown below:



6. Access the Account Aggregation APIs using the domain name accountaggregation.com as shown below:

URL of API's follows the below structure:

Undeployment

For undeployment of ingress we just need to execute stop-ingress.bat/stop-ingress.sh as shown below by navigating to the samples folder of K8 (Helm images) package.