[jira] [Created] (IGNITE-10699) Update documentation for control.sh

["Sergey Antonov (JIRA)" <ji...@apache.org>]

Sergey Antonov created IGNITE-10699:
---------------------------------------

             Summary: Update documentation for control.sh
                 Key: IGNITE-10699
                 URL: https://issues.apache.org/jira/browse/IGNITE-10699
             Project: Ignite
          Issue Type: Task
    Affects Versions: 2.8
            Reporter: Sergey Antonov
            Assignee: Artem Budnikov


I renamed view parameters in control.sh utility. The changes are following:
||Was||Has been||
|--skipZeros|--skip-zeros|
|--cacheFilter|--cache-filter|
|checkFirst|--check-first|
|checkThrough|--check-through|
|limit| --limit|
|order|--order|
|minDuration|--min-duration|
|minSize|--min-size|
|label|--label|
|nodes|--nodes|
|xid|--xid|

 

You could find current output command {{control.sh --cache help}}
{noformat}
Control utility [ver. 2.7.0-SNAPSHOT#19700101-sha1:DEV]
2018 Copyright(C) Apache Software Foundation
User: santonov
--------------------------------------------------------------------------------
The '--cache subcommand' is used to get information about and perform actions with caches. 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-cipher-suites SSL_CIPHER_1[, SSL_CIPHER_2, ...]] [--ssl-key-algorithm SSL_KEY_ALGORITHM] [--keystore-type KEYSTORE_TYPE] [--keystore KEYSTORE] [--keystore-password KEYSTORE_PASSWORD] [--truststore-type TRUSTSTORE_TYPE] [--truststore TRUSTSTORE] [--truststore-password TRUSTSTORE_PASSWORD] --cache[subcommand] <subcommand_parameters>

The subcommands that take [nodeId] as an argument ('list', 'contention' and 'validate_indexes') will be executed on the given node or on all server nodes if the option is not specified. Other commands will run on a random server node.


Subcommands:
--------------------------------------------------------------------------------

--cache list regexPattern [groups|seq] [nodeId] [--config] [--output-format multi-line]

Show information about caches, groups or sequences that match a regular expression. When executed without parameters, this subcommand prints the list of caches.

Parameters:
--config - print a all configuration parameters for each cache.
--output-format multi-line - print configuration parameters per line. This option has effect only when used with --config and without [groups|seq].

--------------------------------------------------------------------------------

--cache contention minQueueSize [nodeId] [maxPrint]

Show the keys that are point of contention for multiple transactions.

--------------------------------------------------------------------------------

--cache idle_verify [--dump] [--skip-zeros] [cache1,...,cacheN] [--cache-filter ALL|SYSTEM|PERSISTENT|NOT_PERSISTENT]

Verify counters and hash sums of primary and backup partitions for the specified caches on an idle cluster and print out the differences, if any.

--------------------------------------------------------------------------------

--cache validate_indexes [cache1,...,cacheN] [nodeId] [--check-first N|--check-through K]

Validate indexes on an idle cluster and print out the keys that are missing in the indexes.

Parameters:
--check-first N - validate only the first N keys
--check-through K - validate every Kth key

--------------------------------------------------------------------------------

--cache distribution nodeId|null [cacheName1,...,cacheNameN] [--user-attributes attName1,...,attrNameN]

Prints the information about partition distribution.

--------------------------------------------------------------------------------

--cache reset_lost_partitions cacheName1,...,cacheNameN

Reset the state of lost partitions for the specified caches.{noformat}
 And {{control.sh --help}}
{noformat}
Control utility [ver. 2.7.0-SNAPSHOT#19700101-sha1:DEV]
2018 Copyright(C) Apache Software Foundation
User: santonov
--------------------------------------------------------------------------------
Contol.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-cipher-suites SSL_CIPHER_1[, SSL_CIPHER_2, ...]] [--ssl-key-algorithm SSL_KEY_ALGORITHM] [--keystore-type KEYSTORE_TYPE] [--keystore KEYSTORE] [--keystore-password KEYSTORE_PASSWORD] [--truststore-type TRUSTSTORE_TYPE] [--truststore TRUSTSTORE] [--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.
{noformat}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)