cloudnative-pg / cloudnative-pg.github.io

CloudNativePG website

Welcome to the CloudNativePG project!

CloudNativePG is a comprehensive open source platform designed to seamlessly manage PostgreSQL databases within Kubernetes environments, covering the entire operational lifecycle from initial deployment to ongoing maintenance. The main component is the CloudNativePG operator.

CloudNativePG was originally built and sponsored by EDB.

Table of content

• Code of conduct
• Governance policies
• Contributing
• Adopters
• License

Getting Started

The best way to get started is with the "Quickstart" section in the documentation.

Scope

The goal of CloudNativePG is to increase the adoption of PostgreSQL, one of the most loved DBMS in traditional VM and bare metal environments, inside Kubernetes, thus making the database an integral part of the development process and GitOps CI/CD automated pipelines.

In scope

CloudNativePG has been designed by Postgres experts with Kubernetes administrators in mind. Put simply, it leverages Kubernetes by extending its controller and by defining, in a programmatic way, all the actions that a good DBA would normally do when managing a highly available PostgreSQL database cluster.

Since the inception, our philosophy has been to adopt a Kubernetes native approach to PostgreSQL cluster management, making incremental decisions that would answer the fundamental question: "What would a Kubernetes user expect from a Postgres operator?".

The most important decision we made is to have the status of a PostgreSQL cluster directly available in the Cluster resource, so to inspect it through the Kubernetes API. We've fully embraced the operator pattern and eventual consistency, two of the core principles upon which Kubernetes is built for managing complex applications.

As a result, the operator is responsible for managing the status of the Cluster resource, keeping it up to date with the information that each PostgreSQL instance manager regularly reports back through the API server. Changes to the cluster status might trigger, for example, actions like:

• a PostgreSQL failover where, after an unexpected failure of a cluster's primary instance, the operator itself elects the new primary, updates the status, and directly coordinates the operation through the reconciliation loop, by relying on the instance managers

• scaling up or down the number of read-only replicas, based on a positive or negative variation in the number of desired instances in the cluster, so that the operator creates or removes the required resources to run PostgreSQL, such as persistent volumes, persistent volume claims, pods, secrets, config maps, and then coordinates cloning and streaming replication tasks

• updates of the endpoints of the PostgreSQL services that applications rely on to interact with the database, as Kubernetes represents the single source of truth and authority

• updates of container images in a rolling fashion, following a change in the image name, by first updating the pods where replicas are running, and then the primary, issuing a switchover first

The latter example is based on another pillar of CloudNativePG: immutable application containers - as explained in the blog article "Why EDB Chose Immutable Application Containers".

The above list can be extended. However, the gist is that CloudNativePG exclusively relies on the Kubernetes API server and the instance manager to coordinate the complex operations that need to take place in a business continuity PostgreSQL cluster, without requiring any assistance from an intermediate management tool responsible for high availability and failover management like similar open source operators.

CloudNativePG also manages additional resources to help the Cluster resource manage PostgreSQL - currently Backup, ClusterImageCatalog, ImageCatalog, Pooler, and ScheduledBackup.

Fully embracing Kubernetes means adopting a hands-off approach during temporary failures of the Kubernetes API server. In such instances, the operator refrains from taking action, deferring decisions until the API server is operational again. Meanwhile, Postgres instances persist, maintaining operations based on the latest known state of the cluster.

Out of scope

CloudNativePG is exclusively focused on the PostgreSQL database management system maintained by the PostgreSQL Global Development Group (PGDG). We are not currently considering adding to CloudNativePG extensions or capabilities that are included in forks of the PostgreSQL database management system, unless in the form of extensible or pluggable frameworks.

CloudNativePG doesn't intend to pursue database independence (e.g. control a MariaDB cluster).

Communications

• Slack Channel
• Github Discussions
• Twitter

Resources

• Roadmap
• Website
• FAQ
• Blog

Adopters

A list of publicly known users of the CloudNativePG operator is in ADOPTERS.md. Help us grow our community and CloudNativePG by adding yourself and your organization to this list!

CloudNativePG at KubeCon

