Skip to content

Commit 9b4e19d

Browse files
authored
Merge pull request #34176 from def-/pr-fix-docs-upgrade
docs: Minor fixes for upgrade docs
2 parents 7ef10cf + 3b3584c commit 9b4e19d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/user/content/installation/upgrading.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ In order to minimize unexpected downtime and avoid connection drops at critical
4747
periods for your application, changes are not immediately and automatically
4848
rolled out by the Operator. Instead, the upgrade process involves two steps:
4949
- First, staging spec changes to the Materialize custom resource.
50-
- Second, applying the changes via a `rolloutRequest`.
50+
- Second, applying the changes via a `requestRollout`.
5151

5252
When upgrading your Materialize instances, you'll first want to update the `environmentdImageRef` field in the Materialize custom resource spec.
5353

@@ -75,7 +75,7 @@ kubectl patch materialize <instance-name> \
7575
-p "{\"spec\": {\"environmentdImageRef\": \"materialize/environmentd:v26.0.0\"}}"
7676
```
7777

78-
#### Applying the changes via `rolloutRequest`
78+
#### Applying the changes via `requestRollout`
7979

8080
To apply changes and kick off the Materialize instance upgrade, you must update the `requestRollout` field in the Materialize custom resource spec to a new UUID.
8181
Be sure to consult the [Rollout Configurations](#rollout-configuration) to ensure you've selected the correct rollout behavior.
@@ -91,7 +91,7 @@ kubectl patch materialize <instance-name> \
9191
It is possible to combine both operations in a single command if preferred:
9292

9393
```shell
94-
kubectl patch materialize 12345678-1234-1234-1234-123456789012 \
94+
kubectl patch materialize <instance-name> \
9595
-n materialize-environment \
9696
--type='merge' \
9797
-p "{\"spec\": {\"environmentdImageRef\": \"materialize/environmentd:v26.0.0\", \"requestRollout\": \"$(uuidgen)\"}}"
@@ -148,7 +148,7 @@ Tears down the prior version before creating and promoting the new version. This
148148

149149
#### In Place Rollout
150150

151-
`inPlaceRollout` has been deprecated and will be ignored.
151+
The `inPlaceRollout` setting has been deprecated and will be ignored.
152152

153153

154154
### Verifying the Upgrade
@@ -165,13 +165,13 @@ kubectl logs -l app.kubernetes.io/name=materialize-operator -n materialize
165165
### Version Specific Upgrade Notes
166166

167167
#### Upgrading to `v26.0`
168-
- This is a major version upgrade. In order to upgrade to `v26.0`, you must first upgrade to `v25.2.15`, then upgrade to `v26.0.0`.
168+
- This is a major version upgrade. In order to upgrade to `v26.0` from `v25.2.X` (where `X < 15`) or `v25.1`, you must first upgrade to `v25.2.15`, then upgrade to `v26.0.0`.
169169
- New requirements were introduced for license keys. In order to upgrade, you will
170170
first need to add a license key to the `backendSecret` used in the spec for your
171-
Materialize resource. Please refer to our [instructions on how to get and install a license keys](/installation/faq#how-do-i-get-a-license-key).
171+
Materialize resource. Please refer to our [instructions on how to get and install a license key](/installation/faq#how-do-i-get-a-license-key).
172172
- Swap is now enabled by default. Swap reduces the memory required to
173173
operate Materialize and improves cost efficiency. Upgrading to `v26.0`
174-
requires some preparation to ensure kubernetes nodes are labeled
174+
requires some preparation to ensure Kubernetes nodes are labeled
175175
and configured correctly. Please refer to our guides:
176176

177177
{{< yaml-table data="self_managed/enable_swap_upgrade_guides" >}}

0 commit comments

Comments
 (0)