Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 4.74 KB

README.md

File metadata and controls

96 lines (65 loc) · 4.74 KB

Mojaloop-TTK-Simulators Helm Chart

Helm Chart for deploying Simulators that are based on an SDK-Scheme-Adapter with a Testing-Toolkit backend.

Overview

N/A

Sub-Charts

Deployment

Pre-requisites

The following-backend dependencies are required for each of the following services.

  1. Kafka - used as a persistent state store, and for correlating async-to-sync requests/responses using the pub-sub mechanisms.

    An example for installing the Bitnami Kafka Helm Chart can be done as follows:

    helm repo add bitnami https://charts.bitnami.com/bitnami
    helm -n <DESTINATION_NAMESPACE> install <KAFKA_INSTALL_NAME> bitnami/kafka --set persistence.enabled=false --set zookeeper.persistence.enabled=false

    IMPORTANT: The above command includes config changes to deploy a single instance with disable persistence, etc which is not recommended for Production grade installations. Please refer to the Bitnami Kafka values.yaml for available configuration parameters.

  2. Redis - used for pub-sub all Domain and Command events.

    An example for installing the Bitnami Redis Helm Chart can be done as follows:

    helm repo add bitnami https://charts.bitnami.com/bitnami
    helm -n <DESTINATION_NAMESPACE> install <REDIS_INSTALL_NAME> bitnami/redis --set architecture=standalone --set master.persistence.enabled=false --set auth.enabled=false

    IMPORTANT: The above command includes config changes to deploy a single instance with disable persistence, etc which is not recommended for Production grade installations. Please refer to the Bitnami Redis values.yaml for available configuration parameters.

Ensure that you configure the appropriate configurations to match the above in the values.yaml:

global:
  kafka:
    host: <KAFKA_INSTALL_NAME>-kafka
    port: 9092

  redis:
    host: <REDIS_INSTALL_NAME>-redis-master
    port: 6379

Or alternatively one can install the chart by adding the following --set parameters:

helm <NAMESPACE> install <INSTALL_NAME> . --set global.kafka.host=<KAFKA_INSTALL_NAME>-kafka --set global.redis.host=<REDIS_INSTALL_NAME>-redis-master

Helm

The Example-Mojaloop-Backend can be used to deploy the necessary backends as follows:

helm -n moja3 install backend ./example-mojaloop-backend --set "centralledger-mysql.enabled=false" --set "account-lookup-mysql.enabled=false" --set "centralledger-obj.enabled=false" --set "cep-mongodb.enabled=false" --set "kafka-console.enabled=false" --set "ttksims-redis.enabled=true" --set "kafka.enabled=true"

Note: Take note that all the unnecessary backends are disabled in the above example command, except for Kafka and Redis

Validation

Helm

Ensure you enable the following value configs are set when deploying via the main Mojaloop Helm Chart:

  • mojaloop-bulk.enabled: true <-- Enables deployment of core Mojaloop Bulk Services
  • mojaloop-ttk-simulators.enabled: true <-- Enables deployment of TTK-based SIMs
  • ml-ttk-test-val-bulk.tests.enabled=true <-- Handles standard Bulk Test-case collection
  • ml-ttk-test-setup-sdk-bulk.tests.enabled=true <- Handles provisioning of TTK-based SIMs
  • ml-ttk-test-val-sdk-bulk.tests.enabled=true <-- Handles the Functional Validation of the SDK Bulk Test-case collection

This can either be set as a parameter when running the helm install command line, or set directly on a customized ../mojaloop/values.yaml file.

Manual