Planning and Configuring

Files to modify

After building the Mashery Local images, copy the /var/jenkins_home/docker-deploy folder in the tml-installer container to the desired host from where you want to run the deployment. If your build and deployment host are the same, the following sample command will copy the tmgc-deploy folder from the container to the current working directory on the local machine. Sample command:

docker cp tml-installer:/var/jenkins_home/docker-deploy .

The following file is a reference deployment manifest in tml-installer container for deployment in a single zone:

docker-deploy/onprem/swarm/manifest-onprem-swarm.json

Mashery Local Components Configuration

The following settings can be customized. The tml_image_tag must be updated to match your docker image build.

Variable Prefix	Description
tml_cm	Cluster Manager Component
tml_api	V3 API Component
tml_tm	Traffic Manager Component
tml_cache	Cache Component
tml_sql	SQL Component
tml_log	Log Component
tml_nosql	NoSQL (Cassandra) Component

"tml_image_tag": "v5.1.0.1",
"tml_cm_count": 1,
"tml_tm_count": 1,
"tml_cache_count": 1,
"tml_sql_count": 1,
"tml_log_count": 1,
"tml_nosql_count": 1,

"tml_tm_http_enabled": "true",
"tml_tm_http_port": 80,
"tml_tm_https_enabled": "true",
"tml_tm_https_port": 443,
"tml_tm_oauth_enabled": "true",
"tml_tm_oauth_port": 8083,

"tml_api_http_enabled": "false",
"tml_api_http_port": 7080,
"tml_api_https_enabled": "false",
"tml_api_https_port": 7443,

"tml_cm_http_enabled": "true",
"tml_cm_http_port": 8080,
"tml_cm_https_enabled": "true",
"tml_cm_https_port": 8443,

"cassandra_max_heap": "512M",
"cassandra_replication_factor": 1

Setting up Mashery Service Configuration Data

Mashery Local offers the option of importing service configuration data offline. A sample data.zip is provided with the TIBCO Mashery Local build that can be loaded into the database during TIBCO Mashery Local cluster creation.

To load the sample data:

In docker-deploy/onprem/swarm/manifest-onprem-swarm.json, set tml_cluster_mode as untethered_cm.
Copy the sample data docker-deploy/sample_data/data.zip into the docker-deploy/properties/ directory; this ensures that the data from the data.zip will be automatically loaded in the database when the TIBCO Mashery Local cluster is created.

Note: Make sure that the apiKey and apiSecret is empty in docker-deploy/properties/tml_sql_properties.json if you want to use the offline data loading feature.

Mashery Local also offers the capability to sync data from MoM (Mashery on-prem Manager) server in TIBCO Cloud Mashery at the time of cluster creation. To load the data using the MoM sync configuration:

In docker-deploy/onprem/swarm/manifest-onprem-swarm.json, set tml_cluster_mode as tethered.
Specify the following properties in the docker-deploy/properties/tml_sql_properties.json:

"apiKey": "<MOM_API_KEY>",
"apiSecret": "<MOM_API_SECRET>",

Note: Do not place the sample data.zip in the docker-deploy/properties/ folder if you are loading the data using the MoM sync configuration.

Option 3: Create Service Configuration Data via TML V3 API

Set tml_cluster_mode as untethered_api in docker-deploy/onprem/swarm/manifest-onprem-swarm.json.
Call TML V3 API service at https://developer.mashery.com/docs/read/mashery_api/30.

Generating Deployment Scripts and Configuration

For single-zone deployment, run the following command and find generated deployment scripts and configuration in the folder manifest-onprem-swarm:

./compose.sh manifest-onprem-swarm.json

Contents