A command line utility you can use to interact with the cluster manager, in either interactive mode or command line mode.
The esp_cluster_admin utility supports several commands you can use to set up your project environment, encrypt sensitive data, and deploy a keystore. To access the utility, provide your user name and password, unless you chose not to set up authentication.
Once you log into the ESP Server, you can run commands on the server side continually until you exit by executing exit or quit.
By default, the cluster generates TIMEOUT after 20 seconds. You can set timeout in interactive mode or command line mode to avoid the TIMEOUT option appearing after 20 seconds. The SDK provides the timeout value (in seconds) for the START PROJECT or STOP PROJECT commands. If the command returns TIMEOUT, obtain the project status using the GET PROJECT or GET PROJECTS command.
$ESP_HOME/bin/esp_cluster_admin <uri|help|helpi> [credentials] [command] [options]
esp_cluster_admin --uri=esps://<host>:<port> [...]
esp_cluster_admin --uri=esp://<host>:<port> --key-alias=serverkey --storepass=<storepass> --keystore=keystore.jks
esp_cluster_admin --uri=esp://<host>:<port> --user name=<user name> --password=<password>
Enter the command followed by the workspace name, a forward slash, and the project name. Do not use spaces in the variable entries.
get project tradespace/sample
Enter the command followed by the workspace name, a forward slash, and the stream name. Do not use spaces in the variable entries.
get streams tradespace/tradedata
Enter the command followed by the workspace name, a forward slash, and the schema name. Do not use spaces in the variable entries.
get schema tradespace/tradedata/dataformat
Enter the command followed by the workspace name. Do not use spaces in the variable entries.
add workspace stockspace
Enter the command, followed by the workspace name to which to add the project, a forward slash, followed by the project name and file name with extension. Do not use spaces in the variable entries.
add project tradespace/tradeanalysis tradeanalysis.ccx
The ccr file is the project configuration file for the ccx file.
Enter the command, followed by the name of the workspace to remove. Do not use spaces in the variable entries.
remove workspace stockspace
Enter the command, followed by the name of the project to remove. Do not use spaces in the variable entries.
remove project tradespace/tradeanalysis
Enter the command, followed by the workspace name, a forward slash, and the name of the project to start. Do not use spaces in the variable entries.
start project tradespace/sample
Enter the command, followed by the workspace name, a forward slash, and the name of the project to stop. Do not use spaces in the variable entries.
stop project tradespace/sample
Enter the command, followed by the node name.
stop node node1
Enter the command, followed by the sensitive data to encrypt. When you run the command, the utility produces encrypted text you can use to replace the sensitive data in the associated file.
encrypt 1234
Enter the command, followed by the new user name, keystore file path, and storepass key-alias.
All nodes in a cluster must share the same keystore file path. The node to which the deploy command is sent updates the keystore and the other nodes then reload that file. To test if the deploy key is working properly, log in to the cluster with the new key, but through a different node.
deploykey jdoe ./mykeystore.jks 123456 jdoe
If you have recently updated the existing policy file, the cluster is reverified against the new policy configuration upon reload.