mirror of https://git.rancher.io/charts
68 lines
2.3 KiB
Diff
68 lines
2.3 KiB
Diff
|
--- charts-original/README.md
|
||
|
|
+++ charts/README.md
|
||
|
|
@@ -2,14 +2,15 @@
|
||
|
|
|
||
|
|
Installs the [kube-state-metrics agent](https://github.com/kubernetes/kube-state-metrics).
|
||
|
|
|
||
|
|
-## Get Repo Info
|
||
|
|
-
|
||
|
|
+## Get Repository Info
|
||
|
|
+<!-- textlint-disable -->
|
||
|
|
```console
|
||
|
|
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
|
||
|
|
helm repo update
|
||
|
|
```
|
||
|
|
|
||
|
|
_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._
|
||
|
|
+<!-- textlint-enable -->
|
||
|
|
|
||
|
|
## Install Chart
|
||
|
|
|
||
|
|
@@ -43,20 +44,19 @@
|
||
|
|
|
||
|
|
You can upgrade in-place:
|
||
|
|
|
||
|
|
-1. [get repo info](#get-repo-info)
|
||
|
|
-1. [upgrade](#upgrading-chart) your existing release name using the new chart repo
|
||
|
|
-
|
||
|
|
+1. [get repository info](#get-repository-info)
|
||
|
|
+1. [upgrade](#upgrading-chart) your existing release name using the new chart repository
|
||
|
|
|
||
|
|
## Upgrading to v3.0.0
|
||
|
|
|
||
|
|
v3.0.0 includes kube-state-metrics v2.0, see the [changelog](https://github.com/kubernetes/kube-state-metrics/blob/release-2.0/CHANGELOG.md) for major changes on the application-side.
|
||
|
|
|
||
|
|
The upgraded chart now the following changes:
|
||
|
|
+
|
||
|
|
* Dropped support for helm v2 (helm v3 or later is required)
|
||
|
|
* collectors key was renamed to resources
|
||
|
|
* namespace key was renamed to namespaces
|
||
|
|
|
||
|
|
-
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
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:
|
||
|
|
@@ -65,4 +65,21 @@
|
||
|
|
helm show values prometheus-community/kube-state-metrics
|
||
|
|
```
|
||
|
|
|
||
|
|
-You may also run `helm show values` on this chart's [dependencies](#dependencies) for additional options.
|
||
|
|
+### kube-rbac-proxy
|
||
|
|
+
|
||
|
|
+You can enable `kube-state-metrics` endpoint protection using `kube-rbac-proxy`. By setting `kubeRBACProxy.enabled: true`, this chart will deploy one RBAC proxy container per endpoint (metrics & telemetry).
|
||
|
|
+To authorize access, authenticate your requests (via a `ServiceAccount` for example) with a `ClusterRole` attached such as:
|
||
|
|
+
|
||
|
|
+```yaml
|
||
|
|
+apiVersion: rbac.authorization.k8s.io/v1
|
||
|
|
+kind: ClusterRole
|
||
|
|
+metadata:
|
||
|
|
+ name: kube-state-metrics-read
|
||
|
|
+rules:
|
||
|
|
+ - apiGroups: [ "" ]
|
||
|
|
+ resources: ["services/kube-state-metrics"]
|
||
|
|
+ verbs:
|
||
|
|
+ - get
|
||
|
|
+```
|
||
|
|
+
|
||
|
|
+See [kube-rbac-proxy examples](https://github.com/brancz/kube-rbac-proxy/tree/master/examples/resource-attributes) for more details.
|