Skip to content

Commit 14d7670

Browse files
fix(operator): fix typo in docs regarding forcepathstyle (#17725)
1 parent 0f01f07 commit 14d7670

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

operator/docs/lokistack/object_storage.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ _Note_: Upon setting up LokiStack for any object storage provider, you should co
6666
--from-literal=sse_type="SSE-S3"
6767
```
6868

69-
Additionally, you can control the S3 URL style access behavior with `force_path_style` parameter:
69+
Additionally, you can control the S3 URL style access behavior with `forcepathstyle` parameter:
7070

7171
```console
7272
kubectl create secret generic lokistack-dev-s3 \
@@ -75,14 +75,14 @@ _Note_: Upon setting up LokiStack for any object storage provider, you should co
7575
--from-literal=access_key_id="<AWS_ACCESS_KEY_ID>" \
7676
--from-literal=access_key_secret="<AWS_ACCESS_KEY_SECRET>" \
7777
--from-literal=region="<AWS_REGION_YOUR_BUCKET_LIVES_IN>" \
78-
--from-literal=force_path_style="true"
78+
--from-literal=forcepathstyle="true"
7979
```
8080

8181
By default:
82-
* AWS endpoints (ending with `.amazonaws.com`) use virtual hosted style (`force_path_style=false`)
83-
* Non-AWS endpoints use path style (`force_path_style=true`)
82+
* AWS endpoints (ending with `.amazonaws.com`) use virtual hosted style (`forcepathstyle=false`)
83+
* Non-AWS endpoints use path style (`forcepathstyle=true`)
8484

85-
Set `force_path_style` to `false` if you need to use virtual-hosted style with non-AWS S3 compatible services.
85+
Set `forcepathstyle` to `false` if you need to use virtual-hosted style with non-AWS S3 compatible services.
8686

8787
where `lokistack-dev-s3` is the secret name.
8888

operator/internal/handlers/internal/storage/secrets.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ func extractS3ConfigSecret(s *corev1.Secret, credentialMode lokiv1.CredentialMod
417417
// Determine if we should use path style URLs for S3
418418
// default to false for non-AWS endpoints
419419
forcePathStyle := !strings.HasSuffix(string(endpoint), awsEndpointSuffix)
420-
// Check if the user has specified force_path_style
420+
// Check if the user has specified forcepathstyle
421421
if configForcePathStyle, ok := s.Data[storage.KeyAWSForcePathStyle]; ok {
422422
strForcePathStyle := string(configForcePathStyle)
423423
switch strForcePathStyle {

0 commit comments

Comments
 (0)