Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/en/functions/10-create-instance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ sourceSHA: f9bfcbdca6540fe5c33b1d774fbf710c3808a2b3c37f3beb9c252bd5845b999e

# Create Instance

Following Redis versions are fully supported: `5.0`, `6.0`, `7.2`; other versions are not supported by default.
Following Redis versions are fully supported: `6.0`, `7.2`, `8.4`; other versions are not supported by default.

<Directive type="tip" title="Version suggestion">
When used in a production environment, it is recommended to prioritize the `7.2` version, followed by `6.0`.
When used in a production environment, it is recommended to prioritize the `7.2` or `8.4` version, followed by `6.0`.

1. `7.2` is a version still maintained by the community, which fixes known issues in `6.0` and `5.0`. The `6.0` and `5.0` versions are no longer maintained by the community.
2. `7.2` is fully compatible with `6.0` and `5.0`.
3. `7.2` has further improved the ACL features.
4. `5.0` is not recommended for use as it does not support advanced features like ACL and lacks user management capabilities; all business processes will share a single password, presenting potential security risks; also, changing the password requires restarting all nodes.
1. `7.2` and `8.4` are still maintained by the community and fix known issues in `6.0`. The `6.0` version is no longer maintained by the community.
2. `7.2` and `8.4` are fully compatible with `6.0`.
3. `7.2` and `8.4` have further improved the ACL features.
</Directive>

<Directive type="note" title="Architecture suggestion">
Expand Down Expand Up @@ -241,12 +240,12 @@ After the instance is created, you can use the following command to check the st
```bash
$ kubectl -n default get redis
NAME ARCH VERSION ACCESS STATUS MESSAGE BUNDLE VERSION AUTOUPGRADE AGE
c5 cluster 5.0 NodePort Ready 4.0.1 2m46s
c6 cluster 6.0 Initializing 4.0.1 3m26s
c7 cluster 7.2 NodePort Initializing 4.0.1 98s
s5 sentinel 5.0 Ready 4.0.1 3m10s
c8 cluster 8.4 NodePort Ready 4.0.1 2m46s
s6 sentinel 6.0 Ready 4.0.1 25m
s7 sentinel 7.2 NodePort Ready 4.0.1 2m15s
s8 sentinel 8.4 Ready 4.0.1 3m10s
standalone standalone 6.0 Initializing 4.0.1 6s
```

Expand All @@ -256,7 +255,7 @@ The meanings of the output table fields are as follows:
| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| NAME | Instance name |
| ARCH | This value corresponds to the architecture of Redis. <ul><li>`cluster`: Cluster mode</li><li> `sentinel`: Sentinel mode </li><li>`standalone`: Single-node Redis</li></ul> This field indicates whether this CR resource manages a standalone, Sentinel, or Cluster mode of Redis. |
| VERSION | Currently supports only the 3 versions: `5.0`, `6.0`, `7.2` |
| VERSION | Currently supports only the 3 versions: `6.0`, `7.2`, `8.4` |
| ACCESS | The access methods supported by the instance. <ul><li>` `: The instance provides services via ClusterIP</li><li>`NodePort`: The instance provides services via NodePort</li><li>`LoadBalancer`: The instance provides services via LoadBalancer</li></ul> |
| STATUS | The current status of the instance, which may include the following states: <ul><li>`Initializing`: The instance is initializing or updating</li><li>`Rebalancing`: The cluster instance is scaling up or down</li><li>`Error`: The instance has encountered a non-recoverable error</li><li>`Paused`: The instance has been manually paused</li><li>`Ready`: The instance is ready</li></ul> |
| MESSAGE | The reason for the instance being in its current status |
Expand Down
38 changes: 1 addition & 37 deletions docs/en/functions/20-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceSHA: 598b38348adf2636d3464b37b2c05a0b9f6c876de00fa7783b93d1e6dc4a67df
Implementing proper authentication and access control is essential for securing your Redis environment. This section covers password management and role-based access control configuration for Redis instances.

<Directive type="info" title="Version Compatibility Note">
Redis 5.0 supports only basic password authentication with a single credential set, while Redis 6.0 and later versions implement a comprehensive Access Control List (ACL) system that supports multiple users with granular permissions. Redis 6.0+ maintains the default user for backward compatibility with legacy clients.
Redis 6.0 and later versions implement a comprehensive Access Control List (ACL) system that supports multiple users with granular permissions. Redis 6.0+ maintains the default user for backward compatibility with legacy clients.
</Directive>

