Important Information
TIBCO Documentation and Support Services
Mashery Local Overview
TIBCO Mashery Local Topology
TIBCO Mashery Local Component Interactions
Quick Start
Mashery Local Components
Components Overview
NoSQL
Registry
Log Service
Accessing QPM Data by Cluster for Untethered Deployments
SQL DB
Onprem Loader
Cache
Memcached Loader
Traffic Manager
TLS Security
Cluster Manager
Cluster Manager CLI
Mashery Local API
Configuration Manager Overview
Mashery Local Installer
TIBCO Mashery Local Installer Overview
HTTP Proxy Support
Deploying the TIBCO Mashery Local Installer
How to Run the Mashery Local 5 Installer on Windows
Managing the TIBCO Mashery Local Installer
Prebuilding
Building and Verifying the Docker Images
Prepushing
Pushing the Docker Images
Deploying the TIBCO Mashery Local Cluster
Installing MySQL Standard (Commercial) Edition in Mashery Local
Deploying a Mashery Local Cluster
Platform and Deployment Options
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
Configuring Properties Common to All Deployments
Changing the MySQL Password of a Running Mashery Local Cluster
API Debug Key Common to All Deployments
Deployments on Amazon AWS
Changes in Mashery Local 5.2 for Amazon AWS Deployments
AWS using Kubernetes
Prerequisites
Planning and Configuring the Mashery Local Cluster
Planning
Configuration
Prebuild
Building and Customizing Deployment
Creating Mashery Local Docker Images
Pushing Mashery Local Docker Images to the AWS Registry
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Customizing Mashery Local Properties
Service Configuration Data
Customizing the Mashery Local Deployment Manifest
Creating a Kubernetes Cluster on AWS
Creating a Mashery Local Cluster
Note about Creating Kubernetes and Mashery Local Clusters
Validating a Mashery Local Cluster
Stopping and Starting the Cluster while Keeping the Cluster State Intact
Deleting a Cluster
Clearing the AWS Registry
AWS EKS using Kubernetes
Prerequisites
Planning and Configuring the Mashery Local Cluster
Planning
Configuration
Prebuild
Building and Customizing Deployment
Creating Mashery Local Docker Images
Pushing Mashery Local Docker Images to the AWS Registry
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Customizing Mashery Local Properties
Service Configuration Data
Customizing the Mashery Local Deployment Manifest
Creating a Kubernetes Cluster on AWS
Creating a Mashery Local Cluster
Note about Creating Kubernetes and Mashery Local Clusters
Validating a Mashery Local Cluster
Stopping and Starting the Cluster while Keeping the Cluster State Intact
Deleting a Cluster
AWS using Docker Swarm
Prerequisites
Planning and Configuring the Mashery Local Cluster
Planning
Configuration
Prebuild
Building and Customizing Deployment
Creating Mashery Local Docker Images
Pushing Mashery Local Docker Images to the AWS Registry
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Customizing Mashery Local Properties
Service Configuration Data
Customizing the Mashery Local Deployment Manifest
Creating a Docker Swarm Cluster in AWS
Creating a Mashery Local Cluster
Validating a Mashery Local Cluster
Deleting a Mashery Local Cluster
Deployments on Microsoft Azure
Changes in Mashery Local 5.2 for Microsoft Azure Deployments
Azure using Kubernetes
Multi-zone Deployment in Azure Kubernetes Service
Prerequisites
Planning and Configuring the Mashery Local Cluster
Planning
Configuration
Prebuild
Building and Customizing Deployment
Creating Mashery Local Docker Images
Pushing Mashery Local Docker Images to Azure
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Customizing Mashery Local Properties
Service Configuration Data
Customizing the Mashery Local Deployment Manifest
Creating an Azure Kubernetes Cluster
Creating a Mashery Local Cluster
Note about Creating Kubernetes and Mashery Local Clusters
Validating a Mashery Local Cluster
Stopping and Starting the Cluster while Keeping the Cluster State Intact
Deleting a Cluster
Azure using OpenShift
Prerequisites
Planning and Configuring the Mashery Local Cluster
Planning
Configuration
Prebuild
Building and Customizing Deployment
Creating Mashery Local Docker Images
Pushing Mashery Local Docker Images to Azure
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Customizing Mashery Local Properties
Service Configuration Data
Customizing the Mashery Local Deployment Manifest
Creating an Azure OpenShift Cluster
Creating a Mashery Local Cluster
Validating a Mashery Local Cluster
Stopping and Starting the Cluster while Keeping the Cluster State Intact
Deleting a Mashery Local Cluster
Azure using Docker Swarm
Prerequisites
Planning and Configuring the Mashery Local Cluster
Planning
Configuration
Prebuild
Building and Customizing Deployment
Creating Mashery Local Docker Images
Pushing Mashery Local Docker Images to Azure
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Customizing Mashery Local Properties
Service Configuration Data
Customizing the Mashery Local Deployment Manifest
Creating a Docker Swarm Cluster (Azure Swarm)
Creating a Mashery Local Cluster
Validating a Mashery Local Cluster
Making an API Traffic Call
Deleting a Mashery Local Cluster
Deployment on Google Cloud Platform using Kubernetes
Prerequisites
Planning and Configuring the Mashery Local Cluster
Planning
Configuration
Prebuild
Building and Deploying
Creating Docker Images
Push Docker Images to GCP Container Registry from Mashery Local Installer
Customizing Mashery Local Deployment Manifest from Mashery Local Installer
Generating Deployment Scripts
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Creating a GCP Kubernetes Cluster
Creating a Mashery Local Cluster
Note about Creating Kubernetes and Mashery Local Clusters
Verifying a Mashery Local Cluster
Stopping and Starting the Cluster while Keeping the Cluster State Intact
Deleting a Cluster
For Advanced Users
Deployment on On-premises Bare Metal using Swarm
Prerequisites
Planning and Configuring
Planning
Configuring
Files to Modify
Mashery Local Cluster Configuration
Mashery Local Component Configuration
Setting up Mashery Service Configuration Data
Option 1: Using Mashery Local Configuration Manager
Option 2: Synchronizing Service Configuration data from Mashery On-premise Manager (MOM)
Building and Customizing Deployment
Customizing the Mashery Local Deployment Manifest
Creating a Docker Swarm Cluster
Creating a Mashery Local Cluster
Validating a Mashery Local Cluster
Making a Traffic Call
Deleting a Mashery Local Cluster
Deployment on On-premises VirtualBox using Kubernetes
Prerequisites
Planning and Configuring the Mashery Local Cluster
Files to Modify
Mashery Local Cluster Configuration
Setting Mashery Service Configuration Data
Building and Customizing Deployment
Customizing Deployment Artifacts and Building Deployment Package
Generating Deployment Scripts
Creating a Kubernetes Cluster
Creating a Mashery Local Cluster
Note about Creating Kubernetes and Mashery Local Clusters
Validating a Mashery Local Cluster
Making a Traffic Call
Stopping and Starting the Cluster while Keeping the Cluster State Intact
Deleting the Mashery Local Cluster
Deployment on On-premises VirtualBox using Swarm
Prerequisites for Deployment on On-premises VirtualBox using Swarm
Planning and Configuring
Building and Customizing Deployment
Customizing Deployment
Generating Deployment Scripts
Creating a Swarm Cluster
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 ESX VMWare using Swarm
Prerequisites
Planning and Configuring
Planning
Configuration
Files to modify
Building and Customizing Deployment
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
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
Deployment on On-premises VMWare using PKS
Prerequisites
Building and Customizing Deployment
Building and Deploying
Customizing Deployment Artifacts and Building Deployment Package
Updating Platform API Properties
Preparing KeyStores for Traffic Manager
Preparing KeyStores for Configuration Manager
Building Deployment Package
Planning and Configuring the Mashery Local Cluster
Creating a PKS Kubernetes Cluster
Creating a Mashery Local Cluster
Validating a Mashery Local Cluster
Deleting a Mashery Local Cluster
Configuration Manager
Managing Configuration Data
Configuring Zone Settings
Content Security Policy Editor
Configuring API Definitions and Endpoints
Configuring API Packages and Plans
Configuring Apps and Package Keys
Configuring API Domains
Configuring Members
Configuring Roles
Configuring API HTTPS Client Profiles
Configuring the Content Management System
Setting Advanced Options
Managing Developer Portal Content
Searching Package Keys
Configuring Interactive Documentation
Configuring Portal Domains
Managing Portal Settings
Managing Organizations
Managing Schedule Maintenance Events
FAQ and Troubleshooting
Developer Portal
Getting Started
Portal Roles
Default Developer Portal Pages
Configuring your Developer Portal Pages
Advanced Customizations for your Developer Portal
Customizing your CSS
Modifying Templates and Layouts
Getting Started
Using User-Specific Data
Creating Form Field HTML
Adding, Removing, and Reordering Fields
Adding Translation Strings
Loading Custom Fonts
Getting Started
Using Fonts and Handling Performance Issues
Configuring Developer Portal Settings
Default Developer Portal Settings
Changing Developer Portal Settings
Getting Developer Portal Settings
Updating Your Logo
Including Mashery Plugins
Getting Started
Toggling Password Visibility
Adding Third-party Scripts, Styles, and Plugins
Loading Scripts
Loading Styles
Initializing Plugins
Translations
Getting Started
Updating a Single String
Adding Multi-Language Support
Translation Strings Reference
JavaScript APIs
API Calls and HTTP Requests
Events
Forms
General
Navigation
Notifications
Plugins
Rendering
Sanitize
Session
Settings
Storage
Templates
Translations
Utilities
Deploying Default Portal Customizations and Assets to Your Clusters
Phase: Design and Development
Zip File Contract Details
Phase: Production
Managing Logs in a Cluster
Viewing Logs
Interacting with Loggers
Collecting Logs
Performing Log Cleanup
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
Recipe for Database
Recipe for Forward
Integrating with TIBCO Spotfire
Preparing TIBCO Spotfire to Consume Access Logs
Changing Output Destinations for Different Types of Logs using CLI
JSON Configuration Files Format for Different Outputs
TIBCO Mashery Local Access Log Sync
HTTPS Configuration
HTTPS Configuration Overview
HTTPS Server Configuration
Mashery Traffic Manager as an HTTPS Server without Mutual SSL
Mashery Traffic Manager as an HTTPS Server with Mutual SSL
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 Mode
Mashery Local SDK Based Adapters and Processors
Quick Start
Getting Started
Creating an Adapter Project
Packaging the Adapter
Uploading the Build Adapters to Mashery Local-Installer Build Job
Building the Changing TIBCO Mashery Local-TM Docker image with Customer-Provided Adapters or Processors
Configuring Endpoints for Processors
Upgrading the Mashery Local SDK 5.2 or 5.3 to Mashery Local SDK 5.3.1
The Mashery Local 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
Using the Adapter SDK in an IDE
Creating an Adapter using Eclipse
Creating an Adapter using IntelliJ IDEA
Creating an Adapter using Apache NetBeans
Adding Third-Party Libraries in an Adapter
Referring to Third-party Libraries with Dependency
Debugging the Adapter
Adding Logger Utility Class
Changing Log Levels
Checking Adapter Logs
Debugging SDK Processor Remotely
Importing Existing Adapters
Developing and Packaging Multiple Adapters
Implementing and Registering Processors or Adapters
Implementing a Processor or Adapter
Creating a Pre-processing Adapter
Reading Body Content of Request
Modifying the Request Body
Terminating Further Processing for Unavailable Header
Creating a Post-processing Adapter
Add Custom Header to the Response to Client
Modifying Body Content of Response to Client
Creating a Custom Authenticator
Stopping a Processing Request on Authentication Failure
Continue Processing Request for Successful Authentication
Implementing the Event Listener
Implementing Lifecycle Callback Handling
Caching Content
Terminating a Call During Processing of an Event
Accessing Package Key EAVs in the Custom Processor
Accessing Plan, Package and Application ID in Custom Processor
Chaining of Processors
FAQs
OAuth
Configuring OAuth 2.0 API Access
OAuth APIs and Authenticator Service
Making OAuth 2.0 Calls
OAuth API Supported Methods
Sample Calls
Mashery Local 5.x 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
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
Memcached Loader Monitoring
Diagnostic Recipe and Alerts for Memcached Loader
Functional Monitoring
Recipes for ELK
Connectors and Adapters
TIBCO-provided Connectors and Adapters
Verifying the Mashery Connectors and Adapters
FAQs
Customer-provided Adapters
Troubleshooting