Skip to content

Commit

Permalink
Update helm docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GerbenWelter committed Nov 23, 2024
1 parent a3792b7 commit b0cdbba
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions production/helm/loki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,29 @@ Helm chart for Grafana Loki and Grafana Enterprise Logs supporting both simple,

## Source Code

- <https://github.com/grafana/loki>
- <https://grafana.com/oss/loki/>
- <https://grafana.com/docs/loki/latest/>
* <https://github.com/grafana/loki>
* <https://grafana.com/oss/loki/>
* <https://grafana.com/docs/loki/latest/>

## Requirements

| Repository | Name | Version |
| ------------------------------------- | ---------------------------------------------- | ------- |
| https://charts.min.io/ | minio(minio) | 5.3.0 |
| https://grafana.github.io/helm-charts | grafana-agent-operator(grafana-agent-operator) | 0.5.0 |
| https://grafana.github.io/helm-charts | rollout_operator(rollout-operator) | 0.19.1 |
| Repository | Name | Version |
|------------|------|---------|
| https://charts.min.io/ | minio(minio) | 5.3.0 |
| https://grafana.github.io/helm-charts | grafana-agent-operator(grafana-agent-operator) | 0.5.0 |
| https://grafana.github.io/helm-charts | rollout_operator(rollout-operator) | 0.19.1 |

Find more information in the Loki Helm Chart [documentation](https://grafana.com/docs/loki/next/installation/helm).

## Contributing and releasing

If you made any changes to the [Chart.yaml](https://github.com/grafana/loki/blob/main/production/helm/loki/Chart.yaml) or [values.yaml](https://github.com/grafana/loki/blob/main/production/helm/loki/values.yaml) run `make helm-docs` from the root of the repository to update the documentation and commit the changed files.

Futhermore, please add an entry to the [CHANGELOG.md](./CHANGELOG.md) file about what you changed. This file has a header that looks like this:
Futhermore, please add an entry to the [CHANGELOG.md](./CHANGELOG.md) file about what you changed. This file has a header that looks like this:

```
[//]: # (<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.)
```
````
Place your changes as a bulleted list below this header. The helm chart is automatically released once a week, at which point the `CHANGELOG.md` file will be updated to reflect the release of all changes between this header the the header of the previous version as the changes for that weeks release. For example, if the weekly release will be `1.21.0`, and the `CHANGELOG.md` file has the following entries:
Expand All @@ -44,7 +44,6 @@ Place your changes as a bulleted list below this header. The helm chart is autom
```
Then the weekly release will create a `CHANGELOG.md` with the following content:

```
[//]: # (<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.)

Expand All @@ -61,7 +60,6 @@ Then the weekly release will create a `CHANGELOG.md` with the following content:
#### Versioning
Normally contributors need _not_ bump the version nor update the [CHANGELOG.md](https://github.com/grafana/loki/blob/main/production/helm/loki/CHANGELOG.md). A new version of the Chart will follow this cadence:

- Automatic weekly releases
- Releases that coincide with Loki/GEL releases
- Manual releases when necessary (ie. to address a CVE or critical bug)

0 comments on commit b0cdbba

Please sign in to comment.