Vous trouverez en ligne les différentes versions complètes de ce document.

Vous n’avez pas le droit d’utiliser cette création à des fins commerciales.

Si vous modifiez, transformez ou adaptez cette création, vous n’avez le droit de distribuer la création qui en résulte que sous un contrat identique à celui-ci.

Vous devez citer le nom de l’auteur original de la manière indiquée par l’auteur de l’œuvre ou le titulaire des droits qui vous confère cette autorisation (mais pas d’une manière qui suggérerait qu’ils vous soutiennent ou approuvent votre utilisation de l’œuvre). À chaque réutilisation ou distribution de cette création, vous devez faire apparaître clairement au public les conditions contractuelles de sa mise à disposition. La meilleure manière de les indiquer est un lien vers cette page web. Chacune de ces conditions peut être levée si vous obtenez l’autorisation du titulaire des droits sur cette œuvre. Rien dans ce contrat ne diminue ou ne restreint le droit moral de l’auteur ou des auteurs.

Le texte complet de la licence est disponible sur http://creativecommons.org/licenses/by-nc-sa/2.0/fr/legalcode

Cette licence interdit la réutilisation pour l’apprentissage d’une IA. Elle couvre les diapositives, les manuels eux-mêmes et les travaux pratiques.

Cette formation peut également contenir quelques images et schémas dont la redistribution est soumise à des licences différentes qui sont alors précisées.

Sur les versions précédentes susceptibles d’être encore rencontrées en production, seuls quelques points très importants sont évoqués, en plus éventuellement de quelques éléments historiques.

Sauf précision contraire, le système d’exploitation utilisé est Linux.

Photo de Walter Gehr, Creative Commons licence.

Différents sujets seront abordés pour présenter l’opérateur le mieux possible, que ce soit sur le projet CloudNativePG (historique, développement, CNCF…), sur ses fonctionnalités, ses mécanismes internes ou encore les images utilisées.

L’objectif de ce module est la découverte de l’opérateur CloudNativePG mais également de sa prise en main. L’opérateur facilite le déploiement de clusters PostgreSQL dans Kubernetes. Une présentation générale de ce qu’est un opérateur et de son rôle sera faite pour bien poser le contexte.

Le TP permet d’installer l’opérateur CloudNativePG, de déployer un cluster PostgreSQL et d’effectuer différentes opérations comme la configuration d’une instance, la mise en place de sauvegardes ou de la restauration.

Kubernetes est une plateforme qui permet d’orchestrer le déploiement de nombreuses applications sous la forme de conteneurs. Cette plateforme, initialement imaginée pour des applications dites Stateless (sans état), est devenue petit à petit une pierre angulaire de l’infrastructure informatique de nombreuses sociétés. Particulièrement appréciée des développeurs, cette solution se voit être de plus en plus utilisée pour héberger des applications de type base de données, quelles soient relationnelles ou non.

Ce schéma montre très simplement le principe d’un cluster Kubernetes, composé de trois nœuds de travail, ou Workers, et d’un plan de contrôle, ou Control Plane qui est en charge de gérer les ressources et la distribution des conteneurs sur l’ensemble des nœuds du cluster

Sur chacun des nœuds se trouvent un environnement d’exécution de conteneur (ou Container Runtime, comme DockerEngine, containerd ou encore CRI-O,) qui permet au Kubelet (composant Kubernetes) de créer les Pods et les conteneurs qui les composent.

Lorsqu’une application conteneurisée doit être déployée, un nœud est choisi en suivant certaines règles et un Pod est créé. Il peut contenir un ou plusieurs conteneurs qui partageront alors une certains nombre de ressources (mémoire, processeur, Huge Pages, pile réseau, etc).

Tout l’objet de ce module est de voir comment il est possible de déployer des instances PostgreSQL conteneurisées grâce au concept d’opérateur Kubernetes.

Kubernetes permet la création de certains objets (Resources), au sein d’un cluster. Il y a de nombreux objets ayant chacun un rôle bien précis dans différents domaines (réseau, stockage, déploiement de conteneur, configuration, tâche planifiée, …). C’est à partir de ces objets de base que l’on peut définir les applications à déployer en écrivant des manifests au format YAML.

Un Pod par exemple est le plus petit objet dans Kubernetes. Il représente la plus petite unité déployable au sein d’un cluster. Il embarque un ou plusieurs conteneurs applicatifs, une identité réseau pour les rendre joignables, des options supplémentaires et des ressources (ram, cpu, …) qui, le cas échéant, seront partagées entre les différents conteneurs.

Les Services quant à eux permettent d’accéder aux Pods quelque soit l’emplacement où ils se trouvent, c’est à dire que, si un Pod est redéployé sur un autre nœud, il saura acheminer les paquets réseaux au bon endroit.

Ces objets, bien que nombreux peuvent être assez génériques, notamment les Pods qui se “contentent” de déployer des conteneurs. Ils n’ont aucune connaissance sur le type d’application qu’ils contiennent.

C’est exactement à ce moment que rentrent en jeu les opérateurs avec la définition de ressources spécifiques et leur gestion fine des applications déployées.

Un opérateur étend les possibilités d’un cluster Kubernetes grâce à la définition de Custom Resource Definition. Elles indiques les spécifications de nouvelles ressources qui seront désormais déployables dans le cluster.

Par exemple, l’opérateur CloudNativePG ajoute les ressources suivantes à l’API de Kubernetes.

kubectl api-resources --api-group=postgresql.cnpg.io
NAME                   SHORTNAMES   APIVERSION              NAMESPACED   KIND
backups                             postgresql.cnpg.io/v1   true         Backup
clusterimagecatalogs                postgresql.cnpg.io/v1   false        ClusterImageCatalog
clusters                            postgresql.cnpg.io/v1   true         Cluster
databases                           postgresql.cnpg.io/v1   true         Database
imagecatalogs                       postgresql.cnpg.io/v1   true         ImageCatalog
poolers                             postgresql.cnpg.io/v1   true         Pooler
publications                        postgresql.cnpg.io/v1   true         Publication
scheduledbackups                    postgresql.cnpg.io/v1   true         ScheduledBackup
subscriptions                       postgresql.cnpg.io/v1   true         Subscription

Au lieu de devoir déployer manuellement des ressources de bases de Kubernetes (Pod, Secret, Service, …) pour former une instance PostgreSQL, un opérateur nous permet d’instancier de nouvelles ressources directement de type instance PostgreSQL. La création des ressources de base est laissé à la discrétion de l’opérateur.

Au delà de ces nouvelles ressources, un opérateur apportera également des fonctionnalités plus poussées, comme, en ce qui concerne des opérateurs dédiés à PostgreSQL, l’automatisation des montées de versions, de la bascule automatique en cas de panne, de la gestion des sauvegardes, etc.

Les opérateurs existants ont chacun leurs spécificités et particularités. Le site operatorhub liste les principaux opérateurs qui existent.

Leur maturité est différente, allant du niveau 1, correspondant à des opérateurs facilitant l’installation et la configuration, jusqu’au niveau 5 où un opérateur se doit de pouvoir faire face à des situations plus complexes (auto-healing, bascule automatique, …). Voir à ce propos le site Operator Framework qui explique les différents niveaux existants.

Le premier opérateur qui a vu le jour est celui de Zalando. Il a été écrit pour répondre à un des besoins de leurs équipes de développeurs. Ils voulaient un outil leur permettant de déployer facilement des instances PostgreSQL sans pour autant passer par des cloud providers et en changeant un outil web interne devant obsolète qui était utilisé jusqu’à présent. Le cas d’usage d’instances de tests ou jetables était présent. Kubernetes pouvait répondre à ce besoin mais nécessitait un outil spécifique pour gérer le déploiement et la configuration des instances.

Chacun de ces opérateurs à des spécificités propres dans différents domaines. Par exemple, l’ajout d’une nouvelle extension PostgreSQL est gérée différemment selon l’opérateur. La plupart imposent qu’elles soient présentes dans l’image de conteneur utilisée, d’autres mettent en place des mécanismes pour en rajouter à chaud. Les licences de publication des opérateurs et des images sont elles aussi différentes (MIT, Apache 2.0, GNU AGPLv3, …). L’opérateur CloudNativePG se repose uniquement sur l’API de Kubernetes pour gérer la haute disponibilité et la bascule automatique en cas de panne. Les autres embarquent l’outil Patroni dans les images. Enfin, les outils de sauvegardes physiques varient. Barman ou pgBackRest restent tout de même principalement utilisés.

Ces opérateurs ont leurs projets sur Github (que ce soit leur vrai dépôt ou un miroir de celui‑ci). Chaque utilisateur sur Github a la possibilité de marquer un projet comme intéressant en lui attribuant une étoile.

Il est donc possible de connaître l’attrait de chaque projet. Le graphique présenté montre l’évolution au fil des années de l’attrait des cinq opérateurs les plus connus. CloudNativePG est celui qui connaît la courbe d’adoption la plus spectaculaire.

Le projet a été initialement développé par la société 2ndQuadrant en 2019. La société a été rachetée par EnterpriseDB (EDB) en 2020. Le développement de cet opérateur a continué en interne avant que le projet ne soit rendu Open Source en 2022.

La gouvernance du projet se rapproche de celle de PostgreSQL avec une core team et l’ouverture à la contribution communautaire. L’intégration d’un nouveau mainteneur est soumise au vote des mainteneurs actuels du projet.

Le projet est bien engagé dans une démarche communautaire et Open Source avec notamment l’acceptation du projet au programme Sandbox de la Cloud Native Computing Foundation en janvier 2025.

La documentation du projet est particulièrement claire et fournie.

D’une manière générale, si vous souhaitez déployer des instances PostgreSQL dans Kubernetes, nous vous recommandons d’utiliser un opérateur, quel qu’il soit. Les opérateurs sont spécialisés dans la gestion d’instances PostgreSQL. Nous déconseillons vivement le déploiement de conteneurs PostgreSQL sans opérateur, d’autant plus pour de la production.

Les fonctionnalités de CloudNativePG sont nombreuses. Il vous permet de gérer de manière déclarative un ensemble d’éléments PostgreSQL (bases, rôles, tablespaces…). Ils seront détaillés dans la suite du module.

Le déploiement d’instances, qu’elles soient primaires ou secondaires est très nettement facilité par l’opérateur : l’utilisateur de réplication est créé automatiquement, le déploiement d’un secondaire se fait en modifiant un seul champ dans la définition YAML, un slot de réplication est automatiquement créé pour protéger la réplication.

L’archivage des journaux de transactions est également supportée nativement par l’opérateur. Le paramètre archive_command est positionné par défaut.

Les sauvegardes PITR sont supportées nativement et faites, par défaut, via l’outil Barman Cloud sur des stockages “cloud” (S3, GCP, Azure Blob).

La haute disponibilité est nativement supportée et gérée par l’intermédiaire des objets Services de Kubernetes et une utilisation astucieuse des Labels (un article de blog a d’ailleurs été écrit à ce sujet.)

Toutes ces fonctionnalités sont très alléchantes, il n’en reste pas moins que de nombreux changements surviennent en déployant PostgreSQL sur une infrastructure conteneurisée comme Kubernetes. Un certain temps doit être alloué à l’étude de cette migration d’infrastructure tant les sujets impactés sont variés et importants : système de stockage, extensions PostgreSQL, images utilisées, accessibilité des instances, récupération des traces…

Des changements d’habitudes de travail auront nécessairement lieu et impliqueront également un accompagnement des équipes DBAs.

Le PostgreSQL Global Development Group supporte chaque version majeure pendant une durée minimale de 5 ans. Par exemple, n’est plus supportée la version 12 depuis novembre 2024. Il n’y aura pour elle plus aucune mise à jour mineure, donc plus de correction de bug ou de faille de sécurité. Le support de la version 13 s’arrêtera en novembre 2025. Le support de la dernière version majeure, la 17, devrait durer jusqu’en 2029. Sur une année, il y a donc cinq versions de PostgreSQL simultanément supportées.

Cette politique de support de version est suivie par le projet CloudNativePG. L’opérateur permet de déployer uniquement des versions de PostgreSQL qui sont supportées par le PGDG.

En ce qui concerne les versions de l’opérateur, deux versions sont supportées simultanément. Actuellement ce sont les versions 1.26.x et 1.27.x. Chaque version est également supportée pour des versions spécifiques de Kubernetes.

La fréquence de montée de version sera donc plus élevée que d’habitude comme l’opérateur doit être mis à jour fréquemment. La durée de vie d’une version de CloudNativePG est de 6 mois.

N’hésitez pas à regarder la documentation à ce sujet : Supported releases.

Il vous sera important d’avoir des créneaux de maintenance pour effectuer ces montées de versions.

Un opérateur Kubernetes est, de manière simplifiée, composé de deux éléments :

• Un contrôleur ;
• Des Custom Resource Definitions.

Le premier élément n’est ni plus ni moins que le code de l’opérateur, son intelligence. Il embarque un ensemble de fonctions pour gérer convenablement PostgreSQL. L’opérateur CloudNativePG est écrit en Go et se base sur le framework de développement de CLI Cobra. Nous ne rentrerons pas dans le détail du développement de l’opérateur, mais sachez que pour chaque Custom Resource définie, il existe dans le code un controller. Cet élément est en charge de la gestion de chacune des ressources qui peuvent être gérées par l’opérateur (Backup, Cluster, etc ).