## View Users
Expand Down Expand Up @@ -67,10 +67,6 @@ The following procedures allow you to update user passwords for enhanced securit

<Tabs>
<Tab label="CLI">
<Directive type="info" title="Version Compatibility">
The following operations apply only to Redis 6.0 or later versions. For Redis 5.0, refer to the "Redis 5.0 CLI" tab.
</Directive>

1. Identify the target user from the RedisUser list.

For this example, we'll update the password for the `default` user of instance `s6`.
Expand Down Expand Up @@ -172,38 +168,6 @@ The following procedures allow you to update user passwords for enhanced securit
After updating the password, the RedisUser resource will temporarily enter the `Pending` state while the change propagates to all Redis nodes. Once synchronized, the status will return to `Success`.
</Tab>

<Tab label="Redis 5.0 CLI">
Redis 5.0 does not support the ACL system and therefore does not use RedisUser resources. Instead, the password is managed through the `spec.passwordSecret` field in the Redis CR (see [Redis API Documentation](../apis/kubernetes_apis/redis/redis)).

<Directive type="warning" title="Service Impact Warning">
Updating the password for a Redis 5.0 instance requires a complete instance restart, which may cause service interruption. Schedule this operation during maintenance windows or periods of low traffic.
</Directive>

1. Create a Secret containing the new password:

```bash
$ kubectl -n default create secret generic new-redis-password --from-literal=password=admin@123456
```

2. Update the Redis CR to reference the new Secret:

```bash
$ kubectl -n default patch redis s5 --type=merge --patch='{"spec": {"passwordSecret": "new-redis-password"}}'
```

3. Monitor the instance status during the update process:

```bash
$ kubectl -n default get redis -w
NAME ARCH VERSION ACCESS STATUS MESSAGE BUNDLE VERSION AUTOUPGRADE AGE
c6 cluster 6.0 Ready 4.0.1 false 125m
s5 sentinel 5.0 Initializing 4.0.1 false 8h
s6 sentinel 6.0 Ready 4.0.1 false 124m
```

The instance will transition to `Ready` status once the password change is complete.
</Tab>

<Tab label="Web Console">
1. In the **User Management** tab, select the target user and click the expand button to view user details.
2. Click **Reset Password** in the action menu.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/functions/30-parameter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sourceSHA: 308585571db88077bffd035151f6160f84c24c6ffd00a0ffdcf91d9a017b364b

When creating a Redis instance, the system's default parameter template is applied.

Alauda Application Services provides specialized parameter templates for each Redis version (three templates for version 6.0+ and two for version 5.0) to accommodate different operational requirements.
Alauda Application Services provides specialized parameter templates for each Redis version (three templates for version 6.0 and later) to accommodate different operational requirements.

| Parameter Template | Description | Considerations |
| :---------------- | :---------- | :------------- |
Expand Down
6 changes: 6 additions & 0 deletions docs/en/how_to/30-upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Redis patch version upgrades provide security fixes and stability improvements.

When patch versions become available, prompt adoption is advised to ensure your Redis instances benefit from the latest security patches and feature enhancements.

<Directive type="warning" title="Upgrade Redis 5.0 instances before upgrading to ACP v4.3">
Upgrading the Alauda Cache Service for Redis OSS operator does **not** automatically upgrade the Redis version of existing instances; each instance's Redis version must be upgraded explicitly.

ACP v4.3 requires Alauda Cache Service for Redis OSS v5.0.x, which no longer supports Redis `5.0`. If you are upgrading from an ACP version earlier than v4.3, upgrade every Redis `5.0` instance to a supported version (`6.0`, `7.2`, or `8.4`) and confirm that no Redis `5.0` instances remain **before** upgrading ACP to v4.3. See [Upgrade](../upgrade.mdx) for the operator and ACP upgrade flow.
</Directive>

## Configure Upgrade Strategy

You can define how patch upgrades are applied to your Redis instances by configuring the upgrade policy.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ title: Introduction
| Cluster | Massive Data/Horizontal Scaling |

2. **Version Support**
- Redis `5.0`, `6.0`, `7.2`.
- Redis `6.0`, `7.2`, `8.4`.

3. **Access Control and Security**
- Supports TLS encryption.
- Integrates **Redis ACL** (Access Control List), supporting fine-grained user permission management (this feature is not supported in Redis 5.0).
- Integrates **Redis ACL** (Access Control List), supporting fine-grained user permission management.

