Skip to content

Add limitation/fix incorrect commands in CRDB operator migration guides #20227

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add limitation/fix incorrect commands in CRDB operator migration guides #20227

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
9d576a0
Fix incorrect public operator migration commands
jhlodin Aug 28, 2025
ed7cd35
Add WAL failover limitation
jhlodin Aug 28, 2025
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
2 changes: 2 additions & 0 deletions src/current/v25.3/migrate-cockroachdb-kubernetes-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ This migration can be completed without affecting cluster availability, and pres

{{site.data.alerts.callout_danger}}
Commands that use RPCs (such as `cockroach node drain` and `cockroach node decommission`) will be unavailable until the public service is updated in step 4. The {{ site.data.products.cockroachdb-operator }} uses a different port than StatefulSets for RPC services, causing these commands to fail for a limited time.

The {{ site.data.products.cockroachdb-operator }} does not support custom store directories for [WAL failover]({% link {{ page.version.version }}/wal-failover.md %}). If the existing Helm deployment uses custom store directories, they must be reconfigured to use the default directories prior to beginning migration.
{{site.data.alerts.end}}

## Step 1. Prepare the migration helper
Expand Down
4 changes: 2 additions & 2 deletions src/current/v25.3/migrate-cockroachdb-kubernetes-operator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@ The {{ site.data.products.cockroachdb-operator }} uses slightly different certif

{% include_cached copy-clipboard.html %}
~~~ shell
bin/migration-helper migrate-certs --statefulset-name $STS_NAME --namespace $NAMESPACE
bin/migration-helper migrate-certs --statefulset-name $CRDBCLUSTER --namespace $NAMESPACE
~~~

Generate a manifest for each crdbnode and the crdbcluster based on the state of the StatefulSet. The new pods and their associated PVCs must have the same names as the original StatefulSet-managed pods and PVCs. The new {{ site.data.products.cockroachdb-operator }}-managed pods will then use the original PVCs, rather than replicate data into empty nodes.

{% include_cached copy-clipboard.html %}
~~~ shell
mkdir -p manifests
bin/migration-helper build-manifest helm --statefulset-name $STS_NAME --namespace $NAMESPACE --cloud-provider $CLOUD_PROVIDER --cloud-region $REGION --output-dir ./manifests
migration-helper build-manifest operator --crdb-cluster $CRDBCLUSTER --namespace $NAMESPACE --cloud-provider $CLOUD_PROVIDER --cloud-region $REGION --output-dir ./manifests
~~~

## Step 3. Uninstall and replace the {{ site.data.products.public-operator }}
Expand Down
Loading