Configuring Properties Common to All Deployments

The administrator can configure properties common to all deployments.

In Mashery Local Installer, property files are located at "/var/jenkins_home/docker-deploy/properties".

For built and downloaded deployment packages, property files are at folder "docker-deploy/properties" after the deployment package is extracted.

Here is an example list of contents:
tml-cm-crt.pem
tml-cm-key.pk8
tml-cm.jks
tml-tm.jks
tml_cache_properties.json
tml_cluster_properties.json
tml_cm_properties.json
tml_log_properties.json
tml_nosql_properties.json
tml_papi_properties.json
tml_sql_properties.json
tml_tm_properties.json
tml_zones_properties.json

Keystores, Keys and Certificates

File Definition Note
tml-cm-crt.pem Certificate used in tml-cm
tml-cm-key.pk8 Key used in tml-cm
tml-cm.jks Keystore used in tml-cm tml-cm.jks has tml-cm-crt.pem and tml-cm-key.pk8 stored inside.

Customer should prepare their own key, certificate and keystore to be used in tml-cm.

The built-in key, certificate and keystore should not be used for production.

Refer to the Preparing Keystore for Configuration Manager section in Deploying the TML Installer .

File Definition
tml-tm.jks Keystore used in tml-tm

Customer should prepare their own keystore to be used in tml-tm.

The built-in keystore should not be used for production

Refer to the Preparing Keystore for Traffic Manager section in Deploying the TML Installer.

Property Hierarchy

File "tml_cluster_properties.json" specifies properties common to Mashery Local cluster, here are the default contents:
{
    "mysql_root_pwd": "changeme",
    "mysql_masheryonprem_pwd": "changeme",
    "mysql_mashonpremrepl_pwd": "changeme",
    "mysql_mashclient_pwd": "changeme",
    "mysql_masherybackup_pwd": "changeme",
    "mom_server": "https://api-mom.mashery.com",
    "mom_key": "",
    "mom_secret": ""
}
The admininstrator can customize all MySQL passwords:
"mysql_root_pwd": "changeme",
"mysql_masheryonprem_pwd": "changeme",
"mysql_mashonpremrepl_pwd": "changeme",
"mysql_mashclient_pwd": "changeme",
"mysql_masherybackup_pwd": "changeme",
The admininstrator can customize MoM access from Mashery Local cluster in tethered mode:
"mom_server": "https://api-mom.mashery.com",
"mom_key": "",
"mom_secret": ""

Zone Level Properties

File "tml_zones_properties.json" specifies properties per zone, here are the default contents:
[
    {
        "zone_serial": "0",
        "mom_server_proxy_host": "",
        "mom_server_proxy_port": 3128,
        "mom_server_proxy_username": "",
        "mom_server_proxy_password": "",
        "target_server_proxy_host": "",
        "target_server_proxy_port": 3128,
        "no_proxy_pool": ""
    },
    {
        "zone_serial": "1",
        "mom_server_proxy_host": "",
        "mom_server_proxy_port": 3128,
        "mom_server_proxy_username": "",
        "mom_server_proxy_password": "",
        "target_server_proxy_host": "",
        "target_server_proxy_port": 3128,
        "no_proxy_pool": ""
    },
    {
        "zone_serial": "2",
        "mom_server_proxy_host": "",
        "mom_server_proxy_port": 3128,
        "mom_server_proxy_username": "",
        "mom_server_proxy_password": "",
        "target_server_proxy_host": "",
        "target_server_proxy_port": 3128,
        "no_proxy_pool": ""
    }
]
The administrator can HTTP Proxy for MoM access per zone:
"mom_server_proxy_host": "",
"mom_server_proxy_port": 3128,
"mom_server_proxy_username": "",
"mom_server_proxy_password": "",
The administrator can HTTP Proxy for accessing target servers per zone:
"target_server_proxy_host": "",
"target_server_proxy_port": 3128,
"no_proxy_pool": ""
Note:

Each zone is identified by "zone_serial", customer admin can tailor the property json according the number of zones to which Mashery Local cluster will be deployed.

Zone properties for zone whose "zone_serial" is above the actual number of deployed zones will not be used.

For target servers covered in "no_proxy_pool", Mashery Local directly calls them without going through HTTP proxy.

REGEX (Regular Expression) can be use in the property value.

Examples #1 (Note the backslash for escaping double quote:
"no_proxy_pool":"\"target1.na.tibco.com\",\"target2.na.tibco.com\"",

In this example, if the target server is "target1.na.tibco.com" or "target2.na.tibco.com", http proxy server will be bypassed.

