THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Page History
...
Has to be rendered in HOCON format.
REPL mode
| command spec | description |
|---|---|
cluster config show [--cluster-endpoint-url] [selector] | Show cluster configuration |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster config show [--cluster-endpoint-url] [selector] | Show cluster configuration |
cluster config update
REPL mode
| command spec | description |
|---|---|
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 spec | description |
|---|---|
ignite 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 spec | description |
|---|---|
cluster topology physical [--cluster-endpoint-url] | Show the physical topology of the cluster |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster topology physical [--cluster-endpoint-url] | Show the physical topology of the cluster |
cluster topology logical
REPL mode
| command spec | description |
|---|---|
cluster topology logical [--cluster-endpoint-url] | Show the logical topology of the cluster |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster topology logical [--cluster-endpoint-url] | Show the logical topology of the cluster |
node
node start
Start the Ignite 3 node.
REPL mode
| command spec | description |
|---|---|
node start [--config] [--port] [--rest-port] [--join] <nodeName> | Start node with the default configuration or reads the config from --config option. Additional port, rest-port and join options override the configuration parameters. |
non-REPL mode
| command spec | description |
|---|---|
ignite node start [--config] [--port] [--rest-port] [--join] <nodeName> | Start node with the default configuration or reads the config from --config option. Additional port, rest-port and join options override the configuration parameters. |
node stop
Stop the Ignite 3 node.
REPL mode
| command spec | description |
|---|---|
node stop <nodeName> | Stop node |
non-REPL mode
| command spec | description |
|---|---|
ignite node stop <nodeName> | Stop node |
node status
Shows the status of the node. Could be starting, started, stopping, and recovering.
REPL mode
| command spec | description |
|---|---|
node status [--node-url] | Shows the node status |
non-REPL mode
| command spec | description |
|---|---|
ignite node status [--node-url] | Shows the node status |
node config show
Has to be rendered in HOCON format.
REPL mode
| command spec | description |
|---|---|
node config show [--node-url] [selector] | Read the local node configuration |
non-REPL mode
| command spec | description |
|---|---|
ignite node config show [--node-url] [selector] | Read the local node configuration |
node config update
REPL mode
| command spec | description |
|---|---|
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 spec | description |
|---|---|
ignite node config update [--node-url] <config in HOCON format or path to file> | Update the local node configuration with provided HOCON configuration |
node list
REPL mode
| command spec | description |
|---|---|
node list | Show the list of nodes running locally |
non-REPL mode
| command spec | description |
|---|---|
ignite node list | Show the list of nodes running locally |
node version
REPL mode
| command spec | description |
|---|---|
node version | Show the ignite node build version |
non-REPL mode
| command spec | description |
|---|---|
ignite node version | Show the ignite node build version |
cli config
cli config get
REPL mode
| command spec | description |
|---|---|
cli config get <config key> | Show the config value for the current profile. |
non-REPL mode
| command spec | description |
|---|---|
ignite cli config get [--profile] <config key> | Show the config value for the specified or default profile. |
cli config set
REPL mode
| command spec | description |
|---|---|
cli config set <config key-value> | Set the config value for the current profile. |
non-REPL mode
| command spec | description |
|---|---|
ignite cli config set [--profile] <config key-value> | Set the config value for the specified or default profile. |
cli config show
REPL mode
| command spec | description |
|---|---|
cli config show | Show the config contents for the current profile. |
non-REPL mode
| command spec | description |
|---|---|
ignite cli config show [--profile] | Show the config contents for the specified or default profile. |
cli config profile
cli config profile show
...
Overview
Content Tools
Apps