TIBCO Mashery

Installation and Configuration Guide

Software Release 5.1 May 2019

Updated August 2019

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE

SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDER SEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH, THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITH TIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES, AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY AT YOUR OWN

DISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDING TO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THE

FOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO and TIBCO Mashery are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.

All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating system platforms for a specific software version are released at the same time. Please see the readme.txt file for the availability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,

INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer to TIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

Copyright

2006-2019. TIBCO Software Inc. All rights reserved.

Contents

TIBCO Documentation and Support Services . . . . 10

TIBCO Mashery Local Overview . . . . 11

TIBCO Mashery Local Topology . . . . ¹²

TIBCO Mashery Local Component Interactions . . . . ¹³

TIBCO Mashery Local Components . . . .16

Components Overview . . . . ¹⁶

NoSQL . . . . ¹⁶

Registry . . . . ¹⁷

Log Service . . . . ¹⁸

Accessing QPM Data by Cluster for Untethered Deployments . . . . ¹⁹

SQL DB . . . . ²⁰

Onprem Loader . . . . ²³

Cache . . . . ²⁴

Memcache Loader . . . . ²⁶

Traffic Manager . . . . ²⁶

Cluster Manager . . . . ²⁹

Cluster Manager CLI . . . . 29

TML API . . . . ⁴⁶

Configuration Manager Overview . . . . ⁴⁷

TIBCO Mashery Local Installer . . . . 48

How to Check for Docker Installation . . . . ⁴⁸

Installer Overview . . . . ⁴⁸

Deploying the Installer . . . . ⁴⁹

Running the Installer . . . . ⁴⁹

How to Run the Mashery Local 5 Installer on Windows . . . . ⁵³

Building the Docker Images . . . . ⁵⁴

Build in Jenkins . . . . ⁵⁸

Deploying the TIBCO Mashery Local Cluster . . . . ⁶⁰

Stopping the Installer . . . . ⁶⁰

Customizing the Installer . . . . ⁶¹

How the Installer build-docker jenkins Job Works . . . . ⁶²

Modifiable Scripts to build Docker Images . . . . ⁶³

Use Cases . . . . 65

Managing a TIBCO Mashery Local Cluster . . . . 67

Deployment Topologies . . . . ⁶⁷

Docker Container View of a Single Zone . . . . ⁶⁸

Mashery Local Cluster in Kubernetes / Docker Swarm - Single Zone . . . . ⁶⁹

Mashery Local Cluster in Kubernetes Docker Swarm - Multizone . . . . ⁷⁰

AWS using Kubernetes . . . . ⁷⁰

Prerequisites . . . . ⁷⁰

Planning and Configuring . . . . ⁷¹

Creating a Mashery Local Cluster . . . . ⁷⁵

Verifying a Mashery Local Cluster . . . . ⁷⁸

Making a Traffic Call . . . . ⁷⁸

Deleting a Mashery Local Cluster . . . . ⁷⁸

Clearing the AWS Registry . . . . ⁷⁹

AWS using Docker Swarm . . . . ⁷⁹

Prerequisites for Deployment on AWS using Swarm . . . . ⁷⁹

Planning and Configuring . . . . ⁷⁹

Creating a Mashery Local Cluster . . . . ⁷⁹

Creating a Swarm Cluster in AWS . . . . 81

Making a Traffic Call . . . . ⁸⁴

Deleting a Mashery Local Cluster . . . . ⁸⁶

Azure using Kubernetes . . . . ⁸⁶

Prerequisites . . . . ⁸⁷

Planning and Configuring . . . . ⁸⁷

Create a TIBCO Mashery Local Cluster . . . . ⁹⁰

Creating an AKS Cluster . . . . ⁹⁰

Creating a TIBCO Mashery Local Cluster . . . . ⁹³

Loading and Uploading Docker Images on AKS . . . . ⁹⁴

Validating a TIBCO Mashery Local Cluster . . . . ⁹⁴

Making a Traffic Call . . . . ⁹⁵

Deleting a Mashery Local Cluster . . . . ⁹⁵

Deleting the Kubernetes Cluster . . . . ⁹⁵

Azure using OpenShift . . . . ⁹⁵

Prerequisites . . . . ⁹⁵

Planning and Configuring . . . . ⁹⁶

Creating a Mashery Local Cluster . . . . ¹⁰⁰

Validating a Mashery Local Cluster . . . . ¹⁰¹

Making a Traffic Call . . . . 101

Deleting a Mashery Local Cluster . . . . ¹⁰²

Azure using Docker Swarm . . . . ¹⁰²

Prerequisites for Deployment on Azure using Swarm . . . . ¹⁰²

Planning and Configuration for a New Cluster on Azure using Swarm . . . . ¹⁰²

Creating a Mashery Local Cluster . . . . ¹⁰⁵

Verifying a Mashery Local Cluster . . . . ¹¹¹

Making a Traffic Call . . . . ¹¹⁶

Google Cloud Platform using Kubernetes . . . . ¹¹⁶

Prerequisites . . . . ¹¹⁶

Planning and Configuring . . . . ¹¹⁷

Creating the Kubernetes Cluster on GCP . . . . ¹²⁰

Loading and Uploading Docker Images on GCP using Kubernetes . . . . ¹²²

Creating the TIBCO Mashery Local Cluster on GCP using Kubernetes . . . . ¹²³

Validating a TIBCO Mashery Local Cluster . . . . ¹²³

Making a Traffic Call . . . . ¹²⁴

Deleting a Mashery Local Cluster . . . . ¹²⁴

Deleting the Kubernetes Cluster . . . . ¹²⁴

On-premises Bare Metal using Swarm . . . . ¹²⁴

Prerequisites . . . . ¹²⁴

Planning and Configuring . . . . 124

Deploying a Cluster on On-Premises Bare Metal using Swarm . . . . ¹²⁶

Creating a Mashery Local Cluster . . . . ¹²⁸

Validating a Mashery Local Cluster . . . . ¹²⁹

Making a Traffic Call . . . . ¹³⁰

Deleting a Mashery Local Cluster . . . . ¹³⁰

Deleting the Local Swarm Cluster . . . . ¹³⁰

Deployment on On-premises VirtualBox using Kubernetes . . . . ¹³¹

Prerequisites . . . . ¹³¹

Planning and Configuration for a New Cluster on On-premises VirtualBox using Kubernetes . . . . ¹³¹

Creating a TIBCO Local Mashery Cluster . . . . ¹³⁴

Validating a Mashery Local Cluster . . . . ¹³⁶

Making a Traffic Call . . . . ¹³⁹

Deleting the Local Kubernetes Cluster . . . . ¹⁴⁰

