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.

Sign up for GitHub

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

Jump to bottom

docs: deprecate redis-based caching #9441

Merged
merged 9 commits into from
Sep 27, 2024
Merged

docs: deprecate redis-based caching #9441

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7896354
docs: deprecate redis-based caching
tacole02 Sep 26, 2024
66e28ec
docs: deprecate redis-based caching
tacole02 Sep 26, 2024
8e44f47
docs: deprecate redis-based caching
tacole02 Sep 26, 2024
9468dda
docs: deprecate redis-based caching
tacole02 Sep 26, 2024
51cecc7
make doc output
tacole02 Sep 27, 2024
c381be8
docs: replaces admonition
tacole02 Sep 27, 2024
965bb5a
docs: reformats deprecation admonition
tacole02 Sep 27, 2024
ebc9945
test commit
tacole02 Sep 27, 2024
5248ca8
make doc again
tacole02 Sep 27, 2024
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
4 changes: 1 addition & 3 deletions docs/sources/mimir/configure/about-versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,6 @@ The following features are currently experimental:
- `-ingester.read-circuit-breaker.initial-delay`
- `-ingester.read-circuit-breaker.request-timeout`
- Querier
- Use of Redis cache backend (`-blocks-storage.bucket-store.metadata-cache.backend=redis`)
- Limiting queries based on the estimated number of chunks that will be used (`-querier.max-estimated-fetched-chunks-per-query-multiplier`)
- Max concurrency for tenant federated queries (`-tenant-federation.max-concurrent`)
- Maximum response size for active series queries (`-querier.active-series-results-max-size-bytes`)
Expand All @@ -157,15 +156,13 @@ The following features are currently experimental:
- `-query-frontend.querier-forget-delay`
- Instant query splitting (`-query-frontend.split-instant-queries-by-interval`)
- Lower TTL for cache entries overlapping the out-of-order samples ingestion window (re-using `-ingester.out-of-order-window` from ingesters)
- Use of Redis cache backend (`-query-frontend.results-cache.backend=redis`)
- Query blocking on a per-tenant basis (configured with the limit `blocked_queries`)
- Sharding of active series queries (`-query-frontend.shard-active-series-queries`)
- Server-side write timeout for responses to active series requests (`-query-frontend.active-series-write-timeout`)
- Caching of non-transient error responses (`-query-frontend.cache-errors`, `-query-frontend.results-cache-ttl-for-errors`)
- Query-scheduler
- `-query-scheduler.querier-forget-delay`
- Store-gateway
- Use of Redis cache backend (`-blocks-storage.bucket-store.chunks-cache.backend=redis`, `-blocks-storage.bucket-store.index-cache.backend=redis`, `-blocks-storage.bucket-store.metadata-cache.backend=redis`)
- Eagerly loading some blocks on startup even when lazy loading is enabled `-blocks-storage.bucket-store.index-header.eager-loading-startup-enabled`
- Read-write deployment mode
- API endpoints:
Expand Down Expand Up @@ -212,3 +209,4 @@ The following features or configuration parameters are currently deprecated and

- Rule group configuration file
- `evaluation_delay` field: use `query_offset` instead
- Support for Redis-based caching
4 changes: 4 additions & 0 deletions docs/sources/mimir/configure/configuration-parameters/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4825,6 +4825,10 @@ The `memcached` block configures the Memcached-based caching backend. The suppor
```

### redis
{{< admonition type="caution" >}}
Starting with Mimir 2.14, Redis-based caching is deprecated.
It will be removed in a future release.
{{< /admonition >}}
Copy link
Contributor

@narqo narqo Sep 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update discussed with @56quarters, and it seems that we don't plan to touch anything in the code. Deprecating with only mentioning it in the release notes, and the docs, works for me. We can do that in 2.14 👍

2.14 is planned to be release in 1+ week, with the rc.0 today. I'm not sure, I would rush in marking everything about redis in the code in the release branch as deprecated to support this statement. Can we deprecate it in 2.15?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want to deprecated it in 2.14 to give people as much time to migrate as possible.


The `redis` block configures the Redis-based caching backend. The supported CLI flags `<prefix>` used to reference this configuration block are:

Expand Down
Loading