• March 21 2024, KubeCon Europe 2024 in Paris: "Scaling Heights: Mastering Postgres Database Vertical Scalability with Kubernetes Storage Magic" (Gari Singh, Google & Gabriele Bartolini, EDB)
• March 19 2024, Data on Kubernetes Day at KubeCon Europe 2024 in Paris: "From Zero to Hero: Scaling Postgres in Kubernetes Using the Power of CloudNativePG" (Gabriele Bartolini, EDB)
• 7 November 2023, KubeCon North America 2023 in Chicago: "Disaster Recovery with Very Large Postgres Databases (in Kubernetes)" (Michelle Au, Google & Gabriele Bartolini, EDB)
• 27 October 2022, KubeCon North America 2022 in Detroit: "Data On Kubernetes, Deploying And Running PostgreSQL And Patterns For Databases In a Kubernetes Cluster" (Chris Milsted, Ondat & Gabriele Bartolini, EDB)

Useful links

• Data on Kubernetes (DoK) Community
• "How to migrate your PostgreSQL database in Kubernetes with ~0 downtime from anywhere" by Gabriele Bartolini (March 2024)
• "Maximizing Microservice Databases with Kubernetes, Postgres, and CloudNativePG" by Gabriele Bartolini (February 2024)
• "Recommended Architectures for PostgreSQL in Kubernetes" by Gabriele Bartolini (September 2023)
• "The Current State of Major PostgreSQL Upgrades with CloudNativePG" by Gabriele Bartolini (August 2023)
• "The Rise of the Kubernetes Native Database" by Jeff Carpenter (December 2022)
• "Why Run Postgres in Kubernetes?" by Gabriele Bartolini (May 2022)
• "Shift-Left Security: The Path To PostgreSQL On Kubernetes" by Gabriele Bartolini (April 2021)
• "Local Persistent Volumes and PostgreSQL usage in Kubernetes" by Gabriele Bartolini (June 2020)

Star History

Trademarks

Postgres, PostgreSQL and the Slonik Logo are trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and used with their permission.

cloudnative-pg.github.io's Issues

Add an author archetype

To make it easier to add authors. We could also have a page of authors, and associated taxonomy /cc @aradhanabirewar @mattmanieri .

Add number of stars in Github

Use https://buttons.github.io/ or similar to add a widget with stars of the project

Fix twitter card

Twitter card doesn't support SVG so the image must be PNG or JPG

Fix import_docs script to build HTML version

Prepare documentation for 1.16.0 and 1.15.2

CloudNativePG 1.16.0 will be released on July 7. We need to prepare the documentation for that version.

This will be the first time we release a patch release for another minor release, 1.15.2.

Update docs to 1.16.1 and 1.15.3

Announce 1.19.0 and updates for the 1.18 and 1.7 minor versions

Add margin-bottom on blog labels (well and sidebar)

Easy fix to list items in Well and Sidebar...
-add class mb-2

<li class="bg-charcoal-opacity-10 py-1 px-2.5 inline-block mr-2 mb-2">blog</li>

Redirect 1.15.1 and 1.15.0 docs to 1.15 folder

With #57 being merged, we should add redirects from the previous 1.15.1 and 1.15.0 versions of the documentation to the 1.15 one.

Properly display list items

List items are rendered without bullets. While in some pages this might be OK, in markdown and structured documents this is reducing the readability of pages. For example:

https://cloudnative-pg.io/blog/cloudnative-pg-1-15-1-released/

Can we please fix this? Thanks.

Add favicon.ico

Add PostgreSQL trademark in the footer

Add:

Postgres, PostgreSQL and the Slonik Logo are trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and used with their permission.

With link: https://www.postgresql.org/about/policies/trademarks

Update to version 1.16.0 and 1.15.2

Add support for mobile devices

While this is not necessary for the open source launch (April 20, 2022), before KubeCon launch (May 10, 2022) we need to make sure that the website is accessible through mobile devices.

Properly display links

In the blog page it is hard to understand which text is actually part of a hyperlink. Can this be fixed please?

Write 1.20 announcement

Move pre-release development from 'main' to 'dev'

Or leave main as is, and use a different branch for publishing the website.

Announcement for 1.19.1, 1.18.3 and 1.17.5

Add per-author RSS feed, possibly with filters

To enable adding to https://planet.postgresql.org

Prepare announcement for 1.17

Update hugo version

Latest version of Hugo is 0.101.0 and we're using 0.96.0

Create blog & release RSS feed(s)

We should have an RSS of blog posts & releases (either as a single feed or multiple)

Use invitation link for Slack

See cloudnative-pg/cloudnative-pg#93

Grafana Sidecar Dashboards has to be enabled

