Forrest logo
back to the stolonctl tool

stolonctl:tldr:0f027

stolonctl: Get cluster status.
$ stolonctl --cluster-name ${cluster_name} --store-backend ${store_backend} --store-endpoints ${store_endpoints} status
try on your machine

The stolonctl command is used to interact with the Stolon database high availability (HA) solution. It provides various operations to manage and monitor a Stolon cluster.

In this specific command:

  • --cluster-name ${cluster_name} specifies the name of the Stolon cluster that you want to interact with. ${cluster_name} is a placeholder for the actual name of the cluster.
  • --store-backend ${store_backend} specifies the backend storage for the Stolon cluster. ${store_backend} is another placeholder for the specific storage backend you are using, such as etcd, consul, boltdb, etc.
  • --store-endpoints ${store_endpoints} defines the endpoints or connection string to connect with the storage backend. ${store_endpoints} is a placeholder that should be replaced with the actual endpoints or connection string for the selected storage backend.

Finally, the status argument is used to request the status of the Stolon cluster. It will retrieve and display the current status of all the components within the cluster, such as primary and standby instances, as well as health information.

Overall, the command is used to check the status of a specific Stolon cluster, providing the necessary parameters to connect with the storage backend and retrieve the cluster information.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the stolonctl tool