Skip to content

Commit a6dc2c8

Browse files
author
Constanti, Mario
committed
docs/metrics: upper camala case for API objects
Signed-off-by: Constanti, Mario <mario.constanti@daimler.com>
1 parent 4c94ed6 commit a6dc2c8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/book/src/reference/metrics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ These metrics are protected by [kube-auth-proxy](https://github.com/brancz/kube-
99
by default.
1010

1111
You will need to grant permissions to your Prometheus server so that it can
12-
scrape the protected metrics. To achieve that, you can create a `clusterRole` and a
13-
`clusterRoleBinding` to bind to the service account that your Prometheus server uses.
12+
scrape the protected metrics. To achieve that, you can create a `ClusterRole` and a
13+
`ClusterRoleBinding` to bind to the service account that your Prometheus server uses.
1414

15-
Create a YAML file named `capi-metrics-reader-clusterrole.yaml` with following content
15+
Create a manifest named `capi-metrics-reader-clusterrole.yaml` with the following content:
1616

1717
```yaml
1818
apiVersion: rbac.authorization.k8s.io/v1
@@ -24,13 +24,13 @@ rules:
2424
verbs: ["get"]
2525
```
2626
27-
and apply the `clusterRole` with
27+
and apply the `ClusterRole` with
2828

2929
```bash
3030
kubectl apply -f capi-metrics-reader-clusterrole.yaml
3131
```
3232

33-
You can run the following kubectl command to create a `clusterRoleBinding` and grant access on the `/metrics` endpoint to your Prometheus instance (`<namespace>` must be the namespace where your Prometheus instance is running. `<service-account-name>` must be the service account name which is configured in your Prometheus instance).
33+
You can run the following kubectl command to create a `ClusterRoleBinding` and grant access on the `/metrics` endpoint to your Prometheus instance (`<namespace>` must be the namespace where your Prometheus instance is running. `<service-account-name>` must be the service account name which is configured in your Prometheus instance).
3434

3535
```bash
3636
kubectl create clusterrolebinding capi-metrics-reader --clusterrole=capi-metrics-reader --serviceaccount=<namespace>:<service-account-name>
@@ -73,4 +73,4 @@ To scrape metrics, your Prometheus instance need at least following [`kubernetes
7373
regex: __meta_kubernetes_service_label_(.+)
7474
```
7575

76-
You are no able to check for metrics in your Prometheus instance. To verify, you could search with e.g. `{namespace="capi-system"}` to get all metrics from components running in `capi-system` Namespace.
76+
You are no able to check for metrics in your Prometheus instance. To verify, you could search with e.g. `{namespace="capi-system"}` to get all metrics from components running in the `capi-system` namespace.

0 commit comments

Comments
 (0)