Forrest logo
tool overview
On this page you find all important commands for the CLI tool stolonctl. If the command you are looking for is missing please ask our AI.

stolonctl

Stolonctl is a command line tool used for managing and controlling Stolon, which is a PostgreSQL high availability (HA) solution. It allows administrators to perform various tasks related to setting up, configuring, and maintaining Stolon clusters. Stolonctl provides an interface for creating, deleting, and modifying Stolon clusters, as well as managing cluster-wide settings and parameters. It allows you to perform actions like initializing a new Stolon cluster, adding or removing PostgreSQL replicas, and promoting replicas to become the new primary. The tool also enables you to manage cluster-wide settings such as timeouts, number of replicas, and various parameters related to Postgres configuration. Stolonctl provides a simple and user-friendly interface to manage and monitor the Stolon clusters remotely using the command line. It uses a client-server architecture, where the Stolonctl client communicates with the Stolon cluster coordinator to perform the requested operations. The tool requires authentication and authorization to ensure the security of cluster management operations. With stolonctl, administrators can easily manage, monitor, and scale Stolon clusters, ensuring high availability and seamless operation of PostgreSQL databases. It is an essential tool for any system administrator or database operator working with Stolon clusters.

List of commands for stolonctl:

  • 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
    explain this command
  • stolonctl:tldr:503f1 stolonctl: Update cluster specification with a patch in JSON format.
    $ stolonctl --cluster-name ${cluster_name} --store-backend ${store_backend} --store-endpoints ${store_endpoints} update --patch '${cluster_spec}'
    try on your machine
    explain this command
  • stolonctl:tldr:6b7d7 stolonctl: Get cluster specification.
    $ stolonctl --cluster-name ${cluster_name} --store-backend ${store_backend} --store-endpoints ${store_endpoints} spec
    try on your machine
    explain this command
  • stolonctl:tldr:fc3da stolonctl: Get cluster data.
    $ stolonctl --cluster-name ${cluster_name} --store-backend ${store_backend} --store-endpoints ${store_endpoints} clusterdata
    try on your machine
    explain this command
tool overview