4. **Network and Access Methods**
- Supports service expose type of **NodePort** and **LoadBalancer**, with the ability to specify NodePort ports.
Expand Down
22 changes: 16 additions & 6 deletions docs/en/lifecycle_policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,28 @@ title: Lifecycle Policy

Below is the lifecycle schedule for released versions of the Alauda Cache Service for Redis OSS:

| Version | Release Date | End of Support |
|:--------|:-------------|:---------------|
| v4.1.x | 2025-08-22 | 2027-08-30 |
| Version | Release Date | End of Full Support | End of Maintenance |
|:--------|:-------------|:--------------------|:-------------------|
| v5.0.x | 2026-04-28 | 2027-04-30 | 2028-04-30 |
| v4.1.x | 2025-08-22 | 2026-08-30 | 2027-08-30 |

## Release Policy

* A new patch version of Alauda Cache Service for Redis OSS is released as needed to address bugs and security vulnerabilities.
* Minor version releases are driven by significant updates to the underlying Redis server, the implementation of new features, or emerging security requirements.
* A new patch version of Alauda Cache Service for Redis OSS is released as needed to address bugs and security vulnerabilities. Patch releases do not introduce new features.
* Minor and major version releases are driven by significant updates to the underlying Redis server, the implementation of new features, or emerging security requirements.

## Support Phases

Each minor version progresses through two support phases over its lifecycle:

* **Full Support (Year 1)**: From the release date until the end of full support. The version receives all bug fixes and security patches via patch releases on the same minor line.
* **Maintenance (Year 2)**: From the end of full support until the end of maintenance. The version receives only critical bug fixes and security patches; non-critical fixes are not backported.

After the end of maintenance, the version is no longer supported. Customers should plan to upgrade to a supported version before this date.

## Maintenance Policy

During a version's maintenance period, Alauda provides the following services:
During a version's supported lifecycle, Alauda provides the following services:

* **Upstream Patching**: We actively track official Redis patch releases and promptly deliver critical bug fixes and security vulnerability patches.
* **Security Updates**: We release security updates for the service operator on-demand to address vulnerabilities and ensure stability.
Expand Down
47 changes: 42 additions & 5 deletions docs/en/release_notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,52 @@ i18n:
title: Release Notes
---

# Release Notes

## Compatibility and support matrix

The following table shows the compatibility and support matrix between the Alauda Cache Service for Redis OSS and ACP versions.

| Alauda Cache Service for Redis OSS Version | Redis Versions | ACP Version |
|:-------------------------------------------|------------------------|:------------|
| v4.1.0 | 5.0.14, 6.0.20, 7.2.10 | v4.1 |
| v4.0.x | 5.0.14, 6.0.20, 7.2.x | v4.0 |
| Alauda Cache Service for Redis OSS Version | Redis Versions | ACP Version |
|:-------------------------------------------|------------------------|:-----------------|
| v5.0.1 | 6.0.21, 7.2.14, 8.4.3 | v4.1, v4.2, v4.3 |
| v5.0.0 | 6.0.21, 7.2.12, 8.4.2 | v4.1, v4.2, v4.3 |
| v4.1.x | 5.0.14, 6.0.20, 7.2.10 | v4.1, v4.2 |
| v4.0.x | 5.0.14, 6.0.20, 7.2.x | v4.0 |

## v5.0.1

### Fixed Issues

{/* release-notes-for-bugs?template=mw-redis-v5.0.1-fixed&project=Middleware */}

### Known Issues

{/* release-notes-for-bugs?template=mw-redis-v5.0.1-known&project=Middleware */}

### Security Fixes

{/* release-notes-for-bugs?template=mw-redis-v5.0.1-security&project=Middleware */}

## v5.0.0

### New and Optimized Features

#### Redis 8.4 Support

Added support for Redis 8.4 (8.4.2), enabling users to provision and manage instances on the latest Redis Server release alongside the existing 6.0 and 7.2 series.

#### Expanded APIs for Redis Modules

The Alauda Cache Service for Redis OSS APIs have been expanded to support Redis modules, allowing users to configure and manage modules on Redis instances.

### Fixed Issues

{/* release-notes-for-bugs?template=mw-redis-v5.0-fixed&project=Middleware */}

### Known Issues

{/* release-notes-for-bugs?template=mw-redis-v5.0-known&project=Middleware */}

## v4.1.0

Expand Down Expand Up @@ -68,4 +106,3 @@ When using LoadBalancer, ensure that the cluster has available external address
### Known Issues

{/* release-notes-for-bugs?template=mw-redis-v4.0-known&project=Middleware */}

Loading