Deployment on On-premises VirtualBox using Swarm . . . . ¹⁴⁰

Prerequisites for Deployment on On-premises VirtualBox using Swarm . . . . ¹⁴⁰

Planning and Configuration for a New Cluster on On-premises VirtualBox using Swarm . . . . ¹⁴⁰

Creating a Swarm Cluster on On-premises VirtualBox . . . . ¹⁴³

Creating the TIBCO Mashery Local Cluster on On-premises VirtualBox using Swarm . . . . ¹⁴⁴

Validating a Mashery Local Cluster . . . . 144

Making a Traffic Call . . . . ¹⁴⁶

Deleting a Mashery Local Cluster . . . . ¹⁴⁶

Deleting the Local Swarm Cluster . . . . ¹⁴⁶

Deployment on On-premises ESX VMWare using Swarm . . . . ¹⁴⁶

Prerequisites . . . . ¹⁴⁶

Planning and Configuring . . . . ¹⁴⁶

Deploying a Swarm Cluster on On-premises VMWare . . . . ¹⁴⁸

Creating a Mashery Local Cluster . . . . ¹⁵⁰

Validating a Mashery Local Cluster . . . . ¹⁵⁰

Making a Traffic Call . . . . ¹⁵²

Deleting a Mashery Local Cluster . . . . ¹⁵²

Deleting the Local Swarm Cluster . . . . ¹⁵²

Migration to Mashery Local 5x . . . . 153

Migration Prerequisites . . . . ¹⁵³

Upgrading Mashery Local . . . . ¹⁵³

Upgrade Script Location . . . . ¹⁵⁴

Upgrade Script Syntax . . . . ¹⁵⁵

Example of an Upgrade Script Run . . . . ¹⁵⁵

Platform Support Matrix . . . . ¹⁵⁵

Reconfiguring the Dependent Components on Docker Swarm . . . . ¹⁵⁶

Configuration Manager . . . . 158

Installing and Configuring Configuration Manager . . . . ¹⁵⁸

Using Mashery Local Configuration Manager . . . . ¹⁵⁹

Importing Configuration Data . . . . ¹⁵⁹

Editing Configuration Data . . . . ¹⁶⁰

Configuring Initializations . . . . ¹⁶¹

Configuring API Definitions and Endpoints . . . . ¹⁶¹

Configuring API Packages and Plans . . . . ¹⁷¹

Configuring Apps and Package Keys . . . . ¹⁷⁴

Searching Package Keys . . . . ¹⁷⁷

Exporting Configuration Data . . . . ¹⁷⁸

Importing Configuration Data into Mashery Local 5.0 Zones . . . . ¹⁷⁸

Managing the Configuration Data File . . . . ¹⁷⁹

Applying Incremental Configurations . . . . ¹⁷⁹

Using the Hello World Example . . . . ¹⁷⁹

FAQ and Troubleshooting . . . . ¹⁸⁰

Managing a Cluster . . . . 185

Log Management . . . . ¹⁸⁵

Viewing Logs . . . . ¹⁸⁵

Interacting with Loggers . . . . ¹⁸⁶

Enriched Access Logs . . . . ¹⁹⁰

Exporting Logs to Different Output Channels . . . . ¹⁹²

Recipe for File Destination . . . . ¹⁹³

Recipe for Elasticsearch . . . . ¹⁹³

Recipe for HTTP Endpoints . . . . ¹⁹⁴

Recipe for Kafka . . . . ¹⁹⁵

Recipe for TCP Socket . . . . ¹⁹⁶

Recipe for SYSLOG Socket . . . . ¹⁹⁷

Recipe for MoM and HTTP . . . . ¹⁹⁸

Configuring Mashery Local and Splunk to Support Monitoring . . . . ¹⁹⁸

TML Consumer . . . . ²⁰³

HTTPS Configuration . . . .206

HTTPS Configuration Overview . . . . ²⁰⁶

HTTPS Server Configuration . . . . ²⁰⁶

HTTPS Client Configuration . . . . ²⁰⁷

HTTPS Endpoint Configuration . . . . ²⁰⁸

Testing the HTTPS Client Call . . . . ²⁰⁹

Troubleshooting HTTPS Problems . . . . ²¹⁰

Enabling Java SSL Debug Logging . . . . ²¹⁰

HTTPS Mutual Authentication . . . . ²¹⁰

Setting up HTTPS Authentication . . . . ²¹¹

One-Way HTTPS Client Configuration . . . . ²¹¹

Mutual HTTPS Client Configuration . . . . ²¹³

Cluster Manager CLI Commands . . . . ²¹⁵

Create Certificate . . . . ²¹⁵

Create Identity . . . . ²¹⁵

Update Certificate . . . . ²¹⁶

Update Identity . . . . ²¹⁶

List Certificates . . . . ²¹⁶

List Identities . . . . ²¹⁷

Creating Mutual Authentication . . . . ²¹⁷

Tethered Mode . . . . ²¹⁷

Untethered Config Manager Mode . . . . ²¹⁸

Untethered API Mode . . . . ²¹⁸

OAuth . . . . 220

Configuring OAuth 2.0 API Access . . . . ²²⁰

OAuth Authenticator Service Configuration . . . . ²²⁰

Making OAuth 2.0 Calls . . . . ²²²

OAuth API Supported Methods . . . . ²²²

Sample Calls . . . . ²²²

Mashery Local 5.1 OAuth API Compatibility with Mashery Local 4.x . . . . ²³³

OAuth Token Migration . . . . ²³⁴

Structure of Token Migration Utility . . . . ²³⁴

Deploying the OAuth Token Migration Utility . . . . ²³⁵

OAuth Token Migration Configuration Properties . . . . ²⁴²

Running the OAuth Token Migration Utility . . . . ²⁴⁴

Verifying OAuth Token Migration . . . . ²⁴⁹

OAuth Token Migration FAQs . . . . ²⁵⁰

Troubleshooting OAuth Token Migration Issues . . . . ²⁵⁰

Monitoring Mashery Local Components . . . . 253

Format of Metrics . . . . ²⁵³

Resource Monitoring . . . . ²⁵³

Component Metrics Monitoring . . . . ²⁵⁹

Traffic Manager Metrics . . . . ²⁵⁹

SQL Container Metrics (MySQL DB) . . . . ²⁶⁷

Diagnostic Recipe and Alerts for MySQL . . . . ²⁷¹

Cache Container Metrics (Memcached) . . . . ²⁷¹

Diagnostic Recipe and Alerts for Memcached . . . . ²⁷⁴

NoSQL Container Metrics (Cassandra) . . . . ²⁷⁴

Diagnostic Recipe and Alerts for NoSQL . . . . ²⁷⁹