Example #2 (Note the backslash for escaping double quote:
"no_proxy_pool":"\"back.*.na.tibco.com\"",

In this example, "back.*.na.tibco.com" is a regular expression, it matches i.e "back1.na.tibco.com", "back2.na.tibco.com", etc.

Platform API Properties

File "tml_papi_properties.json" specifies properties for platform API V3.

Here is the default properties:
{
  "sp_config_environment_domain_suffix": "mashery.com",
  "areas_customer_area_name": "tml",
  "localdevadmin_handle": "admin",
  "localdevadmin_password": "Ap1Us3rPasswd",
  "masherytestautomation_handle": "mltestautomation",
  "area_uuids": [
    {
      "area_uuid_name": "areas_customer_area_uuid",
      "area_uuid_value": "41a96952-ab9f-4abe-a2c8-e096c63324db"
    },
    {
      "area_uuid_name": "areas_mashery_internal_area_uuid",
      "area_uuid_value": "23b1c970-dcb5-4fe5-8e01-1a1fcf957cc4"
    },
    {
      "area_uuid_name": "areas_mashery_area_uuid",
      "area_uuid_value": "2014f1e7-1dd6-496b-b9bf-1c4b58bf7332"
    },
    {
      "area_uuid_name": "areas_solutions_area_uuid",
      "area_uuid_value": "02bcdfbc-47d0-4951-b3b1-60c5adc3762f"
    }
  ],
  "package_keys": [
    {
      "package_key_name": "your_api_key_for_v3_api",
      "package_key_value": "7wevdpn289e9v4k6g5ndqu6c"
    },
    {
      "package_key_name": "package_key_mapi_222ux5v3ydj6qqptk2y733xa_value",
      "package_key_value": "ajajruzw7hrpaguddnt3r2mq"
    },
    {
      "package_key_name": "package_key_mapi_4ayzfcn742zspfmu6jv48htv_value",
      "package_key_value": "87dgm9vxgwapynf68xk2cjcm"
    },
    {
      "package_key_name": "package_key_mapi_4ngdrf2tg62gvgsq7z9fd2f7_value",
      "package_key_value": "2z33rwdddxhndhz7csu566bk"
    },
    {
      "package_key_name": "package_key_mapi_gauhqskrkf4qzuv92esqht6a_value",
      "package_key_value": "d2779hcqjsw2fda445bsr36z"
    },
    {
      "package_key_name": "package_key_mapi_gtgkmxq8nnz9ajy86xtr9z4e_value",
      "package_key_value": "ddk3c6btngm39vgckqd3kq4t"
    },
    {
      "package_key_name": "package_key_mapi_qqky3473rqptpsrsvjdcm6ah_value",
      "package_key_value": "kyjyn5ystz3f3f7tnep6g79y"
    }
  ],
  "package_secrets": [
    {
      "package_secret_name": "your_secret_for_v3_api",
      "package_secret_value": "nbk27dsyrU"
    },
    {
      "package_secret_name": "package_key_mapi_222ux5v3ydj6qqptk2y733xa_secret",
      "package_secret_value": "3hw2BKbAfx"
    },
    {
      "package_secret_name": "package_key_mapi_4ayzfcn742zspfmu6jv48htv_secret",
      "package_secret_value": "kHnrJ6v4xw"
    },
    {
      "package_secret_name": "package_key_mapi_4ngdrf2tg62gvgsq7z9fd2f7_secret",
      "package_secret_value": "jqYwS5twav"
    },
    {
      "package_secret_name": "package_key_mapi_gauhqskrkf4qzuv92esqht6a_secret",
      "package_secret_value": "RkSEpu3N5w"
    },
    {
      "package_secret_name": "package_key_mapi_gtgkmxq8nnz9ajy86xtr9z4e_secret",
      "package_secret_value": "nXxaYcSCgz"
    },
    {
      "package_secret_name": "package_key_mapi_qqky3473rqptpsrsvjdcm6ah_secret",
      "package_secret_value": "Akj8Q645jN"
    }
  ]
}
For customization, refer to the Update Platform API Properties section in Deploying the TML Installer.

Properties per Container Type

The following property files specify property per container type:
tml_cache_properties.json
tml_cm_properties.json
tml_log_properties.json
tml_nosql_properties.json
tml_papi_properties.json
tml_sql_properties.json
tml_tm_properties.json
tml_tm_properties.json tml_cm_properties.json tml_sql_properties.json tml_cache_properties.json tml_log_properties.json tml_nosql_properties.json