Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
  • 何か問題がありますか？
#1,163 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@fjvbn2003 がすでに取り組んでいます。

2026年10月16日 から。

  • #1164 @fjvbn2003 による — オープン

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
go, markdown, postgresql
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Go
スター
204
フォーク
86
平均マージ
1日 19時間
マージ済み PR（30日）
25

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

cloudnative-pg/plugin-barman-cloud のほかの issue

cloudnative-pg/plugin-barman-cloud の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。