Skip to content

fix(operator): validate immutable PVC template fields #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GatewayJ merged 2 commits into from
Aug 2, 2026
+348 −17
Merged

fix(operator): validate immutable PVC template fields #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ce2b7e
fix(operator): validate immutable PVC template fields
GatewayJ Jul 22, 2026
c0feca7
fix(operator): compare PVC quantities semantically
GatewayJ Aug 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/operator-user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ Key fields:
| `name` | Pool name used in labels, StatefulSet names, and peer DNS. Must be unique in the Tenant. |
| `servers` | Number of RustFS pods in the pool. Must be greater than `0`. Immutable after creation. |
| `persistence.volumesPerServer` | Number of PVCs mounted into each server. Must be greater than `0`. Immutable after creation. |
| `persistence.volumeClaimTemplate` | PVC spec used for each generated volume. Set storage size, access modes, and StorageClass here. |
| `persistence.volumeClaimTemplate` | PVC spec used for each generated volume. Set storage size, access modes, and StorageClass at creation; these fields are immutable afterward. |
| `persistence.path` | Base mount path. Defaults to `/data`; mounted paths become `{path}/rustfs0`, `{path}/rustfs1`, and so on. |
| `nodeSelector`, `affinity`, `tolerations`, `topologySpreadConstraints` | Pool-level scheduling controls. |
| `resources` | Container resource requests and limits for the pool. |
Expand Down Expand Up @@ -1001,7 +1001,7 @@ The operator reconciles StatefulSets and reports rollout status in Tenant condit

### Change Storage Capacity

PVC expansion depends on the StorageClass and Kubernetes environment. Do not change immutable pool shape fields (`servers` and `volumesPerServer`) in place. To add capacity, add a new pool when appropriate and follow RustFS decommission and migration procedures.
Do not change an existing pool's `volumeClaimTemplate` storage request, access modes, or StorageClass in place; the StatefulSet template is immutable. To add capacity, add a new pool when appropriate and follow RustFS decommission and migration procedures.

### Restart Tenant Pods

Expand Down
4 changes: 2 additions & 2 deletions docs/operator-user-guide.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ Tenant 名称必须兼容 DNS-1035，且长度不超过 55 个字符，因为 Op
| `name` | Pool 名称，用于 label、StatefulSet 名称和 peer DNS。同一个 Tenant 内必须唯一。 |
| `servers` | 该 pool 的 RustFS Pod 数量。必须大于 `0`。创建后不可变。 |
| `persistence.volumesPerServer` | 每个 server 挂载的 PVC 数量。必须大于 `0`。创建后不可变。 |
| `persistence.volumeClaimTemplate` | 每个数据卷的 PVC spec，可设置容量、access mode 和 StorageClass。 |
| `persistence.volumeClaimTemplate` | 每个数据卷的 PVC spec，可在创建时设置容量、access mode 和 StorageClass；创建后这些字段不可变。 |
| `persistence.path` | 数据卷挂载基础路径。默认 `/data`，最终路径为 `{path}/rustfs0`、`{path}/rustfs1` 等。 |
| `nodeSelector`、`affinity`、`tolerations`、`topologySpreadConstraints` | Pool 级调度控制。 |
| `resources` | Pool 容器资源 request 和 limit。 |
Expand Down Expand Up @@ -977,7 +977,7 @@ Operator 会 reconcile StatefulSet，并通过 Tenant condition 和 pool status

### 修改存储容量

PVC 扩容取决于 StorageClass 和 Kubernetes 环境。不要原地修改不可变的 pool 形态字段（`servers` 和 `volumesPerServer`）。需要扩容时，可按需新增 pool，并结合 RustFS decommission 和迁移流程操作。
不要原地修改已有 pool 的 `volumeClaimTemplate` 存储请求、access mode 或 StorageClass；StatefulSet 模板不可变。需要扩容时，可按需新增 pool，并结合 RustFS decommission 和迁移流程操作。

### 重启 Tenant Pod

Expand Down
Loading
Loading