Installing Generic Configuration Microservices in Docker

This section helps you to install the Generic Configuration Microservice in Docker cloud.

Procedure:

  1. Create the CONFIG_SERVICE_HOME directory
  2. Extract the ms-genericconfig-package-docker-<release>.zip release bundle file into the CONFIG_SERVICE_HOME directory.
  3. To make the microservice up and running, execute the below command for creating images and docker container for that image,
    • Windows: ms-genericconfig.bat up --build -d
    • Linux: ms-genericconfig.sh up --build -d
  4. Verify Generic Config Microservice:
    • Verify get configuration by name API.

      Name

      Detail

      URI

      /system/configurationGroups/{groupId}/configuration/{configName}

      Method

      GET

      Sample-URL

      http://localhost:8100/ms-genericconfig-api/api/v1.0.0/system/configurationGroups/SECURITY.POLICY/configuration/BalanceViewer

      Sample-Response

      [{
      	"message": "Configuration file does not exists:",
      	"code": "404"
      }]
      
    • Verify get all configurations API.

      Name

      Detail

      URI

      /system/configurationGroups/{groupId}/configuration

      Method

      GET

      Sample-URL

      http://localhost:8100/ms-genericconfig-api/api/v1.0.0/system/configurationGroups/SECURITY.POLICY/configuration

      Sample-Response

      [{
      	"message": "Configuration file does not exists:",
      	"code": "404"
      }]
      
  5. To stop and remove the existing container, execute the below command.
    • Windows: ms-genericconfig.bat down --remove-orphans
    • Linux: ms-genericconfig.sh down --remove-orphans

Import policy into configuration server:

  • Value of {groupId} path parameter should be always SECURITY.POLICY
  • Value of {configName} path parameter should be policy ID
  • Value of id field should be policy ID
  • Value of data field should be Base64 encoded
  • Policy files are available under the HOLDINGS_SERVICE_HOME directory
  • To add a policy file into generic-config database, the following described API should be used.

    Name

    Detail

    URI

    /system/configurationGroups/{groupId}/configuration/{configName}

    Method

    POST

    Sample-URL

    http://localhost:8100/ms-genericconfig-api/api/v1.0.0/system/configurationGroups/SECURITY.POLICY/configuration/BalanceViewer

    Sample-Payload

    {
    	"id": "BalanceViewer",
    	"name": "BalanceViewer policy file",
    	"version": "1.0.0",
    	"configData": {
    		"data": "PD94bWwgdmVyc2lvbj0i",
    		"configType": "xml"
    	}
    }
    

    Sample-Response

    {
    	"id": "BalanceViewer",
    	"name": "BalanceViewer policy file",
    	"version": "1.0.0"
    }
    
  • To modify a policy file available in generic-config database, the following described API should be used.

    Name

    Detail

    URI

    /system/configurationGroups/{groupId}/configuration/{configName}

    Method

    PUT

    Sample-URL

    http://localhost:8100/ms-genericconfig-api/api/v1.0.0/system/configurationGroups/SECURITY.POLICY/configuration/BalanceViewer

    Sample-Payload

    {
    	"version": "1.0.0",
    	"configData": {
    		"data": "PD94bWwgdmVyc2lvbj0i",
    		"configType": "xml"
    	}
    }
    

    Sample-Response

    {
    	"id": "BalanceViewer",
    	"name": "BalanceViewer policy file",
    	"version": "1.0.0"
    }
    

Copyright © 2020- Temenos Headquarters SA

Published on :
Friday, October 22, 2021 3:50:02 PM IST

Feedback
x