diff --git a/CHANGELOG.md b/CHANGELOG.md index 931d70d47b2..b54e0a6e0e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ * `cortex_alertmanager_state_replication_failed_total` * `cortex_alertmanager_alerts` * `cortex_alertmanager_silences` +* [CHANGE] Cache: Deprecate experimental support for Redis as a cache backend. #9453 * [FEATURE] Querier: add experimental streaming PromQL engine, enabled with `-querier.query-engine=mimir`. #9367 #9368 #9398 #9399 #9403 #9417 #9418 #9419 #9420 * [FEATURE] Query-frontend: added experimental configuration options `query-frontend.cache-errors` and `query-frontend.results-cache-ttl-for-errors` to allow non-transient responses to be cached. When set to `true` error responses from hitting limits or bad data are cached for a short TTL. #9028 * [FEATURE] gRPC: Support S2 compression. #9322 diff --git a/cmd/mimir/config-descriptor.json b/cmd/mimir/config-descriptor.json index a7ff4d8a459..290791a6685 100644 --- a/cmd/mimir/config-descriptor.json +++ b/cmd/mimir/config-descriptor.json @@ -5978,7 +5978,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.endpoint", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -5988,7 +5989,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.username", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -5998,7 +6000,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.password", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6008,7 +6011,8 @@ "fieldValue": null, "fieldDefaultValue": 0, "fieldFlag": "query-frontend.results-cache.redis.db", - "fieldType": "int" + "fieldType": "int", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6019,7 +6023,7 @@ "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.master-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6030,7 +6034,7 @@ "fieldDefaultValue": 5000000000, "fieldFlag": "query-frontend.results-cache.redis.dial-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6041,7 +6045,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "query-frontend.results-cache.redis.read-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6052,7 +6056,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "query-frontend.results-cache.redis.write-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6063,7 +6067,7 @@ "fieldDefaultValue": 100, "fieldFlag": "query-frontend.results-cache.redis.connection-pool-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6074,7 +6078,7 @@ "fieldDefaultValue": 4000000000, "fieldFlag": "query-frontend.results-cache.redis.connection-pool-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6085,7 +6089,7 @@ "fieldDefaultValue": 10, "fieldFlag": "query-frontend.results-cache.redis.min-idle-connections", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6096,7 +6100,7 @@ "fieldDefaultValue": 300000000000, "fieldFlag": "query-frontend.results-cache.redis.idle-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6107,7 +6111,7 @@ "fieldDefaultValue": 0, "fieldFlag": "query-frontend.results-cache.redis.max-connection-age", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6118,7 +6122,7 @@ "fieldDefaultValue": 16777216, "fieldFlag": "query-frontend.results-cache.redis.max-item-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6129,7 +6133,7 @@ "fieldDefaultValue": 50, "fieldFlag": "query-frontend.results-cache.redis.max-async-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6140,7 +6144,7 @@ "fieldDefaultValue": 25000, "fieldFlag": "query-frontend.results-cache.redis.max-async-buffer-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6151,7 +6155,7 @@ "fieldDefaultValue": 100, "fieldFlag": "query-frontend.results-cache.redis.max-get-multi-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6162,7 +6166,7 @@ "fieldDefaultValue": 100, "fieldFlag": "query-frontend.results-cache.redis.max-get-multi-batch-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6173,7 +6177,7 @@ "fieldDefaultValue": false, "fieldFlag": "query-frontend.results-cache.redis.tls-enabled", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6184,7 +6188,7 @@ "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.tls-cert-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6195,7 +6199,7 @@ "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.tls-key-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6206,7 +6210,7 @@ "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.tls-ca-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6217,7 +6221,7 @@ "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.tls-server-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6228,7 +6232,7 @@ "fieldDefaultValue": false, "fieldFlag": "query-frontend.results-cache.redis.tls-insecure-skip-verify", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6239,7 +6243,7 @@ "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.tls-cipher-suites", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -6250,7 +6254,7 @@ "fieldDefaultValue": "", "fieldFlag": "query-frontend.results-cache.redis.tls-min-version", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" } ], "fieldValue": null, @@ -7734,7 +7738,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.endpoint", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7744,7 +7749,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.username", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7754,7 +7760,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.password", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7764,7 +7771,8 @@ "fieldValue": null, "fieldDefaultValue": 0, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.db", - "fieldType": "int" + "fieldType": "int", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7775,7 +7783,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.master-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7786,7 +7794,7 @@ "fieldDefaultValue": 5000000000, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.dial-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7797,7 +7805,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.read-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7808,7 +7816,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.write-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7819,7 +7827,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.connection-pool-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7830,7 +7838,7 @@ "fieldDefaultValue": 4000000000, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.connection-pool-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7841,7 +7849,7 @@ "fieldDefaultValue": 10, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.min-idle-connections", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7852,7 +7860,7 @@ "fieldDefaultValue": 300000000000, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.idle-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7863,7 +7871,7 @@ "fieldDefaultValue": 0, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.max-connection-age", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7874,7 +7882,7 @@ "fieldDefaultValue": 16777216, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.max-item-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7885,7 +7893,7 @@ "fieldDefaultValue": 50, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.max-async-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7896,7 +7904,7 @@ "fieldDefaultValue": 25000, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.max-async-buffer-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7907,7 +7915,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.max-get-multi-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7918,7 +7926,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.max-get-multi-batch-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7929,7 +7937,7 @@ "fieldDefaultValue": false, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-enabled", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7940,7 +7948,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-cert-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7951,7 +7959,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-key-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7962,7 +7970,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-ca-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7973,7 +7981,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-server-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7984,7 +7992,7 @@ "fieldDefaultValue": false, "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-insecure-skip-verify", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -7995,7 +8003,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-cipher-suites", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8006,7 +8014,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.index-cache.redis.tls-min-version", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" } ], "fieldValue": null, @@ -8293,7 +8301,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.endpoint", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8303,7 +8312,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.username", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8313,7 +8323,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.password", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8323,7 +8334,8 @@ "fieldValue": null, "fieldDefaultValue": 0, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.db", - "fieldType": "int" + "fieldType": "int", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8334,7 +8346,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.master-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8345,7 +8357,7 @@ "fieldDefaultValue": 5000000000, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.dial-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8356,7 +8368,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.read-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8367,7 +8379,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.write-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8378,7 +8390,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.connection-pool-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8389,7 +8401,7 @@ "fieldDefaultValue": 4000000000, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.connection-pool-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8400,7 +8412,7 @@ "fieldDefaultValue": 10, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.min-idle-connections", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8411,7 +8423,7 @@ "fieldDefaultValue": 300000000000, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.idle-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8422,7 +8434,7 @@ "fieldDefaultValue": 0, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.max-connection-age", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8433,7 +8445,7 @@ "fieldDefaultValue": 16777216, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.max-item-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8444,7 +8456,7 @@ "fieldDefaultValue": 50, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.max-async-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8455,7 +8467,7 @@ "fieldDefaultValue": 25000, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.max-async-buffer-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8466,7 +8478,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.max-get-multi-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8477,7 +8489,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.max-get-multi-batch-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8488,7 +8500,7 @@ "fieldDefaultValue": false, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-enabled", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8499,7 +8511,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-cert-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8510,7 +8522,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-key-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8521,7 +8533,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-ca-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8532,7 +8544,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-server-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8543,7 +8555,7 @@ "fieldDefaultValue": false, "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-insecure-skip-verify", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8554,7 +8566,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-cipher-suites", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8565,7 +8577,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.chunks-cache.redis.tls-min-version", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" } ], "fieldValue": null, @@ -8876,7 +8888,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.endpoint", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8886,7 +8899,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.username", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8896,7 +8910,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.password", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8906,7 +8921,8 @@ "fieldValue": null, "fieldDefaultValue": 0, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.db", - "fieldType": "int" + "fieldType": "int", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8917,7 +8933,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.master-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8928,7 +8944,7 @@ "fieldDefaultValue": 5000000000, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.dial-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8939,7 +8955,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.read-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8950,7 +8966,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.write-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8961,7 +8977,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.connection-pool-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8972,7 +8988,7 @@ "fieldDefaultValue": 4000000000, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.connection-pool-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8983,7 +8999,7 @@ "fieldDefaultValue": 10, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.min-idle-connections", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -8994,7 +9010,7 @@ "fieldDefaultValue": 300000000000, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.idle-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9005,7 +9021,7 @@ "fieldDefaultValue": 0, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.max-connection-age", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9016,7 +9032,7 @@ "fieldDefaultValue": 16777216, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.max-item-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9027,7 +9043,7 @@ "fieldDefaultValue": 50, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.max-async-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9038,7 +9054,7 @@ "fieldDefaultValue": 25000, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.max-async-buffer-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9049,7 +9065,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.max-get-multi-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9060,7 +9076,7 @@ "fieldDefaultValue": 100, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.max-get-multi-batch-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9071,7 +9087,7 @@ "fieldDefaultValue": false, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-enabled", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9082,7 +9098,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-cert-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9093,7 +9109,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-key-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9104,7 +9120,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-ca-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9115,7 +9131,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-server-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9126,7 +9142,7 @@ "fieldDefaultValue": false, "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-insecure-skip-verify", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9137,7 +9153,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-cipher-suites", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -9148,7 +9164,7 @@ "fieldDefaultValue": "", "fieldFlag": "blocks-storage.bucket-store.metadata-cache.redis.tls-min-version", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" } ], "fieldValue": null, @@ -13739,7 +13755,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.endpoint", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13749,7 +13766,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.username", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13759,7 +13777,8 @@ "fieldValue": null, "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.password", - "fieldType": "string" + "fieldType": "string", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13769,7 +13788,8 @@ "fieldValue": null, "fieldDefaultValue": 0, "fieldFlag": "ruler-storage.cache.redis.db", - "fieldType": "int" + "fieldType": "int", + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13780,7 +13800,7 @@ "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.master-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13791,7 +13811,7 @@ "fieldDefaultValue": 5000000000, "fieldFlag": "ruler-storage.cache.redis.dial-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13802,7 +13822,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "ruler-storage.cache.redis.read-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13813,7 +13833,7 @@ "fieldDefaultValue": 3000000000, "fieldFlag": "ruler-storage.cache.redis.write-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13824,7 +13844,7 @@ "fieldDefaultValue": 100, "fieldFlag": "ruler-storage.cache.redis.connection-pool-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13835,7 +13855,7 @@ "fieldDefaultValue": 4000000000, "fieldFlag": "ruler-storage.cache.redis.connection-pool-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13846,7 +13866,7 @@ "fieldDefaultValue": 10, "fieldFlag": "ruler-storage.cache.redis.min-idle-connections", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13857,7 +13877,7 @@ "fieldDefaultValue": 300000000000, "fieldFlag": "ruler-storage.cache.redis.idle-timeout", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13868,7 +13888,7 @@ "fieldDefaultValue": 0, "fieldFlag": "ruler-storage.cache.redis.max-connection-age", "fieldType": "duration", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13879,7 +13899,7 @@ "fieldDefaultValue": 16777216, "fieldFlag": "ruler-storage.cache.redis.max-item-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13890,7 +13910,7 @@ "fieldDefaultValue": 50, "fieldFlag": "ruler-storage.cache.redis.max-async-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13901,7 +13921,7 @@ "fieldDefaultValue": 25000, "fieldFlag": "ruler-storage.cache.redis.max-async-buffer-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13912,7 +13932,7 @@ "fieldDefaultValue": 100, "fieldFlag": "ruler-storage.cache.redis.max-get-multi-concurrency", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13923,7 +13943,7 @@ "fieldDefaultValue": 100, "fieldFlag": "ruler-storage.cache.redis.max-get-multi-batch-size", "fieldType": "int", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13934,7 +13954,7 @@ "fieldDefaultValue": false, "fieldFlag": "ruler-storage.cache.redis.tls-enabled", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13945,7 +13965,7 @@ "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.tls-cert-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13956,7 +13976,7 @@ "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.tls-key-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13967,7 +13987,7 @@ "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.tls-ca-path", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13978,7 +13998,7 @@ "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.tls-server-name", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -13989,7 +14009,7 @@ "fieldDefaultValue": false, "fieldFlag": "ruler-storage.cache.redis.tls-insecure-skip-verify", "fieldType": "boolean", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -14000,7 +14020,7 @@ "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.tls-cipher-suites", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" }, { "kind": "field", @@ -14011,7 +14031,7 @@ "fieldDefaultValue": "", "fieldFlag": "ruler-storage.cache.redis.tls-min-version", "fieldType": "string", - "fieldCategory": "advanced" + "fieldCategory": "deprecated" } ], "fieldValue": null, diff --git a/cmd/mimir/help-all.txt.tmpl b/cmd/mimir/help-all.txt.tmpl index 5dc7e93cca9..65098986151 100644 --- a/cmd/mimir/help-all.txt.tmpl +++ b/cmd/mimir/help-all.txt.tmpl @@ -390,57 +390,57 @@ Usage of ./cmd/mimir/mimir: -blocks-storage.bucket-store.chunks-cache.memcached.write-buffer-size-bytes int [experimental] The size of the write buffer (in bytes). The buffer is allocated for each connection to memcached. (default 4096) -blocks-storage.bucket-store.chunks-cache.redis.connection-pool-size int - Maximum number of connections in the pool. (default 100) + [deprecated] Maximum number of connections in the pool. (default 100) -blocks-storage.bucket-store.chunks-cache.redis.connection-pool-timeout duration - Maximum duration to wait to get a connection from pool. (default 4s) + [deprecated] Maximum duration to wait to get a connection from pool. (default 4s) -blocks-storage.bucket-store.chunks-cache.redis.db int - Database index. + [deprecated] Database index. -blocks-storage.bucket-store.chunks-cache.redis.dial-timeout duration - Client dial timeout. (default 5s) + [deprecated] Client dial timeout. (default 5s) -blocks-storage.bucket-store.chunks-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. + [deprecated] Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. -blocks-storage.bucket-store.chunks-cache.redis.idle-timeout duration - Amount of time after which client closes idle connections. (default 5m0s) + [deprecated] Amount of time after which client closes idle connections. (default 5m0s) -blocks-storage.bucket-store.chunks-cache.redis.master-name string - Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. + [deprecated] Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. -blocks-storage.bucket-store.chunks-cache.redis.max-async-buffer-size int - The maximum number of enqueued asynchronous operations allowed. (default 25000) + [deprecated] The maximum number of enqueued asynchronous operations allowed. (default 25000) -blocks-storage.bucket-store.chunks-cache.redis.max-async-concurrency int - The maximum number of concurrent asynchronous operations can occur. (default 50) + [deprecated] The maximum number of concurrent asynchronous operations can occur. (default 50) -blocks-storage.bucket-store.chunks-cache.redis.max-connection-age duration - Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. + [deprecated] Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. -blocks-storage.bucket-store.chunks-cache.redis.max-get-multi-batch-size int - The maximum size per batch for mget operations. (default 100) + [deprecated] The maximum size per batch for mget operations. (default 100) -blocks-storage.bucket-store.chunks-cache.redis.max-get-multi-concurrency int - The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) + [deprecated] The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) -blocks-storage.bucket-store.chunks-cache.redis.max-item-size int - The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) + [deprecated] The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) -blocks-storage.bucket-store.chunks-cache.redis.min-idle-connections int - Minimum number of idle connections. (default 10) + [deprecated] Minimum number of idle connections. (default 10) -blocks-storage.bucket-store.chunks-cache.redis.password string - Password to use when connecting to Redis. + [deprecated] Password to use when connecting to Redis. -blocks-storage.bucket-store.chunks-cache.redis.read-timeout duration - Client read timeout. (default 3s) + [deprecated] Client read timeout. (default 3s) -blocks-storage.bucket-store.chunks-cache.redis.tls-ca-path string - Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. + [deprecated] Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. -blocks-storage.bucket-store.chunks-cache.redis.tls-cert-path string - Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. + [deprecated] Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. -blocks-storage.bucket-store.chunks-cache.redis.tls-cipher-suites string - Override the default cipher suite list (separated by commas). + [deprecated] Override the default cipher suite list (separated by commas). -blocks-storage.bucket-store.chunks-cache.redis.tls-enabled - Enable connecting to Redis with TLS. + [deprecated] Enable connecting to Redis with TLS. -blocks-storage.bucket-store.chunks-cache.redis.tls-insecure-skip-verify - Skip validating server certificate. + [deprecated] Skip validating server certificate. -blocks-storage.bucket-store.chunks-cache.redis.tls-key-path string - Path to the key for the client certificate. Also requires the client certificate to be configured. + [deprecated] Path to the key for the client certificate. Also requires the client certificate to be configured. -blocks-storage.bucket-store.chunks-cache.redis.tls-min-version string - Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 + [deprecated] Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 -blocks-storage.bucket-store.chunks-cache.redis.tls-server-name string - Override the expected name on the server certificate. + [deprecated] Override the expected name on the server certificate. -blocks-storage.bucket-store.chunks-cache.redis.username string - Username to use when connecting to Redis. + [deprecated] Username to use when connecting to Redis. -blocks-storage.bucket-store.chunks-cache.redis.write-timeout duration - Client write timeout. (default 3s) + [deprecated] Client write timeout. (default 3s) -blocks-storage.bucket-store.chunks-cache.subrange-ttl duration TTL for caching individual chunks subranges. (default 24h0m0s) -blocks-storage.bucket-store.ignore-blocks-within duration @@ -494,57 +494,57 @@ Usage of ./cmd/mimir/mimir: -blocks-storage.bucket-store.index-cache.memcached.write-buffer-size-bytes int [experimental] The size of the write buffer (in bytes). The buffer is allocated for each connection to memcached. (default 4096) -blocks-storage.bucket-store.index-cache.redis.connection-pool-size int - Maximum number of connections in the pool. (default 100) + [deprecated] Maximum number of connections in the pool. (default 100) -blocks-storage.bucket-store.index-cache.redis.connection-pool-timeout duration - Maximum duration to wait to get a connection from pool. (default 4s) + [deprecated] Maximum duration to wait to get a connection from pool. (default 4s) -blocks-storage.bucket-store.index-cache.redis.db int - Database index. + [deprecated] Database index. -blocks-storage.bucket-store.index-cache.redis.dial-timeout duration - Client dial timeout. (default 5s) + [deprecated] Client dial timeout. (default 5s) -blocks-storage.bucket-store.index-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. + [deprecated] Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. -blocks-storage.bucket-store.index-cache.redis.idle-timeout duration - Amount of time after which client closes idle connections. (default 5m0s) + [deprecated] Amount of time after which client closes idle connections. (default 5m0s) -blocks-storage.bucket-store.index-cache.redis.master-name string - Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. + [deprecated] Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. -blocks-storage.bucket-store.index-cache.redis.max-async-buffer-size int - The maximum number of enqueued asynchronous operations allowed. (default 25000) + [deprecated] The maximum number of enqueued asynchronous operations allowed. (default 25000) -blocks-storage.bucket-store.index-cache.redis.max-async-concurrency int - The maximum number of concurrent asynchronous operations can occur. (default 50) + [deprecated] The maximum number of concurrent asynchronous operations can occur. (default 50) -blocks-storage.bucket-store.index-cache.redis.max-connection-age duration - Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. + [deprecated] Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. -blocks-storage.bucket-store.index-cache.redis.max-get-multi-batch-size int - The maximum size per batch for mget operations. (default 100) + [deprecated] The maximum size per batch for mget operations. (default 100) -blocks-storage.bucket-store.index-cache.redis.max-get-multi-concurrency int - The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) + [deprecated] The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) -blocks-storage.bucket-store.index-cache.redis.max-item-size int - The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) + [deprecated] The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) -blocks-storage.bucket-store.index-cache.redis.min-idle-connections int - Minimum number of idle connections. (default 10) + [deprecated] Minimum number of idle connections. (default 10) -blocks-storage.bucket-store.index-cache.redis.password string - Password to use when connecting to Redis. + [deprecated] Password to use when connecting to Redis. -blocks-storage.bucket-store.index-cache.redis.read-timeout duration - Client read timeout. (default 3s) + [deprecated] Client read timeout. (default 3s) -blocks-storage.bucket-store.index-cache.redis.tls-ca-path string - Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. + [deprecated] Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. -blocks-storage.bucket-store.index-cache.redis.tls-cert-path string - Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. + [deprecated] Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. -blocks-storage.bucket-store.index-cache.redis.tls-cipher-suites string - Override the default cipher suite list (separated by commas). + [deprecated] Override the default cipher suite list (separated by commas). -blocks-storage.bucket-store.index-cache.redis.tls-enabled - Enable connecting to Redis with TLS. + [deprecated] Enable connecting to Redis with TLS. -blocks-storage.bucket-store.index-cache.redis.tls-insecure-skip-verify - Skip validating server certificate. + [deprecated] Skip validating server certificate. -blocks-storage.bucket-store.index-cache.redis.tls-key-path string - Path to the key for the client certificate. Also requires the client certificate to be configured. + [deprecated] Path to the key for the client certificate. Also requires the client certificate to be configured. -blocks-storage.bucket-store.index-cache.redis.tls-min-version string - Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 + [deprecated] Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 -blocks-storage.bucket-store.index-cache.redis.tls-server-name string - Override the expected name on the server certificate. + [deprecated] Override the expected name on the server certificate. -blocks-storage.bucket-store.index-cache.redis.username string - Username to use when connecting to Redis. + [deprecated] Username to use when connecting to Redis. -blocks-storage.bucket-store.index-cache.redis.write-timeout duration - Client write timeout. (default 3s) + [deprecated] Client write timeout. (default 3s) -blocks-storage.bucket-store.index-header.eager-loading-startup-enabled [experimental] If enabled, store-gateway will periodically persist block IDs of lazy loaded index-headers and load them eagerly during startup. Ignored if index-header lazy loading is disabled. (default true) -blocks-storage.bucket-store.index-header.lazy-loading-concurrency int @@ -626,57 +626,57 @@ Usage of ./cmd/mimir/mimir: -blocks-storage.bucket-store.metadata-cache.metafile-max-size-bytes int Maximum size of metafile content to cache in bytes. Caching will be skipped if the content exceeds this size. This is useful to avoid network round trip for large content if the configured caching backend has an hard limit on cached items size (in this case, you should set this limit to the same limit in the caching backend). (default 1048576) -blocks-storage.bucket-store.metadata-cache.redis.connection-pool-size int - Maximum number of connections in the pool. (default 100) + [deprecated] Maximum number of connections in the pool. (default 100) -blocks-storage.bucket-store.metadata-cache.redis.connection-pool-timeout duration - Maximum duration to wait to get a connection from pool. (default 4s) + [deprecated] Maximum duration to wait to get a connection from pool. (default 4s) -blocks-storage.bucket-store.metadata-cache.redis.db int - Database index. + [deprecated] Database index. -blocks-storage.bucket-store.metadata-cache.redis.dial-timeout duration - Client dial timeout. (default 5s) + [deprecated] Client dial timeout. (default 5s) -blocks-storage.bucket-store.metadata-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. + [deprecated] Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. -blocks-storage.bucket-store.metadata-cache.redis.idle-timeout duration - Amount of time after which client closes idle connections. (default 5m0s) + [deprecated] Amount of time after which client closes idle connections. (default 5m0s) -blocks-storage.bucket-store.metadata-cache.redis.master-name string - Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. + [deprecated] Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. -blocks-storage.bucket-store.metadata-cache.redis.max-async-buffer-size int - The maximum number of enqueued asynchronous operations allowed. (default 25000) + [deprecated] The maximum number of enqueued asynchronous operations allowed. (default 25000) -blocks-storage.bucket-store.metadata-cache.redis.max-async-concurrency int - The maximum number of concurrent asynchronous operations can occur. (default 50) + [deprecated] The maximum number of concurrent asynchronous operations can occur. (default 50) -blocks-storage.bucket-store.metadata-cache.redis.max-connection-age duration - Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. + [deprecated] Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. -blocks-storage.bucket-store.metadata-cache.redis.max-get-multi-batch-size int - The maximum size per batch for mget operations. (default 100) + [deprecated] The maximum size per batch for mget operations. (default 100) -blocks-storage.bucket-store.metadata-cache.redis.max-get-multi-concurrency int - The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) + [deprecated] The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) -blocks-storage.bucket-store.metadata-cache.redis.max-item-size int - The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) + [deprecated] The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) -blocks-storage.bucket-store.metadata-cache.redis.min-idle-connections int - Minimum number of idle connections. (default 10) + [deprecated] Minimum number of idle connections. (default 10) -blocks-storage.bucket-store.metadata-cache.redis.password string - Password to use when connecting to Redis. + [deprecated] Password to use when connecting to Redis. -blocks-storage.bucket-store.metadata-cache.redis.read-timeout duration - Client read timeout. (default 3s) + [deprecated] Client read timeout. (default 3s) -blocks-storage.bucket-store.metadata-cache.redis.tls-ca-path string - Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. + [deprecated] Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. -blocks-storage.bucket-store.metadata-cache.redis.tls-cert-path string - Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. + [deprecated] Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. -blocks-storage.bucket-store.metadata-cache.redis.tls-cipher-suites string - Override the default cipher suite list (separated by commas). + [deprecated] Override the default cipher suite list (separated by commas). -blocks-storage.bucket-store.metadata-cache.redis.tls-enabled - Enable connecting to Redis with TLS. + [deprecated] Enable connecting to Redis with TLS. -blocks-storage.bucket-store.metadata-cache.redis.tls-insecure-skip-verify - Skip validating server certificate. + [deprecated] Skip validating server certificate. -blocks-storage.bucket-store.metadata-cache.redis.tls-key-path string - Path to the key for the client certificate. Also requires the client certificate to be configured. + [deprecated] Path to the key for the client certificate. Also requires the client certificate to be configured. -blocks-storage.bucket-store.metadata-cache.redis.tls-min-version string - Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 + [deprecated] Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 -blocks-storage.bucket-store.metadata-cache.redis.tls-server-name string - Override the expected name on the server certificate. + [deprecated] Override the expected name on the server certificate. -blocks-storage.bucket-store.metadata-cache.redis.username string - Username to use when connecting to Redis. + [deprecated] Username to use when connecting to Redis. -blocks-storage.bucket-store.metadata-cache.redis.write-timeout duration - Client write timeout. (default 3s) + [deprecated] Client write timeout. (default 3s) -blocks-storage.bucket-store.metadata-cache.tenant-blocks-list-ttl duration How long to cache list of blocks for each tenant. (default 5m0s) -blocks-storage.bucket-store.metadata-cache.tenants-list-ttl duration @@ -2164,57 +2164,57 @@ Usage of ./cmd/mimir/mimir: -query-frontend.results-cache.memcached.write-buffer-size-bytes int [experimental] The size of the write buffer (in bytes). The buffer is allocated for each connection to memcached. (default 4096) -query-frontend.results-cache.redis.connection-pool-size int - Maximum number of connections in the pool. (default 100) + [deprecated] Maximum number of connections in the pool. (default 100) -query-frontend.results-cache.redis.connection-pool-timeout duration - Maximum duration to wait to get a connection from pool. (default 4s) + [deprecated] Maximum duration to wait to get a connection from pool. (default 4s) -query-frontend.results-cache.redis.db int - Database index. + [deprecated] Database index. -query-frontend.results-cache.redis.dial-timeout duration - Client dial timeout. (default 5s) + [deprecated] Client dial timeout. (default 5s) -query-frontend.results-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. + [deprecated] Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. -query-frontend.results-cache.redis.idle-timeout duration - Amount of time after which client closes idle connections. (default 5m0s) + [deprecated] Amount of time after which client closes idle connections. (default 5m0s) -query-frontend.results-cache.redis.master-name string - Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. + [deprecated] Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. -query-frontend.results-cache.redis.max-async-buffer-size int - The maximum number of enqueued asynchronous operations allowed. (default 25000) + [deprecated] The maximum number of enqueued asynchronous operations allowed. (default 25000) -query-frontend.results-cache.redis.max-async-concurrency int - The maximum number of concurrent asynchronous operations can occur. (default 50) + [deprecated] The maximum number of concurrent asynchronous operations can occur. (default 50) -query-frontend.results-cache.redis.max-connection-age duration - Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. + [deprecated] Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. -query-frontend.results-cache.redis.max-get-multi-batch-size int - The maximum size per batch for mget operations. (default 100) + [deprecated] The maximum size per batch for mget operations. (default 100) -query-frontend.results-cache.redis.max-get-multi-concurrency int - The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) + [deprecated] The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) -query-frontend.results-cache.redis.max-item-size int - The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) + [deprecated] The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) -query-frontend.results-cache.redis.min-idle-connections int - Minimum number of idle connections. (default 10) + [deprecated] Minimum number of idle connections. (default 10) -query-frontend.results-cache.redis.password string - Password to use when connecting to Redis. + [deprecated] Password to use when connecting to Redis. -query-frontend.results-cache.redis.read-timeout duration - Client read timeout. (default 3s) + [deprecated] Client read timeout. (default 3s) -query-frontend.results-cache.redis.tls-ca-path string - Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. + [deprecated] Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. -query-frontend.results-cache.redis.tls-cert-path string - Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. + [deprecated] Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. -query-frontend.results-cache.redis.tls-cipher-suites string - Override the default cipher suite list (separated by commas). + [deprecated] Override the default cipher suite list (separated by commas). -query-frontend.results-cache.redis.tls-enabled - Enable connecting to Redis with TLS. + [deprecated] Enable connecting to Redis with TLS. -query-frontend.results-cache.redis.tls-insecure-skip-verify - Skip validating server certificate. + [deprecated] Skip validating server certificate. -query-frontend.results-cache.redis.tls-key-path string - Path to the key for the client certificate. Also requires the client certificate to be configured. + [deprecated] Path to the key for the client certificate. Also requires the client certificate to be configured. -query-frontend.results-cache.redis.tls-min-version string - Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 + [deprecated] Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 -query-frontend.results-cache.redis.tls-server-name string - Override the expected name on the server certificate. + [deprecated] Override the expected name on the server certificate. -query-frontend.results-cache.redis.username string - Username to use when connecting to Redis. + [deprecated] Username to use when connecting to Redis. -query-frontend.results-cache.redis.write-timeout duration - Client write timeout. (default 3s) + [deprecated] Client write timeout. (default 3s) -query-frontend.scheduler-address string Address of the query-scheduler component, in host:port format. The host should resolve to all query-scheduler instances. This option should be set only when query-scheduler component is in use and -query-scheduler.service-discovery-mode is set to 'dns'. -query-frontend.scheduler-dns-lookup-period duration @@ -2408,57 +2408,57 @@ Usage of ./cmd/mimir/mimir: -ruler-storage.cache.memcached.write-buffer-size-bytes int [experimental] The size of the write buffer (in bytes). The buffer is allocated for each connection to memcached. (default 4096) -ruler-storage.cache.redis.connection-pool-size int - Maximum number of connections in the pool. (default 100) + [deprecated] Maximum number of connections in the pool. (default 100) -ruler-storage.cache.redis.connection-pool-timeout duration - Maximum duration to wait to get a connection from pool. (default 4s) + [deprecated] Maximum duration to wait to get a connection from pool. (default 4s) -ruler-storage.cache.redis.db int - Database index. + [deprecated] Database index. -ruler-storage.cache.redis.dial-timeout duration - Client dial timeout. (default 5s) + [deprecated] Client dial timeout. (default 5s) -ruler-storage.cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. + [deprecated] Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. -ruler-storage.cache.redis.idle-timeout duration - Amount of time after which client closes idle connections. (default 5m0s) + [deprecated] Amount of time after which client closes idle connections. (default 5m0s) -ruler-storage.cache.redis.master-name string - Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. + [deprecated] Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. -ruler-storage.cache.redis.max-async-buffer-size int - The maximum number of enqueued asynchronous operations allowed. (default 25000) + [deprecated] The maximum number of enqueued asynchronous operations allowed. (default 25000) -ruler-storage.cache.redis.max-async-concurrency int - The maximum number of concurrent asynchronous operations can occur. (default 50) + [deprecated] The maximum number of concurrent asynchronous operations can occur. (default 50) -ruler-storage.cache.redis.max-connection-age duration - Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. + [deprecated] Close connections older than this duration. If the value is zero, then the pool does not close connections based on age. -ruler-storage.cache.redis.max-get-multi-batch-size int - The maximum size per batch for mget operations. (default 100) + [deprecated] The maximum size per batch for mget operations. (default 100) -ruler-storage.cache.redis.max-get-multi-concurrency int - The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) + [deprecated] The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited. (default 100) -ruler-storage.cache.redis.max-item-size int - The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) + [deprecated] The maximum size of an item stored in Redis. Bigger items are not stored. If set to 0, no maximum size is enforced. (default 16777216) -ruler-storage.cache.redis.min-idle-connections int - Minimum number of idle connections. (default 10) + [deprecated] Minimum number of idle connections. (default 10) -ruler-storage.cache.redis.password string - Password to use when connecting to Redis. + [deprecated] Password to use when connecting to Redis. -ruler-storage.cache.redis.read-timeout duration - Client read timeout. (default 3s) + [deprecated] Client read timeout. (default 3s) -ruler-storage.cache.redis.tls-ca-path string - Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. + [deprecated] Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used. -ruler-storage.cache.redis.tls-cert-path string - Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. + [deprecated] Path to the client certificate, which will be used for authenticating with the server. Also requires the key path to be configured. -ruler-storage.cache.redis.tls-cipher-suites string - Override the default cipher suite list (separated by commas). + [deprecated] Override the default cipher suite list (separated by commas). -ruler-storage.cache.redis.tls-enabled - Enable connecting to Redis with TLS. + [deprecated] Enable connecting to Redis with TLS. -ruler-storage.cache.redis.tls-insecure-skip-verify - Skip validating server certificate. + [deprecated] Skip validating server certificate. -ruler-storage.cache.redis.tls-key-path string - Path to the key for the client certificate. Also requires the client certificate to be configured. + [deprecated] Path to the key for the client certificate. Also requires the client certificate to be configured. -ruler-storage.cache.redis.tls-min-version string - Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 + [deprecated] Override the default minimum TLS version. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 -ruler-storage.cache.redis.tls-server-name string - Override the expected name on the server certificate. + [deprecated] Override the expected name on the server certificate. -ruler-storage.cache.redis.username string - Username to use when connecting to Redis. + [deprecated] Username to use when connecting to Redis. -ruler-storage.cache.redis.write-timeout duration - Client write timeout. (default 3s) + [deprecated] Client write timeout. (default 3s) -ruler-storage.filesystem.dir string Local filesystem storage directory. (default "ruler") -ruler-storage.gcs.bucket-name string diff --git a/cmd/mimir/help.txt.tmpl b/cmd/mimir/help.txt.tmpl index e1e5df266bc..d3274551e7b 100644 --- a/cmd/mimir/help.txt.tmpl +++ b/cmd/mimir/help.txt.tmpl @@ -143,14 +143,6 @@ Usage of ./cmd/mimir/mimir: The connection timeout. (default 200ms) -blocks-storage.bucket-store.chunks-cache.memcached.timeout duration The socket read/write timeout. (default 200ms) - -blocks-storage.bucket-store.chunks-cache.redis.db int - Database index. - -blocks-storage.bucket-store.chunks-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. - -blocks-storage.bucket-store.chunks-cache.redis.password string - Password to use when connecting to Redis. - -blocks-storage.bucket-store.chunks-cache.redis.username string - Username to use when connecting to Redis. -blocks-storage.bucket-store.index-cache.backend string The index cache backend type. Supported values: inmemory, memcached, redis. (default "inmemory") -blocks-storage.bucket-store.index-cache.inmemory.max-size-bytes uint @@ -161,14 +153,6 @@ Usage of ./cmd/mimir/mimir: The connection timeout. (default 200ms) -blocks-storage.bucket-store.index-cache.memcached.timeout duration The socket read/write timeout. (default 200ms) - -blocks-storage.bucket-store.index-cache.redis.db int - Database index. - -blocks-storage.bucket-store.index-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. - -blocks-storage.bucket-store.index-cache.redis.password string - Password to use when connecting to Redis. - -blocks-storage.bucket-store.index-cache.redis.username string - Username to use when connecting to Redis. -blocks-storage.bucket-store.metadata-cache.backend string Backend for metadata cache, if not empty. Supported values: memcached, redis. -blocks-storage.bucket-store.metadata-cache.memcached.addresses comma-separated-list-of-strings @@ -177,14 +161,6 @@ Usage of ./cmd/mimir/mimir: The connection timeout. (default 200ms) -blocks-storage.bucket-store.metadata-cache.memcached.timeout duration The socket read/write timeout. (default 200ms) - -blocks-storage.bucket-store.metadata-cache.redis.db int - Database index. - -blocks-storage.bucket-store.metadata-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. - -blocks-storage.bucket-store.metadata-cache.redis.password string - Password to use when connecting to Redis. - -blocks-storage.bucket-store.metadata-cache.redis.username string - Username to use when connecting to Redis. -blocks-storage.bucket-store.sync-dir string Directory to store synchronized TSDB index headers. This directory is not required to be persisted between restarts, but it's highly recommended in order to improve the store-gateway startup time. (default "./tsdb-sync/") -blocks-storage.filesystem.dir string @@ -599,14 +575,6 @@ Usage of ./cmd/mimir/mimir: The connection timeout. (default 200ms) -query-frontend.results-cache.memcached.timeout duration The socket read/write timeout. (default 200ms) - -query-frontend.results-cache.redis.db int - Database index. - -query-frontend.results-cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. - -query-frontend.results-cache.redis.password string - Password to use when connecting to Redis. - -query-frontend.results-cache.redis.username string - Username to use when connecting to Redis. -query-frontend.scheduler-address string Address of the query-scheduler component, in host:port format. The host should resolve to all query-scheduler instances. This option should be set only when query-scheduler component is in use and -query-scheduler.service-discovery-mode is set to 'dns'. -query-scheduler.max-outstanding-requests-per-tenant int @@ -645,14 +613,6 @@ Usage of ./cmd/mimir/mimir: The connection timeout. (default 200ms) -ruler-storage.cache.memcached.timeout duration The socket read/write timeout. (default 200ms) - -ruler-storage.cache.redis.db int - Database index. - -ruler-storage.cache.redis.endpoint comma-separated-list-of-strings - Redis Server or Cluster configuration endpoint to use for caching. A comma-separated list of endpoints for Redis Cluster or Redis Sentinel. - -ruler-storage.cache.redis.password string - Password to use when connecting to Redis. - -ruler-storage.cache.redis.username string - Username to use when connecting to Redis. -ruler-storage.filesystem.dir string Local filesystem storage directory. (default "ruler") -ruler-storage.gcs.bucket-name string diff --git a/docs/sources/mimir/configure/configuration-parameters/index.md b/docs/sources/mimir/configure/configuration-parameters/index.md index 6631bbc7cb8..58726a8a9f1 100644 --- a/docs/sources/mimir/configure/configuration-parameters/index.md +++ b/docs/sources/mimir/configure/configuration-parameters/index.md @@ -4837,111 +4837,113 @@ The `redis` block configures the Redis-based caching backend. The supported CLI   ```yaml -# Redis Server or Cluster configuration endpoint to use for caching. A -# comma-separated list of endpoints for Redis Cluster or Redis Sentinel. +# (deprecated) Redis Server or Cluster configuration endpoint to use for +# caching. A comma-separated list of endpoints for Redis Cluster or Redis +# Sentinel. # CLI flag: -.redis.endpoint [endpoint: | default = ""] -# Username to use when connecting to Redis. +# (deprecated) Username to use when connecting to Redis. # CLI flag: -.redis.username [username: | default = ""] -# Password to use when connecting to Redis. +# (deprecated) Password to use when connecting to Redis. # CLI flag: -.redis.password [password: | default = ""] -# Database index. +# (deprecated) Database index. # CLI flag: -.redis.db [db: | default = 0] -# (advanced) Redis Sentinel master name. An empty string for Redis Server or +# (deprecated) Redis Sentinel master name. An empty string for Redis Server or # Redis Cluster. # CLI flag: -.redis.master-name [master_name: | default = ""] -# (advanced) Client dial timeout. +# (deprecated) Client dial timeout. # CLI flag: -.redis.dial-timeout [dial_timeout: | default = 5s] -# (advanced) Client read timeout. +# (deprecated) Client read timeout. # CLI flag: -.redis.read-timeout [read_timeout: | default = 3s] -# (advanced) Client write timeout. +# (deprecated) Client write timeout. # CLI flag: -.redis.write-timeout [write_timeout: | default = 3s] -# (advanced) Maximum number of connections in the pool. +# (deprecated) Maximum number of connections in the pool. # CLI flag: -.redis.connection-pool-size [connection_pool_size: | default = 100] -# (advanced) Maximum duration to wait to get a connection from pool. +# (deprecated) Maximum duration to wait to get a connection from pool. # CLI flag: -.redis.connection-pool-timeout [connection_pool_timeout: | default = 4s] -# (advanced) Minimum number of idle connections. +# (deprecated) Minimum number of idle connections. # CLI flag: -.redis.min-idle-connections [min_idle_connections: | default = 10] -# (advanced) Amount of time after which client closes idle connections. +# (deprecated) Amount of time after which client closes idle connections. # CLI flag: -.redis.idle-timeout [idle_timeout: | default = 5m] -# (advanced) Close connections older than this duration. If the value is zero, +# (deprecated) Close connections older than this duration. If the value is zero, # then the pool does not close connections based on age. # CLI flag: -.redis.max-connection-age [max_connection_age: | default = 0s] -# (advanced) The maximum size of an item stored in Redis. Bigger items are not +# (deprecated) The maximum size of an item stored in Redis. Bigger items are not # stored. If set to 0, no maximum size is enforced. # CLI flag: -.redis.max-item-size [max_item_size: | default = 16777216] -# (advanced) The maximum number of concurrent asynchronous operations can occur. +# (deprecated) The maximum number of concurrent asynchronous operations can +# occur. # CLI flag: -.redis.max-async-concurrency [max_async_concurrency: | default = 50] -# (advanced) The maximum number of enqueued asynchronous operations allowed. +# (deprecated) The maximum number of enqueued asynchronous operations allowed. # CLI flag: -.redis.max-async-buffer-size [max_async_buffer_size: | default = 25000] -# (advanced) The maximum number of concurrent connections running get +# (deprecated) The maximum number of concurrent connections running get # operations. If set to 0, concurrency is unlimited. # CLI flag: -.redis.max-get-multi-concurrency [max_get_multi_concurrency: | default = 100] -# (advanced) The maximum size per batch for mget operations. +# (deprecated) The maximum size per batch for mget operations. # CLI flag: -.redis.max-get-multi-batch-size [max_get_multi_batch_size: | default = 100] -# (advanced) Enable connecting to Redis with TLS. +# (deprecated) Enable connecting to Redis with TLS. # CLI flag: -.redis.tls-enabled [tls_enabled: | default = false] -# (advanced) Path to the client certificate, which will be used for +# (deprecated) Path to the client certificate, which will be used for # authenticating with the server. Also requires the key path to be configured. # CLI flag: -.redis.tls-cert-path [tls_cert_path: | default = ""] -# (advanced) Path to the key for the client certificate. Also requires the +# (deprecated) Path to the key for the client certificate. Also requires the # client certificate to be configured. # CLI flag: -.redis.tls-key-path [tls_key_path: | default = ""] -# (advanced) Path to the CA certificates to validate server certificate against. -# If not set, the host's root CA certificates are used. +# (deprecated) Path to the CA certificates to validate server certificate +# against. If not set, the host's root CA certificates are used. # CLI flag: -.redis.tls-ca-path [tls_ca_path: | default = ""] -# (advanced) Override the expected name on the server certificate. +# (deprecated) Override the expected name on the server certificate. # CLI flag: -.redis.tls-server-name [tls_server_name: | default = ""] -# (advanced) Skip validating server certificate. +# (deprecated) Skip validating server certificate. # CLI flag: -.redis.tls-insecure-skip-verify [tls_insecure_skip_verify: | default = false] -# (advanced) Override the default cipher suite list (separated by commas). +# (deprecated) Override the default cipher suite list (separated by commas). # Allowed values: # # Secure Ciphers: @@ -4975,7 +4977,7 @@ The `redis` block configures the Redis-based caching backend. The supported CLI # CLI flag: -.redis.tls-cipher-suites [tls_cipher_suites: | default = ""] -# (advanced) Override the default minimum TLS version. Allowed values: +# (deprecated) Override the default minimum TLS version. Allowed values: # VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 # CLI flag: -.redis.tls-min-version [tls_min_version: | default = ""] diff --git a/pkg/util/configdoc/fieldcategory.go b/pkg/util/configdoc/fieldcategory.go index d3f9eb83fca..d30f2073ffd 100644 --- a/pkg/util/configdoc/fieldcategory.go +++ b/pkg/util/configdoc/fieldcategory.go @@ -71,6 +71,143 @@ var categoryOverrides = map[string]Category{ "server.log-request-at-info-level-enabled": Advanced, "server.proxy-protocol-enabled": Experimental, + // Defined in grafana/dskit/cache.RedisClientConfig. Deprecated in 2.14 and + // scheduled to be removed in a future release. + "blocks-storage.bucket-store.chunks-cache.redis.endpoint": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.username": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.password": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.db": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.master-name": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.dial-timeout": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.read-timeout": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.write-timeout": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.connection-pool-size": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.connection-pool-timeout": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.min-idle-connections": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.idle-timeout": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.max-connection-age": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.max-item-size": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.max-async-concurrency": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.max-async-buffer-size": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.max-get-multi-concurrency": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.max-get-multi-batch-size": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-enabled": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-cert-path": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-key-path": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-ca-path": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-server-name": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-insecure-skip-verify": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-cipher-suites": Deprecated, + "blocks-storage.bucket-store.chunks-cache.redis.tls-min-version": Deprecated, + + "blocks-storage.bucket-store.index-cache.redis.endpoint": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.username": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.password": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.db": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.master-name": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.dial-timeout": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.read-timeout": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.write-timeout": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.connection-pool-size": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.connection-pool-timeout": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.min-idle-connections": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.idle-timeout": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.max-connection-age": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.max-item-size": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.max-async-concurrency": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.max-async-buffer-size": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.max-get-multi-concurrency": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.max-get-multi-batch-size": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-enabled": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-cert-path": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-key-path": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-ca-path": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-server-name": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-insecure-skip-verify": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-cipher-suites": Deprecated, + "blocks-storage.bucket-store.index-cache.redis.tls-min-version": Deprecated, + + "blocks-storage.bucket-store.metadata-cache.redis.endpoint": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.username": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.password": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.db": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.master-name": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.dial-timeout": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.read-timeout": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.write-timeout": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.connection-pool-size": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.connection-pool-timeout": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.min-idle-connections": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.idle-timeout": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.max-connection-age": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.max-item-size": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.max-async-concurrency": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.max-async-buffer-size": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.max-get-multi-concurrency": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.max-get-multi-batch-size": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-enabled": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-cert-path": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-key-path": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-ca-path": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-server-name": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-insecure-skip-verify": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-cipher-suites": Deprecated, + "blocks-storage.bucket-store.metadata-cache.redis.tls-min-version": Deprecated, + + "query-frontend.results-cache.redis.endpoint": Deprecated, + "query-frontend.results-cache.redis.username": Deprecated, + "query-frontend.results-cache.redis.password": Deprecated, + "query-frontend.results-cache.redis.db": Deprecated, + "query-frontend.results-cache.redis.master-name": Deprecated, + "query-frontend.results-cache.redis.dial-timeout": Deprecated, + "query-frontend.results-cache.redis.read-timeout": Deprecated, + "query-frontend.results-cache.redis.write-timeout": Deprecated, + "query-frontend.results-cache.redis.connection-pool-size": Deprecated, + "query-frontend.results-cache.redis.connection-pool-timeout": Deprecated, + "query-frontend.results-cache.redis.min-idle-connections": Deprecated, + "query-frontend.results-cache.redis.idle-timeout": Deprecated, + "query-frontend.results-cache.redis.max-connection-age": Deprecated, + "query-frontend.results-cache.redis.max-item-size": Deprecated, + "query-frontend.results-cache.redis.max-async-concurrency": Deprecated, + "query-frontend.results-cache.redis.max-async-buffer-size": Deprecated, + "query-frontend.results-cache.redis.max-get-multi-concurrency": Deprecated, + "query-frontend.results-cache.redis.max-get-multi-batch-size": Deprecated, + "query-frontend.results-cache.redis.tls-enabled": Deprecated, + "query-frontend.results-cache.redis.tls-cert-path": Deprecated, + "query-frontend.results-cache.redis.tls-key-path": Deprecated, + "query-frontend.results-cache.redis.tls-ca-path": Deprecated, + "query-frontend.results-cache.redis.tls-server-name": Deprecated, + "query-frontend.results-cache.redis.tls-insecure-skip-verify": Deprecated, + "query-frontend.results-cache.redis.tls-cipher-suites": Deprecated, + "query-frontend.results-cache.redis.tls-min-version": Deprecated, + + "ruler-storage.cache.redis.endpoint": Deprecated, + "ruler-storage.cache.redis.username": Deprecated, + "ruler-storage.cache.redis.password": Deprecated, + "ruler-storage.cache.redis.db": Deprecated, + "ruler-storage.cache.redis.master-name": Deprecated, + "ruler-storage.cache.redis.dial-timeout": Deprecated, + "ruler-storage.cache.redis.read-timeout": Deprecated, + "ruler-storage.cache.redis.write-timeout": Deprecated, + "ruler-storage.cache.redis.connection-pool-size": Deprecated, + "ruler-storage.cache.redis.connection-pool-timeout": Deprecated, + "ruler-storage.cache.redis.min-idle-connections": Deprecated, + "ruler-storage.cache.redis.idle-timeout": Deprecated, + "ruler-storage.cache.redis.max-connection-age": Deprecated, + "ruler-storage.cache.redis.max-item-size": Deprecated, + "ruler-storage.cache.redis.max-async-concurrency": Deprecated, + "ruler-storage.cache.redis.max-async-buffer-size": Deprecated, + "ruler-storage.cache.redis.max-get-multi-concurrency": Deprecated, + "ruler-storage.cache.redis.max-get-multi-batch-size": Deprecated, + "ruler-storage.cache.redis.tls-enabled": Deprecated, + "ruler-storage.cache.redis.tls-cert-path": Deprecated, + "ruler-storage.cache.redis.tls-key-path": Deprecated, + "ruler-storage.cache.redis.tls-ca-path": Deprecated, + "ruler-storage.cache.redis.tls-server-name": Deprecated, + "ruler-storage.cache.redis.tls-insecure-skip-verify": Deprecated, + "ruler-storage.cache.redis.tls-cipher-suites": Deprecated, + "ruler-storage.cache.redis.tls-min-version": Deprecated, + // main.go global flags "config.file": Basic, "config.expand-env": Basic,