Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#1,163 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@fjvbn2003 đang làm issue này rồi.

Từ ngày 16/10/2026.

  • #1164 của @fjvbn2003 — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
go, markdown, postgresql
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Go
Star
204
Fork
86
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
25

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của cloudnative-pg/plugin-barman-cloud

Tất cả issue của cloudnative-pg/plugin-barman-cloud

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.