Repository files navigation

StackGres

Enterprise Postgres made easy. On Kubernetes

StackGres is a full-stack PostgreSQL distribution for Kubernetes, packed into an easy deployment unit.With a carefully selected and tuned set of surrounding PostgreSQL components.

An enterprise-grade PostgreSQL stack needs several other ecosystem components and significant tuning.It's not only PostgreSQL. It requires connection pooling, automatic failover and HA, monitoring,backups and DR, centralized logging… we have built them all: a Postgres Stack.

Postgres is not just the database. It is also all the ecosystem around it. If Postgres would be theLinux kernel, we need a PostgreSQL Distribution, surrounding PostgreSQL, to complement it with thecomponents that are required for production deployment. This is what we call a PostgreSQL Stack.And the stack needs to be curated. There are often several software for the same functionality. Andnot all are of the same quality or maturity. There are many pros and cons, and they are often noteasy to evaluate. It is better to have an opinionated selection of components, that can be packagedand configured to work together in a predictable and trusted way.

We recommend that you check ourdocumentation and have a look at theDemo / Quickstart section to know how to start using StackGres.

Also, on our webhttps://stackgres.io/install/, you can get the one-line command to install StackGres.

• Automated failover and High Availability with Patroni
• You are in full control. You are the postgres user
• Automated backups, lifecycle management
• Fully-featured management Web Console
• Automatic Prometheus integration. Built-in customized Grafana dashboards
• Distributed logs for Postgres and Patroni
• High-level management CRDs. GitOps ready
• Integrated server-side connection pooling
• Enhanced observability via Envoy Proxy’s Postgres filter
• Expertly tuned by default
• Lightweight, secure container images based on RedHat’s UBI 8

Everybody is welcome in this open Community for StackGres, check out the different ways to collaborate:

• Developer Documentation: If you are a Kubernetes Administrator or a Java Developer, you might want to contribute back to StackGres, either by testing it, developing Kubernetes code (Helm, architecture) or Java’s core operator.
• Public dashboards: If you want to see what’s coming down the road, check our issues. They are open so you can create issues yourself or comment on open issues. We welcome feedback, ideas and collaborations!
• Join theSlack &Discord Community becoming an advocate, user, tester or contributor of StackGres.

To ensure a more open and welcoming community, StackGres adheres to aCode of Conduct, and everyone involved in the projects, issues, chat rooms, and any other official communication channel, is expected to follow it.

This repository holds one of the major components around StackGres and is the StackGres Operatorbuild around Kubernetes. An Operator is a method of packaging, deploying and managing a Kubernetesapplication. Some applications, such as databases, required more hand-holding, and a cloud-nativePostgres requires an operator to provide additional knowledge of how to maintain state and integrateall the components.

This operator is built in pure-Java and uses theQuarkus framework a KubernetesNative Java stack tailored for GraalVM & OpenJDK HotSpot, crafted from the best of breed Javalibraries and standards.

The container image of StackGres is built on Red Hat Universal Base Image and compiled as a native binarywith GraalVM allowing amazingly fast boot time and incredibly low RSS memory.

No. StackGres contains PostgreSQL, plus several other components (such as connection pool orautomatic high availability software) from the PostgreSQL ecosystem. All of them are vanillaversions, as found in their respective open source repositories, including PostgreSQL.Any application that runs against a PostgreSQL database should work as-is.

StackGres source code is licensed under the OSI-approved open source licenseGNU Affero General Public License version 3 (AGPLv3). All the source code is available on thisrepository.

Yes. Contact us if you want a trial or commercial license that does not contain the GPL clauses.Will you ever switch from an open-source license to a source-available one?Our promise is that no, this won’t happen. We respect others who switch to or are directly builtas source-available software, but we don’t follow this approach.We love the concept of GitLab’s stewardship, and in the same spirit, we promise here thatStackGres will always be open source software.

As of now, PostgreSQL major version 12 and 13. As a general rule, StackGres will support the last 2 Postgres version.

StackGres has been designed to run on any Kubernetes-certified platform. Whether is aKubernetes-as-a-Service offered by a cloud provider or a distribution running on-premise,StackGres should run as-is.

High Availability and automatic failover are based on Patroni, a well-reputed and trusted softwarefor PostgreSQL. No external DCS (Distributed Consistent Storage) is required, as it relies onK8s APIs for this (which in turns reach etcd).

Red Hat Universal Base Images (UBI) are OCI-compliant container base operating system images withcomplementary runtime languages and packages that are freely redistributable. UBI lets developerscreate the image once and deploy anywhere using enterprise-grade packages. For more information readthe officialUBI-FAQ.

   _____ _             _     _____  / ____| |           | |   / ____| | (___ | |_ __ _  ___| | _| |  __ _ __ ___  ___  \___ \| __/ _` |/ __| |/ / | |_ | '__/ _ \/ __|  ____) | || (_| | (__|   <| |__| | | |  __/\__ \ |_____/ \__\__,_|\___|_|\_\\_____|_|  \___||___/                                  by OnGres, Inc.