Upgrade StreamNative Operator

StreamNative Operator supports seamless upgrades to newer versions while maintaining the existing Pulsar cluster state and configuration. This guide upgrades to StreamNative Operator Helm chart 0.21.2, which deploys Operator v0.21.17. The chart version and Operator version differ. Use the CRDs and Helm chart from the same release.

If you previously installed pulsar-operator/zookeeper-operator/bookkeeper-operator, please refer to upgrade-from-pulsar-operators to upgrade.

Before you begin

Check that a valid license Secret exists in the Operator’s namespace. The default namespace is sn-system for Helm and operators for Operator Lifecycle Manager (OLM). If you installed the Operator in another namespace, use that namespace instead. Set the namespace for the commands in this guide:

export OPERATOR_NAMESPACE=sn-system
# For the default OLM installation, use operators instead.

If you need to import a license, replace the license token and apply this Secret:

cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
  # This label is required for the Operator to detect the license.
  labels:
    cloud.streamnative.io/type: "license"
  name: sn-license
  namespace: ${OPERATOR_NAMESPACE}
type: Opaque
stringData:
  license: "Your license token"
EOF

If you do not have any valid license, you can contact StreamNative to apply for a free trial.

Helm
OLM

To upgrade a Helm installation, follow these steps.

Plan a maintenance window. This Operator version can change generated pod templates and roll the affected StatefulSets.

Apply the StreamNative Operator CRDs from chart version 0.21.2 for Operator v0.21.17.

kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/bookkeeper.streamnative.io_bookkeeperclusters.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agentenvironments.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agentfiles.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agentfunctions.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agentmemorystores.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agents.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agentsessions.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agentskills.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agenttriggers.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_agentvaults.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_apikeys.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_connections.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_connectorcatalogs.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_consoles.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_coordinators.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_kafkaclusters.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_kafkaconnects.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_kafkarestproxies.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_kafkavkcgateways.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_mqttproxies.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_oxiaclusters.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_oxianamespaces.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_pfsqlclusters.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_pulsarcoordinators.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_snschemaregistries.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_sqlcatalogs.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_sqlgateways.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_sqlworkspaces.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_storagecatalogs.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_unilinks.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_unilinkschemas.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/k8s.streamnative.io_virtualkafkaclusters.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/pulsar.streamnative.io_pulsarbrokerrevisions.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/pulsar.streamnative.io_pulsarbrokers.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/pulsar.streamnative.io_pulsarfunctionsworkers.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/pulsar.streamnative.io_pulsarproxies.yaml --server-side --force-conflicts
kubectl apply -f https://raw.githubusercontent.com/streamnative/private-cloud/refs/tags/sn-operator-0.21.2/charts/sn-operator/crds/zookeeper.streamnative.io_zookeeperclusters.yaml --server-side --force-conflicts

Update the Helm repository index and install the StreamNative Operator chart:

helm repo update streamnative
helm upgrade --install sn-operator streamnative/sn-operator --version 0.21.2 -n "$OPERATOR_NAMESPACE"

After the Operator is running, upgrade your sn-platform or sn-platform-slim chart if needed. These charts can render fields that older CRDs reject, so apply the CRDs and upgrade the Operator first.

OLM will automatically handle the upgrade process, you don’t need to do anything. Available channels are alpha, beta, and stable - for production environments, use the stable channel.Before the upgrade, apply the license Secret in the namespace where OLM runs the Operator, which is operators by default. Set OPERATOR_NAMESPACE to that namespace for the license command and verification commands in this guide.

Post-Upgrade Verification

After completing the upgrade, perform the following verification steps:

1. Check Operator Status

# Verify operator is running
kubectl get pods -n "$OPERATOR_NAMESPACE"

# Check operator logs for any errors
kubectl logs -f -n "$OPERATOR_NAMESPACE" deployment/sn-operator

Overview

Quick Start

Configure Private Cloud

Operate Private Cloud

References

Before you begin

Post-Upgrade Verification

1. Check Operator Status

​Before you begin

​Post-Upgrade Verification

​1. Check Operator Status

Before you begin

Post-Upgrade Verification

1. Check Operator Status