Skip to content

fix(operator): fix typo in docs regarding forcepathstyle #17725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2025
Merged

fix(operator): fix typo in docs regarding forcepathstyle #17725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions operator/docs/lokistack/object_storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ _Note_: Upon setting up LokiStack for any object storage provider, you should co
--from-literal=sse_type="SSE-S3"
```

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

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

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion operator/internal/handlers/internal/storage/secrets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ func extractS3ConfigSecret(s *corev1.Secret, credentialMode lokiv1.CredentialMod
// Determine if we should use path style URLs for S3
// default to false for non-AWS endpoints
forcePathStyle := !strings.HasSuffix(string(endpoint), awsEndpointSuffix)
// Check if the user has specified force_path_style
// Check if the user has specified forcepathstyle
if configForcePathStyle, ok := s.Data[storage.KeyAWSForcePathStyle]; ok {
strForcePathStyle := string(configForcePathStyle)
switch strForcePathStyle {
Expand Down
Loading