Skip to content

Commit

Permalink
Helm: add support for setting an s3 backoff_config via the loki helm …
Browse files Browse the repository at this point in the history
…chart (#11458)

**What this PR does / why we need it**:
Currently the Loki helm chart does not support defining s3 backoff
config settings. This PR adds support to the loki.commonStorageConfig
helper to add backoff config options when they're specified in the helm
values
**Which issue(s) this PR fixes**:
Fixes #<issue number>

**Special notes for your reviewer**:

**Checklist**
- [x] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [ ] Documentation added
- [ ] Tests updated
- [ ] `CHANGELOG.md` updated
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md`
- [x] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](d10549e)
- [ ] If the change is deprecating or removing a configuration option,
update the `deprecated-config.yaml` and `deleted-config.yaml` files
respectively in the `tools/deprecated-config-checker` directory.
[Example
PR](0d4416a)

---------

Co-authored-by: Michel Hollands <[email protected]>
  • Loading branch information
rl0nergan and MichelHollands authored Dec 15, 2023
1 parent d048e93 commit a192fc2
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 2 deletions.
10 changes: 10 additions & 0 deletions docs/sources/setup/install/helm/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2252,6 +2252,7 @@ null
},
"s3": {
"accessKeyId": null,
"backoff_config": {},
"endpoint": null,
"http_config": {},
"insecure": false,
Expand Down Expand Up @@ -2285,6 +2286,15 @@ null
"type": "s3"
}
</pre>
</td>
</tr>
<tr>
<td>loki.storage.s3.backoff_config</td>
<td>object</td>
<td>Check https://grafana.com/docs/loki/latest/configure/#s3_storage_config for more info on how to provide a backoff_config</td>
<td><pre lang="json">
{}
</pre>
</td>
</tr>
<tr>
Expand Down
4 changes: 4 additions & 0 deletions production/helm/loki/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ Entries should include a reference to the pull request that introduced the chang

[//]: # (<AUTOMATED_UPDATES_LOCATOR> : do not remove this line. This locator is used by the CI pipeline to automatically create a changelog entry for each new Loki release. Add other chart versions and respective changelog entries bellow this line.)

## 5.41.3

- [FEATURE] Add support for defining an s3 backoff config.

## 5.41.2

- [FEATURE] Add ciliumnetworkpolicies.
Expand Down
2 changes: 1 addition & 1 deletion production/helm/loki/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: loki
description: Helm chart for Grafana Loki in simple, scalable mode
type: application
appVersion: 2.9.3
version: 5.41.2
version: 5.41.3
home: https://grafana.github.io/helm-charts
sources:
- https://github.com/grafana/loki
Expand Down
2 changes: 1 addition & 1 deletion production/helm/loki/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# loki

![Version: 5.41.2](https://img.shields.io/badge/Version-5.41.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.9.3](https://img.shields.io/badge/AppVersion-2.9.3-informational?style=flat-square)
![Version: 5.41.3](https://img.shields.io/badge/Version-5.41.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.9.3](https://img.shields.io/badge/AppVersion-2.9.3-informational?style=flat-square)

Helm chart for Grafana Loki in simple, scalable mode

Expand Down
13 changes: 13 additions & 0 deletions production/helm/loki/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,20 @@ s3:
ca_file: {{ . }}
{{- end}}
{{- end }}
{{- with .backoff_config}}
backoff_config:
{{- with .min_period }}
min_period: {{ . }}
{{- end}}
{{- with .max_period }}
max_period: {{ . }}
{{- end}}
{{- with .max_retries }}
max_retries: {{ . }}
{{- end}}
{{- end }}
{{- end -}}

{{- else if eq .Values.loki.storage.type "gcs" -}}
{{- with .Values.loki.storage.gcs }}
gcs:
Expand Down
2 changes: 2 additions & 0 deletions production/helm/loki/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,8 @@ loki:
s3ForcePathStyle: false
insecure: false
http_config: {}
# -- Check https://grafana.com/docs/loki/latest/configure/#s3_storage_config for more info on how to provide a backoff_config
backoff_config: {}
gcs:
chunkBufferSize: 0
requestTimeout: "0s"
Expand Down

0 comments on commit a192fc2

Please sign in to comment.