Skip to content

Commit 160fe29

Browse files
fix upgrade sections
1 parent 3daa731 commit 160fe29

File tree

2 files changed

+33
-30
lines changed

2 files changed

+33
-30
lines changed

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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ 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
@@ -23,19 +23,19 @@ The following steps ensure you have the minimum versions of all components neces
2323

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

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

2828
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 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

3636
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

4040
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

@@ -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

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

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ weight: 40
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-redis-enterprise-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
@@ -23,19 +23,19 @@ The following steps ensure you have the minimum versions of all components neces
2323

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

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

2828
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

4040
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

@@ -75,6 +75,7 @@ You can monitor the upgrade from the **Installed Operators** page. A new Redis E
7575

7676
## Reapply the SCC
7777

78+
7879
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
@@ -85,30 +86,26 @@ 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
8890

89-
### Upgrade databases
91+
{{<warning>}}
92+
Verify your license is valid before upgrading. Invalid licenses will cause the upgrade to fail.
9093

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 this operator version include `"7.2"` and `"7.4"` (note this value is a string).
94+
Use `oc get rec` and verify the `LICENSE STATE` is valid on your REC before you start the upgrade process.
95+
{{</warning>}}
9296

93-
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.
9497
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.
9598

96-
Before beginning the upgrade of the Redis Enterprise cluster, check the [Redis Enterprise for Kubernetes release notes]({{<relref "/operate/kubernetes/release-notes/7-8-2-releases">}}) to find the Redis Enterprise image tag.
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.
97100

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

100-
### Upgrade an REC with an Active-Active database
101-
102-
We recommend upgrading all participating clusters to the same operator version.
103-
104-
If you are upgrading from a preview version of the Active-Active controller, you can remove the following environment variables: `ACTIVE_ACTIVE_DATABASE_CONTROLLER_ENABLED`, `REMOTE_CLUSTER_CONTROLLER_ENABLED`, and `ENABLE_ALPHA_FEATURES`.
105-
106-
### Edit `redisEnterpriseImageSpec` in the REC spec
103+
### Edit `redisEnterpriseImageSpec`
107104

108105
1. Edit the REC custom resource YAML file.
109106

110107
```sh
111-
kubectl edit rec <your-rec.yaml>
108+
oc edit rec <your-rec.yaml>
112109
```
113110

114111
1. Replace the `versionTag:` declaration under `redisEnterpriseImageSpec` with the new version tag.
@@ -129,24 +126,31 @@ If your operator is monitoring multiple namespaces, you'll need to [reapply your
129126
130127
### Monitor the upgrade
131128
132-
You can view the state of the REC with `kubectl get rec`.
129+
You can view the state of the REC with `oc get rec`.
133130
134131
During the upgrade, the state should be `Upgrade`.
135132
When the upgrade is complete and the cluster is ready to use, the state will change to `Running`.
136133
If the state is `InvalidUpgrade`, there is an error (usually relating to configuration) in the upgrade.
137134
138135
```sh
139-
$ kubectl get rec
136+
$ oc get rec
140137
NAME NODES VERSION STATE SPEC STATUS LICENSE STATE SHARDS LIMIT LICENSE EXPIRATION DATE AGE
141138
rec 3 6.2.10-107 Upgrade Valid Valid 4 2022-07-16T13:59:00Z 92m
142139
```
143140
144141
To see the status of the current rolling upgrade, run:
145142
146143
```sh
147-
kubectl rollout status sts <REC_name>
144+
oc rollout status sts <REC_name>
148145
```
149146
147+
## Upgrade databases
148+
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).
150+
151+
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.
153+
150154
## Troubleshooting
151155
152156
If you start an upgrade without meeting the [prerequisites](#prerequisites), the operator will freeze the upgrade. Check the operator logs for the source of the error. The REDB reconsilliation doesn't work during an upgrade, so you need to apply a manual fix with the Redis Software API (examples below). The updates will also need to be added to the REDB custom resource.

0 commit comments

Comments
 (0)