Skip to content

Commit c857034

Browse files
committed
Fix broken upgrade finalization includes
1 parent 152ac55 commit c857034

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

src/current/_includes/common/upgrade/disable-auto-finalization.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ Either of these settings prevents automatic finalization.
88
{{site.data.alerts.end}}
99
{% endcapture %}
1010

11-
{% if page.path contains 'kubernetes' %}
11+
{% if page.name == 'upgrade-cockroachdb-kubernetes.md' %}
1212

1313
<section class="filter-content" markdown="1" data-scope="operator">
14-
For clusters managed by the Operator, auto-finalization is disabled and cannot be enabled. A major version upgrade is not complete until it is manually [finalized](#finalize-a-major-version-upgrade-manually). The Operator does not yet support the [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) `cluster.auto_upgrade.enabled`.
14+
15+
For clusters managed by the {{ site.data.products.public-operator }}, auto-finalization is disabled and cannot be enabled. A major version upgrade is not complete until it is manually [finalized](#finalize-a-major-version-upgrade-manually). The {{ site.data.products.public-operator }} does not support the [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) `cluster.auto_upgrade.enabled`.
16+
1517
</section>
1618

1719
<section class="filter-content" markdown="1" data-scope="manual">
@@ -22,6 +24,7 @@ To disable auto-finalization:
2224

2325
1. Connect to the cluster using the SQL shell:
2426

27+
{% include_cached copy-clipboard.html %}
2528
~~~ shell
2629
$ kubectl exec -it cockroachdb-client-secure \
2730
-- ./cockroach sql \
@@ -45,6 +48,7 @@ To disable auto-finalization:
4548

4649
1. Connect to the cluster using the SQL shell:
4750

51+
{% include_cached copy-clipboard.html %}
4852
~~~ shell
4953
$ kubectl exec -it cockroachdb-client-secure \
5054
-- ./cockroach sql \
@@ -58,6 +62,28 @@ Now, to complete a major-version upgrade, you must manually [finalize it](#final
5862
5963
</section>
6064
65+
{% else if page.name == 'upgrade-cockroachdb-kubernetes-operator.md' %}
66+
67+
By default, auto-finalization is enabled, and a major-version upgrade is finalized when all nodes have rejoined the cluster using the new `cockroach` binary. This means that by default, a major-version upgrade cannot be rolled back. Instead, you must [restore the cluster to the previous version]({% link {{ page.version.version }}/restoring-backups-across-versions.md %}#support-for-restoring-backups-into-a-newer-version).
68+
69+
To disable auto-finalization:
70+
71+
1. Connect to the cluster using the SQL shell:
72+
73+
{% include_cached copy-clipboard.html %}
74+
~~~ shell
75+
kubectl exec -it cockroachdb-client-secure \
76+
-- ./cockroach sql \
77+
--certs-dir=/cockroach-certs \
78+
--host=cockroachdb-public
79+
~~~
80+
81+
1. Set the [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) `cluster.auto_upgrade.enabled` to `false`.
82+
83+
Now, to complete a major-version upgrade, you must manually [finalize it](#finalize-a-major-version-upgrade-manually) or [roll it back](#roll-back-a-major-version-upgrade).
84+
85+
{{ new_flag }}
86+
6187
{% else %}
6288
6389
By default, auto-finalization is enabled, and a major-version upgrade is finalized when all nodes have rejoined the cluster using the new `cockroach` binary. This means that by default, a major-version upgrade cannot be rolled back. Instead, you must [restore the cluster to the previous version]({% link {{ page.version.version }}/restoring-backups-across-versions.md %}#support-for-restoring-backups-into-a-newer-version).

0 commit comments

Comments
 (0)