Les Custom Resource Definitions contiennent la définition des nouvelles ressources Kubernetes qu’apporte l’opérateur. À partir du moment où les définitions sont déclarées dans le cluster Kubernetes, elles pourront être créées par un utilisateur. Ce sera alors l’opérateur qui saura les gérer (création, modification…).

L’installation de l’opérateur peut se faire de plusieurs manières différentes :

• soit en appliquant directement les fichiers YAML ;
• soit en utilisant le Helm Chart fourni par le projet ;
• soit via OLM (Operator Lifecycle Manager).

Les fichiers YAML se trouvent sur le githubusercontent.com du projet CloudNativePG. Pour la version 1.27.0 de l’opérateur, il est possible de les trouver ici : https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/release-1.27/releases/cnpg-1.27.0.yaml.

Pour installer l’opérateur sur un cluster Kubernetes auquel vous avez accès, rien de plus simple. Il suffit d’appeler kubectl apply --server-side -f suivi de l’URL.

kubectl apply --server-side \
-f  https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/main/releases/cnpg-1.yaml

Différentes ressources Kubernetes seront créées (Namespace, ServiceAccount, Configmap, Deployment etc). Toutes sont importantes évidemment, mais la Deployment nommée cnpg-controller-manager est la plus centrale puisqu’elle correspond concrètement à l’intelligence de l’opérateur CloudNativePG.

namespace/cnpg-system serverside-applied
customresourcedefinition.apiextensions.k8s.io/backups.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/clusterimagecatalogs.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/clusters.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/imagecatalogs.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/poolers.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/scheduledbackups.postgresql.cnpg.io serverside-applied
serviceaccount/cnpg-manager serverside-applied
clusterrole.rbac.authorization.k8s.io/cnpg-manager serverside-applied
clusterrolebinding.rbac.authorization.k8s.io/cnpg-manager-rolebinding serverside-applied
configmap/cnpg-default-monitoring serverside-applied
service/cnpg-webhook-service serverside-applied
deployment.apps/cnpg-controller-manager serverside-applied
mutatingwebhookconfiguration.admissionregistration.k8s.io/cnpg-mutating-webhook-configuration serverside-applied
validatingwebhookconfiguration.admissionregistration.k8s.io/cnpg-validating-webhook-configuration serverside-applied

