Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte
  • Quelque chose ne va pas ?
#1,163 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@fjvbn2003 y travaille déjà.

Depuis le 16/10/2026.

  • #1164 par @fjvbn2003 — ouverte

Évaluation

Difficulté
1/5
Temps estimé
1-3 heures
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
go, markdown, postgresql
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Go
Étoiles
204
Forks
86
Merge moyen
1 j 19 h
PR mergées (30 j)
25

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de cloudnative-pg/plugin-barman-cloud

Toutes les issues de cloudnative-pg/plugin-barman-cloud

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.