Skip to content

Commit 946681b

Browse files
K8s: upgrade article fixes (#1182)
* doc-4859 * copy edits * fix upgrade sections * Update content/operate/kubernetes/release-notes/7-8-4-releases/7-8-4-8-feb25.md Co-authored-by: Zvi Cahana <zcahana@users.noreply.github.com> --------- Co-authored-by: Zvi Cahana <zcahana@users.noreply.github.com>
1 parent 1087821 commit 946681b

File tree

4 files changed

+94
-36
lines changed

4 files changed

+94
-36
lines changed

content/operate/kubernetes/release-notes/7-8-4-releases/7-8-4-8-feb25.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ Any distribution not listed below is not supported for production workloads.
6060

6161
- **Redis Enterprise**: `redislabs/redis:7.8.4-66`
6262
- **Operator**: `redislabs/operator:7.8.4-8`
63-
- **Services Rigger**: `redislabs/k8s-controller:7.8.`
63+
- **Services Rigger**: `redislabs/k8s-controller:7.8.4-8`
6464
- **OLM operator bundle** : `v7.8.4-8.0`

content/operate/kubernetes/upgrade/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Title: Upgrade Redis Enterprise for Kubernetes 7.8.2-6
2+
Title: Upgrade Redis Enterprise for Kubernetes
33
alwaysopen: false
44
categories:
55
- docs
@@ -27,11 +27,11 @@ For all other Kubernetes distributions, see [Upgrade Redis Enterprise for Kubern
2727

2828
When upgrading, both your Kubernetes version and Redis operator version need to be supported at all times.
2929

30-
{{<warning>}}If your current Kubernetes distribution is not [supported by 7.8.2-6]({{<relref "/operate/kubernetes/release-notes/7-8-2-releases/7-8-2-6-nov24#supported-distributions">}}), upgrade to a supported distribution before upgrading. {{</warning>}}
30+
{{<warning>}}If your current Kubernetes distribution is not [supported]({{<relref "/operate/kubernetes/reference/supported_k8s_distributions.md">}}), upgrade to a supported distribution before upgrading. {{</warning>}}
3131

3232
## RHEL9-based image
3333

34-
Redis Enterprise images are now based on Red Hat Enterprise Linux 9 (RHEL9). This means upgrades to 7.8.2-6 require:
34+
Redis Enterprise images are now based on Red Hat Enterprise Linux 9 (RHEL9). This means upgrades require:
3535

3636
- [Cluster version of 7.4.2-2 or later](https://redis.io/docs/latest/operate/kubernetes/7.4.6/upgrade/).
3737
- Database version 7.2 or later.

content/operate/kubernetes/upgrade/openshift-cli.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Title: Upgrade Redis Enterprise 7.8.2-6 with OpenShift CLI
2+
Title: Upgrade Redis Enterprise with OpenShift CLI
33
alwaysopen: false
44
categories:
55
- docs
@@ -14,30 +14,30 @@ weight: 20
1414
Redis implements rolling updates for software upgrades in Kubernetes deployments. The upgrade process includes updating three components:
1515

1616
1. [Upgrade the Redis Enterprise operator](#upgrade-the-operator)
17-
1. [Upgrade the Redis Enterprise cluster (REC)](#upgrade-the-redis-enterprise-cluster-rec)
17+
1. [Upgrade the Redis Enterprise cluster (REC)](#upgrade-the-redis-enterprise-cluster)
1818
1. [Upgrade Redis Enterprise databases (REDB)](#upgrade-databases)
1919

2020
## Prerequisites
2121

22-
The following steps ensure you have the minimum versions of all components necessary to upgrade to 7.8.2-6. **Without these minimum versions, the upgrade will freeze and require manual recovery.**
22+
The following steps ensure you have the minimum versions of all components necessary to upgrade to 7.8.2-6 or later. **Without these minimum versions, the upgrade will freeze and require manual recovery.**
2323

2424
See the [troubleshooting](#troubleshooting) section for details on recovering a failed upgrade.
2525

26-
### Kubernetes version
26+
#### Kubernetes version
2727

28-
Check [Supported Kubernetes distributions]({{<relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported by 7.8.2-6. If not, upgrade your Kubernetes distribution before upgrading the Redis operator.
28+
Check [Supported Kubernetes distributions]({{<relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. If not, upgrade your Kubernetes distribution before upgrading the Redis operator.
2929

30-
### Redis operator version
30+
#### Redis operator version
3131

32-
Your Redis Enterprise clusters must be running version 7.4.2-2 or later before upgrading to 7.8.2-6. See the [7.4 upgrade](https://redis.io/docs/latest/operate/kubernetes/7.4.6/upgrade/openshift-cli/) for detailed steps.
32+
Your Redis Enterprise clusters must be running version 7.4.2-2 or later before upgrading to 7.8.2-6 or later. See the [7.4 upgrade](https://redis.io/docs/latest/operate/kubernetes/7.4.6/upgrade/openshift-cli/) for detailed steps.
3333

34-
### Redis database version
34+
#### Redis database version
3535

36-
Your Redis databases must be running version 7.2 or later before upgrading your cluster version to 7.8.2-6. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}).
36+
Your Redis databases must be running version 7.2 or later before upgrading your cluster version. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}).
3737

38-
### RHEL9-compatible modules
38+
#### RHEL9-compatible modules
3939

40-
Upgrading to Redis operator version 7.8.2-6 involves migrating your Redis Enterprise nodes to RHEL9 from either Ubuntu 18 or RHEL8. If your databases use modules, you need to manually install modules compatible with RHEL9.
40+
Upgrading to Redis operator versions 7.8.2-6 and later involves migrating your Redis Enterprise nodes to RHEL9 from either Ubuntu 18 or RHEL8. If your databases use modules, you need to manually install modules compatible with RHEL9.
4141

4242
To see which modules you have installed, run:
4343

@@ -53,7 +53,7 @@ curl -k -u <rec_username>:<rec_password> -X GET https://localhost:9443/v1/bdbs |
5353

5454
See [Upgrade modules]({{<relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module">}}) for details on how to upgrade modules with the `rladmin` tool.
5555

56-
### Valid license
56+
#### Valid license
5757

5858
Use `kubectl get rec` and verify the `LICENSE STATE` is valid on your REC before you start the upgrade process.
5959

@@ -143,8 +143,7 @@ oc adm policy add-scc-to-user redis-enterprise-scc-v2 \
143143

144144
If you are upgrading from operator version 6.4.2-6 or before, see the ["after upgrading"](#after-upgrading) section to delete the old SCC and role binding after all clusters are running 6.4.2-6 or later.
145145

146-
## Upgrade the RedisEnterpriseCluster (REC)
147-
146+
## Upgrade the Redis Enterprise Cluster
148147

149148
{{<warning>}}
150149
Verify your license is valid before upgrading. Invalid licenses will cause the upgrade to fail.
@@ -154,11 +153,11 @@ Use `oc get rec` and verify the `LICENSE STATE` is valid on your REC before you
154153

155154
The Redis Enterprise cluster (REC) can be updated automatically or manually. To trigger automatic upgrade of the REC after the operator upgrade completes, specify `autoUpgradeRedisEnterprise: true` in your REC spec. If you don't have automatic upgrade enabled, follow the below steps for the manual upgrade.
156155

157-
Before beginning the upgrade of the Redis Enterprise cluster, check the K8s operator release notes to find the Redis Enterprise image tag. For example, in Redis Enterprise K8s operator release [6.0.12-5](https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases/tag/v6.0.12-5), the `Images` section shows the Redis Enterprise tag is `6.0.12-57`.
156+
Before beginning the upgrade of the Redis Enterprise cluster, check the K8s operator [release notes]({{<relref "/operate/kubernetes/release-notes">}}) to find the Redis Enterprise image tag.
158157

159158
After the operator upgrade is complete, you can upgrade Redis Enterprise cluster (REC).
160159

161-
### Edit `redisEnterpriseImageSpec` in the REC spec
160+
### Edit `redisEnterpriseImageSpec`
162161

163162
1. Edit the REC custom resource YAML file.
164163

@@ -204,7 +203,7 @@ oc rollout status sts <REC_name>
204203
205204
### Upgrade databases
206205
207-
After the cluster is upgraded, you can upgrade your databases. Specify your new database version in the `spec.redisVersion` field for your REDB and REAADB custom resources. Supported database versions for operator version 7.8.2-6 include `"7.2"` and `"7.4"` (note this value is a string).
206+
After the cluster is upgraded, you can upgrade your databases. Specify your new database version in the `spec.redisVersion` field for your REDB and REAADB custom resources. Supported database versions include `"7.2"` and `"7.4"` (note this value is a string).
208207
209208
Note that if your cluster [`redisUpgradePolicy`]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api#redisupgradepolicy" >}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details.
210209

content/operate/kubernetes/upgrade/upgrade-olm.md

Lines changed: 74 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Title: Upgrade Redis Enterprise 7.8.2-6 with OpenShift OperatorHub
2+
Title: Upgrade Redis Enterprise with OpenShift OperatorHub
33
alwaysopen: false
44
categories:
55
- docs
@@ -13,31 +13,31 @@ weight: 40
1313

1414
Redis implements rolling updates for software upgrades in Kubernetes deployments. The upgrade process includes updating three components:
1515

16-
1. [Upgrade the Redis Enterprise operator](#upgrade-the-operator)
17-
1. [Upgrade the Redis Enterprise cluster (REC)](#upgrade-the-redis-enterprise-cluster-rec)
16+
1. [Upgrade the Redis Enterprise operator](#upgrade-the-redis-enterprise-operator)
17+
1. [Upgrade the Redis Enterprise cluster (REC)](#upgrade-the-redis-enterprise-cluster)
1818
1. [Upgrade Redis Enterprise databases (REDB)](#upgrade-databases)
1919

2020
## Prerequisites
2121

22-
The following steps ensure you have the minimum versions of all components necessary to upgrade to 7.8.2-6. **Without these minimum versions, the upgrade will freeze and require manual recovery.**
22+
The following steps ensure you have the minimum versions of all components necessary to upgrade. **Without these minimum versions, the upgrade will freeze and require manual recovery.**
2323

2424
See the [troubleshooting](#troubleshooting) section for details on recovering a failed upgrade.
2525

26-
### Kubernetes version
26+
#### Kubernetes version
2727

28-
Check [Supported Kubernetes distributions]({{<relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported by 7.8.2-6. If not, upgrade your Kubernetes distribution before upgrading the Redis operator.
28+
Check [Supported Kubernetes distributions]({{<relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. If not, upgrade your Kubernetes distribution before upgrading the Redis operator.
2929

30-
### Redis operator version
30+
#### Redis operator version
3131

3232
Your Redis Enterprise clusters must be running version 7.4.2-2 or later before upgrading to 7.8.2-6. See the [7.4 upgrade](https://redis.io/docs/latest/operate/kubernetes/7.4.6/upgrade/upgrade-olm/) for detailed steps.
3333

34-
### Redis database version
34+
#### Redis database version
3535

3636
Your Redis databases must be running version 7.2 or later before upgrading your cluster version to 7.8.2-6. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}).
3737

38-
### RHEL9-compatible modules
38+
#### RHEL9-compatible modules
3939

40-
Upgrading to Redis operator version 7.8.2-6 involves migrating your Redis Enterprise nodes to RHEL9 from either Ubuntu 18 or RHEL8. If your databases use modules, you need to manually install modules compatibile with RHEL9.
40+
Upgrading to Redis operator version 7.8.2-6 or later involves migrating your Redis Enterprise nodes to RHEL9 from either Ubuntu 18 or RHEL8. If your databases use modules, you need to manually install modules compatible with RHEL9.
4141

4242
To see which modules you have installed, run:
4343

@@ -65,17 +65,18 @@ Use `kubectl get rec` and verify the `LICENSE STATE` is valid on your REC before
6565

6666
3. Verify your **Update approval** is set to "Manual".
6767

68-
4. If you wish to upgrade to the most recent version, set your **Update channel** to "production". If you wish to upgrade to an older version, select it for your Update channel.
68+
4. To upgrade to the latest version, set your **Update Channel** to production’. To upgrade to an older version, specify the desired version for your **Update Channel**.
6969

7070
5. Select **Upgrade available** shown under **Upgrade status**.
7171

7272
6. When the "Review manual InstallPlan" section appears, select **Preview installPlan** and then **Approve** after reviewing the details. This will start the operator upgrade.
7373

74-
You can monitor the upgrade from the **Installed Operators** page. A new Redis Enterprise Operator will appear in the list, with the status "Installing". The OpenShift will delete the old operator, showing the "Cannot update" status during deletion.
74+
You can monitor the upgrade from the **Installed Operators** page. A new Redis Enterprise Operator will appear in the list, with the status "Installing". OpenShift will delete the old operator, showing the "Cannot update" status during deletion.
7575

7676
## Reapply the SCC
7777

78-
If you are using OpenShift, you will also need to manually reapply the [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account.
78+
79+
If you are using OpenShift, you must manually reappply the [security context constraints (SCC)](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account.
7980

8081
```sh
8182
oc apply -f openshift/scc.yaml
@@ -85,12 +86,70 @@ oc apply -f openshift/scc.yaml
8586
oc adm policy add-scc-to-user redis-enterprise-scc-v2 \
8687
system:serviceaccount:<my-project>:<rec-name>
8788
```
89+
## Upgrade the Redis Enterprise Cluster
90+
91+
{{<warning>}}
92+
Verify your license is valid before upgrading. Invalid licenses will cause the upgrade to fail.
93+
94+
Use `oc get rec` and verify the `LICENSE STATE` is valid on your REC before you start the upgrade process.
95+
{{</warning>}}
96+
97+
The Redis Enterprise cluster (REC) can be updated automatically or manually. To trigger automatic upgrade of the REC after the operator upgrade completes, specify `autoUpgradeRedisEnterprise: true` in your REC spec. If you don't have automatic upgrade enabled, follow the below steps for the manual upgrade.
98+
99+
Before beginning the upgrade of the Redis Enterprise cluster, check the K8s operator [release notes]({{<relref "/operate/kubernetes/release-notes">}}) to find the Redis Enterprise image tag.
100+
101+
After the operator upgrade is complete, you can upgrade Redis Enterprise cluster (REC).
102+
103+
### Edit `redisEnterpriseImageSpec`
104+
105+
1. Edit the REC custom resource YAML file.
106+
107+
```sh
108+
oc edit rec <your-rec.yaml>
109+
```
110+
111+
1. Replace the `versionTag:` declaration under `redisEnterpriseImageSpec` with the new version tag.
112+
113+
```YAML
114+
spec:
115+
redisEnterpriseImageSpec:
116+
imagePullPolicy: IfNotPresent
117+
repository: redislabs/redis
118+
versionTag: <new-version-tag>
119+
```
120+
121+
1. Save the changes to apply.
122+
123+
### Reapply roles and role bindings
124+
125+
If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) for more details.
126+
127+
### Monitor the upgrade
128+
129+
You can view the state of the REC with `oc get rec`.
130+
131+
During the upgrade, the state should be `Upgrade`.
132+
When the upgrade is complete and the cluster is ready to use, the state will change to `Running`.
133+
If the state is `InvalidUpgrade`, there is an error (usually relating to configuration) in the upgrade.
134+
135+
```sh
136+
$ oc get rec
137+
NAME NODES VERSION STATE SPEC STATUS LICENSE STATE SHARDS LIMIT LICENSE EXPIRATION DATE AGE
138+
rec 3 6.2.10-107 Upgrade Valid Valid 4 2022-07-16T13:59:00Z 92m
139+
```
140+
141+
To see the status of the current rolling upgrade, run:
142+
143+
```sh
144+
oc rollout status sts <REC_name>
145+
```
88146
89-
### Upgrade databases
147+
## Upgrade databases
90148
91-
After the cluster is upgraded, you can upgrade your databases. Specify your new database version in the `spec.redisVersion` field for your REDB and REAADB custom resources. Supported database versions for operator version 7.8.2-6 include `"7.2"` and `"7.4"` (note this value is a string).
149+
After the cluster is upgraded, you can upgrade your databases. Specify your new database version in the `spec.redisVersion` field for your REDB and REAADB custom resources. Supported database versions for this operator version include `"7.2"` and `"7.4"` (note this value is a string).
92150
93151
Note that if your cluster [`redisUpgradePolicy`]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api#redisupgradepolicy" >}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details.
152+
The Redis Enterprise cluster (REC) can be updated automatically or manually. To trigger automatic upgrade of the REC after the operator upgrade completes, specify `autoUpgradeRedisEnterprise: true` in your REC spec. If you don't have automatic upgrade enabled, follow the below steps for the manual upgrade.
94153
95154
## Troubleshooting
96155

0 commit comments

Comments
 (0)