Add bucket prefix to experimental features (#1951)

* Add bucket prefix to experimental features

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

* Update flag status of storage_prefix to experimental

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

Author: dimitarvdimitrov

CHANGELOG.md

@@ -21,7 +21,7 @@
 * [ENHANCEMENT] Store-gateway: Add the experimental ability to run requests in a dedicated OS thread pool. This feature can be configured using `-store-gateway.thread-pool-size` and is disabled by default. Replaces the ability to run index header operations in a dedicated thread pool. #1660 #1812
 * [ENHANCEMENT] Improved error messages to make them easier to understand; each now have a unique, global identifier that you can use to look up in the runbooks for more information. #1907 #1919 #1888 #1939
 * [ENHANCEMENT] Memberlist KV: incoming messages are now processed on per-key goroutine. This may reduce loss of "maintanance" packets in busy memberlist installations, but use more CPU. New `memberlist_client_received_broadcasts_dropped_total` counter tracks number of dropped per-key messages. #1912
-* [ENHANCEMENT] Blocks Storage, Alertmanager, Ruler: add support a prefix to the bucket store (`*_storage.storage_prefix`). This enables using the same bucket for the three components. #1686
+* [ENHANCEMENT] Blocks Storage, Alertmanager, Ruler: add support a prefix to the bucket store (`*_storage.storage_prefix`). This enables using the same bucket for the three components. #1686 #1951
 * [BUGFIX] Fix regexp parsing panic for regexp label matchers with start/end quantifiers. #1883
 * [BUGFIX] Ingester: fixed deceiving error log "failed to update cached shipped blocks after shipper initialisation", occurring for each new tenant in the ingester. #1893
 * [BUGFIX] Ring: fix bug where instances may appear unhealthy in the hash ring web UI even though they are not. #1933

cmd/mimir/config-descriptor.json

@@ -3795,7 +3795,7 @@
           "fieldDefaultValue": "",
           "fieldFlag": "blocks-storage.storage-prefix",
           "fieldType": "string",
-          "fieldCategory": "advanced"
+          "fieldCategory": "experimental"
         },
         {
           "kind": "block",
@@ -7588,7 +7588,7 @@
           "fieldDefaultValue": "",
           "fieldFlag": "ruler-storage.storage-prefix",
           "fieldType": "string",
-          "fieldCategory": "advanced"
+          "fieldCategory": "experimental"
         },
         {
           "kind": "block",
@@ -8906,7 +8906,7 @@
           "fieldDefaultValue": "",
           "fieldFlag": "alertmanager-storage.storage-prefix",
           "fieldType": "string",
-          "fieldCategory": "advanced"
+          "fieldCategory": "experimental"
         },
         {
           "kind": "block",

cmd/mimir/help-all.txt.tmpl

@@ -67,7 +67,7 @@ Usage of ./cmd/mimir/mimir:
   -alertmanager-storage.s3.tls-handshake-timeout duration
     	Maximum time to wait for a TLS handshake. 0 means no limit. (default 10s)
   -alertmanager-storage.storage-prefix string
-    	Prefix for all objects stored in the backend storage. For simplicity, it may only contain digits and English alphabet letters.
+    	[experimental] Prefix for all objects stored in the backend storage. For simplicity, it may only contain digits and English alphabet letters.
   -alertmanager-storage.swift.auth-url string
     	OpenStack Swift authentication URL
   -alertmanager-storage.swift.auth-version int
@@ -438,7 +438,7 @@ Usage of ./cmd/mimir/mimir:
   -blocks-storage.s3.tls-handshake-timeout duration
     	Maximum time to wait for a TLS handshake. 0 means no limit. (default 10s)
   -blocks-storage.storage-prefix string
-    	Prefix for all objects stored in the backend storage. For simplicity, it may only contain digits and English alphabet letters.
+    	[experimental] Prefix for all objects stored in the backend storage. For simplicity, it may only contain digits and English alphabet letters.
   -blocks-storage.swift.auth-url string
     	OpenStack Swift authentication URL
   -blocks-storage.swift.auth-version int
@@ -1299,7 +1299,7 @@ Usage of ./cmd/mimir/mimir:
   -ruler-storage.s3.tls-handshake-timeout duration
     	Maximum time to wait for a TLS handshake. 0 means no limit. (default 10s)
   -ruler-storage.storage-prefix string
-    	Prefix for all objects stored in the backend storage. For simplicity, it may only contain digits and English alphabet letters.
+    	[experimental] Prefix for all objects stored in the backend storage. For simplicity, it may only contain digits and English alphabet letters.
   -ruler-storage.swift.auth-url string
     	OpenStack Swift authentication URL
   -ruler-storage.swift.auth-version int

docs/sources/operators-guide/configuring/about-versioning.md

@@ -82,6 +82,10 @@ The following features are currently experimental:
   - `-query-scheduler.querier-forget-delay`
 - Store-gateway
   - `-blocks-storage.bucket-store.index-header-thread-pool-size`
+- Blocks Storage, Alertmanager, and Ruler support for partitioning access to the same storage bucket
+  - `-alertmanager-storage.storage-prefix`
+  - `-blocks-storage.storage-prefix`
+  - `-ruler-storage.storage-prefix`
 
 ## Deprecated features
 

docs/sources/operators-guide/configuring/reference-configuration-parameters/index.md

@@ -1488,7 +1488,7 @@ The `ruler_storage` block configures the ruler storage backend.
 # CLI flag: -ruler-storage.backend
 [backend: <string> | default = "filesystem"]
 
-# (advanced) Prefix for all objects stored in the backend storage. For
+# (experimental) Prefix for all objects stored in the backend storage. For
 # simplicity, it may only contain digits and English alphabet letters.
 # CLI flag: -ruler-storage.storage-prefix
 [storage_prefix: <string> | default = ""]
@@ -1938,7 +1938,7 @@ The `alertmanager_storage` block configures the alertmanager storage backend.
 # CLI flag: -alertmanager-storage.backend
 [backend: <string> | default = "filesystem"]
 
-# (advanced) Prefix for all objects stored in the backend storage. For
+# (experimental) Prefix for all objects stored in the backend storage. For
 # simplicity, it may only contain digits and English alphabet letters.
 # CLI flag: -alertmanager-storage.storage-prefix
 [storage_prefix: <string> | default = ""]
@@ -2942,7 +2942,7 @@ The `blocks_storage` block configures the blocks storage.
 # CLI flag: -blocks-storage.backend
 [backend: <string> | default = "filesystem"]
 
-# (advanced) Prefix for all objects stored in the backend storage. For
+# (experimental) Prefix for all objects stored in the backend storage. For
 # simplicity, it may only contain digits and English alphabet letters.
 # CLI flag: -blocks-storage.storage-prefix
 [storage_prefix: <string> | default = ""]

pkg/storage/bucket/client.go

@@ -56,7 +56,7 @@ var (
 // Config holds configuration for accessing long-term storage.
 type Config struct {
 	Backend       string `yaml:"backend"`
-	StoragePrefix string `yaml:"storage_prefix" category:"advanced"`
+	StoragePrefix string `yaml:"storage_prefix" category:"experimental"`
 	// Backends
 	S3         s3.Config         `yaml:"s3"`
 	GCS        gcs.Config        `yaml:"gcs"`