feat: add S3 chunk delimiter config to support MinIO running on Windows (#16319)

Signed-off-by: Notedop <raoul2405@hotmail.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: Ashwanth <iamashwanth@gmail.com>

Author: 3 people

docs/sources/shared/configuration.md

@@ -5111,6 +5111,12 @@ The `s3_storage_config` block configures the connection to Amazon S3 object stor
 # CLI flag: -<prefix>.s3.insecure
 [insecure: <boolean> | default = false]
 
+# Delimiter used to replace the default delimiter ':' in chunk IDs when storing
+# chunks. This is mainly intended when you run a MinIO instance on a Windows
+# machine. You should not change this value inflight.
+# CLI flag: -<prefix>.s3.chunk-delimiter
+[chunk_delimiter: <string> | default = ""]
+
 http_config:
   # Timeout specifies a time limit for requests made by s3 Client.
   # CLI flag: -<prefix>.s3.http.timeout

pkg/loki/config_wrapper_test.go

@@ -274,6 +274,7 @@ memberlist:
       secret_access_key: def789
       insecure: true
       disable_dualstack: true
+      chunk_delimiter: "-"
       http_config:
         response_header_timeout: 5m`
 
@@ -299,6 +300,7 @@ memberlist:
 				assert.Equal(t, "", actual.SessionToken.String())
 				assert.Equal(t, true, actual.Insecure)
 				assert.True(t, actual.DisableDualstack)
+				assert.Equal(t, "-", actual.ChunkDelimiter)
 				assert.Equal(t, 5*time.Minute, actual.HTTPConfig.ResponseHeaderTimeout)
 				assert.Equal(t, false, actual.HTTPConfig.InsecureSkipVerify)
 
@@ -364,6 +366,7 @@ memberlist:
 				assert.Equal(t, "456abc", actual.SessionToken.String())
 				assert.Equal(t, true, actual.Insecure)
 				assert.False(t, actual.DisableDualstack)
+				assert.Equal(t, "", actual.ChunkDelimiter)
 				assert.Equal(t, 5*time.Minute, actual.HTTPConfig.ResponseHeaderTimeout)
 				assert.Equal(t, false, actual.HTTPConfig.InsecureSkipVerify)
 

pkg/storage/chunk/client/aws/s3_storage_client.go

@@ -76,6 +76,7 @@ type S3Config struct {
 	SecretAccessKey  flagext.Secret      `yaml:"secret_access_key"`
 	SessionToken     flagext.Secret      `yaml:"session_token"`
 	Insecure         bool                `yaml:"insecure"`
+	ChunkDelimiter   string              `yaml:"chunk_delimiter"`
 	HTTPConfig       HTTPConfig          `yaml:"http_config"`
 	SignatureVersion string              `yaml:"signature_version"`
 	StorageClass     string              `yaml:"storage_class"`
@@ -113,6 +114,7 @@ func (cfg *S3Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
 	f.Var(&cfg.SecretAccessKey, prefix+"s3.secret-access-key", "AWS Secret Access Key")
 	f.Var(&cfg.SessionToken, prefix+"s3.session-token", "AWS Session Token")
 	f.BoolVar(&cfg.Insecure, prefix+"s3.insecure", false, "Disable https on s3 connection.")
+	f.StringVar(&cfg.ChunkDelimiter, prefix+"s3.chunk-delimiter", "", "Delimiter used to replace the default delimiter ':' in chunk IDs when storing chunks. This is mainly intended when you run a MinIO instance on a Windows machine. You should not change this value inflight.")
 	f.BoolVar(&cfg.DisableDualstack, prefix+"s3.disable-dualstack", false, "Disable forcing S3 dualstack endpoint usage.")
 
 	cfg.SSEConfig.RegisterFlagsWithPrefix(prefix+"s3.sse.", f)
@@ -335,7 +337,7 @@ func (a *S3ObjectClient) objectAttributes(ctx context.Context, objectKey, method
 		lastErr = instrument.CollectedRequest(ctx, method, s3RequestDuration, instrument.ErrorCode, func(_ context.Context) error {
 			headObjectInput := &s3.HeadObjectInput{
 				Bucket: aws.String(a.bucketFromKey(objectKey)),
-				Key:    aws.String(objectKey),
+				Key:    aws.String(a.convertObjectKey(objectKey, true)),
 			}
 			headOutput, requestErr := a.S3.HeadObject(headObjectInput)
 			if requestErr != nil {
@@ -365,7 +367,7 @@ func (a *S3ObjectClient) DeleteObject(ctx context.Context, objectKey string) err
 	return instrument.CollectedRequest(ctx, "S3.DeleteObject", s3RequestDuration, instrument.ErrorCode, func(ctx context.Context) error {
 		deleteObjectInput := &s3.DeleteObjectInput{
 			Bucket: aws.String(a.bucketFromKey(objectKey)),
-			Key:    aws.String(objectKey),
+			Key:    aws.String(a.convertObjectKey(objectKey, true)),
 		}
 
 		_, err := a.S3.DeleteObjectWithContext(ctx, deleteObjectInput)
@@ -405,7 +407,7 @@ func (a *S3ObjectClient) GetObject(ctx context.Context, objectKey string) (io.Re
 			var requestErr error
 			resp, requestErr = a.hedgedS3.GetObjectWithContext(ctx, &s3.GetObjectInput{
 				Bucket: aws.String(bucket),
-				Key:    aws.String(objectKey),
+				Key:    aws.String(a.convertObjectKey(objectKey, true)),
 			})
 			return requestErr
 		})
@@ -442,7 +444,7 @@ func (a *S3ObjectClient) GetObjectRange(ctx context.Context, objectKey string, o
 			var requestErr error
 			resp, requestErr = a.hedgedS3.GetObjectWithContext(ctx, &s3.GetObjectInput{
 				Bucket: aws.String(bucket),
-				Key:    aws.String(objectKey),
+				Key:    aws.String(a.convertObjectKey(objectKey, true)),
 				Range:  aws.String(fmt.Sprintf("bytes=%d-%d", offset, offset+length-1)),
 			})
 			return requestErr
@@ -467,7 +469,7 @@ func (a *S3ObjectClient) PutObject(ctx context.Context, objectKey string, object
 		putObjectInput := &s3.PutObjectInput{
 			Body:         readSeeker,
 			Bucket:       aws.String(a.bucketFromKey(objectKey)),
-			Key:          aws.String(objectKey),
+			Key:          aws.String(a.convertObjectKey(objectKey, true)),
 			StorageClass: aws.String(a.cfg.StorageClass),
 		}
 
@@ -504,7 +506,7 @@ func (a *S3ObjectClient) List(ctx context.Context, prefix, delimiter string) ([]
 
 				for _, content := range output.Contents {
 					storageObjects = append(storageObjects, client.StorageObject{
-						Key:        *content.Key,
+						Key:        a.convertObjectKey(*content.Key, false),
 						ModifiedAt: *content.LastModified,
 					})
 				}
@@ -617,3 +619,15 @@ func IsRetryableErr(err error) bool {
 func (a *S3ObjectClient) IsRetryableErr(err error) bool {
 	return IsRetryableErr(err)
 }
+
+// convertObjectKey modifies the object key based on a delimiter and a mode flag determining conversion.
+func (a *S3ObjectClient) convertObjectKey(objectKey string, toS3 bool) string {
+	if len(a.cfg.ChunkDelimiter) == 1 {
+		if toS3 {
+			objectKey = strings.ReplaceAll(objectKey, ":", a.cfg.ChunkDelimiter)
+		} else {
+			objectKey = strings.ReplaceAll(objectKey, a.cfg.ChunkDelimiter, ":")
+		}
+	}
+	return objectKey
+}