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

docs: migration guide does not say where `serverName` goes, and the default differs for external clusters

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

I maintainer di solito rispondono entro 1 giorno

@fjvbn2003 ci sta già lavorando.

Dal 16/10/2026.

  • #1164 di @fjvbn2003 — aperta

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
go, markdown, postgresql
Ambito
documentation

Direzione di ricerca

Start with web/docs/migration.md Steps 1, 2, and 4, then check parameters.md for the current serverName guidance. The issue proposes documenting the CRD restriction and the changed default for external clusters. Done means the migration guide explains where to set serverName and when it must be explicit, and parameters.md states its default. A linked pull request is already open.

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

Descrizione

What is wrong

The migration guide (web/docs/migration.md, Step 1) says the
.spec.backup.barmanObjectStore section maps directly to
ObjectStore.spec.configuration, "with one key difference" (retention).
There is a second one: serverName.

  1. If the in-tree configuration sets barmanObjectStore.serverName, copying it
    into the ObjectStore is rejected by the CRD:

    spec.configuration.serverName: Forbidden: use the 'serverName' plugin parameter in the Cluster resource

    The rule is in api/v1/objectstore_types.go (added in #336). usage.md and
    parameters.md mention it, but the migration guide, which is the page that
    tells users to copy the section, does not. Step 2 does not show the
    serverName plugin parameter either.

  2. For external clusters the default is different. In-tree,
    ExternalCluster.GetServerName() falls back to the external cluster name
    (pg-eu). In the plugin, NewFromCluster falls back to cluster.Name, the
    Cluster being created (pg-us), for both the recovery and the replica
    source (internal/cnpgi/operator/config/config.go). Step 4 happens to set
    serverName: pg-eu explicitly, but nothing says it is required, and an
    in-tree entry that relied on the default would read from a different path
    after the conversion.

How I hit it

I migrated a CNPG 1.30 cluster from the in-tree barmanObjectStore to the
plugin (v0.14.0). The Cluster had an explicit serverName so that the plugin
would keep using the existing backup path. Following the guide literally, the
ObjectStore was rejected with the error above. Moving serverName to
.spec.plugins[].parameters worked, and the plugin kept appending to the
existing archive (the ObjectStore status shows a recovery window that
started before the migration, and daily plugin backups complete).

Proposal

A docs-only change:

  • Step 1: list serverName as a second difference, with the error message.
  • Step 2: show the serverName plugin parameter for clusters that set one.
  • Step 4: warn that serverName must be set explicitly, because the default
    changes from the external cluster name to the Cluster name.
  • parameters.md: state the default of serverName.

If the different default for external clusters is not intended, I am happy to
turn this into a code change instead. I have a patch for the docs ready.

Lingua principale
Go
Stelle
204
Fork
86
Merge medio
1g 19h
PR unite (30g)
25

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.