L’autre possibilité est d’utiliser le Helm Chart proposé par le projet CloudNativePG (ou vos propres Helm Chart si vous êtes suffisamment à l’aise). Il est également disponible publiquement sur Github (voir https://github.com/cloudnative-pg/charts/tree/main/charts/cloudnative-pg). Il vous faudra avant tout ajouter le dépôt cnpg pour retrouver les Charts :

helm repo add cnpg https://cloudnative-pg.github.io/charts

Puis installer avec la commande helm upgrade --install :

helm upgrade --install cnpg \
  --namespace cnpg-system \
  --create-namespace \
  cnpg/cloudnative-pg

La dernière option, via OLM, nécessite l’installation du manager OLM dans votre cluster Kubernetes puis d’installer CloudNativePG via ce manager.

Le choix de la méthode d’installation vous revient entièrement. Il doit être adapté à votre méthode de déploiement (à la main ? avec une chaîne CI/CD ?).

Quelque soit la manière dont est installé l’opérateur, vous ne pourrez installer qu’un seul opérateur par cluster Kubernetes.

Il est nécessaire de distinguer deux types d’images. La première concerne l’opérateur CloudNativePG qui est une brique logicielle, développée en Go, et qui est mise à disposition sous forme d’image par l’équipe en charge du projet. Par défaut, l’image utilisée est cloudnative-pg:1.27.0. Elle se trouve sur la registry de Github (ghcr.io) associée au projet CloudNativePG.

L’opérateur va se charger de déployer PostgreSQL pour nous. Ces déploiements se font à partir d’images également fournies par le projet. Elles se trouvent également sur cette même registry et leur nom est postgresql:X.Y ou X correspond à la version majeure de PostgreSQL et Y à la version mineure qui doit être déployée.

Cette image-là repose sur une autre image fournie quant à elle par la communauté Docker PostgreSQL. Il est possible de voir cela dans le fichier Dockerfile de l’image, avec la ligne FROM postgres:%%POSTGRES_IMAGE_VERSION%%. L’image qui contient PostgreSQL et utilisée par l’opérateur CloudNativePG est construite à partir d’une autre image.

Il vous est possible de créer vos propres images et de les utiliser avec CloudNativePG. Certains pré-requis sont nécessaires comme par exemple la présence dans le PATH des outils initdb, pg_ctl et d’exécutables Barman Cloud. Tous les pré-requis sont listés dans la documentation.

Le principe de la gestion déclarative est de décrire ce que l’on souhaite (une instance PostgreSQL, une sauvegarde, une base de données, etc) et de laisser le système, en l’occurrence Kubernetes et l’opérateur CloudNativePG, faire le travail de déploiement pour nous.

Leurs rôles est de faire en sorte que l’état d’une ressource corresponde toujours à l’état désiré (i.e défini dans le fichier YAML). C’est ce qui est appelé une boucle de réconciliation. L’opérateur suit les changements, voulus ou exceptionnels, qui ont lieu sur la ressource en question et réagira en conséquence.

Passons en revue quelques ressources qui sont désormais créables dans Kubernetes.

Quelques lignes de YAML suffisent pour décrire un cluster PostgreSQL. Voici une explication des différents champs présents :

• apiVersion : la version de l’API de Kubernetes utilisée (ici celle apportée par l’opérateur CloudNativePG) ;
• kind : le type d’objet créé; ici un cluster PostgreSQL (donc une ou plusieurs instances) ;
• metadata : des informations pour identifier l’objet, notamment son nom (name) ;
• spec : les spécifications de l’objet en question ;
  • instances : le nombre d’instances voulues (sera toujours un primaire, plus le reste en secondaire(s)) ;
  • storage : les informations sur le stockage souhaité pour PGDATA, par exemple la taille (size) des Persistant Volumes ;
  • walStorage : les informations sur le stockage souhaité pour les journaux de transactions.

Vous noterez qu’il n’est pas obligatoire d’indiquer quelle image sera utilisée. Par défaut, l’image utilisée pour ce Pod sera celle proposée par le projet CloudNativePG : ghcr.io/cloudnative-pg/postgresql:X.Y ou X représente le numéro de la dernière version majeure et Y le numéro de la dernière version mineure publiée par le projet PostgreSQL.

Une bonne pratique dans PostgreSQL souvent recommandée mais peu appliquée est d’avoir au moins deux espaces de stockage bien distincts :

• un pour les données ;
• un pour les journaux de transactions (WAL).

CloudNativePG respecte cette bonne pratique avec le paramètre spec.walStorage. Lorsque le cluster est créé, deux Persistant Volumes distincts sont créés automatiquement, un pour PGDATA et un pour les journaux de transactions (WAL). Si ce paramètre n’est pas utilisé, les journaux se trouveront dans le même volume que PGDATA, ce que nous ne recommandons pas.

De nombreux paramètres supplémentaires existent pour configurer nos instances PostgreSQL. Des subtilités existent aussi dans le déploiement du Pod, notamment sur le fait qu’un init-container est déployé avant le conteneur PostgreSQL. Tout ceci sera détaillé plus tard dans ce module.

Lorsque vous déployez une instance, plusieurs éléments sont automatiquement créés par l’opérateur, que ce soit dans l’instance avec la création de rôles ou d’une base de données, ou dans Kubernetes comme des Secrets ou des Services.

L’instance déployée est partiellement configurée pour fonctionner dès sa création. Plusieurs paramètres PostgreSQL sont déjà configurés, le fichier pg_hba.conf est en partie renseigné, des certificats sont générés, etc.

Deux nouveaux rôles existent : app et streaming_replica. Le premier est un rôle basique avec le droit de connexion. Le deuxième est un rôle utilisé par les instances secondaires lors de la mise en place de la réplication physique. Le rôle postgres existe lui aussi mais n’est pas créé par CloudNativePG.

Une base de données nommée app est d’office créée avec la configuration suivante :

• Name : app
• Owner : app
• Encoding : UTF8
• Locale Provider : libc
• Collate : C
• Locale Provider : C

Du côté de Kubernetes aussi, des ressources sont automatiquement créées. Certaines nous concernent directement en tant qu’administrateur PostgreSQL. Il y a notamment un Secret qui est créé et qui contient le mot de passe du rôle PostgreSQL app. D’autres objets comme des Services sont utilisés pour la connectivité de l’instance, ou des instances si des réplications existent.

Pour chaque cluster PostgreSQL déployé, trois services dédiés sont créés. Par exemple, pour le Cluster nommé postgresql :

• un service qui permet d’accéder au primaire : postgresql-rw qui est en lecture/écriture ;
• un service qui permet d’accéder uniquement aux secondaires : postgresql-ro qui sont en lecture seule ;
• un service qui permet d’accéder à toutes les instances : postgresql-r.

Nous verrons lorsque le sujet de la haute disponibilité sera abordé à quoi ces Services peuvent servir.

Les éléments déployés par défaut par CloudNativePG peuvent être modifiés si ils ne vous conviennent pas. Cependant, vous devez le faire à l’initialisation de l’instance. Cela ne sera plus possible après coup.

La section bootstrap correspond à la manière dont est initiée l’instance. Par défaut c’est la méthode initdb qui est utilisée, mais nous verrons que d’autres méthodes peuvent être utlisées, notamment pour créer une instance à partir d’une sauvegarde.

Les changements que vous voulez apporter doivent être inscrits dans la section bootstrap.initdb. Dans l’exemple suivant, le nom de la base automatiquement créée et le nom du rôle sont modifiés par mabase et monrole.

  bootstrap:
    initdb:
      database: mabase
      owner: monrole

De nombreuses autres options peuvent être passées à initdb, comme les plus notables :

• dataChecksums : pour activer les sommes de contrôle sur l’instance (false par défaut ) ;
• encoding : pour choisir l’encodage des caractères (UTF8 par défaut) ;
• walSegmentSize : si voulez changer la taille par défaut (16 Mo) des WALs.

Vous pouvez créer des ressources Database depuis la version 1.25.0 de l’opérateur. L’exemple ci-dessus permet de créer la base mabase dans l’instance PostgreSQL référencée par le paramètre spec.cluster.name. Le rôle monrole sera le propriétaire de cette base. Il doit exister dans l’instance pour que la création de cette ressource se fasse correctement. Autrement, un message d’erreur apparaîtra dans la description de la ressource. Par exemple :

kubectl get databases.postgresql.cnpg.io -o=custom-columns=MESSAGE:..message

MESSAGE
while creating database "mabase": ERROR: role "monrole" does not exist (SQLSTATE 42704)

Il existe là aussi de nombreux paramètres pour configurer une ressource Database. En ce qui concerne l’exemple ci-dessus :

• apiVersion : la version de l’API de Kubernetes est utilisée (ici celle apportée par l’opérateur CloudNativePG) ;
• kind : le type d’objet créé, ici une base de données ;
• metadata : des informations pour identifier l’objet, notamment son nom (name) ;
• spec : les spécifications de l’objet en question ;
  • name : le nom de la base de données ;
  • owner : le nom du rôle PostgreSQL qui sera le propriétaire de la base de données, qui doit exister ;
  • cluster : le nom du cluster PostgreSQL dans laquelle doit être créée cette base de données.

Vous pouvez trouver de manière détaillée les autres paramètres sur cette page. Voici d’autres paramètres de la section spec qui nous semblent intéressants :

• encoding: permet d’indiquer l’encodage de la base (UTF8, LATIN1… ) ;
• template : correspond au nom du modèle de base qui doit être utilisé pour la base créée ;
• isTemplate : permet d’indiquer si la base créée est un modèle ou pas ;
• allowConnections : permet d’indiquer s’il sera possible de se connecter à cette base ;
• connectionLimit : correspond au nombre de connexions simultanées autorisées à cette base ;
• tablespace : correspond au TABLESPACE où sera créée la base de données.

Ces paramètres ne sont ni plus ni moins que les options de la commande CREATE DATABASE de PostgreSQL.

Le renommage d’une base de données n’est pas possible.

La création d’un schéma dans une base de données se fait avec l’instruction CREATE SCHEMA, mais vous pouvez aussi le faire en l’indiquant dans le fichier YAML de l’objet Database.

[...]
spec:
  schemas:
  - name: monschema
    owner: moi
    ensure: present
[...]

ensure peut prendre la valeur present ou absent. Dans le deuxième cas de figure, CloudNativePG va faire en sorte que le schéma ne soit pas présent et le supprimera s’il existe ! Attention au nom que vous renseignez.

Suivant le même principe que pour les schémas, l’ajout d’une extension peut se faire avec l’instruction CREATE EXTENSION. Vous pouvez le faire à la main lorsque vous êtes connectés à la base, ou alors le demander à CloudNativePG lors de la création de la Database. Pour cela, indiquer les extensions que vous souhaitez en les renseignant dans la partie spec.extensions. Par exemple :

[...]
spec:
  extensions:
  - name: vector
    ensure: present
[...]

D’autres paramètres peuvent être utilisés pour indiquer la version de l’extension à installer ou le schéma dans lequel est doit l’être.

Les fichiers de l’extensions doivent évidement être présents dans l’image du conteneur. Certaines sont embarquées dans l’image fournie par CloudNativePG, d’autres non. Nous verrons plus tard comment intégrer de nouvelles extension avec le mécanisme d’ajout dynamique (v1.27).

Jusqu’à présent, une extension devait nécessairement se trouver dans l’image utilisée pour déployer PostgreSQL. CloudNativePG en embarquait par défaut et ils nous était possible d’en rajouter de nouvelles en créant de nouvelles images personnalisées.

À partir de la version 1.27 de l’opérateur et pour les versions de PostgreSQL supérieures ou égales à 18, il est possible de tirer parti du chargement dynamique d’une extension. Ce mécanisme se repose sur le concept d’ImageVolume de Kubernetes disponible en version 1.33.

Le principe est de décorréler l’image utilisée pour déployer PostgreSQL et celles utilisées pour ajouter des extensions.

Les images utilisées pour ajouter une extension doivent respecter certaines contraintes pour pouvoir être utilisées par CloudNativePG (voir les indications disponibles sur cette page).

Une attention particulière est à apporter sur les versions des extensions utilisées ainsi que sur les distributions utilisées pour ces images : elles doivent être compatibles au niveau système et architecture CPU.

Les rôles PostgreSQL sont définis directement dans l’objet Cluster, dans la section spec.managed.roles. Il n’existe pas à l’heure actuelle de Custom Resource rôles.

• roles: est la liste des rôles qui doivent être présents dans l’instance ;
  • name : est évidemment le nom du rôle. N’oubliez pas le - en début de ligne indiquant qu’il s’agit d’un nouvel élément de la liste ;
  • ensure : positionné à present (valeur par défaut), l’opérateur vérifiera si le rôle existe et si ce n’est pas le cas, le créera. Le comportement est l’inverse s’il est positionné à absent ;
  • comment: simple champ commentaire ajouté au rôle si renseigné ;
  • login: indique si le rôle peut se connecter (true, valeur par défaut), false sinon ;
  • superuser: indique si le rôle est un super-utilisateur, false (valeur par défaut) ;
  • passwordSecret.name : indique le nom du Secret Kubernetes ou se trouve le mot de passe du rôle.

Vous pouvez trouver de manière détaillée les autres paramètres sur cette page. Voici d’autres paramètres de la section spec.managed.roles qui nous semblent intéressants :

• validUntil : la date à partir de laquelle le rôle ne sera plus valide (exemple validUntil: "2025-06-17T15:00:00Z" );
• inRoles : la liste des rôles auxquels le rôle créé doit appartenir ;
• replication : indique si le rôle doit avoir le rôle REPLICATION, par défaut à false par défaut.

Il est possible d’indiquer le mot de passe que doit avoir un nouveau rôle. Pour cela, il faut utiliser le paramètre passwordSecret.name qui doit contenir le nom d’un objet Secret dans le cluster Kubernetes. Il s’agit donc d’un pré-requis à la création d’un rôle avec mot de passe.

Dans l’exemple de la slide, le Secret dalibo-password doit être créé en amont.

apiVersion: v1
kind: Secret
type: kubernetes.io/basic-auth
metadata:
  name: dalibo-password
  labels:
    cnpg.io/reload: "true"
data:
  username: ZGFsaWJv
  password: Q0hBTkdFTUU=

Les champs username et password doivent contenir les valeurs encodées en BASE64. Cela peut se faire en ligne de commande avec printf et base64 :

printf "dalibo" | base64
ZGFsaWJv
printf "CHANGEME" | base64
Q0hBTkdFTUU=

À l’image des rôles, les tablespaces sont également déclarés dans la ressource Cluster. Il est possible de renseigner une liste de tablespaces et de configurer chacun d’eux de manière spécifique.

• tablespaces: est la liste des tablespaces qui doivent être créés ;
  • name : est évidemment le nom du tablespace. N’oubliez pas le - en début de ligne qui indique qu’il s’agit d’un nouvel élément de la liste ;
  • storage: contient la configuration au niveau du stockage du tablespace ;
    • size: la taille du volume où sera créé le tablespace ;
    • storageClass: indique quelle classe de stockage doit être utilisée pour ce volume-là ;
  • owner : indique le nom du propriétaire de ce tablespace;
  • temporary : permet d’indiquer si le tablespace doit être créé avec la clause TEMPORARY.

Si le propriétaire du tablespace n’est pas renseigné, l’utilisateur app le sera par défaut. Par défaut aussi, le tablespace est créé avec le paramètre temporary à false.

L’option storageClass est particulièrement intéressante pour configurer la classe de stockage sous-jacente au tablespace et donc, in fine, au volume. Cela vous permet d’utiliser des classes de stockage plus ou moins rapides selon vos besoins.

Lorsque le Cluster est créé, ou modifié, l’opérateur se charge de créer les objets Persistant Volumes / Persistant Volume Claims nécessaires et les associe au Pod de l’instance. Par exemple, lors d’un premier déploiement sans tablespace supplémentaire nous sommes dans la situation suivante avec un seul PVC et un seul PV.

kubectl get pvc
NAME                    STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
postgresql-1            Bound    pvc-b0eb7368-0795-48ea-89be-88475dc2a486   2Gi        RWO            standard       <unset>                 3m8s

kubectl get pv
NAME                                       CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                           STORAGECLASS   VOLUMEATTRIBUTESCLASS   REASON   AGE
pvc-67dda23b-5b3c-4e15-950d-681db723d62f   1Gi        RWO            Delete           Bound    default/postgresql-1-tbs-data   standard       <unset>                          3m10s

Après l’ajout des deux tablespaces, la situation est la suivante, avec trois PVC et trois PV. Le premier couple PV / PVC correspond au tablespace par défaut.

kubectl get pvc     
NAME                    STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
postgresql-1            Bound    pvc-b0eb7368-0795-48ea-89be-88475dc2a486   2Gi        RWO            standard       <unset>                 6m41s
postgresql-1-tbs-data   Bound    pvc-67dda23b-5b3c-4e15-950d-681db723d62f   1Gi        RWO            standard       <unset>                 4m4s
postgresql-1-tbs-fast   Bound    pvc-934a3ab9-123e-481c-af44-d3b741961859   2Gi        RWO            standard       <unset>                 4m4s

kubectl get pv
NAME                                       CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                           STORAGECLASS   VOLUMEATTRIBUTESCLASS   REASON   AGE
pvc-67dda23b-5b3c-4e15-950d-681db723d62f   1Gi        RWO            Delete           Bound    default/postgresql-1-tbs-data   standard       <unset>                          3m59s
pvc-934a3ab9-123e-481c-af44-d3b741961859   2Gi        RWO            Delete           Bound    default/postgresql-1-tbs-fast   standard       <unset>                          3m59s
pvc-b0eb7368-0795-48ea-89be-88475dc2a486   2Gi        RWO            Delete           Bound    default/postgresql-1            standard       <unset>                          6m46s

Comme vous le savez, installer une instance PostgreSQL ne suffit pas. Il faut en plus la configurer. Généralement, la configuration se fait dans le fichier postgresql.conf et nécessite soit un rechargement, soit un redémarrage de l’instance selon le paramètre modifié.

Avec l’utilisation de CloudNativePG, il n’est plus possible de modifier directement le fichier de configuration. Tout se fait dans la définition YAML de l’instance. Voyons quels sont les changements auxquels s’attendre.

Voici par exemple comment passer le paramètre shared_buffersà 1GB, et activer la compression des journaux de transactions.

[…]
spec:
  postgresql:
    parameters:
      shared_buffers: "1GB"
      wal_compression: "on"
[…]

La configuration d’une instance se fait dans la section .spec.postgresql.parameters de la définition YAML du Cluster. Les noms des paramètres sont les mêmes que ceux de PostgreSQL. CloudNativePG ne les renomme pas d’une manière ou d’une autre.

Un bon nombre de paramètres PostgreSQL ne sont pas modifiables dans la section .spec.postgresql.parameters de l’instance. La liste est disponible dans la documentation.

Cette interdiction peut paraitre surprenante, d’autant plus qu’avec un logiciel open source et libre comme l’est PostgreSQL, nous nous attendons plutôt à être libres de nos mouvements. Le parti pris par les développeurs est que tous ces paramètres sont liés à des fonctionnalités dont l’opérateur a la charge (sauvegarde, réplication, archivage des journaux, gestion des traces, etc).

Certains d’entre eux, comme allow_alter_system, sont modifiables par l’utilisation d’éléments présents dans d’autres sections de configuration, comme par exemple enableAlterSystem, qui se trouve dans la section .spec.postgresql.

Des vérifications sont faites sur certains. Pour reprendre l’exemple de shared_buffers, si vous renseignez une valeur plus grande que resources.requests.memory (allouée au Pod), vous lèverez une alerte, et votre modification ne sera pas appliquée.

Exemple de message d’erreur remonté :

The Cluster "postgresql" is invalid: spec.resources.requests.memory:
Invalid value: "512Mi": Memory request is lower than PostgreSQL `shared_buffers` value

Vous n’êtes pas sans savoir que la modification de certains paramètres nécessite soit un rechargement de la configuration, soit un redémarrage de l’instance.

Par défaut l’opération de rechargement ou de redémarrage est déclenchée automatiquement lorsque le nouveau paramètre est appliqué. Concrêtement, si vous modifiez max_connections, vos instances seront automatiquement redémarrées.

Ce dernier point sera détaillé lorsque l’on traitera de la stratégie de mise à jour que vous voulez mettre en place avec le paramètre primaryUpdateStrategy.

Il existe trois sections dans le fichier pg_hba.conf :

• FIXED RULES : qui sont des règles fixées par l’opérateur. On retrouve une règle concernant la réplication par exemple ;
• USER-DEFINED RULES : qui correspond aux règles qui seront créées par les administrateurs ;
• DEFAULT RULES : qui autorise par défaut toutes les connexions par mot de passe à toutes les bases de données.

Il existe deux sections dans le fichier pg_ident.conf :

• FIXED RULES : qui sont des règles fixées par l’opérateur. On retrouve une ligne concernant l’association de l’utilisateur système postgres au rôle postgres ;
• USER-DEFINED RULES : qui correspond aux règles qui seront créées par les administrateurs.

Un plugin CloudNativePG (cnpg) existe pour l’outil kubectl. Il permet d’obtenir très simplement un ensemble d’informations sur un cluster PostgreSQL ou de se connecter à une instance, déclencher une sauvegarde, promouvoir un secondaire en primaire, etc. Il est écrit en Go et se base, comme le code de l’opérateur, sur le framework Cobra.

Il existe plusieurs méthodes d’installation : par script, par paquets .rpm ou .deb ou encore via krew ou homebrew. À vous de choisir ce qui convient le mieux à vos utilisateurs et administrateurs, qu’ils soient sur Linux, MacOS ou Windows.

La liste des fonctionnalités offertes est assez longue. Elles couvrent des thèmes très variés allant de la simple connexion psql à une instance, à la création de publication pour des réplications logiques ou encore le déclenchement de tests de charges avec fio ou pgbench. Voici quelques unes des commandes qui paraissent essentielles à connaitre dans un premier temps :

• kubectl cnpg status [cluster] : génère un résumé sur l’état du cluster PostgreSQL (nombre d’instances, sauvegardes, secondaires, réplications…) ;
• kubectl cnpg psql [cluster] : permet de se connecter avec psql à l’instance primaire ;
• kubectl cnpg logs [cluster] : affiche les traces PostgreSQL. La commande pretty permet d’afficher les traces de manière plus lisible. L’outil jq peut également s’avérer utile ;
• kubectl cnpg reload [cluster] : déclenche une boucle de réconciliation pour prendre en compte les modifications apportées au cluster PostgreSQL ;
• kubectl cnpg restart [cluster] [node] : redémarre soit le cluster en entier, soit une seule instance si [node] est renseigné ;
• kubectl cnpg promote [cluster] [node] : promeut l’instance indiquée comme nouvelle primaire ;
• kubectl cnpg backup [cluster] : déclenche une sauvegarde physique de l’instance mentionnée. La configuration de la sauvegarde doit être faite dans la définition du cluster.

En embarquant PostgreSQL dans un conteneur et dans Kubernetes, il ne vous sera plus possible d’accéder au serveur sur lequel est installé PostgreSQL. Cela vous demandera davantage de configuration et de connaissances (notamment sur les différentes couches qui existent dans Kubernetes).

Vous n’aurez plus accès au serveur sous-jacent, comme ce serait le cas avec une solution de PGaaS. Si vous gérez vous même votre cluster Kubernetes, il vous sera évidemment possible d’accéder aux nœuds Workers.

Il faut différencier deux types d’accès à une instance PostgreSQL :

1. les accès inités depuis un client déployé dans le cluster Kubernetes (interne) ;
2. et ceux initiés depuis un client en dehors du cluster Kubernetes (externe).

Dans le premier cas, l’application pourra accéder à l’instance PostgreSQL si les Network Policies l’autorisent. Dans le second cas, vos administrateurs Kubernetes devront mettre en place un Load Balancer en frontal du cluster pour autoriser les accès externes. Dès lors que votre instance est accessible depuis l’extérieur (interface et port exposés), vous pourrez vous y connecter avec psql par exemple. Dans le cas contraire, vous ne pourrez pas vous y connecter directement.

L’outil kubectl permet à des utilisateurs de se connecter à une instance spécifique. La commande kubectl exec permet d’exécuter une commande dans un conteneur. Par « chance », l’image utilisée pour déployer PostgreSQL contient psql. Dès lors que vous avez accès au cluster Kubernetes et que vous avez les bons droits pour le faire, kubectl exec -it POD CONTAINER -- psql vous permet de vous connecter à l’instance avec le rôle postgres.

kubectl exec -it postgresql-1 -c postgres -- psql        
psql (17.2 (Debian 17.2-1.pgdg110+1))
Type "help" for help.

postgres=# 

Le plugin cnpg permet la même chose avec sa commande psql :

kubectl cnpg psql postgresql   
psql (17.2 (Debian 17.2-1.pgdg110+1))
Type "help" for help.

postgres=# 

Au sein du cluster Kubernetes, vous pouvez utile le DNS attribué au Pod ou au Service pour vous connecter à une instance.

Dès lors que vous déploierez PostgreSQL avec CloudNativePG, les traces que vous connaissez ne seront ni accessibles dans le fichier postgresql.log ni du même format.

Concernant les traces de l’opérateur, vous pouvez gérer le niveau de celles-ci avec l’argument --log-level du Deployment de l’opérateur. Les valeurs error, warning, info, debug et trace sont disponibles. La valeur par défaut est info.

Concernant le(s) Pod(s) PostgreSQL, les traces contiennent les traces de l’instance, mais également les traces d’autres éléments comme celles de l’instance manager ou encore de la solution de sauvegarde. Toutes les traces sont renvoyées sur la sortie standard du Pod au format JSON et sont mélangées. La clé logger de la trace JSON indique qui est responsable de cette ligne. Par exemple, la trace suivante a été générée par l’instance. On peut le voir avec le paramètre logger qui est à postgres.

{
  "level": "info",
  "ts": 1619781249.7188137,
  "logger": "postgres",
  "msg": "record",
  "record": {
    "log_time": "2021-04-30 11:14:09.718 UTC",
    "user_name": "",
  […]
  }

Concernant les paramètres de traces PostgreSQL, vous ne pouvez pas modifier les paramètres PostgreSQL suivants. CloudNativePG l’interdit.

log_destination
log_directory
log_file_mode
log_filenameas de `Custom Resource Definition`
log_rotation_age
log_rotation_size
log_truncate_on_rotation
logging_collector

Il est possible de suivre les traces d’un Pod en ligne de commande avec la commande kubectl logs -f <cluster> ou kubectl cnpg logs cluster <cluster> si vous avez installé le plugin cnpg pour kubectl.

Les traces ne sont pas persistées dans le Pod. Il est donc essentiel d’avoir une solution de centralisation des traces pour que vos administrateurs puissent y avoir accès. Des outils comme Loki, Fluentd.

L’outil pgBadger supporte le format des traces générées par CloudNativePG.

Le déploiement d’instances secondaires est très grandement facilité par CloudNativePG. En modifiant uniquement le nombre d’instances dans l’objet Cluster, une ou plusieurs nouvelles instances sera créée et configurée pour suivre le primaire grâce à la réplication physique (Streaming Replication). Un nouveau Pod sera donc créé, reprenant le nom du Cluster suivi d’un chiffre incrémenté de 1 pour chaque nouvelle instance. Avec la sortie de la commande kubectl get pod suivante, nous pouvons comprendre qu’au sein du cluster Kubernetes, deux Pods PostgreSQL existent et appartiennent au même Cluster (au sens de CloudNativePG) nommé postgresql.

kubectl get pod
NAME                   READY   STATUS    RESTARTS   AGE
postgresql-1           1/1     Running   0          14h
postgresql-2           1/1     Running   0          7h

Il existe plusieurs méthodes pour retrouver l’instance primaire d’un cluster. Par exemple :

kubectl get cluster postgresql                                           
NAME         AGE   INSTANCES   READY   STATUS                     PRIMARY
postgresql   14h   2           2       Cluster in healthy state   postgresql-1

L’opérateur et la configuration de base font en sorte que les instances secondaires soient réparties, si cela est possible, sur les différents workers qui composent le cluster Kubernetes. L’idée est de ne pas déployer au même endroit toutes les instances, auquel cas, en cas de panne, l’intégralité du Cluster PostgreSQL serait perdu.

Un slot de réplication sera automatiquement créé pour chaque nouveau secondaire. Le principal avantage est de ne plus avoir de décrochage du secondaire en conservant les journaux de transactions nécessaires. La conséquence directe est le risque d’accumulation de ces mêmes journaux qui pourraient saturer l’espace disque du primaire. Le nom du slot de réplication est automatiquement généré avec cnpg et le nom de l’instance. Voici un extrait de la vue pg_stat_replication_slot qui montre cela.

-[ RECORD 1 ]-------+-------------------
slot_name           | _cnpg_postgresql_2
plugin              | 
slot_type           | physical
[…]

Vous trouverez davantage d’informations sur le concept de slot de réplication dans notre module W2B.

Par défaut, la réplication mise en place est asynchrone. Il est possible de mettre en place de la réplication synchrone.

La version 1.26 de l’opérateur apporte un changement majeure dans la mise en place de l’archivage et des sauvegardes des instances. Il est désormais nécessaire d’utiliser un plugin pour gérer cette partie. L’ancienne méthode, qui consistait à tout définir dans l’objet Cluster est considérée comme obsolète et disparaitra avec la version 1.28. Un message d’erreur est remonté en cas d’utilisation :

Warning: Native support for Barman Cloud backups and recovery is deprecated and will be completely removed in CloudNativePG 1.28.0. Found usage in: spec.backup.barmanObjectStore. Please migrate existing clusters to the new Barman Cloud Plugin to ensure a smooth transition.

L’intérêt est de laisser la possibilité d’utiliser d’autres outils de sauvegarde, sans devoir les intégrer aux images de conteneur. Pour les plus connaisseurs, c’est un conteneur sidecar qui sera créé à côté du conteneur PostgreSQL. On peut notamment penser à pgBackRest. Cet [article(https://blog.dalibo.com/2025/04/03/cnpg-6.html)] sur notre blog présente d’ailleurs de cette possibilité.

Le projet maintient le plugin Barman Cloud Plugin. C’est celui-que nous utiliserons pour la présentation et les travaux pratiques. Il peut tout à fait être utilisé en production. Aussi, chaque plugin aura ses propres prérequis. Référez-vous à sa documentation d’installation pour les connaitre.

En ce qui concernant Barman Cloud Plugin, il doit être installé dans le même Namespace que l’opérateur et nécessite que cert-manager soit installé dans le cluster Kubernetes. Il apporte une nouvelle ressource : ObjectStore.

Cette ressource est fournie par Barman Cloud Plugin. Elle représente un emplacement de stockage objet. Trois providers sont supportés : Amazon S3, Microsoft Azure Blob Storage ou encore Google Cloud Storage. Des services compatibles S3 peuvent être également utilisés comme MinIO ou encore Scaleway Object Storage.

D’un fournisseur de stockage à un autre, les champs destinationPath et endpointURL peuvent changer. En plus de la connaissance du point d’entrée de votre solution de stockage, vous devez renseigner les informations de connexion dans la section s3Credentials.

Ces informations là doivent être enregistrées dans un objet Secret (objet Kubernetes). Dans l’exemple, le nom de ce Secret est scaleway-api-secret. Voici ce à quoi il pourrait ressembler.

apiVersion: v1
kind: Secret
metadata: 
  name: scaleway-api-secret
type: Opaque
data:
  ACCESS_KEY_ID: bWEgY2xlIGQgYWNjZXMK
  ACCESS_REGION: ZnItcGFy
  ACCESS_SECRET_KEY: bW9uIHNlY3JldCBiaWVuIGdhcmRlCg==

Les valeurs de chacun des trois champs data doivent être encodées en Base64.

L’archivage des journaux de transaction est fortement conseillé lorsque qu’il est question de sauvegarde physique et permet notamment la mise en place de sauvegardes dites PITR (voir notre module I2).

CloudNativePG supporte ce mécanisme par défaut. L’archivage des journaux se fait via l’intermédiaire d’un plugin. Le choix du plugin reste libre.

L’archive ne peut se faire que sur un stockage de type objet (type S3, Google Cloud Storage, Azure Blob Storage ou MinIO). C’est le cas quelque soit la méthode de sauvegarde utilisée.

Il est nécessaire de créer une ressource ObjectStore au sein du cluster Kubernetes qui sera réutilisée plus tard par les objets Cluster PostgreSQL.

Pour configurer l’archivage sur un Cluster, il est demandé de renseigner spec.plugins avec le nom du plugin, s’il a la capacité d’archiver des journaux (isWALArchiver) et l’ObjectStore sur lequel seront envoyés les journaux. Par exemple :

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
[...]
spec:
  plugins:
  - name: barman-cloud.cloudnative-pg.io
    isWALArchiver: true
    parameters:
      barmanObjectName: scaleway-store

Le paramètre archive_command de l’instance PostgreSQL sera automatiquement mise à jour.

L’opérateur sait gérer pour vous des sauvegardes dites physiques. C’est le seul type de sauvegarde que vous allez pouvoir déclencher via l’opérateur. Autrement dit, il existe une nouvelle ressource Kubernetes, appelée Backup qui correspond à une sauvegarde physique d’un Cluster PostgreSQL.

Les sauvegardes logiques (faites avec pg_dump ou pg_dumpall par exemple) pourront toujours se faire avec ces outils dès lors que votre instance est accessible.

Plusieurs méthodes de sauvegarde existent. Quelle que soit la méthode, la configuration se fait dans l’objet Cluster correspondant à vos instances. Certains paramètres peuvent également être renseignés dans les objets Backup ou ScheduledBackup. C’est ce que nous allons découvrir par la suite.

Aussi, vous pourrez effectuer ces sauvegardes à partir des instances secondaires pour décharger les instances primaires, et ce, quelle que soit la méthode choisie.

La première méthode consiste à effectuer les sauvegardes sur un stockage objet de type S3, Azure Blob Storage, Google Cloud Storage ou MinIO. Cette méthode se repose à l’heure actuelle sur l’outil Barman Cloud. C’est le même fonctionnement que pour l’archivage.

Couplé avec l’archivage des journaux de transactions, vous obtenez une sauvegarde PITR fonctionnelle pour votre instance.

La seconde méthode utilise quant à elle un mécanisme propre à l’API de Kubernetes, le Volume Snapshot. C’est une fonctionnalité qui doit être supportée par la Storage Class (et donc in fine par le CSI) avec laquelle les volumes de votre instance ont été créés.

Cette méthode va créer un objet Volume Snapshot dans votre cluster Kubernetes qui contiendra un instantané du Persistent Volume ciblé. Cette sauvegarde sera donc locale à votre système de stockage et non plus envoyée sur un stockage objet. Un snapshot sera créé pour chaque volume de votre instance (storage et walStorage).

Des mécanismes plus complexes comme les sauvegardes incrémentales ou différentielles sont possibles si la Storage Class le permet.

Couplé avec l’archivage des journaux de transactions, vous obtenez une sauvegarde PITR fonctionnelle pour votre instance. Les journaux de transaction sont quant à eux stockés sur un stockage objet.

Voici un exemple d’un objet Backup qui, une fois créé dans le cluster Kubernetes, déclenchera une sauvegarde physique du Cluster nommé postgresql. Si rien n’est mentionné, la sauvegarde se fera sur un stockage objet.

Il existe d’autres paramètres de configuration, comme :

• target : qui indique à partir de quelle instance doit être faite la sauvegarde ;
  • prefer-standby : pour demander à la faire depuis un secondaire ;
  • primary : pour demander à la faire depuis le primaire.
• method : permet de définir par quel moyen la sauvegarde physique doit être faite ;
  • barmanObjectStore : avec l’outil Barman Cloud sur un stockage objet (type S3, Google Cloud Storage, Azure Blob Storage ou MinIO). C’est le choix par défaut ;
  • volumeSnapshot : en se basant sur la fonctionnalité de Volume Snapshot. Votre CSI doit supporter cette fonctionnalité pour utiliser cette méthode ;
  • plugin : si la sauvegarde se fait à partir d’un plugin autre que vous aurez déployé au préalable. Fonctionnalité encore en test.

Pour les sauvegardes qui utilisent la méthode barmanObjectStore, les informations sur l’emplacement de stockage seront reprises de la configuration spec.backup.barmanObjectStore du Cluster référencé dans le champ spec.cluster.name. Il y aura deux dossiers, un contenant les journaux archivés, un contenant les sauvegardes.

Pour les sauvegardes qui utilisent la méthode volumeSnapshot, la configuration sera récupérée depuis spec.backup.volumeSnapshot.

Par défaut, les sauvegardes se font à chaud. Seule la méthode par Volume Snapshot permet de faire des sauvegardes à froid (i.e instance arrêtée).

Il existe une deuxième ressource appelée ScheduledBackup qui, comme son nom l’indique, permet de déclencher une sauvegarde régulièrement. L’exemple donné correspond au déclenchement d’une sauvegarde quotidienne à 20h00:00.

Quelques paramètres de configuration sont spécifiques à cet objet, comme :

• schedule : définit le moment où la sauvegarde sera déclenchée. Il y a bien six arguments, correspondant aux secondes, minutes, heures, jours du mois, mois et jour de la semaine ;
• backupOwnerReference : indique à quelle ressource sera rattachée cette sauvegarde ;
  • self : au ScheduledBackup qui a déclenché cette sauvegarde ;
  • cluster : au Cluster mentionné ;
  • none: à aucune ressource.

D’autres paramètres comme method ou target peuvent être renseignés dans un ScheduledBackup.

Le paramètre backupOwnerReference a un impact sur la manière dont sont conservés les objets Kubernetes Backup. Dans l’exemple ci-dessus, si l’objet ScheduledBackup masauvegardequotidienne est supprimé, tous les objets Backup qui auraient été créés par la sauvegarde planifiée seront supprimés. Dans le cas où backupOwnerReference est configuré à cluster, les objets Backup seront supprimés si l’objet Cluster est supprimé. À none ils seront tout le temps conservés. Notez bien qu’il s’agit bien des objets Kubernetes. Les sauvegardes qui se trouvent sur le stockage S3 par exemple, ne seront pas supprimées.

Il est tout à fait possible de combiner ces deux types de déclenchements (manuel ou régulier) de sauvegardes.

La première chose à noter est qu’une restauration d’une instance avec CloudNativePG se fera toujours par la création d’une nouvelle instance. Autrement dit, il n’est pas possible de faire une restauration sur une instance déjà déployée. La restauration in-place n’est pas possible.

CloudNativePG se base sur une sauvegarde physique pour créer cette nouvelle instance. Le paramètre de configuration spec.bootstrap.recovery permet de configurer cette restauration. Lorsque ce paramétre est utilisée dans le fichier YAML, CloudNativePG comprend qu’il doit créer (bootstrap) une instance à partir d’une sauvegarde.

Comme l’archive_command, le paramètre restore_command est déjà positionné par l’opérateur et utilise l’instance-manager. Cette fois-ci c’est la commande wal-restore qui est utilisée.

/controller/manager wal-restore --log-destination /controller/log/postgres.json %f %p

La source utilisée pour la restauration peut être de nature différente selon la méthode (method) de la sauvegarde.

• Si vous repartez d’une sauvegarde faite sur un stockage objets, utilisez le paramètre bootstrap.recovery.source associé à externalClusters. La partie barmanObjectStore contiendra alors toutes les informations du stockage objets où se trouve la sauvegarde. Par exemple :

  spec:
  […]

  bootstrap:
    recovery:
      source: clusterBackup

  externalClusters:
    - name: clusterBackup
      barmanObjectStore:
      […]

• Si vous repartez d’un Volume Snapshot, vous devrez utiliser bootstrap.recovery.volumeSnapshots.storage. Dans le cas où le snapshot a été fait depuis une instance ayant deux espaces de stockage (storage et walStorage) vous devez également le renseigner.

Quelques éléments supplémentaires sont à prendre en compte. Tout d’abord, CloudNativePG part du principe que la base app existe dans la sauvegarde et qu’elle a pour propriétaire app. Si vous utilisez d’autres noms, vous devez le renseigner dans la partie recovery. Aussi, si vous souhaitez conserver un mot de passe en particulier pour le rôle par défaut, vous devez renseigner le Secret à utiliser. Autrement, CloudNativePG se chargera d’en générer un aléatoirement.

Par défaut, la sauvegarde se fera en rejouant l’intégralité des journaux de transactions disponibles sur la dernière timeline. Il est possible de faire une restauration de type Point In Time Recovery en renseignant le champs bootstrap.recovery.recoveryTarget. Par exemple :

[…]
      recoveryTarget:
        # Time base target for the recovery
        targetTime: "2023-08-11 11:14:21.00000+02"

D’autres cibles de restauration existent, comme :

• targetTime : l’horodatage auquel vous souhaitez restaurer votre instance ;
• targetXID : l’ID de transaction jusqu’auquel vous souhaitez restaurer votre instance ;
• targetName : le nom du point de restauration que vous aurez créé au préalable avec pg_create_restore_point() ;
• targetLSN : La position dans les journaux de transactions à laquelle arrêter la restauration ;
• targetImmediate : Indique si la restauration doit s’arrêter dès qu’un point de consistance est atteint.

Une montée de version consiste à la mise à jour des binaires de PostgreSQL. En mode conteneur, et donc sur Kubernetes, il n’est pas envisageable de les mettre à jour via apt ou yum. Cela se fait en modifiant l’image utilisée dans la définition YAML de votre Cluster` PostgreSQL. Une nouvelle image contenant la nouvelle version souhaitée sera alors téléchargée.

Il faut distinguer deux types de montées de versions d’une instance :

• Les montées de versions mineures ;
• Les montées de versions majeurs.

Selon le type de montée de version, le déroulé des étapes sera différent. Voyons en détails ces deux types de montées de version.

La modification de l’image entraine une montée de version de toutes les instances du Cluster. Cette montée de version se fera en mode Rolling Update. Les instances secondaires seront les premières à être mises à jour, une par une. L’instance primaire est la dernière à être mise à jour.

La mise à jour de l’instance primaire peut se faire automatiquement ou de manière supervisée selon le paramètre de primaryUpdateStrategy qui peut prendre deux valeurs.

• unsupervised : après que toutes les instances secondaires aient été mises à jour, l’instance primaire est automatiquement mise à jour. C’est la valeur par défaut ;
• supervised : le mécanisme de montée de version attend une opération manuelle pour effectuer la montée de version de l’instance primaire.

En mode unsupervised, le paramètre primaryUpdateMethod est pris en compte pour savoir comment procéder à la mise à jour de l’instance primaire. Il peut lui aussi prendre deux valeurs :

• restart : l’instance primaire est redémarrée. Il faudra attendre la fin de la mise à jour pour que le primaire soit de nouveau accessible. C’est la valeur par défaut ;
• switchover : une bascule sur un secondaire est effectuée et le primaire devient secondaire. Le nouveau primaire est déjà accessible comme il a déjà été mis à jour.

En mode supervised, vous devrez donc vous même procéder à ce redémarrage ou à ce switchover avec le plugin cnpg de kubectl. Par exemple pour le switchover vous pouvez utiliser la commande suivante pour passer l’instance postgresql-2 en tant que nouvelle primaire :

kubectl cnpg promote postgresql 2

Si au contraire, vous souhaitez procédre à un redémarrage du primaire vous pouvez utiliser la commande restart du plugin.

kubectl cnpg restart postgresql 1

Changer de version majeure de PostgreSQL est un peu moins trivial qu’une montée de version mineure. Des changements structurels peuvent avoir lieu dans les nouvelles versions et le passage dans une nouvelle version majeure ne peut pas se faire par une simple installation de binaires. Différentes méthodes existent pour mettre à jour une instance. Il existe globalement trois méthodes pour y parvenir :

• Avec les outils pg_dump / pg_restore ;
• Avec la réplication logique de PostgreSQL ;
• Avec l’outil pg_upgrade.

Chaque méthodes a ses avantages et inconvénients. Toutes trois sont supportées par CloudNativePG (comprendre qu’il est possible de les déclenchée de manière déclarative). Voir par exemple cette page de documentation sur l’import de base à la création d’un nouveau Cluster ou alors celle-ci qui explique les quelques étapes à suivre pour la réplication logique.

Depuis la version 1.26 de l’opérateur, il est possible de faire des In-Place Major Upgrade qui permet de mettre à jour une instance sans devoir en recréer d’autres avant. Cette méthode va arrêter toutes les instances (liées au Cluister à mettre à jour) qui existeraient, va utiliser l’outil pg_upgrade et va manipuler les objets Kubernetes (PV, PVC) pour transférer les données présentes dans PGDATA vers un autre emplacement de stockage. Si tout se déroule correctement, les instances secondaires seront recréées entièrement. Avec cette méthode, les noms des ressources Kubernetes sont conservés.

La mise à jour de l’opérateur se fait en plusieurs temps et impacte les instances PostgreSQL qu’il gère. Le principe de mise à jour est simple, il suffit d’appliquer les nouveaux manifestes de l’opérateur sur Kubernetes. Si vous avez installé l’opérateur avec Helm, mettez le à jour avec Helm. Même chose pour les autres méthodes de déploiement.

Ces nouveaux manifestes mettent à jour les Custom Resource Definitions (comme Cluster, ScheduledBackup, etc) et l’opérateur en tant que tel, c’est à dire le Pod qui contient le controller.

Cette première étape terminée, la seconde va être automatiquement déclenchée. Elle consiste à la mise à jour de tous les Pods des instances PostgreSQL déployées. En effet, il existe dans le Pod de l’instance, un composant appelé instance-manager. Celui-ci est étroitement lié au controller CloudNativePG. Ils doivent être dans la même version. La mise à jour des instances suit le modèle de Rolling Update que nous verrons plus tard lorsque nous évoquerons la montée de version mineure d’une instance PostgreSQL.

Par défaut toutes les instances gérées par l’opérateur seront mises à jour en même temps. Ceci peut poser problème si vous avez de très nombreuses instances. Il est possible de répartir ces redémarrages dans le temps avec les paramètres :

• CLUSTERS_ROLLOUT_DELAY : permet de définir un délai entre le redémarrage de deux Cluster différents. Par défaut positionné à 0 ;
• INSTANCES_ROLLOUT_DELAY : permet de définir un délai entre le redémarrage de deux instances différentes qui font partie du même Cluster. Par défaut positionné à 0 ;

Ces paramètres là sont à définir dans le Configmap de configuration de l’opérateur, à savoir le Configmap cnpg-controller-manager-config qui doit être créé dans le même Namespace que l’opérateur.

Si il y a bien une chose à retenir, c’est qu’une mise à jour de l’opérateur déclenche la mise à jour d’un composant au sein des Pods PostgreSQL. Opération qui nécessite un redémarrage du Pod.

Nous l’avons vu, l’ajout de secondaire se fait très simplement en modifiant le paramètre spec.instances. Par défaut, CloudNativePG essaye de répartir les instances PostgreSQL d’un même Cluster sur des nœuds différents. Cette configuration est modifiable dans la partie spec.affinity de la définition YAML.

Voici quatre paramètres intéressants :

• enablePodAntiAffinity : par défaut à true, il indique si ce mécanisme d’affinité / anti-affinité doit être utilisé ou non ;
  
• topologyKey : indique sur quel paramètre va se reposer la répartition des Pods. Par défaut à kubernetes.io/hostname, le répartition se fera selon le nom du nœud. Il est possible d’utiliser d’autres valeurs comme topology.kubernetes.io/zone pour répartir les Pods non pas selon les nœuds mais sur des zones de disponibilité ;
• podAntiAffinityType : ce paramètre permet d’indiquer le type d’affinité qui doit être utilisé. À prefered, le scheduler de Kubernetes tente de respecter la règle d’affinité. Si il ne peut pas, il déploiera tout de même le Pod sur un nœud. À required, le Pod sera déployé uniquement si la règle est respectée.
• nodeSelector : vous permet de sélectionner les nœuds où pourra être déployé un Pod. Les nœuds qui possèdent ces labels seront les cibles potentielles du déploiement.

CloudNativePG gère nativement la bascule, qu’elle soit manuelle ou automatique. Par bascule, on entend la promotion d’un secondaire en primaire. Vous pouvez promouvoir une instance secondaire en primaire grâce au plugin cnpg pour kubectl.

kubectl cnpg promote CLUSTER CLUSTER-INSTANCE

Il faut s’avoir qu’à chaque instance est associé un ou plusieurs labels. Celui qui nous intéresse particulièrement est cnpg.io/instanceRole. Chacun des Pod PostgreSQL possède ces labels, qui sont ajoutés automatiquement par l’opérateur CloudNativePG.

Ce label permet donc de connaitre le rôle de l’instance. Les Services Kubernetes, automatiquement créés, permettent de se connecter à un Pod. L’association Service - Pod se fait grâce à ces labels, et plus précisement grâce aux Selector créés sur le Service.

Lorsque la commande de promotion est lancée, en plus d’autres opérations qui sont faites au niveau de PostgreSQL, le label cnpg.io/instanceRole va être mis à jour sur chaque Pod. L’instance qui était jusqu’à présent la secondaire, devient la nouvelle instance primaire. Le label cnpg.io/instanceRole est mis à jour. Ainsi, si vos applications utilisent le Service postgresql-rw (où postgresql est le nom du Cluster) elles devront uniquement initier une nouvelle connexion pour interagir avec la nouvelle instance primaire.

Les deux schémas si dessous montrent ce principe. Entre ces deux schémas, une promotion de l’instance postgresql-1 en tant que nouveau primaire a eu lieu. L’instance postgresql-2 est redevenue secondaire. Le Service postgresql-rw a suivi ce changement grâce au mécanisme de Label - Selector.

Le principe d’hibernation vous permet d’arrêter un Cluster PostgreSQL tout en conservant les volumes de données. Les Pods PostgreSQL seront arrêtés un à un en commençant par le primaire. Les PVC et PV de chaque instance, qu’elle soit primaire ou secondaire, existeront toujours.

La première méthode pour passer un Cluster en hibernation est de lui ajouter l’annotation cnpg.io/hibernation=on, avec par exemple, la commande suivante :

kubectl annotate cluster <cluster-name> --overwrite cnpg.io/hibernation=on

Voici un exemple de situation lorsqu’une instance est en hibernation.

$ kubectl get pod
No resources found in default namespace.

$ kubectl get pvc
NAME           STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
postgresql-1   Bound    pvc-bb811ce2-c4db-4f3d-8286-1187bcd91174   2Gi        RWO            standard       <unset>                 7m30s
postgresql-2   Bound    pvc-b8b35ea1-073c-4dd9-8ff1-3fc9d6f60418   2Gi        RWO            standard       <unset>                 2m2s

Il n’y a plus de Pod mais les PVC sont bien encore présents. Si vous souhaitez redéployer les Pods (primaire et secondaire) du Cluster, utilisez la même commande avec l’option off cette fois-ci.

Il est également possible d’hiberner un Cluster avec le plugin cnpg de kubectl. Une différence notable existe entre ces deux méthodes. Avec cette deuxième méthode, seul le PVC de l’instance primaire est conservé.

$ kubectl cnpg hibernate on postgresql                                   
hibernation process starting...
waiting for the cluster to be fenced
cluster is now fenced, storing primary pg_controldata output
primary pg_controldata output fetched
annotating the PVC with the cluster manifest
PVC annotation complete
destroying the primary instance while preserving the pvc
Instance postgresql-1 of cluster postgresql has been destroyed and the PVC was kept
primary instance destroy completed
deleting the cluster resource
cluster resource deletion complete
Hibernation completed

$ kubectl get pvc
NAME           STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
postgresql-1   Bound    pvc-bb811ce2-c4db-4f3d-8286-1187bcd91174   2Gi        RWO            standard       <unset>                 10m

Lorsque le Cluster sortira d’hibernation (avec kubectl cnpg hibernate off postgresql) les PVCs nécessaires aux secondaires seront recréés. Selon la volumétrie des instances, cette copie pourra représenter beaucoup de volume et de temps.

Le fencing quant à lui permet d’arrêter le service postmaster de PostgreSQL sans pour autant arrêter le Pod. Cela revient à faire une arrêt propre de l’instance PostgreSQL au sein du Pod.

Il est possible de passer en fencing une instance spécifique (qu’elle soit primaire ou secondaire), une liste d’instances, ou toutes les instances d’un Cluster. Là encore, ce mécanisme est géré par une annotation, en l’occurence cnpg.io/fencedInstances. Par exemple, avec :

• cnpg.io/fencedInstances: '["postgresql-1"]', seule cette instance sera en fencing  ;
• cnpg.io/fencedInstances: '["postgresql-1","postgresql-3"]', ces deux instances seront passées en fencing;
• cnpg.io/fencedInstances: '["*"]', toutes les instances du Cluster qui seront annotés passeront en fencing.

Vous pouvez, soit utiliser la commande kubectl annotate … soit le plugin cnpg avec par exemple kubectl cnpg fencing on postgresql 1.

Lorsqu’une instance est passée en fencing, le Pod ne sera plus marqué READY, comme le montre cet exemple.

$ kubectl cnpg fencing on postgresql 1
postgresql-1 fenced

$ kubectl get pod
NAME           READY   STATUS    RESTARTS   AGE
postgresql-1   0/1     Running   0          19m
postgresql-2   1/1     Running   0          19m

Le Pod est toujours accessible, permettant par exemple de procéder à du débogage.

À travers ce module, vous a été présenté l’opérateur CloudNativePG, son principe de fonctionnement, son installation et une grande partie de ce qu’il permet de faire. Cela représente une bonne découverte de l’opérateur, tant sur ses fonctionnalités que sur certains aspects critiques de son utilisation.

L’opérateur CloudNativePG est celui qui connait la plus forte adoption ces dernières années. Il est complet (niveau 5 sur le site https://operatorhub.io/), open-source, avec un souhait de gouvernance partagée. Il fait d’ailleurs partie du projet d’incubation de la_ Cloud Native Computing Foundation_, garant de certains principes open-source.

Le déploiement d’instances PostgreSQL est facilité par la nature déclarative de la gestion par CloudNativePG. En se reposant sur les fonctionnalitées de Kubernetes, l’opérateur permet la mise en place de mécanismes complexes comme la haute disponibilité ou la bascule automatique.

Des mécanismes propres à l’opérateur sont à connaitre, comme sa mise à jour et les conséquences sur les instances, les différents paramètres et spécifications utilisables dans les fichiers YAML ou encore ce qui est automatiquement créé par l’opérateur (rôle, base, Secret, etc).

L’opérateur se repose sur un certain nombre de concepts liés à PostgreSQL. Il s’agit donc de bien les connaître (réplication par flux, sauvegarde PITR, etc) pour comprendre comment l’opérateur les utilise ou les configure.

L’intégration de PostgreSQL dans Kubernetes est grandement facilité par CloudNativePG. En contrepartie, cela demande à un administrateur PostgreSQL de vraies connaissances sur Kubernetes (qu’est-ce qu’un Pod ? un Service ? un Secret ?) et de revoir sa manière de travailler avec son SGBD favori.

Prise en main du cluster Kubernetes

Installation de l’opérateur CloudNativePG

kubectl apply --server-side -f \
  https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/release-1.25/releases/cnpg-1.27.0.yaml

Déploiement d’instances PostgreSQL

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  walStorage:
    size: 5Gi
  affinity:
    enablePodAntiAffinity: true 
    topologyKey: kubernetes.io/hostname 
    podAntiAffinityType: preferred
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"

kubectl exec -it postgresql-demo-1 -- psql

kubectl cnpg psql postgresql-demo

Éléments initiaux

apiVersion: v1
data:
  username: ZGJh
  password: aWxvdmVteWRiYQ==
kind: Secret
metadata:
  name: secret-password-dba
  labels:
    cnpg.io/reload: "true"
type: kubernetes.io/basic-auth

Déploiement d’une instance secondaire

Tests de bascules

Mise en place d’une sauvegarde PITR

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.18.2/cert-manager.yaml

kubectl apply -f https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v0.5.0/manifest.yaml

kubectl get pod -n cnpg-system
NAME                                       READY   STATUS    RESTARTS   AGE
barman-cloud-6858cdc47f-gr2bh              1/1     Running   0          3m32s
cnpg-controller-manager-7b7fcf5cf6-8rmj9   1/1     Running   0          9m18s

---
apiVersion: v1
kind: Secret
metadata:
  name: s3-creds
type: Opaque
data:
  ACCESS_KEY_ID: U0NXQkhBWlFWMzk4N004Q1kxWEM=
  ACCESS_REGION: ZnItcGFy
  ACCESS_SECRET_KEY: MDVlZDFhZjMtNzc4Ni00MjE2LTlhZWYtOTQ5MmM3YzRjMzJh

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-with-backup-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
      work_mem: "8MB"
      archive_timeout: "20min"
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"
  backup:
    plugins:
    - name: barman-cloud.cloudnative-pg.io
      isWALArchiver: true
      parameters:
        barmanObjectName: objectstore-demo   

apiVersion: barmancloud.cnpg.io/v1
kind: ObjectStore
metadata:
  name: objectstore-demo
spec:
  configuration:
    destinationPath: "s3://demo-cnpg/CHANGEME/"
      endpointURL: "https://s3.fr-par.scw.cloud"
      s3Credentials:
        accessKeyId:
          name: s3-creds
          key: ACCESS_KEY_ID
        secretAccessKey:
          name: s3-creds
          key: ACCESS_SECRET_KEY
        region:
          name: s3-creds
          key: ACCESS_REGION
      wal:
        compression: gzip

kubectl apply -f ~/objectstore-demo.yaml

kubectl apply -f ~/postgresql-with-backup-demo.yaml

apiVersion: postgresql.cnpg.io/v1
kind: Backup
metadata:
  name: first-backup
spec:
  cluster:
    name: postgresql-with-backup-demo

Procéder à une restauration PITR

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-restored-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
      work_mem: '8MB'
      archive_timeout: '20min'
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"
  bootstrap:
    recovery:
      backup:
        name: first-backup

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-external-cluster-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
      work_mem: '8MB'
      archive_timeout: '20min'
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"
  
  bootstrap:
    recovery:
      source: postgresql-with-backup-demo
      
  externalClusters:
    - name: postgresql-with-backup-demo
      barmanObjectStore:
        destinationPath: "s3://demo-cnpg/CHANGEME/"
        endpointURL: "https://s3.fr-par.scw.cloud"
        s3Credentials:
          accessKeyId:
            name: s3-creds
            key: ACCESS_KEY_ID
          secretAccessKey:
            name: s3-creds
            key: ACCESS_SECRET_KEY
          region:
            name: s3-creds
            key: ACCESS_REGION
        wal:
          compression: gzip  

Montée de version mineure de PostgreSQL

Montée de version majeure de PostgreSQL

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-test
spec:
  instances: 2
  imageName: ghcr.io/cloudnative-pg/postgresql:15.0
  storage:
    size: 1Gi

Montée de version de l’opérateur

cat /proc/1/cmdline 
/controller/manager instance run--status-port-tls--log-level=info

watch kubectl get pod

watch kubectl get pod -n cnpg-system

apiVersion: v1
kind: ConfigMap
metadata:
  name: cnpg-controller-manager-config
  namespace: cnpg-system
data:
  ENABLE_INSTANCE_MANAGER_INPLACE_UPDATES: 'true'

Exercices optionnels

apiVersion: postgresql.cnpg.io/v1
kind: ScheduledBackup
metadata:
  name: backup-every-day
spec:
  schedule: "0 0 16 * * *"
  backupOwnerReference: self
  cluster:
    name: postgresql-with-backup-demo

[...]
  postgresql:
    synchronous:
      method: any
      number: 1
[...]

apiVersion: apps/v1
kind: Deployment
metadata:
  name: pgadmin
spec:
  replicas: 1
  selector:
    matchLabels:
      app: pgadmin
  template:
    metadata:
      labels:
        app: pgadmin
    spec:
      containers:
        - name: pgadmin
          image: dpage/pgadmin4
          ports:
            - containerPort: 80
          env:
            - name: PGADMIN_DEFAULT_EMAIL
              value: admin@example.com
            - name: PGADMIN_DEFAULT_PASSWORD
              value: admin

kubectl port-forward --address 0.0.0.0 pgadmin-*****-***** 8888:80

Prise en main du cluster Kubernetes

touch ~/.kube/config

vi ~/.kube/config

kubectl version

Client Version: v1.31.0
Kustomize Version: v5.5.0
Server Version: v1.31.0

kubectl get nodes

NAME           STATUS   ROLES           AGE   VERSION
k8s-demo       Ready    control-plane   57m   v1.31.0
k8s-demo-m02   Ready    <none>          56m   v1.31.0
k8s-demo-m03   Ready    <none>          55m   v1.31.0

Installation de l’opérateur CloudNativePG

kubectl apply --server-side -f \
  https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/release-1.25/releases/cnpg-1.27.0.yaml

namespace/cnpg-system serverside-applied
customresourcedefinition.apiextensions.k8s.io/backups.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/clusterimagecatalogs.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/clusters.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/imagecatalogs.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/poolers.postgresql.cnpg.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/scheduledbackups.postgresql.cnpg.io serverside-applied
serviceaccount/cnpg-manager serverside-applied
clusterrole.rbac.authorization.k8s.io/cnpg-manager serverside-applied
clusterrolebinding.rbac.authorization.k8s.io/cnpg-manager-rolebinding serverside-applied
configmap/cnpg-default-monitoring serverside-applied
service/cnpg-webhook-service serverside-applied
deployment.apps/cnpg-controller-manager serverside-applied
mutatingwebhookconfiguration.admissionregistration.k8s.io/cnpg-mutating-webhook-configuration serverside-applied
validatingwebhookconfiguration.admissionregistration.k8s.io/cnpg-validating-webhook-configuration serverside-applied

kubectl get pods -n cnpg-system

NAME                                       READY   STATUS    RESTARTS   AGE
cnpg-controller-manager-7fc549dc69-xq7gq   1/1     Running   0          11s

kubectl api-resources --api-group postgresql.cnpg.io

backups                                          postgresql.cnpg.io/v1             true         Backup
clusterimagecatalogs                             postgresql.cnpg.io/v1             false        ClusterImageCatalog
clusters                                         postgresql.cnpg.io/v1             true         Cluster
imagecatalogs                                    postgresql.cnpg.io/v1             true         ImageCatalog
poolers                                          postgresql.cnpg.io/v1             true         Pooler
scheduledbackups                                 postgresql.cnpg.io/v1             true         ScheduledBackup

Déploiement d’instances PostgreSQL

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  walStorage:
    size: 5Gi
  affinity:
    enablePodAntiAffinity: true 
    topologyKey: kubernetes.io/hostname 
    podAntiAffinityType: preferred
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"

$ cat <<'EOF' > ~/postgresql-demo.yaml
apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  walStorage:
    size: 5Gi
  affinity:
    enablePodAntiAffinity: true 
    topologyKey: kubernetes.io/hostname 
    podAntiAffinityType: preferred
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"
EOF

kubectl logs -f -n cnpg-system cnpg-controller-manager-7fc549dc69-8v8xw | jq

kubectl apply -f ~/postgresql-demo.yaml

cluster.postgresql.cnpg.io/postgresql-demo created

kubectl get pods --watch

NAME                             READY   STATUS    RESTARTS   AGE   IP       NODE     NOMINATED NODE   READINESS GATES
postgresql-demo-1-initdb-5pndc   0/1     Pending   0          2s    <none>   <none>   <none>           <none>

NAME                             READY   STATUS     RESTARTS   AGE   IP       NODE       NOMINATED NODE   READINESS GATES
postgresql-demo-1-initdb-5pndc   0/1     Init:0/1   0          13s   <none>   k8s-demo   <none>           <none>

NAME                             READY   STATUS            RESTARTS   AGE   IP              NODE       NOMINATED NODE   READINESS GATES
postgresql-demo-1-initdb-5pndc   0/1     PodInitializing   0          24s   10.244.228.68   k8s-demo   <none>           <none>

NAME                             READY   STATUS    RESTARTS   AGE   IP              NODE       NOMINATED NODE   READINESS GATES
postgresql-demo-1-initdb-5pndc   1/1     Running   0          35s   10.244.228.68   k8s-demo   <none>           <none>

kubectl get pods -o wide

NAME                READY   STATUS    RESTARTS   AGE   IP              NODE       NOMINATED NODE   READINESS GATES
postgresql-demo-1   1/1     Running   0          10m   10.244.228.69   k8s-demo   <none>           <none>

kubectl exec -it postgresql-demo-1 -- psql

kubectl cnpg psql postgresql-demo

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
psql (17.0 (Debian 17.0-1.pgdg110+1))
Type "help" for help.

postgres=# select version()\gx
-[ RECORD 1 ]
----------------
version | PostgreSQL 17.0 (Debian 17.0-1.pgdg110+1) on aarch64-unknown-linux-gnu, compiled by gcc (Debian 10.2.1-6) 10.2.1 20210110, 64-bit

postgres=# exit

postgres=# \q

kubectl logs -f postgresql-demo-1

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
{"level":"info","ts":"2025-03-25T14:30:48.192432437Z","msg":"Starting CloudNativePG Instance Manager","logger":"instance-manager","logging_pod":"postgresql-demo-1","version":"1.25.1","build":{"Version":"1.25.1","Commit":"c56e00d4","Date":"2025-02-28"}}
{"level":"info","ts":"2025-03-25T14:30:48.192533981Z","msg":"Checking for free disk space for WALs before starting PostgreSQL","logger":"instance-manager","logging_pod":"postgresql-demo-1"}
{"level":"info","ts":"2025-03-25T14:30:48.203813591Z","msg":"starting tablespace manager","logger":"instance-manager","logging_pod":"postgresql-demo-1"}

kubectl logs -f postgresql-demo-1 | jq

{
  "level": "info",
  "ts": "2024-11-19T09:43:46.00225746Z",
  "logger": "postgres",
  "msg": "record",
  "logging_pod": "postgresql-demo-1",
  "record": {
    "log_time": "2024-11-19 09:43:46.002 UTC",
    "process_id": "20",
    "session_id": "673c5dd1.14",
    "session_line_num": "6",
    "session_start_time": "2024-11-19 09:43:45 UTC",
    "transaction_id": "0",
    "error_severity": "LOG",
    "sql_state_code": "00000",
    "message": "database system is ready to accept connections",
    "backend_type": "postmaster",
    "query_id": "0"
  }
}

Éléments initiaux

kubectl exec -it postgresql-demo-1 -- psql -c "\l"

kubectl cnpg psql postgresql -- -c '\l'

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
                                                List of databases
   Name    |  Owner   | Encoding | Locale Provider | Collate | Ctype | Locale | ICU Rules |   Access privileges   
-----------+----------+----------+-----------------+---------+-------+--------+-----------+-----------------------
 app       | app      | UTF8     | libc            | C       | C     |        |           | 
 postgres  | postgres | UTF8     | libc            | C       | C     |        |           | 
 template0 | postgres | UTF8     | libc            | C       | C     |        |           | =c/postgres          +
           |          |          |                 |         |       |        |           | postgres=CTc/postgres
 template1 | postgres | UTF8     | libc            | C       | C     |        |           | =c/postgres          +
           |          |          |                 |         |       |        |           | postgres=CTc/postgres
(4 rows)

kubectl cnpg psql postgresql-demo -- -c '\du'

kubectl exec -it postgresql-demo-1 -- psql -c "\du"

                                 List of roles
     Role name     |                         Attributes                         
-------------------+------------------------------------------------------------
 app               | 
 postgres          | Superuser, Create role, Create DB, Replication, Bypass RLS
 streaming_replica | Replication

kubectl exec -it postgresql-demo-1 -- psql -U app

kubectl cnpg psql postgresql-demo -- -U app -c '\du'

psql: error: connection to server on socket "/controller/run/.s.PGSQL.5432" failed: FATAL:  Peer authentication failed for user "app"
command terminated with exit code 2

kubectl exec -it postgresql-demo-1 -- psql -U app -h 127.0.0.1

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
Password for user app: 

kubectl get secrets

NAME                          TYPE                       DATA   AGE
postgresql-demo-app           kubernetes.io/basic-auth   9      39m
postgresql-demo-ca            Opaque                     2      39m
postgresql-demo-replication   kubernetes.io/tls          2      39m
postgresql-demo-server        kubernetes.io/tls          2      39m

kubectl get secret postgresql-demo-app -o json | jq '.data.password'

"VFdyejRQbmY1RWMwVjFjUHlqYkdFZnI5RG52WE5YaXN0NUhIaFZkOENwSkpKOEthVkVLUkNxUGwweTRzaGlVbw=="

$ kubectl get secret postgresql-demo-app --no-headers -o custom-columns=Passwd:.data.password
VFdyejRQbmY1RWMwVjFjUHlqYkdFZnI5RG52WE5YaXN0NUhIaFZkOENwSkpKOEthVkVLUkNxUGwweTRzaGlVbw==

$ echo "VFdyejRQbmY1RWMwVjFjUHlqYkdFZnI5RG52WE5YaXN0NUhIaFZkOENwSkpKOEthVkVLUkNxUGwweTRzaGlVbw==" | base64 -d
TWrz4Pnf5Ec0V1cPyjbGEfr9DnvXNXist5HHhVd8CpJJJ8KaVEKRCqPl0y4shiUo

$ kubectl get secret postgresql-demo-app --no-headers -o custom-columns=Passwd:.data.password | base64 -d
TWrz4Pnf5Ec0V1cPyjbGEfr9DnvXNXist5HHhVd8CpJJJ8KaVEKRCqPl0y4shiUo

kubectl exec -it postgresql-demo-1 -- psql -U app -h 127.0.0.1

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
Password for user app: 
psql (17.0 (Debian 17.0-1.pgdg110+1))
SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, compression: off, ALPN: postgresql)
Type "help" for help.

app=> 

kubectl get svc

NAME                 TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
kubernetes           ClusterIP   10.96.0.1        <none>        443/TCP    6h24m
postgresql-demo-r    ClusterIP   10.105.219.134   <none>        5432/TCP   6h11m
postgresql-demo-ro   ClusterIP   10.105.155.153   <none>        5432/TCP   6h11m
postgresql-demo-rw   ClusterIP   10.105.191.44    <none>        5432/TCP   6h11m

kubectl get pod postgresql-demo-1 --show-labels

NAME                READY   STATUS    RESTARTS   AGE   LABELS
postgresql-demo-1   1/1     Running   0          26h   cnpg.io/cluster=postgresql-demo,cnpg.io/instanceName=postgresql-demo-1,cnpg.io/instanceRole=primary,cnpg.io/podRole=instance,role=primary

kubectl describe service postgresql-demo-ro

Name:                     postgresql-demo-ro
Namespace:                default
Labels:                   cnpg.io/cluster=postgresql-demo
Annotations:              cnpg.io/operatorVersion: 1.27.0
Selector:                 cnpg.io/cluster=postgresql-demo,cnpg.io/instanceRole=replica
Type:                     ClusterIP
IP Family Policy:         SingleStack
IP Families:              IPv4
IP:                       10.105.155.153
IPs:                      10.105.155.153
Port:                     postgres  5432/TCP
TargetPort:               5432/TCP
Endpoints:                10.244.112.199:5432
Session Affinity:         None
Internal Traffic Policy:  Cluster
Events:                   <none>

cp ~/postgresql-demo.yaml ~/postgresql-demo.bckp

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
  affinity:
    enablePodAntiAffinity: true 
    topologyKey: kubernetes.io/hostname 
    podAntiAffinityType: preferred
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"

{
  "level": "info",
  "ts": "2024-11-19T10:16:20.260220994Z",
  "msg": "Requesting configuration reload",
  "logger": "instance-manager",
  "logging_pod": "postgresql-demo-1",
  "controller": "instance-cluster",
  "controllerGroup": "postgresql.cnpg.io",
  "controllerKind": "Cluster",
  "Cluster": {
    "name": "postgresql-demo",
    "namespace": "default"
  },
  "namespace": "default",
  "name": "postgresql-demo",
  "reconcileID": "ee16f0eb-c352-41e9-a955-0587219b4d7b",
  "pgdata": "/var/lib/postgresql/data/pgdata"
}

{
  "level": "info",
  "ts": "2024-11-19T10:16:20.269390325Z",
  "logger": "postgres",
  "msg": "record",
  "logging_pod": "postgresql-demo-1",
  "record": {
    "log_time": "2024-11-19 10:16:20.263 UTC",
    "process_id": "21",
    "session_id": "673c655c.15",
    "session_line_num": "9",
    "session_start_time": "2024-11-19 10:15:56 UTC",
    "transaction_id": "0",
    "error_severity": "LOG",
    "sql_state_code": "55P02",
    "message": "parameter \"shared_buffers\" cannot be changed without restarting the server",
    "backend_type": "postmaster",
    "query_id": "0"
  }
}

{
  "level": "info",
  "ts": "2024-11-19T10:16:20.811302094Z",
  "logger": "postgres",
  "msg": "record",
  "logging_pod": "postgresql-demo-1",
  "record": {
    "log_time": "2024-11-19 10:16:20.811 UTC",
    "process_id": "204",
    "session_id": "673c6574.cc",
    "session_line_num": "6",
    "session_start_time": "2024-11-19 10:16:20 UTC",
    "transaction_id": "0",
    "error_severity": "LOG",
    "sql_state_code": "00000",
    "message": "database system is ready to accept connections",
    "backend_type": "postmaster",
    "query_id": "0"
  }
}

[...]

  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
      work_mem: '8MB'
[...]

{
  "level": "info",
  "ts": "2024-11-29T06:02:03Z",
  "logger": "postgres",
  "msg": "record",
  "logging_pod": "postgresql-demo-1",
  "record": {
    "log_time": "2024-11-29 06:02:03.388 UTC",
    "process_id": "936",
    "session_id": "67495814.3a8",
    "session_line_num": "7",
    "session_start_time": "2024-11-29 05:58:44 UTC",
    "transaction_id": "0",
    "error_severity": "LOG",
    "sql_state_code": "00000",
    "message": "received SIGHUP, reloading configuration files",
    "backend_type": "postmaster",
    "query_id": "0"
  }
}

{
  "level": "info",
  "ts": "2024-11-29T06:02:03Z",
  "logger": "postgres",
  "msg": "record",
  "logging_pod": "postgresql-demo-1",
  "record": {
    "log_time": "2024-11-29 06:02:03.390 UTC",
    "process_id": "936",
    "session_id": "67495814.3a8",
    "session_line_num": "8",
    "session_start_time": "2024-11-29 05:58:44 UTC",
    "transaction_id": "0",
    "error_severity": "LOG",
    "sql_state_code": "00000",
    "message": "parameter \"work_mem\" changed to \"8MB\"",
    "backend_type": "postmaster",
    "query_id": "0"
  }
}

kubectl exec -it postgresql-demo-1 -- psql

kubectl cnpg psql postgresql-demo

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
psql (17.0 (Debian 17.0-1.pgdg110+1))
Type "help" for help.

postgres=# show work_mem ;
 work_mem 
----------
 8MB
(1 row)

[...]
spec:
[...]
  managed:
    roles:
    - name: dba
      ensure: present
      comment: Administrateur
      login: true
      superuser: true

kubectl exec -it postgresql-demo-1 -- psql -c '\du'

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
                                 List of roles
     Role name     |                         Attributes                         
-------------------+------------------------------------------------------------
 app               | 
 dba               | Superuser
 postgres          | Superuser, Create role, Create DB, Replication, Bypass RLS
 streaming_replica | Replication

printf "dba" | base64
ZGJh

printf "ilovemydba" | base64   
aWxvdmVteWRiYQ==

apiVersion: v1
data:
  username: ZGJh
  password: aWxvdmVteWRiYQ==
kind: Secret
metadata:
  name: secret-password-dba
  labels:
    cnpg.io/reload: "true"
type: kubernetes.io/basic-auth

kubectl apply -f ~/secret.yaml

secret/secret-password-dba created

[...]
  managed:
    roles:
    - name: dba
      ensure: present
      comment: Administrateur
      login: true
      superuser: true
      passwordSecret:
        name: secret-password-dba

kubectl apply -f ~/postgresql-demo.yaml

cluster.postgresql.cnpg.io/postgresql-demo configured

kubectl exec -it postgresql-demo-1 -- psql -d postgres -U dba -h 127.0.0.1

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
Password for user dba:
psql (17.0 (Debian 17.0-1.pgdg110+1))
SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, compression: off, ALPN: postgresql)
Type "help" for help.

postgres=# 

apiVersion: postgresql.cnpg.io/v1
kind: Database
metadata:
  name: db1
spec:
  name: db1
  owner: app
  cluster:
    name: postgresql-demo

$ kubectl apply -f db1.yaml 
database.postgresql.cnpg.io/db1 created 

$ kubectl cnpg psql postgresql-demo -- -c "\l"

                                                List of databases
   Name    |  Owner   | Encoding | Locale Provider | Collate | Ctype | Locale | ICU Rules |   Access privileges   
-----------+----------+----------+-----------------+---------+-------+--------+-----------+-----------------------
 app       | app      | UTF8     | libc            | C       | C     |        |           | 
 db1       | app      | UTF8     | libc            | C       | C     |        |           | 
 postgres  | postgres | UTF8     | libc            | C       | C     |        |           | 
 template0 | postgres | UTF8     | libc            | C       | C     |        |           | =c/postgres          +
           |          |          |                 |         |       |        |           | postgres=CTc/postgres
 template1 | postgres | UTF8     | libc            | C       | C     |        |           | =c/postgres          +
           |          |          |                 |         |       |        |           | postgres=CTc/postgres
(5 rows)

Déploiement d’une instance secondaire

[...]
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 2
[...]

kubectl apply -f ~/postgresql-demo.yaml

kubectl get pod | grep demo
postgresql-demo-1              1/1     Running    0          73m
postgresql-demo-2-join-h2vvw   0/1     Init:0/1   0          38s

kubectl get pod | grep demo

postgresql-demo-1              1/1     Running           0          73m
postgresql-demo-2-join-h2vvw   0/1     PodInitializing   0          58s

kubectl get pod | grep demo

postgresql-demo-1              1/1     Running     0          73m
postgresql-demo-2              1/1     Running     0          31s

kubectl exec -it postgresql-demo-2 -- psql

postgres=# \x
Expanded display is on.
postgres=# show primary_conninfo ;

-[ RECORD 1 ]----+---------------------
primary_conninfo | host=postgresql-demo-rw user=streaming_replica [...]

host=postgresql-demo-rw
user=streaming_replica
port=5432
sslkey=/controller/certificates/streaming_replica.key
sslcert=/controller/certificates/streaming_replica.crt
sslrootcert=/controller/certificates/server-ca.crt
application_name=postgresql-demo-2
sslmode=verify-ca

kubectl exec -it postgresql-demo-1 -- psql

kubectl cnpg psql postgresql-demo

postgres=# select * from pg_stat_replication\gx
-[ RECORD 1 ]----+------------------------------
pid              | 2370
usesysid         | 16388
usename          | streaming_replica
application_name | postgresql-demo-2
client_addr      | 10.244.41.198
client_hostname  | 
client_port      | 35530
backend_start    | 2024-11-29 07:47:00.777328+00
backend_xmin     | 
state            | streaming
sent_lsn         | 0/6000060
write_lsn        | 0/6000060
flush_lsn        | 0/6000060
replay_lsn       | 0/6000060
write_lag        | 
flush_lag        | 
replay_lag       | 
sync_priority    | 0
sync_state       | async
reply_time       | 2024-11-29 08:51:20.1176+00

postgres=# select * from pg_replication_slots \gx

-[ RECORD 1 ]-------+------------------------
slot_name           | _cnpg_postgresql_demo_2
plugin              | 
slot_type           | physical
datoid              | 
database            | 
temporary           | f
active              | t
active_pid          | 2370
xmin                | 
catalog_xmin        | 
restart_lsn         | 0/6000060
confirmed_flush_lsn | 
wal_status          | reserved
safe_wal_size       | 
two_phase           | f
inactive_since      | 
conflicting         | 
invalidation_reason | 
failover            | f
synced              | f

kubectl exec -it postgresql-demo-1 -- psql -c "create table ma_table (i int);" app

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
CREATE TABLE

kubectl exec -it postgresql-demo-2 -- psql -c "\dt" app

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
          List of relations
 Schema |   Name   | Type  |  Owner   
--------+----------+-------+----------
 public | ma_table | table | postgres
(1 row)

kubectl get pod -o wide

NAME                       READY   STATUS    RESTARTS   AGE    IP              NODE           NOMINATED NODE   READINESS GATES
postgresql-demo-1          1/1     Running   0          3h3m   10.244.228.71   k8s-demo       <none>           <none>
postgresql-demo-2          1/1     Running   0          109m   10.244.41.198   k8s-demo-m03   <none>           <none>

Tests de bascules

kubectl cnpg status postgresql-demo

Cluster Summary
Name                 default/postgresql-demo
System ID:           7445242620478582804
PostgreSQL Image:    ghcr.io/cloudnative-pg/postgresql:17.0
Primary instance:    postgresql-demo-1
Primary start time:  2024-12-06 10:24:03 +0000 UTC (uptime 2m3s)
Status:              Cluster in healthy state 
Instances:           2
Ready instances:     2
Size:                94M
Current Write LSN:   0/4050170 (Timeline: 1 - WAL File: 000000010000000000000004)

Continuous Backup status
Not configured

Physical backups
Name  Phase  Started at  Total  Transferred  Progress  Tablespaces
----  -----  ----------  -----  -----------  --------  -----------

Streaming Replication status
Replication Slots Enabled
Name               Sent LSN   Write LSN  Flush LSN  Replay LSN  Write Lag        Flush Lag        Replay Lag       State      Sync State  Sync Priority  Replication Slot
----               --------   ---------  ---------  ----------  ---------        ---------        ----------       -----      ----------  -------------  ----------------
postgresql-demo-2  0/4050170  0/4050170  0/4050170  0/4050170   00:00:00.001012  00:00:00.007096  00:00:00.011149  streaming  async       0              active

Instances status
Name               Current LSN  Replication role  Status  QoS        Manager Version  Node
----               -----------  ----------------  ------  ---        ---------------  ----
postgresql-demo-1  0/4050170    Primary           OK      Burstable  1.27.0           k8s-demo-m03
postgresql-demo-2  0/4050170    Standby (async)   OK      Burstable  1.27.0           k8s-demo-m02

kubectl cnpg promote postgresql-demo 2

{"level":"info","ts":"2024-12-06T10:40:18.767552528Z","msg":"Cluster is not healthy"}
Node postgresql-demo-2 in cluster postgresql-demo will be promoted

kubectl cnpg status postgresql-demo

[...]
Instances status
Name               Current LSN  Replication role  Status  QoS        Manager Version  Node
----               -----------  ----------------  ------  ---        ---------------  ----
postgresql-demo-2  0/6006778    Primary                OK      Burstable  1.27.0           k8s-demo-m02
postgresql-demo-1  0/60000A0    Standby (starting up)  OK      Burstable  1.27.0           k8s-demo

[...]
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 2
  failoverDelay: 10
[...]

kubectl apply -f ~/postgresql-demo.yaml

watch kubectl get pod

kubectl delete pod postgresql-demo-2

pod "postgresql-demo-2" deleted

Instances status
Name               Current LSN  Replication role  Status  QoS        Manager Version  Node
----               -----------  ----------------  ------  ---        ---------------  ----
postgresql-demo-1  0/7001080    Primary               OK      Burstable  1.27.0           k8s-demo
postgresql-demo-2  0/70000A0    Standby (file based)  OK      Burstable  1.27.0           k8s-demo-m02

Mise en place d’une sauvegarde PITR

---
apiVersion: v1
kind: Secret
metadata: 
  name: s3-creds
type: Opaque
data:
  ACCESS_KEY_ID: U0NXQkhBWlFWMzk4N004Q1kxWEM=
  ACCESS_REGION: ZnItcGFy
  ACCESS_SECRET_KEY: MDVlZDFhZjMtNzc4Ni00MjE2LTlhZWYtOTQ5MmM3YzRjMzJh

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-with-backup-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
      work_mem: '8MB'
      archive_timeout: '20min'
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"
  backup:
    barmanObjectStore:
      destinationPath: "s3://demo-cnpg/CHANGEME/"
      endpointURL: "https://s3.fr-par.scw.cloud"
      s3Credentials:
        accessKeyId:
          name: s3-creds
          key: ACCESS_KEY_ID
        secretAccessKey:
          name: s3-creds
          key: ACCESS_SECRET_KEY
        region:
          name: s3-creds
          key: ACCESS_REGION
      wal:
        compression: gzip

kubectl apply -f ~/postgresql-with-backup-demo.yaml

kubectl logs -f postgresql-with-backup-demo-1 | jq

[...]

{
  "level": "info",
  "ts": "2024-11-20T13:29:44.953496179Z",
  "logger": "wal-archive",
  "msg": "Archived WAL file",
  "logging_pod": "postgresql-with-backup-demo-1",
  "walName": "pg_wal/000000010000000000000003",
  "startTime": "2024-11-20T13:29:44.115115707Z",
  "endTime": "2024-11-20T13:29:44.953469619Z",
  "elapsedWalTime": 0.838353912
}

apiVersion: postgresql.cnpg.io/v1
kind: Backup
metadata:
  name: first-backup
spec:
  cluster:
    name: postgresql-with-backup-demo

kubectl apply -f ~/letsbackup.yaml 

backup.postgresql.cnpg.io/first-backup created

kubectl get backup

NAME           AGE     CLUSTER                       METHOD              PHASE       ERROR
first-backup   4m41s   postgresql-with-backup-demo   barmanObjectStore   completed 

kubectl logs postgresql-with-backup-demo-1 | grep completed | jq

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
{
  "level": "info",
  "ts": "2024-11-20T14:22:46.968654454Z",
  "msg": "Backup completed",
  "backupName": "first-backup",
  "backupNamespace": "first-backup",
  "logging_pod": "postgresql-with-backup-demo-1"
}

kubectl exec -it postgresql-with-backup-demo-1 -- psql -c "SHOW archive_command"

                                  archive_command                                   
------------------------------------------------------------------------------------
 /controller/manager wal-archive --log-destination /controller/log/postgres.json %p
(1 row)

kubectl exec -it postgresql-with-backup-demo-1 -- psql

kubectl cnpg psql postgresql-with-backup-demo

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
psql (17.0 (Debian 17.0-1.pgdg110+1))
Type "help" for help.

postgres=# create table t1 (i int);
CREATE TABLE
postgres=# insert into t1 select generate_series(1, 100);
INSERT 0 100
postgres=# checkpoint ;
CHECKPOINT

postgres=# postgres=# select pg_switch_wal();
 pg_switch_wal 
---------------
 1/FFCFCAA8
(1 row)

Procéder à une restauration PITR

kubectl delete -f ~/postgresql-with-backup-demo.yaml

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-restored-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
      work_mem: '8MB'
      archive_timeout: '20min'
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"
  bootstrap:
    recovery:
      backup:
        name: first-backup

kubectl get backup

kubectl describe backup first-backup

kubectl apply -f  ~/postgresql-restored-demo.yaml

kubectl exec -it postgresql-restored-demo-1 -- psql -c "select count(*) from t1;"

Defaulted container "postgres" out of: postgres, bootstrap-controller (init)
 count 
-------
   100
(1 row)

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: postgresql-external-cluster-demo
spec:
  imageName: ghcr.io/cloudnative-pg/postgresql:17.0
  instances: 1
  storage:
    size: 5Gi
  postgresql:
    parameters:
      shared_buffers: '256MB'
      max_connections: '10'
      work_mem: '8MB'
      archive_timeout: '20min'
  resources:
    requests:
      memory: "256Mi"
      cpu: "0.5"
    limits:
      memory: "512Mi"
      cpu: "1"
  
  bootstrap:
    recovery:
      source: postgresql-with-backup-demo
      
  externalClusters:
    - name: postgresql-with-backup-demo
      barmanObjectStore:
        destinationPath: "s3://demo-cnpg/CHANGEME/"
        endpointURL: "https://s3.fr-par.scw.cloud"
        s3Credentials:
          accessKeyId:
            name: s3-creds
            key: ACCESS_KEY_ID
          secretAccessKey:
            name: s3-creds
            key: ACCESS_SECRET_KEY
          region:
            name: s3-creds
            key: ACCESS_REGION
        wal:
          compression: gzip