Onprem Loader Monitoring . . . . ²⁸¹

Diagnostic Recipe and Alerts for Onprem Loader . . . . ²⁸²

Memcache Loader Monitoring . . . . ²⁸²

Diagnostic Recipe and Alerts for Memcache Loader . . . . ²⁸⁴

Functional Monitoring . . . . ²⁸⁴

Recipes for ELK . . . . ²⁸⁶

Custom Adapters and Processors . . . . 287

Using the Adapter SDK . . . . ²⁸⁷

Adapter SDK Package . . . . ²⁸⁷

TIBCO Mashery Domain SDK . . . . ²⁸⁷

TIBCO Mashery Infrastructure SDK . . . . ²⁸⁷

SDK Domain Model . . . . ²⁸⁷

Extended Attributes . . . . ²⁸⁹

Pre and Post Processor Extension Points . . . . ²⁹⁰

Listener Pattern . . . . ²⁹⁰

Event Types and Event . . . . ²⁹⁰

Event Listener API . . . . ²⁹⁰

Creating a Custom Authenticator . . . . ²⁹⁰

Implementing and Registering Processors . . . . ²⁹⁴

Downloading the SDK . . . . ²⁹⁴

Implementing the Event Listener . . . . ²⁹⁵

Implementing Lifecycle Callback Handling . . . . ²⁹⁶

Adding Libraries to Classpath . . . . ²⁹⁷

Deploying Processors to Runtime . . . . ²⁹⁷

Packaging the Custom Processor . . . . ²⁹⁷

Uploading the Custom Processor . . . . ²⁹⁷

How Custom Processors are Updated . . . . ²⁹⁸

Enabling Debugging . . . . ²⁹⁸

Caching Content . . . . ³⁰⁰

Terminating a Call During Processing of an Event . . . . ³⁰¹

Accessing Package Key EAVs in the Custom Processor . . . . ³⁰³

Adapter SDK Usage and Examples . . . . ³⁰³

Adapter SDK Development Environment Example Setup . . . . ³⁰⁴

Setting up the Adapter SDK for Maven . . . . ³⁰⁴

Using the Adapter SDK in Mashery Local with Single Processor . . . . ³⁰⁴

Using the Adapter SDK in Mashery Local with Third-Party Libraries . . . . ³⁰⁸

Using the Adapter SDK in Mashery Local with Multiple Processors in One Eclipse Project . . . . 311

Using the Adapter SDK in Mashery Local with Multiple Processors in One Zip Package . . . . ³¹²

Using the Adapter SDK in Mashery Local with Multiple Processors in One Package and Third Party Libraries 314 TIBCO-provided Adapters and Processors . . . . ³¹⁴

Customer-provided Adapters and Processors . . . . ³¹⁵

TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainly in HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any other documentation included with the product. To access the latest documentation, visit https://

docs.tibco.com.

Product-Specific Documentation

The following document for this product can be found on the TIBCO Documentation site:

●

TIBCO Mashery

Local Installation and Configuration Guide How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

●

For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

●

For accessing the Support Knowledge Base and getting personalized content about products you are interested in, visit the TIBCO Support portal at https://support.tibco.com.

●

For creating a Support case, you must have a valid maintenance or support contract with TIBCO.

You also need a user name and password to log in to https://support.tibco.com. If you do not have a user name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matter

experts to share and access their collective experience. TIBCO Community offers access to Q&A forums,

product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, and

tools that extend and enable customers to gain full value from TIBCO products. In addition, users can

submit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to

https://community.tibco.com.

TIBCO Mashery Local Overview

TIBCO Mashery

Local is a cloud-native API gateway that can be deployed within a customer's datacenter or on cloud platforms.

TIBCO Mashery Local supports two deployment options: Untethered, without any external

dependencies, or in a hybrid manner working with TIBCO Cloud

Mashery. When operating in an untethered mode, the Configuration Manager tool can be used to configure API policies, packages and plans, and manage API keys. Logs from TIBCO Mashery Local can be collected and forwarded for downstream reporting and analytics via other externally-available tools. When operating in a hybrid mode, TIBCO Cloud Mashery includes the cloud-hosted Developer Portal, Administration Dashboard, and API Reporting and Analytics.

TIBCO Mashery Local includes commercial support for Project Flogo microgateway. For more information about Project Flogo microgateway, see https://github.com/project- flogo/microgateway.

TIBCO Mashery Local is available to customers for installation in container-based environments.

TIBCO Mashery Local Components include:

●

NoSQL

Each NoSQL component is a Cassandra Node. Multiple nodes can be deployed as a ring in a Data Center that maps to a TIBCO Mashery Local Zone and Kubernetes Zone. TIBCO Mashery Local relies on Cassandra for data availability across Zones in a TIBCO Mashery Local Cluster.

●

Registry

The Registry component is responsible for storing the topology of a TIBCO Mashery Local cluster.

Every TIBCO Mashery Local component communicates with the registry so it knows about each components's physical information (host, IP, Container Agent URL), its state, and bindings to resources.

●

Log

The Log service component provides the data collection services for all TIBCO Mashery Local components. It also provides Log Consumer services to be able to send the logs to various destinations for processing and analytics.

●

SQL

The SQL component runs a MySQL Database and stores the configuration data related to services, packages, keys, applications and related information.

●

Cache

The Cache component runs memcaches pools and provides in-memory cache for fast access to configuration and OAuth data.

●

Traffic Manager

The Traffic Manager component provides the traffic management and OAuth capabilities.

TIBCO Mashery Local components can be deployed in a single zone or multiple zones to form a cluster of components to address scalability, reliability, and high availability requirements. TIBCO Mashery Local relies on Cassandra for data availability within and across Zones.

Definition of a Cluster

"Cluster" means a TIBCO Mashery Local installation with all the necessary Mashery Local components

located at the same physical address (for example, 3307 Hillview Avenue) if being deployed within a

customer's premises; or one region, if being deployed in the cloud. Each TIBCO Mashery Local cluster

includes support for up to 10 Flogo app instances with microgateways.

