postgresql_cluster icon indicating copy to clipboard operation
postgresql_cluster copied to clipboard

Console (UI/API): Cluster management functionality

Open vitabaks opened this issue 1 year ago • 6 comments

With the release version 2.0, we introduced a Console (UI) designed for deploying clusters through a graphical interface.

Image

The next step is to add functionality for managing an already deployed cluster through the UI, including:

  • Edit a cluster
    • Change the cluster name, description, environment, synchronous mode, etc.
  • Stop/Start a cluster or a specific cluster node
    • Control the Patroni service or the VM (for cloud deployments)
  • Delete a cluster
    • Remove cluster components from the server or the entire VM (for cloud deployments)
  • Switchover/Failover, Reinit, Reload, Restart
    • Integration with the Patroni API
  • Users
    • Create and edit database users
  • Databases
    • Create and edit databases
  • Extensions
    • Create and edit database extensions
  • Parameters
    • Edit Postgres and system parameters
  • Connections
    • Manage connection settings
      • Enable/disable public access to the database (for cloud deployments)
      • Configure connection pools
      • Manage pg_hba rules
  • Backups
    • Manage database backup settings
      • Backup schedule
      • Backup retention
      • Backup tool configuration
    • Doc: https://autobase.tech/docs/management/backup
  • Restore a cluster
    • Restoring (PITR) or Cloning a cluster from a backup
    • Doc: https://autobase.tech/docs/management/restore
  • Upgrades
    • Minor and major cluster upgrade
    • Doc: https://autobase.tech/docs/management/upgrades
  • Cluster Scaling
    • Scaling the cluster - add Postgres node
    • Doc: https://autobase.tech/docs/management/cluster-scaling

[!NOTE] Access to the Figma project with all implementation details will be provided during development.


Consider sponsoring the project via GitHub or Patreon

vitabaks avatar Sep 11 '24 10:09 vitabaks

If you're interested in this feature, please consider becoming a sponsor.

The development of this feature requires sponsorship to fund developer efforts. If you're already a sponsor and are interested in this feature, please leave a comment here so we can prioritize this issue accordingly.

We also welcome contributions from those willing to dedicate their time to implement this feature on a voluntary basis. Please see the Contributing Guide for more information.

vitabaks avatar Sep 11 '24 10:09 vitabaks

Hello @vitabaks thank you so much for this marvelous software, and all this work of automation with Ansible.

I don't know if it's the right place to put a wish list, but I realized a little lack last days when testing deployments : I can't import an existing cluster deployed through command line and Ansible into the UI (or I pass by this feature). Do you think it would be possible ? (even if I have to connect in bash in the container and launch several commands to do the job). I tried to deploy my cluster in the UI, adapted vars in Ansible automation files, and config / update cluster launching ansible-playbook commands, but it's not really simple, and not really do the job in some cases.

stanlog avatar Nov 21 '24 09:11 stanlog

Hello @stanlog Thank you for your feedback and suggestion.

For the feature request to import an existing cluster into the Console, it’s better to create a separate issue so we can track and consider it for future development.

In the meantime, this can be done manually by adding the cluster data directly into the clusters and servers tables in the console database.

vitabaks avatar Nov 21 '24 09:11 vitabaks

For the feature request to import an existing cluster into the Console, it’s better to create a separate issue so we can track and consider it for future development.

Yes, I will create a dedicated issue to ask for this enhancement.

Thank you for the workaround to populate the database in the UI to import an existing cluster :)

stanlog avatar Nov 21 '24 09:11 stanlog

UPDATE May 2025:

We’re currently looking for more sponsors to help fund frontend/backend development and make these features a reality.

vitabaks avatar May 23 '25 08:05 vitabaks

UPDATE November 2025:

The implementation cost at about $5,000–7,000. We can’t say yet in which release it will be included — this depends on attracting more sponsors, as we don’t rely on venture capital. That said, as the project gains popularity, its budget is likely to grow as well — making this feature feasible sooner or later.

vitabaks avatar Nov 06 '25 06:11 vitabaks