Cluster Management

Owned by Baseer Khan
Last updated: Apr 30, 2018
2 min read


The purpose cluster management CLI command is to perform following subtasks associated within  a cluster:

  1. Setup - Initial setup of the cluster
  2. Start - Start the cluster instances
  3. Stop - Stop the cluster instances
  4. Status - Check the status of the cluster
  5. Delete - Delete the cluster
  6. List - List all the clusters

Usage: This section explains the usage of TQL CLI cluster management options

Please refer to Environment Variable section before starting to use the command tool.


Cluster Setup

TQL CLI Cluster Setup Command
$ bin/tql -cluster -setup inputtype=file,path=<file path>


Cluster Setup takes input from a file containing following JSON structure:

TQL CLI Cluster Setup Command Input File Format
{
   "ClusterSetup": {
  	"ClusterId": "TestTenant123",
  	"ShortName": "TestTenant123",
  	"Description": "test tenant to check setup from cli",
  	"InitialDirectory": "/home/ec2-user/TestTenant123",
  	"Installer": {
     	"InstallerBundleFile": "/home/ec2-user/yourbundleinstaller.zip",
     	"VersionNumber": "6.14"
  	},
  	"Instances": {
     	"InstanceDetails": [{
        	"HostName": "",
        	"IPAddress": "18.216.147.127",
        	"Port": "8081",
            "RuntimeMemory":"2"
     	},{
        	"HostName": "",
        	"IPAddress": "18.216.147.127",
        	"Port": "8082",
            "RuntimeMemory":"2"
     	}]
  	},
    "LogFilesDirectory": "/home/ec2-user/logsDirectory1",
    "LogServer":{
            	"ClusterId" : "TestTenant123",
            	"SetupDirectory": "/home/ec2-user/LogServerTest11",
            	"LogFilesDirectory": "/home/ec2-user/logsDirectory1",
            	"Host": "deconfig.atomiton.com",
            	"IPAddress": "18.216.147.127",
            	"InstanceDetails": "18.216.147.127:8081,18.216.147.127:8082"
      	}
   }
}


Cluster Start

TQL CLI Cluster Start Command
$ bin/tql -cluster -start tenantid=<tenantId>,memoryInGB=<value | Optional Parameter>

To start the cluster instances: Specify the tenantid, and optionally size of memory in GB.


Cluster Stop

TQL CLI Cluster Stop Command
$ bin/tql -cluster -stop tenantid=<tenantId>

To stop the cluster instances: Specify the tenantid.

Cluster Status

TQL CLI Cluster Status Command
$ bin/tql -cluster -status tenantid=<tenantId>

 To check the status of the cluster specify the tenantid


Cluster Delete

TQL CLI Cluster Delete Command
$ bin/tql -cluster -delete tenantid=<tenantId>

 To delete the cluster specify the tenantid. Instances will be stopped and the data deleted from file system.

Cluster List

TQL CLI Cluster List Command
$ bin/tql -cluster -list

List all the defined/configured clusters.