Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Record the object store and server name of a backup in Backup.status.pluginMetadata

Aperta
  • Qualcosa non va?
#1,140 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@BoxBoxJason ci sta già lavorando.

Dal 4/10/2026.

  • #1141 di @BoxBoxJason — aperta

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
go, postgresql
Ambito
databases

Direzione di ricerca

Start in internal/cnpgi/instance/types.go at newBackupResultMetadata, then trace how the plugin resolves the ObjectStore and serverName for a backup. Check the existing backup/plugin tests and add coverage for the proposed metadata keys, including the optional endpointURL. Done means Backup.status.pluginMetadata records the backup location and resolved server name without changing existing metadata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Description

A Backup taken through the plugin doesn't record which ObjectStore and which serverName the backup was written to. When creating a recovery cluster, we have to find that out by other means and write it by hand in the externalClusters entry.
I'd like the plugin to add this information to the backup result metadata, so that it ends up in Backup.status.pluginMetadata.

This is related to #510 and cloudnative-pg/cloudnative-pg#7989 (recovery from a plugin Backup object), which I believe need this as a first step.

Our use case

Our clusters archive under a timestamped serverName (for example mydb-20261003T120000), set through the serverName plugin parameter, and a new one is generated for each new generation of a cluster.
The archive path has to be empty when a cluster starts archiving, and a fresh, dated serverName gives us that without deleting older archives.
Over time, the bucket holds one folder per generation.

To create a recovery cluster from a given backup, we need to know which of these folders holds it. The plugin's recovery default for serverName is the name of the new cluster (internal/cnpgi/operator/config/config.go), which never matches a timestamp, so we have to find the value by listing the bucket or
digging through old manifests.
The Backup object is the natural place to keep the link between a backup and its location, and it's where the in-tree integration kept it: Backup.status.serverName, destinationPath and endpointURL were all set. Since the in-tree integration is deprecated since 1.26, anyone migrating to the plugin loses that.

Environment
  • CloudNativePG operator: main (the behaviour is the same on current releases)
  • plugin-barman-cloud: v0.15.1
What a plugin backup records today
apiVersion: postgresql.cnpg.io/v1
kind: Backup
spec:
  method: plugin
  pluginConfiguration:
    name: barman-cloud.cloudnative-pg.io
status:
  backupId: ...
  pluginMetadata:
    clusterUID: ...
    displayName: ...
    name: ...
    pluginName: ...
    timeline: "1"
    version: ...

Nothing in it says where the backup went. newBackupResultMetadata (internal/cnpgi/instance/types.go) is where these keys are built.

Proposal

Add the configuration the backup was taken with to the same map:

Key Value
barmanObjectName name of the ObjectStore used for the backup
serverName resolved server name (the serverName parameter, or the cluster name when unset)
destinationPath ObjectStore.spec.configuration.destinationPath at backup time
endpointURL ObjectStore.spec.configuration.endpointURL at backup time, when set

This only adds keys and doesn't change any existing behaviour. destinationPath and endpointURL aren't strictly needed to locate the data, since they can be read from the ObjectStore, but they let a later restore detect that the ObjectStore has been changed to point somewhere else since the backup was taken.

Shipping this early matters even if nothing consumes it yet: backups taken before it lands will never carry the information.

Alternatives considered
  • Dedicated fields in Backup.status (serverName, destinationPath): they would need new fields in the CNPG-I BackupResult message for concepts that are specific to Barman, so pluginMetadata looks like the right place.
  • Keep the status quo and document that serverName must always be set in the recovery source.
    This is what we do today, but with timestamped names the value has to be found outside the cluster.
  • Change the default recovery serverName: no default can guess a timestamp, and changing it would break users who rely on the current one.

I used an AI assistant (Claude) to help draft this issue and to check the references against the plugin and operator sources, as the AI policy asks for disclosure.

Lingua principale
Go
Stelle
196
Fork
76
Merge medio
4g 13h
PR unite (30g)
19

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cloudnative-pg/plugin-barman-cloud

Tutte le issue di cloudnative-pg/plugin-barman-cloud

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.