base on Automated database platform for PostgreSQL® - Your own DBaaS. The open-source alternative to cloud-managed databases. <p align="center"> <img src="images/github-autobase.png"> </p> # Autobase for PostgreSQL® :elephant: :sparkling_heart: [](https://github.com/vitabaks/autobase/actions/workflows/ansible-lint.yml) [](https://github.com/vitabaks/autobase/actions/workflows/yamllint.yml) [](https://github.com/vitabaks/autobase/actions/workflows/flake8.yml) [](https://github.com/vitabaks/autobase/actions/workflows/molecule.yml) [](https://github.com/vitabaks/autobase/blob/master/LICENSE)  **Autobase for PostgreSQL®** is an open-source alternative to cloud-managed databases (DBaaS) such as Amazon RDS, Google Cloud SQL, Azure Database, and more. This automated database platform enables you to create and manage production-ready, highly available PostgreSQL clusters. It simplifies the deployment process, reduces operational costs, and makes database management accessible—even for teams without specialized expertise. **Automate deployment, failover, backups, restore, upgrades, scaling, and more with ease.** You can find a version of this documentation that is searchable and also easier to navigate at [autobase.tech](https://autobase.tech) --- ### Project Status Autobase has been actively developed for over 5 years (since 2019) and is trusted by companies worldwide, including in production environments with high loads and demanding reliability requirements. Our mission is to provide an open-source DBaaS that delivers reliability, flexibility, and cost-efficiency. The project will remain open-source forever, but to ensure its continuous growth and development, we rely on [sponsorship](https://autobase.tech/docs/sponsor). By subscribing to [Autobase packages](https://autobase.tech/docs/support), you gain access to personalized support from the project authors and PostgreSQL experts, ensuring the reliability of your database infrastructure. --- ### Supported setups of Postgres Cluster   You have three schemes available for deployment: #### 1. PostgreSQL High-Availability only This is simple scheme without load balancing. ##### Components: - [**Patroni**](https://github.com/zalando/patroni) is a template for you to create your own customized, high-availability solution using Python and - for maximum accessibility - a distributed configuration store like ZooKeeper, etcd, Consul or Kubernetes. Used for automate the management of PostgreSQL instances and auto failover. - [**etcd**](https://github.com/etcd-io/etcd) is a distributed reliable key-value store for the most critical data of a distributed system. etcd is written in Go and uses the [Raft](https://raft.github.io/) consensus algorithm to manage a highly-available replicated log. It is used by Patroni to store information about the status of the cluster and PostgreSQL configuration parameters. [What is Distributed Consensus?](https://thesecretlivesofdata.com/raft/) - [**vip-manager**](https://github.com/cybertec-postgresql/vip-manager) (_optional, if the `cluster_vip` variable is specified_) is a service that gets started on all cluster nodes and connects to the DCS. If the local node owns the leader-key, vip-manager starts the configured VIP. In case of a failover, vip-manager removes the VIP on the old leader and the corresponding service on the new leader starts it there. Used to provide a single entry point (VIP) for database access. - [**PgBouncer**](https://pgbouncer.github.io/features.html) (optional, if the `pgbouncer_install` variable is `true`) is a connection pooler for PostgreSQL. #### 2. PostgreSQL High-Availability with Load Balancing This scheme enables load distribution for read operations and also allows for scaling out the cluster with read-only replicas. When deploying to cloud providers such as AWS, GCP, Azure, DigitalOcean, and Hetzner Cloud, a cloud load balancer is automatically created by default to provide a single entry point to the database (controlled by the `cloud_load_balancer` variable). For non-cloud environments, such as when deploying on Your Own Machines, the HAProxy load balancer is available for use. To enable it, set `with_haproxy_load_balancing: true` in the vars/main.yml file. > [!NOTE] > Your application must have support sending read requests to a custom port 5001, and write requests to port 5000. List of ports when using HAProxy: - port 5000 (read / write) master - port 5001 (read only) all replicas - port 5002 (read only) synchronous replica only - port 5003 (read only) asynchronous replicas only ##### Components of HAProxy load balancing: - [**HAProxy**](https://www.haproxy.org/) is a free, very fast and reliable solution offering high availability, load balancing, and proxying for TCP and HTTP-based applications. - [**confd**](https://github.com/kelseyhightower/confd) manage local application configuration files using templates and data from etcd or consul. Used to automate HAProxy configuration file management. - [**Keepalived**](https://github.com/acassen/keepalived) (_optional, if the `cluster_vip` variable is specified_) provides a virtual high-available IP address (VIP) and single entry point for databases access. Implementing VRRP (Virtual Router Redundancy Protocol) for Linux. In our configuration keepalived checks the status of the HAProxy service and in case of a failure delegates the VIP to another server in the cluster. #### 3. PostgreSQL High-Availability with Consul Service Discovery To use this scheme, specify `dcs_type: consul` in variable file vars/main.yml This scheme is suitable for master-only access and for load balancing (using DNS) for reading across replicas. Consul [Service Discovery](https://developer.hashicorp.com/consul/docs/concepts/service-discovery) with [DNS resolving ](https://developer.hashicorp.com/consul/docs/discovery/dns) is used as a client access point to the database. Client access point (example): - `master.postgres-cluster.service.consul` - `replica.postgres-cluster.service.consul` Besides, it can be useful for a distributed cluster across different data centers. We can specify in advance which data center the database server is located in and then use this for applications running in the same data center. Example: `replica.postgres-cluster.service.dc1.consul`, `replica.postgres-cluster.service.dc2.consul` It requires the installation of a consul in client mode on each application server for service DNS resolution (or use [forward DNS](https://developer.hashicorp.com/consul/tutorials/networking/dns-forwarding?utm_source=docs) to the remote consul server instead of installing a local consul client). ## Compatibility RedHat and Debian based distros (x86_64) ###### Supported Linux Distributions: - **Debian**: 11, 12 - **Ubuntu**: 22.04, 24.04 - **CentOS Stream**: 9 - **Oracle Linux**: 8, 9 - **Rocky Linux**: 8, 9 - **AlmaLinux**: 8, 9 ###### PostgreSQL versions: all supported PostgreSQL versions :white_check_mark: tested, works fine: PostgreSQL 10, 11, 12, 13, 14, 15, 16, 17 _Table of results of daily automated testing of cluster deployment:_ | Distribution | Test result | |--------------|:----------:| | Debian 11 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_debian11.yml) | | Debian 12 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_debian12.yml) | | Ubuntu 22.04 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_ubuntu2204.yml) | | Ubuntu 24.04 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_ubuntu2404.yml) | | CentOS Stream 9 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_centosstream9.yml) | | Oracle Linux 8 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_oracle_linux8.yml) | | Oracle Linux 9 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_oracle_linux9.yml) | | Rocky Linux 8 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_rockylinux8.yml) | | Rocky Linux 9 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_rockylinux9.yml) | | AlmaLinux 8 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_almalinux8.yml) | | AlmaLinux 9 | [](https://github.com/vitabaks/autobase/actions/workflows/schedule_pg_almalinux9.yml) | ## Getting Started You have the option to easily deploy Postgres clusters using the Console (UI), command line, or GitOps. > [!TIP] > 📩 **Contact us at [email protected]**, and our team will provide you with detailed deployment instructions and help you implement Autobase into your infrastructure. Deploying and managing PostgreSQL clusters can be challenging, especially without a dedicated database administrator (DBA). With **Autobase**, it becomes simpler: alongside powerful automation tools, you get **DBA as a Service (DBAaaS)**. This means access to PostgreSQL experts who will assist with deployment, maintenance, and optimization, ensuring your clusters run smoothly. Explore our [support packages](https://autobase.tech/docs/support) to find a plan that fits your needs.  Refer to the [Deployment](https://autobase.tech/docs/category/deployment) section to learn more about the different deployment methods. ## Star us If you find our project helpful, consider giving it a star on GitHub! Your support helps us grow and motivates us to keep improving. Starring the project is a simple yet effective way to show your appreciation and help others discover it. <a href="https://star-history.com/#vitabaks/autobase&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=vitabaks/autobase&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=vitabaks/autobase&type=Date" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=vitabaks/autobase&type=Date" /> </picture> </a> ## Sponsor this project By sponsoring our project, you directly contribute to its continuous improvement and innovation. As a sponsor, you'll receive exclusive benefits, including personalized support, early access to new features, and the opportunity to influence the project's direction. Your sponsorship is invaluable to us and helps ensure the project's sustainability and progress. Become a sponsor today and help us take this project to the next level! Support our work through [GitHub Sponsors](https://github.com/sponsors/vitabaks) [](https://github.com/sponsors/vitabaks) Support our work through [Patreon](https://www.patreon.com/vitabaks) [](https://patreon.com/vitabaks) ## License Licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. ## Author Vitaliy Kukharik (PostgreSQL DBA) \ [email protected] ## Feedback, bug-reports, requests, ... Are [welcome](https://github.com/vitabaks/autobase/issues)! ", Assign "at most 3 tags" to the expected json: {"id":"11909","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"