Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions .github/workflows/operator-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,34 @@ jobs:
labels: |
release
automated

sync-gh-pages-version:
# Keeps gh-pages' docs version in sync with releases. Pushes directly
# (gh-pages has no branch protection) using secrets.PAT, which also
# triggers gh-pages to build and deploy the site.
runs-on: ubuntu-latest
needs: [prepare, release-helm]
if: needs.prepare.outputs.is_canonical == 'true'
permissions:
contents: read
steps:
- name: Checkout gh-pages
uses: actions/checkout@v7
with:
ref: gh-pages
token: ${{ secrets.PAT }}
- name: Update docs version
run: |
TAG="${{ needs.prepare.outputs.tag }}"
CONFIG="config/_default/config.toml"
sed -i "s/^ latest_version = \"[^\"]*\"/ latest_version = \"${TAG}\"/" "$CONFIG"
sed -i "s/^ version = \"[^\"]*\"/ version = \"${TAG}\"/" "$CONFIG"
if git diff --quiet -- "$CONFIG"; then
echo "Docs version already up to date; nothing to push."
exit 0
fi
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add "$CONFIG"
git commit -m "Update docs version to ${TAG}"
git push origin gh-pages
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ spec:
replicas: 1
image:
repository: ghcr.io/adobe/zookeeper-operator/zookeeper
tag: 3.8.4-0.2.15-adobe-20250923
tag: 3.8.4-0.2.15-adobe-20260423
persistence:
reclaimPolicy: Delete
EOF
Expand Down Expand Up @@ -124,11 +124,9 @@ kubectl apply -f https://raw.githubusercontent.com/adobe/koperator/refs/heads/ma

> 📦 **View available versions**: [ghcr.io/adobe/helm-charts/kafka-operator](https://github.com/adobe/koperator/pkgs/container/helm-charts%2Fkafka-operator/versions)

```sh
# Install the latest release
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator --namespace=kafka --create-namespace --skip-crds
OCI registries have no floating "latest" tag, so `--version` is required (replace with your desired version, see available versions above):

# Or install a specific version (replace with desired version)
```sh
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator --version 0.28.0-adobe-20260622 --namespace=kafka --create-namespace --skip-crds
```

Expand Down
15 changes: 4 additions & 11 deletions charts/kafka-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,33 +25,26 @@ previous step - without it, Helm's own CRD install can conflict with the `kubect

> 📦 **View available versions**: [ghcr.io/adobe/helm-charts/kafka-operator](https://github.com/adobe/koperator/pkgs/container/helm-charts%2Fkafka-operator/versions)

```bash
# Install the latest release
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--namespace=kafka --create-namespace --skip-crds
OCI registries have no floating "latest" tag, so `--version` is required (see available versions above):

# Or install a specific version
```bash
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--version 0.28.0-adobe-20260622 --namespace=kafka --create-namespace --skip-crds
```

To install the operator using an already installed cert-manager:
```bash
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--version 0.28.0-adobe-20260622 \
--set certManager.namespace=<your cert manager namespace> --namespace=kafka --create-namespace --skip-crds
```

## Upgrading the chart

To upgrade the chart since the helm 3 limitation you have to set a value as well to keep your CRDs.
If this value is not set your CRDs might be deleted.
If this value is not set your CRDs might be deleted. `--version` is required, same as for install.

```bash
# Upgrade to latest version
helm upgrade kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--namespace=kafka

# Upgrade to specific version
helm upgrade kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--version 0.28.0-adobe-20260622 --namespace=kafka
```
Expand Down
15 changes: 4 additions & 11 deletions charts/kafka-operator/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -25,33 +25,26 @@ previous step - without it, Helm's own CRD install can conflict with the `kubect

> 📦 **View available versions**: [ghcr.io/adobe/helm-charts/kafka-operator](https://github.com/adobe/koperator/pkgs/container/helm-charts%2Fkafka-operator/versions)

```bash
# Install the latest release
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--namespace=kafka --create-namespace --skip-crds
OCI registries have no floating "latest" tag, so `--version` is required (see available versions above):

# Or install a specific version
```bash
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--version 0.28.0-adobe-20260622 --namespace=kafka --create-namespace --skip-crds
```

To install the operator using an already installed cert-manager:
```bash
helm install kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--version 0.28.0-adobe-20260622 \
--set certManager.namespace=<your cert manager namespace> --namespace=kafka --create-namespace --skip-crds
```

## Upgrading the chart

To upgrade the chart since the helm 3 limitation you have to set a value as well to keep your CRDs.
If this value is not set your CRDs might be deleted.
If this value is not set your CRDs might be deleted. `--version` is required, same as for install.

```bash
# Upgrade to latest version
helm upgrade kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--namespace=kafka

# Upgrade to specific version
helm upgrade kafka-operator oci://ghcr.io/adobe/helm-charts/kafka-operator \
--version 0.28.0-adobe-20260622 --namespace=kafka
```
Expand Down
7 changes: 5 additions & 2 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"forkProcessing": "enabled",
"baseBranchPatterns": ["master", "gh-pages"],
"extends": [
":dependencyDashboard",
":ignoreUnstable",
Expand All @@ -19,7 +20,8 @@
"customType": "regex",
"managerFilePatterns": [
"/(^|/)Makefile$/",
"/(^|/)Dockerfile$/"
"/(^|/)Dockerfile$/",
"/(^|/)\\.github/workflows/regenerate-crd-docs\\.yaml$/"
],
"matchStrings": [
"(?<depName>[A-Z][A-Z0-9_]*)_VERSION\\s*=\\s*(?<currentValue>[^\\s]+)\\s*#\\s*renovate:\\s*datasource=(?<datasource>[^\\s]+)\\s*depName=(?<packageName>[^\\s]+)(?:\\s*extractVersion=(?<extractVersion>[^\\s]+))?"
Expand Down Expand Up @@ -68,8 +70,9 @@
"matchManagers": [
"gomod"
],
"matchBaseBranches": ["master"],
"enabled": false,
"description": "Disable Go module updates - handled by automated workflow: .github/workflows/update-go-deps.yml"
"description": "Disable Go module updates on master - handled by automated workflow: .github/workflows/update-go-deps.yml. gh-pages' go.mod is Hugo Modules (theme deps like docsy), not app code, so it stays enabled there."
},
{
"matchCategories": [
Expand Down