By default sidecar.dashboards.enabled is set to false as stated in The Grafana Helm Chart Doc

It has to be enabled in this config in order to Grafana automatically creates the dashboard from the configMap.

cloudnative-pg.github.io/assets/documentation/1.18/samples/monitoring/kube-stack-config.yaml

Lines 61 to 65 in bb91f6f

	grafana:
	enabled: true
	# -- the grafana admin password
	adminPassword: prom-operator
	defaultDashboardsEnabled: false

It Should look lile:

  grafana:
    enabled: true
    # -- the grafana admin password
    adminPassword: prom-operator
    defaultDashboardsEnabled: false
    sidecar:
      dashboards:
        enabled: true

Blog images may be deformed: e.g. elephant image in release notes

In the release notes: https://cloudnative-pg.io/blog/cloudnative-pg-1-16-0-released/
The elephant image has a variable width and will be deformed.
Looking at the image element, seems to have a w-full full width. This results in deformation of the image.

<img src="wildlife-zoo-mammal-fauna-elephant-sri-lanka-988769-pxhere.com.jpg" alt="blog image" class="h-80 mx-auto w-full">

Update documentation for supported branches

Fix rendering of Authors page on mobile

The new Author pages don't render well on mobile.

• The photo gets deformed
• The text is too narrow

We had similar issue with the blog pages, already fixed: #129

Introduce multiple release branches in the import docs script

Improve the import docs script to manage release branches. Also, documentation should now consider having only one folder per minor release, with the latest stable one in that release branch to be displayed.

Announcement for 1.20.1

Fix link to 1.15.0 docs in the nav

Website readability/accessibility

Hi, I wanted to leave a note here that the website is not very readable - red on blue is hard for me to read (I have no visual impairment), and I think the difference in contrast is not enough for people who do have vision problems. Perhaps we can investigate a change in colours?

Documentation for 1.17.0, 1.16.2, and 1.15.4

Announce 1.16.1 and 1.15.3

Fix narrow tag cloud and blog snippets, and UPPERCASE

In blog pages, we have the article displayed in normal width.
At the bottom, there is a section with the tag cloud, and other posts.
This is displayed super narrow.
And the tags in all caps are an eye sore and look like a shady site.
Also, the images in the snippets don't have their aspect ratios preserved.

Update documentation for 1.21

Add author page & RSS feed

Each author should have their own page, with all their blogs on, have this x-linked with the posts themselves, and an RSS feed per author.

Enable Open Graph

We should enable Open Graph to have pretty presentation of the URL in different places like Slack

Update docs for 1.15.1

Add robots exclusions for version specific documentation

We should encourage search engines to index only the current version documentation, and exclude the specific version docs.

For example:

• allow https://cloudnative-pg.io/documentation/current/
• deny https://cloudnative-pg.io/documentation/1.17/
• deny https://cloudnative-pg.io/documentation/1.16/
• and so on

Update documentation for supported branches

Announce 1.18

Add link to EDB's k8s landing page from home page

As original creater, allos EDB to include a link to the designated URL in the home page. The URL is https://www.enterprisedb.com/products/cloud-native-postgresql-kubernetes-ha-clusters-k8s-containers-scalable

Prepare blog article about the 1.16 release

Also mention the 1.15 release and 1.17 expected release date, as well as 1.15 EOL

Add twitter card

When sharing the post on twitter we should make use of the twitter card

Update documentation for 1.19.0 release

Blog section renders poorly on mobile

While the landing page, and the Documents section, render OK on mobile,
the Blogs section, and individual blog entries, are on the verge of unusable.

Salient issues:

• The <h1> font is so large that CloudNativePG will not fit in portrait
  orientation, and will screw up the page width for the whole post. (see grab)
• The blog image gets squashed (see grab)
• The button Continue Reading is broken (see grab)
• When rendering a blog post, the left and right margins are too big, leaving
  little room for the text (see grab)

Add v1.15.0 docs

Documentation section is off

Seen Tue 17 May.
In https://cloudnative-pg.io/docs/
I just get this blurb

Documentation

These documentation pages are built from the operators source code and are versioned along side tags/releases of the operator. Please report any dificiencies via the projects issue tracker.

And no further content. Was working yesterday,

Add support page

Create the "Support" page. A placeholder would do, then @gbartolini will be adding content.

Add end users page

Next to Support, add a new page called "End users". Similar to #5 create a placeholder page and @gbartolini will add the content.