Any installation spanning across multiple regions in the cloud (or multiple physical addresses if within customer's premises) are counted as separate Clusters.

TIBCO Mashery Local Topology

The following image represents the TIBCO Mashery Local topology:

TIBCO Mashery Local Component Interactions

The following image represents the interactions between the TIBCO Mashery Local components:

TIBCO Mashery Local Components

The following sections describe TIBCO Mashery Local (TML) components in more detail.

●

Components Overview

●

NoSQL

●

Registry

●

Log

●

SQL

●

Cache

●

Traffic Manager

●

Cluster Manager

●

TML API

●

Configuration Manager

Components Overview

Each TIBCO Mashery Local component has:

●

a container agent that provides access to the component and interacts with the registry on its behalf.

●

one or more managed processes that are started by the container agent. These provide the services and functionality of a TIBCO Mashery Local component.

The container agent is responsible for:

●

starting the managed processes within a TIBCO Mashery Local component.

●

interacting with the registry to provide properties, resource bindings and report status on the TIBCO Mashery Local component.

NoSQL

What's Inside

Cassandra Node

Services

Cassandra DB Service Resource Dependencies

●

LogProducer Binding

●

Registry Binding Properties

Name Default Value Comment

auto_binding ON When turned ON, logservice urls will be auto- discovered and bound to the TIBCO Mashery Local component.

logserviceURL log-set-0.log-

svc.default.svc.cluster.loc al

Logservice url to connect to process the logs.

Registry

Overview

The Registry component of TIBCO Mashery Local 5.0 acts as a common service accessible to the other TIBCO Mashery Local components to discover other TIBCO Mashery Local component services, such as:

●

The host/port of the service

●

The properties of the TIBCO Mashery Local components

●

The bindings of the TIBCO Mashery Local components The registry also outlines the Cluster-wide topology, including:

●

Cluster

●

Zones

●

TIBCO Mashery Local components

●

Properties and bindings of the TIBCO Mashery Local components The Registry has following core characteristics:

●

Redundantly available through the cluster

●

Works with the persistence layer (for example, Cassandra) to maintain a "current snapshot" of the cluster-wide topology.

●

Provides fine-grained REST APIs for each of the TIBCO Mashery Local components; for example, Cache, SQL DB, Traffic Manager. This includes:

—

Creation of TIBCO Mashery Local components

—

Listing of TIBCO Mashery Local components

—

Updates to TIBCO Mashery Local components

—

Receiving status and heartbeats from TIBCO Mashery Local components

In Mashery Local 5.0, the Registry is run as part of a Jetty process alongside the Cassandra process inside the NoSQL TIBCO Mashery Local component container. The proximity to Cassandra enables the Registry process to access Cassandra over 127.0.0.1:9042 host/port.

What's Inside

Java and Jetty Registry implementation.

Services Registry Service

Resource Dependencies

●

Log Producer Binding

Log Service

What's Inside

●

td-agent/fluentd

Services

●

Log Producer Service

●

Log Consumer Service Resource Dependencies

●

Log Consumers

●

Registry Binding Configuration Properties

Name Default Value Comments

api_key Only needed for "Tethered" setup.

api_secret Only needed for "Tethered" setup.

td_agent_output_

channelType DEFAULT

(always enabled) Set this property if you need to send access logs to other destinations. Accepted values are DEFAULT,

ELASTICSEARCH, KAFKA, HTTP and TCP. Changing to anything other than DEFAULT requires additional properties:

Property Name / Default Value

●

td_agent_out_elasticsearch_host / NULL

●

td_agent_out_elasticsearch_port / NULL

●

td_agent_out_elasticsearch_index / $ {TAG}

●

td_agent_out_http_URI / NULL

●

td_agent_out_kafka_brokers / NULL

●

td_agent_out_kafka_topic / ${TAG}

●

td_agent_out_tcp_host / NULL

●

td_agent_out_tcp_port / NULL mom_host https://api-

mom.mashery.co m

Only needed for "Tethered" setup.

Accessing QPM Data by Cluster for Untethered Deployments

QPM, or Queries per Month, is the total count of all Traffic/API calls made in a month. It includes all requests regardless of response status.

QPM Implementation

1. Every API request gets captured as an access log.

2. Each access log is transferred to the log service.

3. Every time the log service encounters an in-coming access log, it increments the counter.

The counters are stored in the log pod/container at

. 4. At the turn of every 1 hour, on the zeroeth minute, the counter is written to a disk.

This is similar to cron setting of

. 5. The counter is then reset to 0 for the counts of the next hour.

How to find the QPM

To find the total count of queries for a given month, a convenient script is available on the log pod/

container at

.

You'll need to provide the

parameter to execute the script successfully.

Usage:

getCounts.sh -t|--time mm-yyyy example: getCounts.sh -t 04-2019 or

example: getCounts.sh --time 04-2019

Example execution of getCounts.shgetCounts.sh

/opt/mashery/containeragent/bin/getCounts.sh -t 04-2019

Output:

Counting total number of access logs 234

Finished counting of access logs

How to Check Compliance using QPM Implementation

1. Run the following command (for Docker Swarm) on each Log Pod/Container:

docker exec -it <containerid> /opt/mashery/containeragent/bin/getCounts.sh <mm- yyyy>Exampledocker exec -it <containerid> /opt/mashery/containeragent/bin/

getCounts.sh 04-2019

2. Add up the output for each of the pods.

QPM = LogService1_Total+LogService2_total....+LogService*n*_total

SQL DB

What's Inside

●

MySQL DB

●

SQL DB Loader Services

SQL DB Service

Resource Dependencies

●

MOM Binding

●

Log Producer Binding

●

Registry Binding Properties

Name Default Value Comment

api_Key api key needed to connect to MOM HOST in TIBCO

Cloud

Mashery.

api_Secret api password needed to connect to MOM HOST in

TIBCO Cloud

Mashery.

auto_binding ON When turned ON, logservice urls will be auto- discovered and bound to the TIBCO Mashery Local component.

data_directory /var/lib/mysql The path to the MySQL data directory. Only the last component of the path name is created if it does not exist; the parent directory must already exist or an error occurs.

dimdataLogService

URL log-set-0-0.log-

svc-0.default.svc.cl uster.local

expire_logs_days 30 Specifies the number of days before automatic removal of binary log files.

innodb_buffer_pool

_size 128M The size in bytes of the buffer pool, the memory area where InnoDB caches table and index data.

key_buffer_size 16M It is the size of the buffer used for index blocks. The key buffer is also known as the key cache.

mysql_bin mysql-bin Specifies the base name to use for binary log files.

mysql_log_error /var/log/

mysqld.log Option to determine whether the default error log

destination is the console or a file, and, if a file, the file

name.

Name Default Value Comment mysql_log_error_ver

bosity 1 The verbosity for handling events intended for the

error log, as filtered by the log_filter_internal error log filter component, which is enabled by default.

logserviceURL log-set-0.log- svc.default.svc.clus ter.local

Logservice url to connect to process the logs.

max_allowed_packe

t 16777216 Maximum packet length to send to or receive from

server.

max_binlog_size 1073741824 If a write to the binary log causes the current log file size to exceed the value of this variable, the server rotates the binary logs (closes the current file and opens the next one). The minimum value is 4096 bytes.

The maximum and default value is 1GB.

mom_host https://api-

mom.mashery.com MOM host to connect to sync data from TIBCO Cloud

Mashery.

mom_connect_timeo

ut 30000 Sets a specified timeout value, in milliseconds, to be used when opening a communications link to MOM referenced by a URLConnection.

mom_read_timeout 120000 Sets the read timeout to MOM url to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to MOM. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised.

plugin_load validate_password.

so This option tells the server to load the named plugins at startup. If multiple --plugin-load options are given, only the last one is used.

query_cache_size 8M This system variable was removed in MySQL 8.0.3.

server_id 1234567890 Specifies the server ID. This variable is set by the -- server-id option. The server_id system variable is set to 1 by default. The server can be started with this default ID, but when binary logging is enabled, an informational message is issued if you did not specify a server ID explicitly using the --server-id option.

syncInterval 15 Sync Interval used to sync tokens.

Starting with Mashery Local 5.0, OAuth tokens are not synced with TIBCO Cloud Mashery.

table_open_cache 1000 The number of open tables for all threads. Increasing

this value increases the number of file descriptors that

mysqld requires.

Specifying a password for MySQL database deployed with Docker

At the time of Mashery Local installation, you can specify your own password for a MySQL database deployed with Docker. Specify the password in the following file:

. Change the MySQL password before running

Onprem Loader

The Onprem Loader is a program that syncs with TIBCO Cloud Mashery and loads data into the on- premises database in Mashery Local. The sync process syncs the following SQL data:

●

Developer classes

●

Packages

●

Services

●

HttpsClientSecurity

The following diagram describes the components for scheduling Onprem Loader jobs to storing data objects to the database.

The cron jobs execute the Onprem Loader script periodically. A full sync happens every 1 hour; a partial sync happens every 15 minutes.

The timing for cron jobs is not configurable.

For information on monitoring the Onprem Loader, see Onprem Loader Monitoring.

Cache

What's Inside

●

Memcached Pools

●

Memcached Loader Services

Cache Service

Resource Dependencies

●

SQL DB Binding

●

NoSQL DB Binding

●

Log Producer Binding

●

Registry Binding Configuration Properties

Name Default Value Comments

auto_binding ON When turned ON, sql, logservice urls will be auto- discovered and bound to the TIBCO Mashery Local component.

content_cachesize 384 Cache size for memcache Content Pool content_maxconn 10240 Max connection for memcache Content Pool content_options -o modern Options for memcache Content Pool

content_port 11213 Port for memcache Content Pool

content_user nobody User for memcache Content Pool

Name Default Value Comments

count_cachesize 256 Cache size for memcache Count Pool count_maxconn 10240 Max connection for memcache Count Pool count_options -o modern Options for memcache Count Pool

count_port 11212 Port for memcache Count Pool count_user nobody User for memcache Count Pool logserviceURL log-set-0.log-

svc.default.sv c.cluster.local

Logservice url to connect to process the logs.

mem_cachesize 384 Cache size for memcache Pool mem_maxconn 10240 Max connection for memcache Pool mem_options -o modern Options for memcache Pool

mem_port 11211 Port for memcache Pool

mem_user nobody User for memcache Pool

packager_cachesize 128 Cache size for memcache Packager Pool packager_maxconn 10240 Max connection for memcache Packager Pool packager_options -o modern Options for memcache Packager Pool

packager_port 11215 Port for memcache Packager Pool packager_user nobody User for memcache Packager Pool services_cachesize 128 Cache size for memcache Service Pool services_maxconn 10240 Max connection for memcache Service Pool services_options -o modern Options for memcache Service Pool

services_port 11214 Port for memcache Service Pool services_user nobody User for memcache Service Pool

sqlURL mysql-

set-0.mysql- svc.default.sv c.cluster.local

MYSQL url to connect to load data from

updateddevclass 10 Sync dev classes updated in the last X minutes. X is the

value of this property.

Name Default Value Comments updatedhttpsclients

ecurity 30 Sync https client security information updated in the last X minutes. X is the value of this property.

updatedmapi 10 Sync mapi's updated in the last X minutes. X is the value of this property.

updatedpackager 30 Sync packager's updated in the last X minutes. X is the value of this property.

updatedservice 10 Sync services updated in the last X minutes. X is the value of this property.

Memcache Loader

The Memcache Loader is a program that updates the following in the different Memcache pools:

●

Mapis

●

Developer classes

●

Packages

●

Services

●

HttpClientSecurity

The following diagram describes the components for scheduling Memache Loader jobs to storing data objects to memcache pools.

The cron jobs execute the Memcache Loader script periodically. A full sync happens every 1 hour; a partial sync happens every 15 minutes.

The timing for cron jobs is not configurable.

For information on monitoring the Memcache Loader, see Memcache Loader Monitoring.

Traffic Manager

What's Inside

●

Java and Jetty Traffic Manager

●

OAuth Services

●

Traffic Manager Service

●

OAuth Service

Resource Dependencies

●

SQL DB Binding

●

NoSQL Binding

●

Cache Binding

●

Log Producer Binding

●

Registry Binding Properties

Name Default Value Comments

auto_binding ON When turned ON, sql, cache and logservice urls will be auto-discovered and bound to the TIBCO Mashery Local component.

http_conn_manager_

max_total 256 Caps the maximum supported backend client connections at any given time.

jetty_acceptqueuesiz

e 10 (256 in

code) Jetty Queue size.

jetty_maxidletime 18000 (30000

in code) Jetty Maximum Idle time.

Name Default Value Comments jetty_pool_maxthrea

ds 500 (500 in

code) Maximum number of jetty threads to be running logserviceURL log-

set-0-0.log- svc-0.default.s vc.cluster.loca l

Logservice URL is used to communicate with logservice component which processes the Traffic Manager logs.

mail_protocol smtp TCP/IP protocol used in sending and receiving e-mail.

mail_smtp_host The SMTP server to connect to.

mail_smtp_passwor

d Password to connect to SMTP.

mail_smtp_port The SMTP server port to connect to, if the connect() method doesn't explicitly specify one. Defaults to 25.

mail_smtp_user Default user name for SMTP.

mail_smtps_host The SMTPS server to connect to.

mail_smtps_passwor

d Password to connect to SMTPS.

mail_smtps_port The SMTPS server port to connect to, if the connect() method doesn't explicitly specify one. Defaults to 465.

mail_smtps_user Default user name for SMTPS.

max_uri_len_for_acc

esslog 2048 This property is used to limit the maximum length of uri data being written to the access log.

java_security_negati

ve_cache_lookups 0 Specified in java.security to indicate the caching policy for unsuccessful name lookups from the name service. The value is specified as integer to indicate the number of seconds to cache the failure for unsuccessful lookups.

java_security_cache_

lookups 0 Specified in java.security to indicate the caching policy for successful name lookups from the name service. The value is specified as integer to indicate the number of seconds to cache the successful lookup.

nosqlURL cass-

set-0.cass- svc.default.sv c.cluster.local

NoSQL URL is used to communicate with registry service.

oauth_http_enabled TRUE OAuth HTTP is enabled by default.

oauth_http_port 9083 HTTP port for OAuth.

Name Default Value Comments

oauth_https_enabled TRUE OAuth HTTPS is enabled by default.

oauth_https_port 8083 HTTPS port for OAuth.

sqlURL mysql-

set-0.mysql- svc.default.sv c.cluster.local

SQL URL is used to communicate with the SQL component to get the data.

vmargs "-d64 \n-

Xmx1024m" VM arguments that typically change the behavior of the Java Virtual Machine (JVM). Here, Xmx argument allows the Java heap to grow.

Cluster Manager

The Cluster Manager component provides a Topology Manager CLI that accesses the registry to report on the Cluster components, their states, bindings, and properties.

Cluster Manager CLI

Cluster Manager CLI is a command-line utility that works with the Mashery Local 5.0 registry API to:

●

Get all Clusters: `clustermanager list clusters`

●

Use one of the clusters: `clustermanager use cluster <cluster-id>`

●

Get all Zones: `clustermanager list zones`

●

Use one of the zones: `clustermanager use zone <zone-id>`

●

Get all nodes of different types in a zone: `clustermanager list nodes --type=<node-type>` or get all nodes in a zone: `clustermanager list nodes`

The following are valid node types:

The Cluster Manager CLI is a binary that is aware of its own Cluster and Zone context.

The CLI container is also aware of how many "initial" set of components form the cluster:

●

How many zones in the cluster

●

How many NoSQL, SQL, Cache, Log Service, TrafficManager (TM) components in each zone

●

The Cassandra Data Centers (DCs) and the replication factor

●

The registry URL

The CLI acts as the client to the following set of services:

1. The Registry APIs

The CLI uses the Registry for most of its operations such as:

●

Listing of Clusters

●

Listing of Zones in a cluster

●

Listing of Components in a zone

●

Listing of Config properties for a Component ID

●

Listing of Config properties for all components of a Component Type in the zone, e.g. common

properties across all SQL components in the zone

●

Listing of Config properties for all components of a Component Type in the cluster, e.g. common properties across all SQL components across all the zones in a cluster

●

Setting config properties on component/zone/cluster

●

Listing of Resource Bindings for a Component ID

●

Setting of Resource Bindings for all components of a Component Type in the zone, e.g. bind all TMs in a zone to a specific SQL component in the zone

2. The Agent APIs

The CLI uses the Agent APIs for some of its operations that affect the lifecycle of the Agent.

●

Set new config property - The CLI sets the Agent state to "UNSATISFIED" thereby causing the Agent to go through its lifecycle again.

●

Set new resource binding - The CLI sets the Agent state to "UNSATISFIED" thereby causing the Agent to go through its lifecycle again.

●

Set log level.

●

Set log sync interval.

●

Set verbose logging.

3. Certificate Management Local APIs

●

Lists certificates/identities.

●

Sets certificates/identities with new certificates.

CLI Commands Valid Usage:

Valid Cluster Manager Usage

[root@cm-deploy-0-856b6c784c-x278w builder]# clustermanager A command-line application to manage the Mashery 5.0 topology Usage:

clustermanager [command]

Available Commands:

deploy Deploy Mashery cluster topology help Help about any command

inspect Inspect the cluster deployment or configs of components in a zone list List of [clusters|zones|components|loggers|config|bindings|identities|

certificates] in the topology

set Set configuration, bindings, loggers, logsyncinterval, identities &

trust certificates in the topology

use Use available cluster or zone

version Print the version number of clustermanager CLI Flags:

-h, --help help for clustermanager

Use "clustermanager [command] --help" for more information about a command.

[root@cm-deploy-0-856b6c784c-x278w builder]# alias cm=clustermanager

Command Help:

Cluster Manager Help

[root@cm-deploy-0-856b6c784c-x278w builder]# cm --help

A command-line application to manage the Mashery 5.0 topology Usage:

clustermanager [command]

Available Commands:

deploy Deploy Mashery cluster topology help Help about any command

inspect Inspect the cluster deployment or configs of components in a zone list List of [clusters|zones|components|loggers|config|bindings|identities|

certificates] in the topology

set Set configuration, bindings, loggers, logsyncinterval, identities &

trust certificates in the topology

use Use available cluster or zone

version Print the version number of clustermanager CLI Flags:

-h, --help help for clustermanager

Use "clustermanager [command] --help" for more information about a command.

Command Specific Help:

Cluster Manager Command Specific Help

[root@cm-deploy-0-856b6c784c-x278w builder]# cm deploy --help Deploy Mashery cluster topology using the deployment file Usage:

clustermanager deploy [flags]

Flags:

--file string path to the cluster deployment descriptor file -h, --help help for deploy

[root@cm-deploy-0-856b6c784c-x278w builder]# cm inspect --help Inspect the cluster deployment or configs of components in a zone Usage:

clustermanager inspect [flags]

clustermanager inspect [command]

Available Commands:

cluster Inspect the cluster

configs Inspect configs in a cluster Flags:

-h, --help help for inspect

Use "clustermanager inspect [command] --help" for more information about a command.

[root@cm-deploy-0-856b6c784c-x278w builder]# cm list --help

List of [clusters|zones|components|loggers|config|bindings|identities|certificates]

in the topology Usage:

clustermanager list [flags]

clustermanager list [command]

Aliases:

list, ls

Available Commands:

bindings List of resource bindings of a specific component

certificates List of trust certificates available for the cluster & zone clusters List of clusters in the topology

components List of Tibco Mashery Components in a zone

config List of configuration settings for a specific component identities List of identities available for the cluster & zone loggers List of loggers available for a specific component zones List of zones in a cluster

Flags:

-h, --help help for list

[root@cm-deploy-0-856b6c784c-x278w builder]# cm set --help

Set configuration, bindings, loggers, logsyncinterval, identities & trust certificates in the topology

Usage:

clustermanager set [flags]

clustermanager set [command]

Available Commands:

binding Set resource binding for a component

certificate Set certificate in the scope of a cluster/zone

config Set configuration property in the scope of a cluster/zone/

component

identity Set identity in the scope of a cluster/zone

loglevel Set log level in the scope of a cluster/zone/component

logsyncinterval Set log sync interval in minutes [range 1-59] in the scope of a cluster/zone

verboselog Set verbose log for traffic manager(s) in the scope of a cluster/

zone/component Flags:

-h, --help help for set

[root@cm-deploy-0-856b6c784c-x278w builder]# cm use -h Use available cluster or zone in the topology

Usage:

clustermanager use [flags]

clustermanager use [command]

Available Commands:

cluster Use available cluster

zone Use available zone in a cluster Flags:

-h, --help help for use

[root@cm-deploy-0-856b6c784c-x278w builder]# cm version -h All software has versions. This is Cluster Manager CLI's Usage:

clustermanager version [flags]

Version

Command:clustermanager version

Command Objective: To get the current version of the Cluster Manager Command Usage:

Version

[root@a9fc970f406e bin]# clustermanager version Mashery Cluster Manager v1.0

Deploy

Command: clustermanager deploy

Command Objective:To deploy a cluster topology using a deployment file Command Help:

Deploy Help

[root@a9fc970f406e bin]# clustermanager deploy --help Deploy Mashery cluster topology using the deployment file Usage:

clustermanager deploy [flags]

Flags:

--file string path to the cluster deployment descriptor file -h, --help help for deploy

Command Valid Usage:

Deploy Valid Usage

[root@a9fc970f406e bin]# clustermanager deploy Creating the deployment..

2018/11/20 23:23:03 Deploying {

"clusterName": "SampleCluster", "zoneNames": [

{

"name": "local"

} ],

"tmCount": 2, "dsCount": 1, "oauthCount": 1, "cacheCount": 1, "sqlCount": 1, "logCount": 1, "nosqlCount": 1 }

Successfully created the deployment for cluster [SampleCluster]

Use

Command: clustermanager use

Command Objective: To allow the user to select the scope of subsequent operations. Valid scopes are Cluster

Command Help:

Use Help

[root@b6caa48479da builder]# clustermanager use --help Use available cluster or zone in the topology

Usage:

clustermanager use [flags]

clustermanager use [command]

Available Commands:

cluster Use available cluster

zone Use available zone in a cluster Flags:

-h, --help help for use

Command Valid Usage:

Select Cluster Scope

[root@cm-deploy-0-856b6c784c-x278w builder]# cm use cluster 8d6f22d1-8797-43d6-9f54-57533ab1d560

Using cluster [Tibco Mashery Local Reference Cluster]

Select Zone Scope

[root@cm-deploy-0-856b6c784c-x278w builder]# cm use zone 535db9aa-e58c-4939-9b14- e4e5746f3b44

Using cluster [Tibco Mashery Local Reference Cluster]

Using Zone [local]

Command Invalid Usage:

Invalid Usage: Select Cluster Scope

[root@cm-deploy-0-856b6c784c-x278w builder]# cm use cluster Tibco No matching cluster found: Tibco

Invalid Usage: Select Zone Scope

[root@cm-deploy-0-856b6c784c-x278w builder]# cm use zone local No matching zone found: local

Registry APIs List

Command: clustermanager list Command Help:

List Help

[root@b6caa48479da builder]# clustermanager list --help

List of [clusters|zones|components|loggers|config|bindings|identities|certificates]

in the topology Usage:

clustermanager list [flags]

clustermanager list [command]

Aliases:

list, ls

Available Commands:

bindings List of resource bindings of a specific component

certificates List of trust certificates available for the cluster & zone clusters List of clusters in the topology

components List of Tibco Mashery Components in a zone

config List of configuration settings for a specific component identities List of identities available for the cluster & zone loggers List of loggers available for a specific component zones List of zones in a cluster

Flags:

-h, --help help for list

Subcommand: clustermanager list clusters

Subcommand Objective: To list all the available clusters.

The default list display format is "table Subcommand Help:

List Clusters Help

[root@b6caa48479da builder]# clustermanager list clusters --help List of clusters in the topology

Usage:

clustermanager list clusters [flags]

Flags:

-h, --help help for clusters

Subcommand Valid Usage:

List of Clusters

[root@cm-deploy-0-856b6c784c-x278w builder]# cm list clusters Cluster ID Cluster Name

--- --- 8d6f22d1-8797-43d6-9f54-57533ab1d560 Tibco Mashery Gat...

Note: The cluster name displays the leading 20 characters of the Cluster name and truncates the rest in table display.

The display format can be changed to "json".

List of Clusters (JSON output)

[root@cm-deploy-0-856b6c784c-x278w builder]# TMG_CLI_OUTPUT=json eval 'cm ls clusters'

[ {

"clusterId": "8d6f22d1-8797-43d6-9f54-57533ab1d560", "name": "Tibco Mashery Local Reference Cluster", "createdTime": ""

} ]

Subcommand: clustermanager list zones

Subcommand Objective: To list all the available zones in the selected cluster. This command executes successfully only after selecting one of the available clusters via "use" command. (Please refer to "use"

command section for details.) Subcommand Help:

List Zones Help

[root@b6caa48479da builder]# clustermanager list zones --help List of zones in a cluster in the topology

Usage:

clustermanager list zones [flags]

Flags:

-h, --help help for zones

Subcommand Valid Usage:

List of Zones

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls zones Using cluster [Tibco Mashery Local Reference Cluster]

Zone ID Zone Name

--- --- 535db9aa-e58c-4939-9b14-e4e5746f3b44 local

Subcommand: clustermanager list components

Subcommand Objective: To list all the available components in a zone.

Subcommand Help:

List Components Help

[root@b6caa48479da builder]# clustermanager list components --help List of Tibco Mashery Components in a zone a cluster in the topology Usage:

clustermanager list components [flags]

Flags:

--clusterId string cluster ID of the component

--componentType string type of the component, valid types [sql, nosql, cache, trafficmanager, logservice]

-h, --help help for components --zoneId string zone ID of the component

Subcommand Valid Usage:

List of Components in a zone

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls components Using cluster [Tibco Mashery Local Reference Cluster]

Using Zone [local]

Component ID Component Type Component Name Component Status Component Host Component Agent Port Component Service Port(s)

--- --- --- --- --- ---

---

5c01c72c-11a8-4bed-ba8f-2421bc931499 sql sql ACTIVE 10.244.1.5 9080 3306

20580ccd-13b1-4662-8827-e07cf3fce567 nosql nosql ACTIVE 10.244.1.2 9080 9042

b30b7141-29dc-4c6f-9bf6-fc0317e6f32e cache cache ACTIVE 10.244.1.6 9080

11212,11211,11213,11214,11215,11216

a08bba64-8a39-4fa6-9fba-4d99e82816e4 trafficmanager tm ACTIVE 10.244.1.7 9080 8080

ce22559e-d6b7-4501-8575-e83fa45f91a2 logservice log ACTIVE 10.244.1.4 9080 24224

Subcommand: clustermanager list config

Subcommand Objective: To list component configuration properties Subcommand Help:

List Component Properties Configuration Help

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls config --help

List of configuration settings for a specific component in the topology Usage:

clustermanager list config [flags]

Flags:

--all get all the configs from agent --clusterId string cluster ID of the component --componentId string ID of the component

--componentType string type of the component, valid types [sql, nosql, cache, trafficmanager, logservice]

-h, --help help for config

--zoneId string zone ID of the component

Subcommand Valid Usage:

Response prior to setting the configuration properties for a given component:

Empty Property Response

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls config --componentId 5c01c72c-11a8-4bed-ba8f-2421bc931499 --componentType sql

clusterId [8d6f22d1-8797-43d6-9f54-57533ab1d560] and zoneId [535db9aa- e58c-4939-9b14-e4e5746f3b44]

No settings found for the given componentId [5c01c72c-11a8-4bed-ba8f-2421bc931499]

of type [sql]

Response after setting the configuration properties for a given component:

Valid Property List Response

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls config --componentId 5c01c72c-11a8-4bed-ba8f-2421bc931499 --componentType sql

clusterId [8d6f22d1-8797-43d6-9f54-57533ab1d560] and zoneId [535db9aa- e58c-4939-9b14-e4e5746f3b44]

Using cluster name [Tibco Mashery Local Reference Cluster]

Using Zone name [local]

Using Component ID [5c01c72c-11a8-4bed-ba8f-2421bc931499] of type [sql]

Property Value Handler Is Encoded? File Destination

--- --- --- --- ---

DUMMY_KEY DUMMY_VAL false

List All Config Properties

[root@cm-deploy-0-67548f4d56-j5j45 builder]# cl ls config --componentId 27b445c3-6656-4548-aff1-30ff84d83ec9 --componentType sql --all

clusterId [3a199dba-c433-4a45-aec6-41983eccb3e8] and zoneId [a81a9fa1-834b-409d-9042-9b405c32a83e]

Agent config files are stored under /root/config-27b445c3-6656-4548- aff1-30ff84d83ec9.zip

Using cluster name [Tibco Mashery Local Example Cluster]

Using Zone name [Tibco Mashery Local Example Zone]

Using Component ID [27b445c3-6656-4548-aff1-30ff84d83ec9] of type [sql]

Property Value Handler Is Encoded? File Destination

--- --- --- --- ---

apiKey testkey123 string false /etc/mashery/proxy.json

apiSecret testsecret345 string false /etc/proxy.json

If no configs are set for a component using CLI then registry won't be having any configs and you will see following message.

No settings found for the given componentId

<your_component_id > of type <your_component_type>

Subcommand: clustermanager list bindings

Subcommand Objective: To list Resource Bindings used by a component.

Subcommand Help:

Help for listing Resource Bindings for a Component

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls bindings --help

List of other components that a given component is using as its resource binding dependency

Usage:

clustermanager list bindings [flags]

Flags:

--clusterId string cluster ID of the component --componentId string ID of the component

--componentType string type of the component, valid types [sql, nosql, cache, trafficmanager, logservice]

-h, --help help for bindings

--resourceType string type of resource binding, valid types [sql, nosql, cache, trafficmanager, logservice]

--zoneId string zone ID of the component

Subcommand Valid Usage:

List All the Resource Bindings of a Component

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls bindings --componentId

a08bba64-8a39-4fa6-9fba-4d99e82816e4 --componentType trafficmanager --resourceType sql

clusterId [8d6f22d1-8797-43d6-9f54-57533ab1d560] and zoneId [535db9aa- e58c-4939-9b14-e4e5746f3b44]

Using cluster name [Tibco Mashery Local Reference Cluster]

Using Zone name [local]

Using Component ID [a08bba64-8a39-4fa6-9fba-4d99e82816e4] of type [trafficmanager]

ComponentID Status

--- --- 5c01c72c-11a8-4bed-ba8f-2421bc931499 connected

[root@cm-deploy-0-856b6c784c-x278w builder]# cm ls bindings --componentId

a08bba64-8a39-4fa6-9fba-4d99e82816e4 --componentType trafficmanager --resourceType cache

clusterId [8d6f22d1-8797-43d6-9f54-57533ab1d560] and zoneId [535db9aa- e58c-4939-9b14-e4e5746f3b44]

Using cluster name [Tibco Mashery Local Reference Cluster]

Using Zone name [local]

Using Component ID [a08bba64-8a39-4fa6-9fba-4d99e82816e4] of type [trafficmanager]

ComponentID Status

--- --- b30b7141-29dc-4c6f-9bf6-fc0317e6f32e connected

Set

Command: clustermanager set

Command Objective: To update the existing component with various parameters.

Command Help:

Set Configuration Setting Help:

Set Config Help

[root@b6caa48479da builder]# clustermanager set config --help Set configuration property in the scope of a cluster/zone/component Usage:

clustermanager set config [flags]

Flags:

--clusterId string cluster ID of the component --componentId string ID of the component

--componentType string type of the component, valid types [sql, nosql, cache, trafficmanager, logservice]

-h, --help help for config --prop string Config property name --value string Config property value --zoneId string zone ID of the component

Set Resource Binding Help:

Set Resource Binding Help

[root@cm-deploy-0-856b6c784c-x278w builder]# cm set binding --help Set resource binding for a component

Usage:

clustermanager set binding [flags]

Flags:

--clusterId string cluster ID of the component --componentId string ID of the component

--componentType string type of the component, valid types [sql, nosql, cache, trafficmanager, logservice]

-h, --help help for binding

--resourceId string ID of the resource binding

--resourceType string type of resource binding, valid types [sql, nosql, cache, trafficmanager, logservice]

--zoneId string zone ID of the component

[root@cm-deploy-0-856b6c784c-x278w builder]# cm set binding --componentId

a08bba64-8a39-4fa6-9fba-4d99e82816e4 --componentType trafficmanager --resourceId 5c01c72c-11a8-4bed-ba8f-2421bc931499--resourceType sql

Updating the TML after the change

Successfully updated the TML component a08bba64-8a39-4fa6-9fba-4d99e82816e4 for components of type trafficmanager

Successfully set the resource binding for the the component a08bba64-8a39-4fa6-9fba-4d99e82816e4 of type trafficmanager

Set Verbose Logging Help:

Set Verbose Logging Help

[root@37268c01c6dd builder]# cm set verbose -h

Set verbose log for traffic manager(s) in the scope of a cluster/zone/component Usage:

clustermanager set verboselog [flags]

Aliases:

verboselog, verbose