Using the CLI
axual.sh
reference
Usage:
./axual.sh [OPTIONS] COMMAND [ARG…]
Options
Option |
Description |
Example |
---|---|---|
|
Verbose. Log all underlying docker commands and shell functions |
|
Available commands
Command |
Description |
Example |
---|---|---|
|
start all cluster / instance / mgmt / client level services that should be running on this node. |
|
|
stop all cluster / instance / mgmt / client level services which are running on this machine. |
|
|
restart all cluster / instance / mgmt / client level services which are running on this machine. |
|
|
clean data, containers or images used in an Axual deployment |
|
|
send the change status command to all instances of the cluster, and getting current status of all instances of the current cluster |
|
|
send the change status command to specified instance of the cluster, and getting current status of specified instance of the current cluster |
|
start
, restart
and stop
Use ./axual.sh [start|restart|stop]
to start, restart or stop (a selection of) instance / cluster / mgmt / client level components. This is always relative to the node this command is ran on.
Usages:
-
./axual.sh [start|restart|stop] [instance] [<instance-name>] [<servicename>]
-
./axual.sh [start|restart|stop] [cluster] [<cluster-name>] [<servicename>]
-
./axual.sh [start|restart|stop] [mgmt] [<servicename>]
-
./axual.sh [start|restart|stop] [client] [<instance-name>][<servicename>]
instance
Use ./axual.sh instance <instance-name>
to get or set a specified instance status.
Usage:
./axual.sh instance <instance-name> [set|get] [status] [metadata|data|offset|app] [on|off]
cluster
Use ./axual.sh cluster
to get or set status of all the instances in the cluster.
Usage:
./axual.sh cluster [set|get] [status] [metadata|data|offset|app] [on|off]
The following statuses can be returned:
-
INACTIVE
: Not participating actively in the instance. -
READY_FOR_METADATA
: Cluster is active and ready to apply topics if necessary. -
READY_FOR_DATA
: All metadata on the cluster is up to date and the cluster is ready to receive data from other clusters through Distributor. -
READY_FOR_OFFSETS
: Cluster is now ready to receive any unsynchronized consumer offsets. -
READY_FOR_APPLICATIONS
: The cluster is fully synched with other clusters in the same instance and is ready to serve client applications.
To activate a cluster, use the following flow: metadata → data → offset → app
To activate a cluster, use the following flow: app → offset → data → metadata
Example usage
when referring to an instance, always use the full instance name, including <tenant>, e.g. for tenant company , instance ota , the full instance name would be company-ota
|
|
Start |
|
Stop all |
|
Restart |
|
Start |
|
Restart |
|
Stop |
|
Start |
|
Restart |
|
Stop all |
|
Get the current status of tenant |
|
Restart |
|
Stop |
|
Start |