Go to Advanced tab as shown below

● 'jq' must be installed on your machine.

● You have the TIBCO Mashery Local Installer in tar.gz format (Example : TIB_mash-local_5.2.0.60_cf.tar.gz) on your machine.

Platform Prerequisites

The quick start setup is supported on Linux-based and MacOS-based machines. Quick start uses the local physical machine and not a virtual machine. It sets up a bare-metal swarm cluster of one node (the local physical machine) and one instance of each type of component. It creates a Docker overlay

network for the components to communicate over. There are no additional prerequisites for the quick start setup.

Planning

The Mashery Local cluster has a single, logical zone, one instance of each type of component, and uses the local machine as the single node. No additional planning is required for the quick start setup.

Configuration

The Mashery Local cluster created using the quick start setup uses the untethered mode of

configuration. It uses default credentials and does not need any user inputs to configure the properties, sizes or credentials.

Building and Deploying

1. Extract the Installer tar.gz file to your desired location and navigate to the folder /<Extracted Folder>/tml-quickstart/ on your terminal.

2. For smooth execution, if it recommended to stop any previously-running tml-installer container (if any) and remove the volme associated with it. Execute the following command in sequence. This step can be skipped if you are running tml-installer for the first time.

Sample execution 1. docker ps -a

2. docker kill <tml-installer container id>

3. docker volume rm -f tml-quickstart_jenkinsvol

3. Execute the script "quick-start.sh" with parameters. The script accepts two parameters:

● -b

● -d

Currently, these parameters are mandatory.

Sample execution

./quick-start.sh -b true -d true

Set ^-b to build the image.

Set ^-d to true to create a Mashery Local cluster.

4. The installer will use default inputs and build the Mashery Local images.

5. The quick start script will then create an overlay Docker network, use swarm to create a single node cluster and proceed to create the simple Mashery Local cluster.

6. If everything goes well, the Mashery Local cluster should be ready in around 30-35 minutes (Including Mashery Local image building and deployment). At the end of the deployment stage, you may see the message Waiting for TML components to be ready for a long time (10-15 minutes) until everything is active.

7. The Developer Portal can be accessed at https://localhost:10443/ and Configuration Manager can be accessed at https://localhost:10443/admin.

Since the cluster is created with default values, you can use the following default username and password to login into Configuration Manager:

UserName: ^admin

Password: Ap1Us3rPasswd

The default username and password used to log in to the Configuration Manager can also be found in the tml_papi_properties.json file (see the Platform API Properties topic in Configuring Properties Common to all Deployments).

Troubleshooting

If you see the error Error response from daemon: This node is not a swarm manager. Use

"docker swarm init" or "docker swarm join" to connect this node to swarm and try again during execution, follow the steps below:

1. Stop/kill the running script.

2. Run docker swarm init.

3. Rerun the quick start with parameters:

./quick-start.sh -b false -d true

Other Use Cases

To only build the image, run the followng script:

./quick-start.sh -b true -d false

If you built the image previously, and now want to run deployment only, run the following script:

./quick-start.sh -b false -d true

Validating the Mashery Local Cluster

Now that the build stage is done, if the deployment is still running, you can check on the progress using following steps: 9160/tcp nosqlstack_nosql_seed.1.n2ci4fu3i75kc80lq7p49v24x

5bd04361f7ee tml-installer:v5.2.0.119 "/sbin/tini -- /usr/…" 26 minutes ago Up 26 minutes 0.0.0.0:8080->8080/tcp,

0.0.0.0:50000->50000/tcp tml-installer

2. Log in to the Configuration Manager container and check the components and their states:

$ docker exec -ti 5a527d7ef2ab bash [root@5a527d7ef2ab builder]#

[root@5a527d7ef2ab builder]# alias cm=clustermanager [root@5a527d7ef2ab builder]# cm ls components

Using cluster [Tibco Mashery Local Reference Cluster]

Using Zone [local]

3. Check the status of the overall cluster and see what action is pending:

[root@5a527d7ef2ab builder]# cm cluster status

*** Checking the status of Cluster 'Tibco Mashery Local Reference Cluster' ***

*** Checking the status of zone 'local' ***

TML component [66157d26-43b5-40ff-aefe-b1f52aa2f44b] of type [nosql] found with status [ACTIVE] on Host IP [10.0.0.3]..

TML component [11261544-ef93-4d1f-8da9-af71b1593763] of type [logservice] found with status [ACTIVE] on Host IP [10.0.0.8]..

TML component [fa66dcbb-35af-4fb3-bc87-09382c0f20ef] of type [sql] found with status [ACTIVE] on Host IP [10.0.0.10]..

TML component [b38efc8f-bffa-4a68-bcf5-a21370434b78] of type [cache] found with status [ACTIVE] on Host IP [10.0.0.12]..

TML component [84792b97-b4ba-4a28-b7f4-1b5cfbd6c76a] of type [trafficmanager]

found with status [STANDBY] on Host IP [10.0.0.14]. See details below

Component ID Component Name Component IP

4. After some time, the cluster status should turn READY. You can check the last failing component for its individual status as follows. In this case, the Traffic Manager is running on 10.0.0.14 IP:

[root@5a527d7ef2ab builder]# curl http://10.0.0.14:9080/container/status {

"tmgcId" : "84792b97-b4ba-4a28-b7f4-1b5cfbd6c76a", "ip" : "10.0.0.14",

"name" : "tm",

"pending_activity" : "checking component status ...", "status" : "Ready"

}

5. As seen in previous step, the Traffic Manager is in ready status, despite what the pending activity indicates. The pending activity was the last successful activity performed by the container agent.

6. If the status indicates error, then check the log-service container for corresponding errors.

1. Log in to the logservice container

2. Check the appropriate log files under the "^/mnt/data" location

3. Check for any errors in the Configuration Manager container. For example, check the "^/mnt/

data/tml-cm" location.

Creating the Cluster Configuration

Follow these steps to create a "Hello World" API example using Configuration Manager.

1. Login to Configuration Manager.

2. Click on API Domains to whitelist your public and internal api domains. Create a new entry for the