You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2026/08/07 01:36:41 UTC
(superset) branch master updated: feat(docs): add documentation for usage of minio or other s3 compatible service as a cache backend or celery results backend (#35825)
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new 448eb25d764 feat(docs): add documentation for usage of minio or other s3 compatible service as a cache backend or celery results backend (#35825)
448eb25d764 is described below
commit 448eb25d76421094e387c5d518b4f1eb62927950
Author: Grégoire Gailly <59...@users.noreply.github.com>
AuthorDate: Fri Aug 7 03:36:34 2026 +0200
feat(docs): add documentation for usage of minio or other s3 compatible service as a cache backend or celery results backend (#35825)
Co-authored-by: Claude Opus 4.8 <no...@anthropic.com>
---
docs/admin_docs/configuration/async-queries-celery.mdx | 10 ++++++++--
docs/admin_docs/configuration/cache.mdx | 6 +++---
2 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/docs/admin_docs/configuration/async-queries-celery.mdx b/docs/admin_docs/configuration/async-queries-celery.mdx
index 5c960f89433..020a34acfd2 100644
--- a/docs/admin_docs/configuration/async-queries-celery.mdx
+++ b/docs/admin_docs/configuration/async-queries-celery.mdx
@@ -54,8 +54,8 @@ celery --app=superset.tasks.celery_app:app beat
To setup a result backend, you need to pass an instance of a derivative of `BaseCache` (`from
flask_caching.backends.base import BaseCache`) to the RESULTS_BACKEND configuration key in your
-superset_config.py. You can use Memcached, Redis, S3 (https://pypi.python.org/pypi/s3werkzeugcache),
-memory or the file system (in a single server-type setup or for testing), or to write your own
+superset_config.py. You can use Memcached, Redis, S3, MinIO, memory
+or the file system (in a single server-type setup or for testing), or to write your own
caching interface. Your `superset_config.py` may look something like:
```python
@@ -89,6 +89,12 @@ issues arise. Please clear your existing results cache store when upgrading an e
- SQL Lab will _only run your queries asynchronously if_ you enable **Asynchronous Query Execution**
in your database settings (Sources > Databases > Edit record).
+- In order to use dedicated results backend, additional python libraries must be installed. These libraries can be installed using pip.
+ - [redis-py](https://pypi.org/project/redis/) for Redis.
+ - [pylibmc](https://pypi.org/project/pylibmc/) for memcached
+ - [s3werkzeugcache](https://pypi.python.org/pypi/s3werkzeugcache) for S3
+ - [minio-flask-cache](https://github.com/greggailly/minio-flask-cache) for MinIO or other S3 compatible service
+
## Celery Flower
Flower is a web based tool for monitoring the Celery cluster which you can install from pip:
diff --git a/docs/admin_docs/configuration/cache.mdx b/docs/admin_docs/configuration/cache.mdx
index cc44426850b..2383226907b 100644
--- a/docs/admin_docs/configuration/cache.mdx
+++ b/docs/admin_docs/configuration/cache.mdx
@@ -15,9 +15,8 @@ fail-fast behavior ensures operators are immediately aware of infrastructure iss
Superset uses [Flask-Caching](https://flask-caching.readthedocs.io/) for caching purposes.
Flask-Caching supports various caching backends, including Redis (recommended), Memcached,
-SimpleCache (in-memory), or the local filesystem.
-[Custom cache backends](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends)
-are also supported.
+SimpleCache (in-memory), MinIO/S3, or the local filesystem.
+[Custom cache backends](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends) are also supported.
Caching can be configured by providing dictionaries in
`superset_config.py` that comply with [the Flask-Caching config specifications](https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching).
@@ -47,6 +46,7 @@ In order to use dedicated cache stores, additional python libraries must be inst
- For Redis: we recommend the [redis](https://pypi.python.org/pypi/redis) Python package
- Memcached: we recommend using [pylibmc](https://pypi.org/project/pylibmc/) client library as
`python-memcached` does not handle storing binary data correctly.
+- MinIO (S3): we recommend using the [minio-flask-cache](https://github.com/greggailly/minio-flask-cache) package
These libraries can be installed using pip.