[IGNITE-10649] Add documentation for control.sh about SSL

• Type: Task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Fix Version/s: 2.17
• Component/s: control.sh, documentation
• Ignite Flags: Docs Required
• Assignee: Unassigned
• Reporter: Sergey Antonov
• Created: 12/Dec/18 08:58
• Updated: 25/Dec/23 13:01

Description

Control.sh help output:

Control.sh is used to execute admin commands on cluster or get common cluster info. The command has the following syntax:

control.sh [--host HOST_OR_IP] [--port PORT] [--user USER] [--password PASSWORD] [--ping-interval PING_INTERVAL] [--ping-timeout PING_TIMEOUT] [--ssl-protocol SSL_PROTOCOL[, SSL_PROTOCOL_2, ..., SSL_PROTOCOL_N]] [--ssl-cipher-suites SSL_CIPHER_1[, SSL_CIPHER_2, ..., SSL_CIPHER_N]] [--ssl-key-algorithm SSL_KEY_ALGORITHM] [--keystore-type KEYSTORE_TYPE] [--keystore KEYSTORE_PATH] [--keystore-password KEYSTORE_PASSWORD] [--truststore-type TRUSTSTORE_TYPE] [--truststore TRUSTSTORE_PATH] [--truststore-password TRUSTSTORE_PASSWORD] [command] <command_parameters>


This utility can do the following commands:
Activate cluster:
control.sh --activate 

Deactivate cluster:
control.sh --deactivate [--yes]

Print current cluster state:
control.sh --state 

Print cluster baseline topology:
control.sh --baseline 

Add nodes into baseline topology:
control.sh --baseline add consistentId1[,consistentId2,....,consistentIdN] [--yes]

Remove nodes from baseline topology:
control.sh --baseline remove consistentId1[,consistentId2,....,consistentIdN] [--yes]

Set baseline topology:
control.sh --baseline set consistentId1[,consistentId2,....,consistentIdN] [--yes]

Set baseline topology based on version:
control.sh --baseline version topologyVersion [--yes]

List or kill transactions:
control.sh --tx [--xid XID] [--min-duration SECONDS] [--min-size SIZE] [--label PATTERN_REGEX] [--servers|--clients] [--nodes consistentId1[,consistentId2,....,consistentIdN]] [--limit NUMBER] [--order DURATION|SIZE|START_TIME] [--kill] [--yes]

Print absolute paths of unused archived wal segments on each node:
control.sh --wal print [consistentId1,consistentId2,....,consistentIdN]

Delete unused archived wal segments on each node:
control.sh --wal delete [consistentId1,consistentId2,....,consistentIdN] [--yes]

View caches information in a cluster. For more details type:
control.sh --cache help

By default commands affecting the cluster require interactive confirmation.
Use --yes option to disable it.

Default values:
HOST_OR_IP=127.0.0.1
PORT=11211
PING_INTERVAL=5000
PING_TIMEOUT=30000
SSL_PROTOCOL=TLS
SSL_KEY_ALGORITHM=SunX509
KEYSTORE_TYPE=JKS
TRUSTSTORE_TYPE=JKS

Exit codes:
0 - successful execution.
1 - invalid arguments.
2 - connection failed.
3 - authentication failed.
4 - unexpected error.

Issue Links

• relates to: IGNITE-9298 control.sh does not support SSL (org.apache.ignite.internal.commandline.CommandHandler)