Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc-900 K8s Heart of gold release updates #1648

Merged
merged 13 commits into from
Nov 5, 2021
39 changes: 39 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,45 @@

The docs are updated regularly; here are some recent highlights:

## October 2021

- Redis Enterprise Software doc updates:

- Updated docs to support the v6.2.8 release ([PR #1632](https://github.com/RedisLabs/redislabs-docs/pull/1632)), which included:
- [Release notes](https://docs.redis.com/latest/rs/release-notes/rs-6-2-8-october-2021/) ([PR #1628](https://github.com/RedisLabs/redislabs-docs/pull/1628))
- Updates to the [Redis upgrade policy](https://docs.redis.com/latest/rs/installing-upgrading/upgrading/#redis-upgrade-policy) docs ([PR #1599](https://github.com/RedisLabs/redislabs-docs/pull/1599))
- Updates to the [backup data](https://docs.redis.com/latest/rs/administering/import-export/database-backup/) and [export data](https://docs.redis.com/latest/rs/administering/import-export/exporting-data/) articles ([PR #1548](https://github.com/RedisLabs/redislabs-docs/pull/1548) & [PR #1598](https://github.com/RedisLabs/redislabs-docs/pull/1598))

- REST API docs are [in preview](https://docs.redis.com/staging/rs-rest-api/rs/references/rest-api/) ([PR #1533](https://github.com/RedisLabs/redislabs-docs/pull/1533), [PR #1621](https://github.com/RedisLabs/redislabs-docs/pull/1621))

- Redis Enterprise Cloud updates:

- REST API docs have been clarified and updated to reflect the new user experience ([PR #1651](https://github.com/RedisLabs/redislabs-docs/pull/1651)), which includes:
- [Get started](https://docs.redis.com/latest/rc/api/get-started/)
- [Enable the API](https://docs.redis.com/latest/rc/api/get-started/enable-the-api/)
- [Manage API keys](https://docs.redis.com/latest/rc/api/get-started/manage-api-keys/)

- A new article describes how to [migrate data](https://docs.redis.com/latest/rc/databases/migrate-databases/) to Redis Enterprise Cloud subscriptions ([PR #1619](https://github.com/RedisLabs/redislabs-docs/pull/1619))

- Kubernetes doc updates:

- The Platforms section of the docs has been renamed to Kubernetes ([PR #1562](https://github.com/RedisLabs/redislabs-docs/pull/1562))

- Additional changes

- Modules: A new article documents Redis Enterprise [feature compatibility support](https://docs.redis.com/latest/modules/enterprise-capabilities/) ([PR #1504](https://github.com/RedisLabs/redislabs-docs/pull/1504))

- Release notes have been added for:
- [RedisGraph v2.4.11](https://docs.redis.com/latest/modules/redisgraph/release-notes/redisgraph-2.4-release-notes/#v2411-october-2021) ([PR #1560](https://github.com/RedisLabs/redislabs-docs/pull/1560))
- [RediSearch v2.0.12](https://docs.redis.com/latest/modules/redisearch/release-notes/redisearch-2.0-release-notes/#v2012-september-2021) ([PR #1616](https://github.com/RedisLabs/redislabs-docs/pull/1616))

- RedisInsight: [v1.11 release notes](https://docs.redis.com/latest/ri/release-notes/v1.11.0/) have been added ([PR #1605](https://github.com/RedisLabs/redislabs-docs/pull/1605))

- Additional updates to fix typos, missing images, and other glitches

To learn more, review the [merged pull requests](https://github.com/RedisLabs/redislabs-docs/pulls?q=is%3Apr+merged%3A2021-10-01..2021-10-31).


## September 2021

- Changes affecting all sections:
Expand Down
2 changes: 1 addition & 1 deletion content/kubernetes/deployment/tanzu/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Title: Redis Enterprise Software on Kubernetes deployment with VMWare Tanzu Kubernetes Grid Integrated Edition (formerly Pivotal PKS)
linkTitle: VMWare Tanzu
linkTitle: TKGI
description: This section provides the steps required to set up a Redis Enterprise cluster with the Kubernetes Operator on VMWare Tanzu Kubernetes Grid Integrated Edition (formerly Pivotal PKS).
weight: 60
alwaysopen: false
Expand Down
4 changes: 2 additions & 2 deletions content/kubernetes/deployment/using-kustomize.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/kubernetes/tasks/using-kustomize/,
/platforms/kubernetes/tasks/using-kustomize.md
/platforms/kubernetes/tasks/using-kustomize.md,
/platforms/kubernetes/deployment/using-kustomize/,
/platforms/kubernetes/deployment/using-kustomize.md,
/kubernetes/deployment/using-kustomize.md,
/kubernetes/deployment/using-kustomize/
/kubernetes/deployment/using-kustomize/,
]
---

Expand Down
6 changes: 5 additions & 1 deletion content/kubernetes/re-clusters/cluster-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,12 @@ When the last pod is manually deleted, the recovery process resumes.
```sh
kubectl exec <pod-name> -- rladmin recover all
```

This command recovers the data for all nodes in the cluster based on the cluster configuration in pod-0.

{{< note >}}
If the database status is `missing files`, make sure all persistence files are palced on the correct nodes under the persistence path. In case of databases with AOF persistence enabled, you may need to rename AOF files on the pods to remove the .prev suffix
{{< /note >}}
kaitlynmichael marked this conversation as resolved.
Show resolved Hide resolved

If you want to recover based on the cluster configuration of another pod, copy the cluster configuration from the source pod (/var/opt/redislabs/persist/ccs/ccs-redis.rdb) to pod-0.

Expand Down
6 changes: 3 additions & 3 deletions content/kubernetes/re-clusters/upgrade-redis-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ aliases: [
/kubernetes/re-clusters/upgrade-redis-cluster/,
]
---
Redis implements rolling updates for software upgrades in Kubernetes deployments.
Redis implements rolling updates for software upgrades in Kubernetes deployments. The upgrade process consists of two steps: upgrading the Redis Enterprise operator, and upgrading the Redis Enterprise cluster version.

## Upgrade Redis Enterprise
## 1- Upgrade Redis Enterprise

### Download the bundle
You need to ensure that you pull the correct version of the bundle. You can find the version tags
Expand Down Expand Up @@ -86,7 +86,7 @@ NAME READY UP-TO-DATE AVAILABLE AGE
redis-enterprise-operator 1/1 1 1 0m36s
```

### Upgrade the Redis Enterprise cluster version
### 2- Upgrade the Redis Enterprise cluster version

Before beginning the upgrade of the Redis Enterprise cluster version, 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`.

Expand Down
4 changes: 2 additions & 2 deletions content/kubernetes/reference/cluster-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ weight: 32
alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/kubernetes/cluster-options/
/platforms/kubernetes/cluster-options/,
/platforms/kubernetes/cluster-options.md,
/kubernetes/reference/cluster-options.md,
/kubernetes/reference/cluster-options/
/kubernetes/reference/cluster-options/,
]
---
A Redis Enterprise cluster is defined in a Custom Resource Definition (CRD).
Expand Down
29 changes: 8 additions & 21 deletions content/kubernetes/reference/db-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/kubernetes/reference/db-options.md,
/platforms/kubernetes/reference/db-options/
/platforms/kubernetes/reference/db-options/,
/kubernetes/reference/db-options.md,
/kubernetes/reference/db-options/
/kubernetes/reference/db-options/,
]
---

Expand All @@ -19,28 +19,15 @@ These options include options that you can change and options that are created b

A string containing the name of a secret that contains the desired database password.

If you do not specify a secret name, a secret is created for you with the name
constructed from the database name (`metadata.name`) with "`redb-`" as a prefix.

If you specify a secret name, you must create the secret before you create the
database resource.

To create your own database password in the secret, run:
If you specify a secret name, you must create an [opaque secret] before you create the
kaitlynmichael marked this conversation as resolved.
Show resolved Hide resolved
kaitlynmichael marked this conversation as resolved.
Show resolved Hide resolved
database resource. The operator takes the password from the `password` key in the secret.

```sh
kubectl create secret generic mydb --from-literal=password=<password>
```
To disable authentication for the database, use an empty string as a value for the `password` key.

where \<password> is your desired password in plain text.

In the database custom resource, the value is just secret name. In this example,
the name is `mydb`:

```yaml
databaseSecretName: mydb
```
If you do not specify a secret name, the operator will create a secret for you with the name
constructed from the database name (`metadata.name`) with "`redb-`" as a prefix.

When the database is created, the secret is updated to include the port and service name for the database
When the database is created, the secret is updated to include the port and service name for the database,
but the password does not change. If you did not create the secret, it is
also updated with the generated database password.

Expand Down
4 changes: 2 additions & 2 deletions content/kubernetes/reference/supported_k8s_distributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Each release of the Redis Enterprise operator is thoroughly tested against a set
| GKE 1.19 | supported |
| GKE 1.20 | supported |
| GKE 1.21 | supported |
| Rancher 2.4 (K8s 1.17) | supported |
| Rancher 2.4 (K8s 1.18) | supported |
| Rancher 2.4 (K8s 1.17) | deprecated |
| Rancher 2.4 (K8s 1.18) | deprecated |
| Rancher 2.5 (K8s 1.17) | supported |
| Rancher 2.5 (K8s 1.18) | supported |
| Rancher 2.5 (K8s 1.19) | supported |
Expand Down
4 changes: 2 additions & 2 deletions content/kubernetes/release-notes/k8s-6-0-20-12-2021-07.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@ is required, the only fix is to upgrade the K8s cluster to a newer version.
* EKS is now supported (K8s 1.18)
* OpenShift 4.4 (previously deprecated) is no longer supported
* GKE K8s versions 1.15, 1.16 (previously deprecated) is no longer supported
* VMWare TKGIE 1.10 (K8s 1.19) is now supported
* VMWare TKGI 1.10 (K8s 1.19) is now supported

## Deprecation notice

* GKE K8s version 1.17 (no longer supported by Google) is deprecated
* kOps 1.15 is deprecated
* VMWare TKGIE 1.7 (K8s 1.16), VMWare TKGIE 1.8 (K8s 1.17) are deprecated (no longer supported by VMWare)
* VMWare TKGI 1.7 (K8s 1.16), VMWare TKGI 1.8 (K8s 1.17) are deprecated (no longer supported by VMWare)
4 changes: 2 additions & 2 deletions content/kubernetes/release-notes/k8s-6-0-6-11-2020-07.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/release-notes/k8s-6-0-6-11-2020-07.md,
/platforms/release-notes/k8s-6-0-6-11-2020-07/
/platforms/release-notes/k8s-6-0-6-11-2020-07/,
/kubernetes/release-notes/k8s-6-0-6-11-2020-07.md,
/kubernetes/release-notes/k8s-6-0-6-11-2020-07/
/kubernetes/release-notes/k8s-6-0-6-11-2020-07/,
]
---

Expand Down
4 changes: 2 additions & 2 deletions content/kubernetes/release-notes/k8s-6-2-4-1-2021-09.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This release includes the following container images:

* **Redis Enterprise**: `redislabs/redis:6.2.4-55` or `redislabs/redis:6.2.4-55.rhel7-openshift`
* **Operator**: `redislabs/operator:6.2.4-1`
* **Services Rigger**: `redislabs/k8s-controller:6.0.20-1` or `redislabs/services-manager:6.2.4-1` (on the Red Hat registry)
* **Services Rigger**: `redislabs/k8s-controller:6.2.4-1` or `redislabs/services-manager:6.2.4-1` (on the Red Hat registry)

## New features

Expand Down Expand Up @@ -159,5 +159,5 @@ See [Supported Kubernetes distributions]({{< relref "/kubernetes/reference/suppo
## Deprecation notice

* kOps 1.16 and 1.17 are deprecated
* VMWare TKGIE 1.7 (K8s 1.16), VMWare TKGIE 1.8 (K8s 1.17) are deprecated (no longer supported by VMWare)
* VMWare TKGI 1.7 (K8s 1.16), VMWare TKGI 1.8 (K8s 1.17) are deprecated (no longer supported by VMWare)
* Openshift 3.11 (K8s 1.11) is now deprecated. Redis will continue to support existing deployments for the lifetime of Openshift 3.11, but new deployments are strongly discouraged.
131 changes: 131 additions & 0 deletions content/kubernetes/release-notes/k8s-6-2-8-tbd-2021-11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
---
Title: Redis Enterprise for Kubernetes Release Notes 6.2.8-tbd (November 2021)
linktitle: 6.2.8-tbd (November 2021)
description: Release notes for version 6.2.8-tbd of Redis Enterprise Software for Kubernetes.
weight: 66
alwaysopen: false
categories: ["Platforms"]
aliases: [
/kubernetes/release-notes/k8s-6-2-8-tbd-2021-11.md,
/kubernetes/release-notes/k8s-6-2-8-tbd-2021-11/,
]
---
## Overview

The Redis Enterprise [K8s 6.2.8-tbd](https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases/tag/v6.2.8-tbd) release provides support for the [Redis Enterprise Software release 6.2.8] and includes several enhancements and bug fixes.

The key new features, bug fixes, and known limitations are described below.

## Images

This release includes the following container images:

* **Redis Enterprise**: `redislabs/redis:6.2.8-tbd` or `redislabs/redis:6.2.8-tbd.rhel7-openshift`
* **Operator**: `redislabs/operator:6.2.8-tbd`
* **Services Rigger**: `redislabs/k8s-controller:6.2.8-tbd` or `redislabs/services-manager:6.2.8-tbd` (on the Red Hat registry)

## New features

* Certificate management capabilities through the Redis Enterprise cluster API (RED-61176)
* Single-node cluster support preview (only available for select customers) (RED-59549)
kaitlynmichael marked this conversation as resolved.
Show resolved Hide resolved

## Feature improvements

* Support for managing database ports through the REDB API (RED-48286)
* Use explicit object instead of wildcard for roles (RED-38013)
* Advanced use case support for custom attributes for REC stateful set and rigger pods (RED-56502, RED-62550, RED-63426)
* Services rigger and K8s controller image changed to ubi-minimal lightweight base image (RED-61866)
* Support for the Redis upgrade policy setting through the REC API (RED-63000)

## Fixed bugs

* Fixed issue of log rotation not working on OpenShift (RED-64726)

## Known limitations


### Long cluster names cause routes to be rejected (RED-25871)

A cluster name longer than 20 characters will result in a rejected route configuration because the host part of the domain name will exceed 63 characters. The workaround is to limit cluster name to 20 characters or less.

### Cluster CR (REC) errors are not reported after invalid updates (RED-25542)

A cluster CR specification error is not reported if two or more invalid CR resources are updated in sequence.

### An unreachable cluster has status running (RED-32805)

When a cluster is in an unreachable state, the state is still `running` instead of being reported as an error.

### Readiness probe incorrect on failures (RED-39300)

STS Readiness probe does not mark a node as "not ready" when running `rladmin status` on the node fails.
kaitlynmichael marked this conversation as resolved.
Show resolved Hide resolved

### Role missing on replica sets (RED-39002)

The `redis-enterprise-operator` role is missing permission on replica sets.

### Private registries are not supported on OpenShift 3.11 (RED-38579)

OpenShift 3.11 does not support DockerHub private registries. This is a known OpenShift issue.

### Internal DNS and Kubernetes DNS may have conflicts (RED-37462)

DNS conflicts are possible between the cluster `mdns_server` and the K8s DNS. This only impacts DNS resolution from within cluster nodes for Kubernetes DNS names.

### 5.4.10 negatively impacts 5.4.6 (RED-37233)

Kubernetes-based 5.4.10 deployments seem to negatively impact existing 5.4.6 deployments that share a Kubernetes cluster.

### Node CPU usage is reported instead of pod CPU usage (RED-36884)

In Kubernetes, the node CPU usage we report on is the usage of the Kubernetes worker node hosting the REC pod.

### Clusters must be named "rec" in OLM-based deployments (RED-39825)

In OLM-deployed operators, the deployment of the cluster will fail if the name is not "rec". When the operator is deployed via the OLM, the security context constraints (scc) are bound to a specific service account name (i.e., "rec"). The workaround is to name the cluster "rec".

### REC clusters fail to start on Kubernetes clusters with unsynchronized clocks (RED-47254)

When REC clusters are deployed on Kubernetes clusters with unsynchronized clocks, the REC cluster does not start correctly. The fix is to use NTP to synchronize the underlying K8s nodes.

### Deleting an OpenShift project with an REC deployed may hang (RED-47192)

When a REC cluster is deployed in a project (namespace) and has REDB resources, the
REDB resources must be deleted first before the REC can be deleted. As such, until the
REDB resources are deleted, the project deletion will hang. The fix is to delete the
REDB resources first and the REC second. Afterwards, you may delete the project.

### REC extraLabels are not applied to PVCs on K8s versions 1.15 or older (RED-51921)

In K8s 1.15 or older, the PVC labels come from the match selectors and not the
PVC templates. As such, these versions can not support PVC labels. If this feature
is required, the only fix is to upgrade the K8s cluster to a newer version.

### Hashicorp Vault integration - no support for Gesher (RED-55080)

There is no workaround at this time

### REC might report error states on initial startup (RED-61707)

There is no workaround at this time except to ignore the errors.

### PVC size issues when using decimal value in spec (RED-62132)

The workaround for this issue is to make sure you use integer values for the PVC size.

## Compatibility Notes

See [Supported Kubernetes distributions]({{< relref "/kubernetes/reference/supported_k8s_distributions.md" >}}) for the full list of supported distributions.


### No longer supported

* kOps K8s versions 1.16 and 1.17 (previously deprecated) are no longer supported
* AKS K8s version 1.18 (previously deprecated) is no longer supported
* GKE K8s version 1.18 (previously deprecated) is no longer supported
* VMWare TKGI version 1.7 (K8s 1.16) (previously deprecated) is no longer supported
* VMWare TKGI version 1.8 (K8s 1.17) (previously deprecated) is no longer supported

## Deprecation notice

* Rancher version 2.4 support is deprecated