Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Has to be rendered in HOCON format.

REPL mode

command specdescription
cluster config show [--cluster-endpoint-url] [selector]

Show cluster configuration

non-REPL mode

command specdescription
ignite3 cluster config show [--cluster-endpoint-url] [selector]

Show cluster configuration

cluster config update

REPL mode

command specdescription
cluster config update [--cluster-endpoint-url] <config in HOCON format or path to file>

Update the cluster configuration with provided HOCON configuration 

non-REPL mode

command specdescription
ignite3 cluster config update [--cluster-endpoint-url] <config in HOCON format or path to file>

Update the cluster configuration with provided HOCON configuration

cluster topology physical

According to the join protocol, we are going to have two types of node topologies: "physical" (a.k.a. network) topology and "logical" topology. It may be convenient for the user to know which nodes have passed validation and have joined the logical topology, therefore it is suggested to implement a CLI command for this purpose.

Response example:

consistent ID, ID, address, status

node 1, e2d4988a-b836-4e7e-a888-2639e6f79ef0, 127.0.0.1

node 2, 5cb561fc-1963-4f95-98f8-deb407669a86, 127.0.0.2

REPL mode

command specdescription
cluster topology physical [--cluster-endpoint-url]Show the physical topology of the cluster

non-REPL mode

command specdescription
ignite3 cluster topology physical [--cluster-endpoint-url]Show the physical topology of the cluster

cluster topology logical

REPL mode

command specdescription
cluster topology logical [--cluster-endpoint-url]Show the logical topology of the cluster

non-REPL mode

command specdescription
ignite3 cluster topology logical [--cluster-endpoint-url]Show the logical topology of the cluster

node

node status

Shows the status of the node. Could be starting, started, stopping, and recovering.

REPL mode

command specdescription
node status [--node-url]

Shows the node status 

non-REPL mode

command specdescription
ignite3 node status [--node-url]

Shows the node status

node config show

Has to be rendered in HOCON format.

REPL mode

command specdescription
node config show [--node-url] [selector]

Read the local node configuration 

non-REPL mode

command specdescription
ignite3 node config show [--node-url] [selector]

Read the local node configuration

node config update

REPL mode

command specdescription
node config update [--node-url] <config in HOCON format or path to file>

Update the connected local node configuration with provided HOCON configuration 

non-REPL mode

command specdescription
ignite3 node config update [--node-url] <config in HOCON format or path to file>

Update the local node configuration with provided HOCON configuration

node version

REPL mode

command specdescription
node version

Show the ignite node build version 

non-REPL mode

command specdescription
ignite3 node version

Show the ignite node build version

node metric enable

REPL mode

command specdescription
node metric enable [--node-url] <srcName>

Enable node metric source 

non-REPL mode

command specdescription
ignite3 node metric enable [--node-url] <srcName>

Enable node metric source

node metric disable

REPL mode

command specdescription
node metric disable [--node-url] <srcName>

Disable node metric source 

non-REPL mode

command specdescription
ignite3 node metric disable [--node-url] <srcName>

Disable node metric source

node metric list

REPL mode

command specdescription
node metric list [--node-url]

List node metric sources 

non-REPL mode

command specdescription
ignite3 node metric list [--node-url]

List node metric sources

cli config 

cli config get

REPL mode

command specdescription
cli config get <config key>  Show the config value for the current profile.

non-REPL mode

command specdescription
ignite3 cli config get [--profile] <config key>Show the config value for the specified or default profile.

cli config set

REPL mode

command specdescription
cli config set <config key-value>Set the config value for the current profile.

non-REPL mode

command specdescription
ignite3 cli config set [--profile] <config key-value>Set the config value for the specified or default profile.

cli config show

REPL mode

command specdescription
cli config showShow the config contents for the current profile.

non-REPL mode

command specdescription
ignite3 cli config show [--profile]Show the config contents for the specified or default profile.

cli config profile

...

REPL mode

command specdescription
cli config profile show  Show current default profile of CLI Tool

non-REPL mode

command specdescription
ignite3 cli config show Show current default profile

cli config profile

use

show

REPL mode

command specdescription
cli config profile listList profiles of CLI Tool

non-REPL mode

command specdescription
ignite3 cli config listList profiles

cli config profile activate

REPL mode

command specdescription
cli config profile activate <profileName> Activate profile as default for CLI Tool

non-REPL mode

command specdescription
ignite3 cli config profile activate <profileName> Activate profile as default for CLI Tool


cli config profile create

REPL mode

command specdescription
cli config profile create [--name -n] [--copy-from -c] [--activate -a]  Create new profile and optionally copy content from another profile and optionally activate new profile as default for CLI Tool

non-REPL mode

command specdescription
ignite3 cli config profile create [--name -n] [--copy-from -c] [--activate -a]Create new profile and optionally copy content from another profile and optionally activate new profile as default for CLI Tool



...