Skip to content

docs: add upgrading section covering manual CRD updates #264

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
aa1ex merged 1 commit into from
Jul 20, 2026
Merged

docs: add upgrading section covering manual CRD updates #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Connect us in Telegram - https://t.me/+Y0PzGa1d5DFiYThi

## Documentation
- Quick start [doc](https://github.com/kaasops/vector-operator/blob/main/docs/quick-start.md)
- Upgrading [doc](https://github.com/kaasops/vector-operator/blob/main/docs/quick-start.md#upgrading)
- Design [doc](https://github.com/kaasops/vector-operator/blob/main/docs/design.md)
- Specification [doc](https://github.com/kaasops/vector-operator/blob/main/docs/specification.md)
- Secure credentials [doc](https://github.com/kaasops/vector-operator/blob/main/docs/secure-credential.md)
Expand Down
20 changes: 20 additions & 0 deletions docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Operator serves to make running Vector applications on top of Kubernetes as easy

- [Installing by Helm](#installing-by-helm)
- [Installing by Manifest](#installing-by-manifest)
- [Upgrading](#upgrading)


# Installing by Helm
Expand Down Expand Up @@ -391,6 +392,25 @@ Output

You can see field `testfield`, which we add in transform section in VectorPipeline

# Upgrading

Upgrade the operator with Helm as usual:

```sh
helm repo update
helm upgrade vector-operator vector-operator/vector-operator -n NAMESPACE
```

**Then update the CRDs — Helm does not upgrade them.** Helm installs the chart's `crds/` directory only on the first install and intentionally never touches it again on `helm upgrade`. New or changed CRD fields (and CRD schema fixes) therefore do not reach your cluster until you apply the CRDs yourself:

```sh
kubectl apply --server-side --force-conflicts -k "https://github.com/kaasops/vector-operator/config/crd?ref=<version-tag>"
```

Replace `<version-tag>` with the operator version you upgraded to (for example `v0.5.0`).

Skipping the CRD update can break the operator in subtle ways. For example, versions up to v0.4.1 shipped CRDs that declared the pipeline hash status field as `format: int32`; Kubernetes versions that enforce integer formats (observed on v1.36) reject status updates for pipelines whose hash exceeds the int32 range, and such pipelines are silently excluded from the generated vector config. v0.5.0 fixes the schema, but only if the updated CRDs are applied.

# Cleanup
```bash
kubectl delete namespace test
Expand Down