Skip to content

Commit eace969

Browse files
lilioidzanhsiehjkroepke
authored
[kube-prometheus-stack] Document OCI artiacts in README (#5919)
Co-authored-by: MH <[email protected]> Co-authored-by: Jan-Otto Kröpke <[email protected]>
1 parent 1349052 commit eace969

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

charts/kube-prometheus-stack/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ name: kube-prometheus-stack
3131
sources:
3232
- https://github.com/prometheus-community/helm-charts
3333
- https://github.com/prometheus-operator/kube-prometheus
34-
version: 75.15.0
34+
version: 75.15.1
3535
# renovate: github=prometheus-operator/prometheus-operator
3636
appVersion: v0.83.0
3737
kubeVersion: ">=1.25.0-0"

charts/kube-prometheus-stack/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,26 @@ _Note: This chart was formerly named `prometheus-operator` chart, now renamed to
1111
- Kubernetes 1.19+
1212
- Helm 3+
1313

14-
## Get Helm Repository Info
14+
## Usage
1515

16-
```console
17-
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
18-
helm repo update
19-
```
16+
The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/).
17+
18+
- OCI Artifact: `oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack`
19+
- Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `kube-prometheus-stack`
2020

21-
_See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._
21+
The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository.
2222

23-
## Install Helm Chart
23+
### Install Helm Chart
2424

2525
```console
26-
helm install [RELEASE_NAME] prometheus-community/kube-prometheus-stack
26+
helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack
2727
```
2828

2929
_See [configuration](#configuration) below._
3030

3131
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
3232

33-
## Dependencies
33+
### Dependencies
3434

3535
By default this chart installs additional, dependent charts:
3636

@@ -42,7 +42,7 @@ To disable dependencies during installation, see [multiple releases](#multiple-r
4242

4343
_See [helm dependency](https://helm.sh/docs/helm/helm_dependency/) for command documentation._
4444

45-
### Grafana Dashboards
45+
#### Grafana Dashboards
4646

4747
This chart provisions a collection of curated Grafana dashboards that are automatically loaded into Grafana via ConfigMaps. These dashboards are rendered into the Helm chart under [`templates/grafana/`](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack/templates/grafana/), but **this is not their source of truth**.
4848

@@ -52,7 +52,7 @@ The dashboards originate from various upstream projects and are gathered and pro
5252
5353
If you wish to contribute or modify dashboards, please follow the guidance in the `hack/README.md` to ensure consistency and reproducibility.
5454

55-
## Uninstall Helm Chart
55+
### Uninstall Helm Chart
5656

5757
```console
5858
helm uninstall [RELEASE_NAME]
@@ -77,10 +77,10 @@ kubectl delete crd servicemonitors.monitoring.coreos.com
7777
kubectl delete crd thanosrulers.monitoring.coreos.com
7878
```
7979

80-
## Upgrading Chart
80+
### Upgrading Chart
8181

8282
```console
83-
helm upgrade [RELEASE_NAME] prometheus-community/kube-prometheus-stack
83+
helm upgrade [RELEASE_NAME] [CHART]
8484
```
8585

8686
With Helm v3, CRDs created by this chart are not updated by default and should be manually updated.
@@ -91,7 +91,7 @@ The Chart's [appVersion](https://github.com/prometheus-community/helm-charts/blo
9191

9292
_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
9393

94-
### Upgrading an existing Release to a new major version
94+
#### Upgrading an existing Release to a new major version
9595

9696
A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions.
9797

@@ -103,7 +103,7 @@ for breaking changes between versions.
103103
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments:
104104

105105
```console
106-
helm show values prometheus-community/kube-prometheus-stack
106+
helm show values oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack
107107
```
108108

109109
You may also `helm show values` on this chart's [dependencies](#dependencies) for additional options.
@@ -262,7 +262,7 @@ There is no simple and direct migration path between the charts as the changes a
262262

263263
The capabilities of the old chart are all available in the new chart, including the ability to run multiple prometheus instances on a single cluster - you will need to disable the parts of the chart you do not wish to deploy.
264264

265-
You can check out the tickets for this change [here](https://github.com/prometheus-operator/prometheus-operator/issues/592) and [here](https://github.com/helm/charts/pull/6765).
265+
You can check out the tickets for this change at [prometheus-operator/prometheus-operator #592](https://github.com/prometheus-operator/prometheus-operator/issues/592) and [helm/charts #6765](https://github.com/helm/charts/pull/6765).
266266

267267
### High-level overview of Changes
268268

0 commit comments

Comments
 (0)