Skip to content

Commit 095e25e

Browse files
lilioidzanhsieh
andauthored
[kube-state-metrics] Document OCI artiacts in README (#5920)
Signed-off-by: Lilly Sell <[email protected]> Signed-off-by: MH <[email protected]> Co-authored-by: MH <[email protected]>
1 parent 8296e70 commit 095e25e

File tree

2 files changed

+18
-20
lines changed

2 files changed

+18
-20
lines changed

charts/kube-state-metrics/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ keywords:
77
- prometheus
88
- kubernetes
99
type: application
10-
version: 6.1.1
10+
version: 6.1.2
1111
# renovate: github-releases=kubernetes/kube-state-metrics
1212
appVersion: 2.16.0
1313
home: https://github.com/kubernetes/kube-state-metrics/

charts/kube-state-metrics/README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,26 @@
22

33
Installs the [kube-state-metrics agent](https://github.com/kubernetes/kube-state-metrics).
44

5-
## Get Repository Info
6-
<!-- textlint-disable -->
7-
```console
8-
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
9-
helm repo update
10-
```
5+
## Usage
6+
7+
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/).
8+
9+
- OCI Artifact: `oci://ghcr.io/prometheus-community/charts/kube-state-metrics`
10+
- Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `kube-state-metrics`
1111

12-
_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._
13-
<!-- textlint-enable -->
12+
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.
1413

15-
## Install Chart
14+
### Install Chart
1615

1716
```console
18-
helm install [RELEASE_NAME] prometheus-community/kube-state-metrics [flags]
17+
helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-state-metrics [flags]
1918
```
2019

2120
_See [configuration](#configuration) below._
2221

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

25-
## Uninstall Chart
24+
### Uninstall Chart
2625

2726
```console
2827
helm uninstall [RELEASE_NAME]
@@ -32,19 +31,18 @@ This removes all the Kubernetes components associated with the chart and deletes
3231

3332
_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
3433

35-
## Upgrading Chart
34+
### Upgrading Chart
3635

3736
```console
38-
helm upgrade [RELEASE_NAME] prometheus-community/kube-state-metrics [flags]
37+
helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-state-metrics [flags]
3938
```
4039

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

43-
### Migrating from stable/kube-state-metrics and kubernetes/kube-state-metrics
42+
#### Migrating from stable/kube-state-metrics and kubernetes/kube-state-metrics
4443

4544
You can upgrade in-place:
4645

47-
1. [get repository info](#get-repository-info)
4846
1. [upgrade](#upgrading-chart) your existing release name using the new chart repository
4947

5048
## Upgrading to v6.0.0
@@ -57,16 +55,16 @@ v3.0.0 includes kube-state-metrics v2.0, see the [changelog](https://github.com/
5755

5856
The upgraded chart now the following changes:
5957

60-
* Dropped support for helm v2 (helm v3 or later is required)
61-
* collectors key was renamed to resources
62-
* namespace key was renamed to namespaces
58+
- Dropped support for helm v2 (helm v3 or later is required)
59+
- collectors key was renamed to resources
60+
- namespace key was renamed to namespaces
6361

6462
## Configuration
6563

6664
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:
6765

6866
```console
69-
helm show values prometheus-community/kube-state-metrics
67+
helm show values oci://ghcr.io/prometheus-community/charts/kube-state-metrics
7068
```
7169

7270
### kube-rbac-proxy

0 commit comments

Comments
 (0)