Skip to content

[kube-prometheus-stack] Document OCI artiacts in README #5919

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 4 commits into from
Jul 28, 2025
Merged

[kube-prometheus-stack] Document OCI artiacts in README #5919

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
880e3d8
[kube-prometheus-stack] Document OCI artifacts in README
lilioid Jul 19, 2025
f2bb30a
Update README.md
zanhsieh Jul 28, 2025
5f63117
Merge branch 'main' into oci-kube-prometheus-stack
zanhsieh Jul 28, 2025
c0f982d
Merge branch 'main' into oci-kube-prometheus-stack
jkroepke Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/kube-prometheus-stack/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ name: kube-prometheus-stack
sources:
- https://github.com/prometheus-community/helm-charts
- https://github.com/prometheus-operator/kube-prometheus
version: 75.12.0
version: 75.12.1
# renovate: github=prometheus-operator/prometheus-operator
appVersion: v0.83.0
kubeVersion: ">=1.25.0-0"
Expand Down
30 changes: 15 additions & 15 deletions charts/kube-prometheus-stack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,26 @@ _Note: This chart was formerly named `prometheus-operator` chart, now renamed to
- Kubernetes 1.19+
- Helm 3+

## Get Helm Repository Info
## Usage

```console
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update
```
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/).

- OCI Artifact: `oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack`
- Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `kube-prometheus-stack`

_See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._
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.

## Install Helm Chart
### Install Helm Chart

```console
helm install [RELEASE_NAME] prometheus-community/kube-prometheus-stack
helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack
```

_See [configuration](#configuration) below._

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

## Dependencies
### Dependencies

By default this chart installs additional, dependent charts:

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

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

### Grafana Dashboards
#### Grafana Dashboards

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**.

Expand All @@ -52,7 +52,7 @@ The dashboards originate from various upstream projects and are gathered and pro

If you wish to contribute or modify dashboards, please follow the guidance in the `hack/README.md` to ensure consistency and reproducibility.

## Uninstall Helm Chart
### Uninstall Helm Chart

```console
helm uninstall [RELEASE_NAME]
Expand All @@ -77,10 +77,10 @@ kubectl delete crd servicemonitors.monitoring.coreos.com
kubectl delete crd thanosrulers.monitoring.coreos.com
```

## Upgrading Chart
### Upgrading Chart

```console
helm upgrade [RELEASE_NAME] prometheus-community/kube-prometheus-stack
helm upgrade [RELEASE_NAME] [CHART]
```

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

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

### Upgrading an existing Release to a new major version
#### Upgrading an existing Release to a new major version

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

Expand All @@ -103,7 +103,7 @@ for breaking changes between versions.
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:

```console
helm show values prometheus-community/kube-prometheus-stack
helm show values oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack
```

You may also `helm show values` on this chart's [dependencies](#dependencies) for additional options.
Expand Down