Skip to content

Commit e68493c

Browse files
authored
Add limitation/fix incorrect commands in CRDB operator migration guides (#20227)
* Fix incorrect public operator migration commands * Add WAL failover limitation * Copy to 25.4 content
1 parent c2c3c3f commit e68493c

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

src/current/v25.3/migrate-cockroachdb-kubernetes-helm.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ This migration can be completed without affecting cluster availability, and pres
2727

2828
{{site.data.alerts.callout_danger}}
2929
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.
30+
31+
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.
3032
{{site.data.alerts.end}}
3133

3234
## Step 1. Prepare the migration helper

src/current/v25.3/migrate-cockroachdb-kubernetes-operator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ The {{ site.data.products.cockroachdb-operator }} uses slightly different certif
7878
7979
{% include_cached copy-clipboard.html %}
8080
~~~ shell
81-
bin/migration-helper migrate-certs --statefulset-name $STS_NAME --namespace $NAMESPACE
81+
bin/migration-helper migrate-certs --statefulset-name $CRDBCLUSTER --namespace $NAMESPACE
8282
~~~
8383
8484
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.
8585
8686
{% include_cached copy-clipboard.html %}
8787
~~~ shell
8888
mkdir -p manifests
89-
bin/migration-helper build-manifest helm --statefulset-name $STS_NAME --namespace $NAMESPACE --cloud-provider $CLOUD_PROVIDER --cloud-region $REGION --output-dir ./manifests
89+
migration-helper build-manifest operator --crdb-cluster $CRDBCLUSTER --namespace $NAMESPACE --cloud-provider $CLOUD_PROVIDER --cloud-region $REGION --output-dir ./manifests
9090
~~~
9191
9292
## Step 3. Uninstall and replace the {{ site.data.products.public-operator }}

src/current/v25.4/migrate-cockroachdb-kubernetes-helm.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ This migration can be completed without affecting cluster availability, and pres
2727

2828
{{site.data.alerts.callout_danger}}
2929
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.
30+
31+
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.
3032
{{site.data.alerts.end}}
3133

3234
## Step 1. Prepare the migration helper

src/current/v25.4/migrate-cockroachdb-kubernetes-operator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ The {{ site.data.products.cockroachdb-operator }} uses slightly different certif
7878
7979
{% include_cached copy-clipboard.html %}
8080
~~~ shell
81-
bin/migration-helper migrate-certs --statefulset-name $STS_NAME --namespace $NAMESPACE
81+
bin/migration-helper migrate-certs --statefulset-name $CRDBCLUSTER --namespace $NAMESPACE
8282
~~~
8383
8484
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.
8585
8686
{% include_cached copy-clipboard.html %}
8787
~~~ shell
8888
mkdir -p manifests
89-
bin/migration-helper build-manifest helm --statefulset-name $STS_NAME --namespace $NAMESPACE --cloud-provider $CLOUD_PROVIDER --cloud-region $REGION --output-dir ./manifests
89+
migration-helper build-manifest operator --crdb-cluster $CRDBCLUSTER --namespace $NAMESPACE --cloud-provider $CLOUD_PROVIDER --cloud-region $REGION --output-dir ./manifests
9090
~~~
9191
9292
## Step 3. Uninstall and replace the {{ site.data.products.public-operator }}

0 commit comments

Comments
 (0)