Skip to content

Commit

Permalink
[Doc][KubeRay]: Redis eviction suggestions when `ENABLE_GCS_FT_REDIS_…
Browse files Browse the repository at this point in the history
…CLEANUP=false` (#40949)

As discussed with @kevin85421, it would be better if we could provide a guide as well as a warning in the documentation about using Redis native eviction instead of KubeRay's Redis cleanup.

---------

Signed-off-by: Rueian <rueiancsie@gmail.com>
Co-authored-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
  • Loading branch information
rueian and architkulkarni authored Nov 17, 2023
1 parent 29dba63 commit 9a34839
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion doc/source/cluster/kubernetes/user-guides/kuberay-gcs-ft.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,21 @@ Refer to [this section](kuberay-external-storage-namespace-example) in the earli
(kuberay-redis-cleanup-gate)=
### 4. Turn off Redis cleanup

* `ENABLE_GCS_FT_REDIS_CLEANUP`: The feature gate `ENABLE_GCS_FT_REDIS_CLEANUP` is true by default, and users can turn if off by setting the environment variable in [KubeRay operator's Helm chart](https://github.com/ray-project/kuberay/blob/master/helm-chart/kuberay-operator/values.yaml).
* `ENABLE_GCS_FT_REDIS_CLEANUP`: True by default. You can turn this feature off by setting the environment variable in the [KubeRay operator's Helm chart](https://github.com/ray-project/kuberay/blob/master/helm-chart/kuberay-operator/values.yaml).

```{admonition} Key eviction setup on Redis
If you disable `ENABLE_GCS_FT_REDIS_CLEANUP` but want Redis to remove GCS metadata automatically,
set these two options in your `redis.conf` or in the command line options of your redis-server command [(example)](https://github.com/ray-project/ray/pull/40949#issuecomment-1799057691):

* `maxmemory=<your_memory_limit>`
* `maxmemory-policy=allkeys-lru`

These two options instruct Redis to delete the least recently used keys when it reaches the `maxmemory` limit.
See [Key eviction](https://redis.io/docs/reference/eviction/) from Redis for more information.

Note that Redis does this eviction and it doesn't guarantee that
Ray won't use the deleted keys.
```

## Next steps

Expand Down

0 comments on commit 9a34839

Please sign in to comment.