Skip to content

Commit 7596a31

Browse files
authored
IGNITE-24444 Updated documentation for password related control.sh options (#11911)
1 parent da8da4a commit 7596a31

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/_docs/tools/control-script.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,16 @@ If you want to connect to a node that is running on a remove machine, specify th
4747
| --host HOST_OR_IP | The host name or IP address of the node. | `localhost`
4848
| --port PORT | The port to connect to. | `10800`
4949
| --user USER | The user name. |
50-
| --password PASSWORD |The user password. |
50+
| --password | Force `control.sh` to prompt for a user password before connecting to a cluster. Although you can explicitly specify a value for this option like `--password PASSWORD`, doing so is strongly discouraged due to security concerns. If this option is omitted, `control.sh` will automatically prompt for a user password if the server requires password authentication. However, `control.sh` will waste a connection attempt while determining whether the server needs a password. |
5151
| --ssl-protocol PROTOCOL1, PROTOCOL2... | A list of SSL protocols to try when connecting to the cluster. link:https://docs.oracle.com/en/java/javase/11/security/java-security-overview1.html#GUID-FCF419A7-B856-46DD-A36F-C6F88F9AF37F[Supported protocols,window=_blank]. | `TLS`
5252
| --ssl-cipher-suites CIPHER1,CIPHER2... | A list of SSL ciphers. link:https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names[Supported ciphers,window=_blank]. |
5353
| --ssl-key-algorithm ALG | The SSL key algorithm. | `SunX509`
5454
| --keystore-type KEYSTORE_TYPE | The keystore type. | `JKS`
5555
| --keystore KEYSTORE_PATH | The path to the keystore. Specify a keystore to enable SSL for the control script.|
56-
| --keystore-password KEYSTORE_PWD | The password to the keystore. |
56+
| --keystore-password | Force `control.sh` to prompt for a keystore password before connecting to a cluster. Although you can explicitly specify a value for this option like `--keystore-password KEYSTORE_PWD`, doing so is strongly discouraged due to security concerns. If this option is omitted, `control.sh` will automatically prompt for a keystore password before connecting to the cluster if `--keystore KEYSTORE_PATH` argument is specified. |
5757
| --truststore-type TRUSTSTORE_TYPE | The type of the truststore. | `JKS`
5858
| --truststore TRUSTSTORE_PATH | The path to the truststore. |
59-
| --truststore-password TRUSTSTORE_PWD | The password to the truststore. |
59+
| --truststore-password | Force `control.sh` to prompt for a truststore password before connecting to a cluster. Although you can explicitly specify a value for this option like `--truststore-password TRUSTSTORE_PWD`, doing so is strongly discouraged due to security concerns. If this option is omitted, `control.sh` will automatically prompt for a truststore password before connecting to the cluster if `--truststore TRUSTSTORE_PATH` argument is specified. |
6060
| --ssl-factory SSL_FACTORY_PATH | Custom SSL factory Spring xml file path. |
6161
|===
6262

0 commit comments

Comments
 (0)