Skip to content

Commit dcb8cf5

Browse files
dfredelldfredell
committed
Add Description to all doc markdown tables. Add controlled by cli note about labels and annotations to all markdown files.
1 parent 66a6cae commit dcb8cf5

29 files changed

+264
-263
lines changed

‎docs/certificatesigningrequest-metrics.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# CertificateSigningRequest Metrics
22

3-
| Metric name | Metric type | Labels/tags | Status |
4-
|--------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|
5-
| kube_certificatesigningrequest_annotations | Gauge | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | EXPERIMENTAL |
6-
| kube_certificatesigningrequest_created | Gauge | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | STABLE |
7-
| kube_certificatesigningrequest_condition | Gauge | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; <br> `condition`=&lt;approved\|denied&gt; | STABLE |
8-
| kube_certificatesigningrequest_labels | Gauge | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | STABLE |
9-
| kube_certificatesigningrequest_cert_length | Gauge | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | STABLE |
3+
| Metric name | Metric type | Description | Labels/tags | Status |
4+
| ------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
5+
| kube_certificatesigningrequest_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | EXPERIMENTAL |
6+
| kube_certificatesigningrequest_created | Gauge | | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | STABLE |
7+
| kube_certificatesigningrequest_condition | Gauge | | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; <br> `condition`=&lt;approved\|denied&gt; | STABLE |
8+
| kube_certificatesigningrequest_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | STABLE |
9+
| kube_certificatesigningrequest_cert_length | Gauge | | `certificatesigningrequest`=&lt;certificatesigningrequest-name&gt; <br> `signer_name`=&lt;certificatesigningrequest-signer-name&gt; | STABLE |

‎docs/clusterrole-metrics.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# ClusterRole Metrics
22

3-
| Metric name | Metric type | Labels/tags | Status |
4-
|--------------------------------------------|-------------|----------------------------------------|--------------|
5-
| kube_clusterrole_annotations | Gauge | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
6-
| kube_clusterrole_labels | Gauge | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
7-
| kube_clusterrole_info | Gauge | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
8-
| kube_clusterrole_created | Gauge | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
9-
| kube_clusterrole_metadata_resource_version | Gauge | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
3+
| Metric name | Metric type | Description | Labels/tags | Status |
4+
| ------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------------ |
5+
| kube_clusterrole_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
6+
| kube_clusterrole_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
7+
| kube_clusterrole_info | Gauge | | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
8+
| kube_clusterrole_created | Gauge | | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |
9+
| kube_clusterrole_metadata_resource_version | Gauge | | `clusterrole`=&lt;clusterrole-name&gt; | EXPERIMENTAL |

‎docs/clusterrolebinding-metrics.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# ClusterRoleBinding Metrics
22

3-
| Metric name | Metric type | Labels/tags | Status |
4-
| ------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------ |
5-
| kube_clusterrolebinding_annotations | Gauge | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
6-
| kube_clusterrolebinding_labels | Gauge | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
7-
| kube_clusterrolebinding_info | Gauge | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; <br> `roleref_kind`=&lt;role-kind&gt; <br> `roleref_name`=&lt;role-name&gt; | EXPERIMENTAL |
8-
| kube_clusterrolebinding_created | Gauge | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
9-
| kube_clusterrolebinding_metadata_resource_version | Gauge | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
3+
| Metric name | Metric type | Description | Labels/tags | Status |
4+
| ------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------ |
5+
| kube_clusterrolebinding_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
6+
| kube_clusterrolebinding_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
7+
| kube_clusterrolebinding_info | Gauge | | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; <br> `roleref_kind`=&lt;role-kind&gt; <br> `roleref_name`=&lt;role-name&gt; | EXPERIMENTAL |
8+
| kube_clusterrolebinding_created | Gauge | | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
9+
| kube_clusterrolebinding_metadata_resource_version | Gauge | | `clusterrolebinding`=&lt;clusterrolebinding-name&gt; | EXPERIMENTAL |
10+

‎docs/configmap-metrics.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# ConfigMap Metrics
22

3-
| Metric name | Metric type | Labels/tags | Status |
4-
| ---------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
5-
| kube_configmap_annotations | Gauge | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; <br> `annotation_CONFIGMAP_ANNOTATION`=&lt;CONFIGMAP_ANNOTATION&gt; | EXPERIMENTAL |
6-
| kube_configmap_labels | Gauge | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; <br> `label_CONFIGMAP_LABEL`=&lt;CONFIGMAP_LABEL&gt; | STABLE |
7-
| kube_configmap_info | Gauge | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; | STABLE |
8-
| kube_configmap_created | Gauge | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; | STABLE |
9-
| kube_configmap_metadata_resource_version | Gauge | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; | EXPERIMENTAL |
3+
| Metric name | Metric type | Description | Labels/tags | Status |
4+
| ---------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
5+
| kube_configmap_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](./cli-arguments.md) | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; <br> `annotation_CONFIGMAP_ANNOTATION`=&lt;CONFIGMAP_ANNOTATION&gt; | EXPERIMENTAL |
6+
| kube_configmap_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](./cli-arguments.md) | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; <br> `label_CONFIGMAP_LABEL`=&lt;CONFIGMAP_LABEL&gt; | STABLE |
7+
| kube_configmap_info | Gauge | | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; | STABLE |
8+
| kube_configmap_created | Gauge | | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; | STABLE |
9+
| kube_configmap_metadata_resource_version | Gauge | | `configmap`=&lt;configmap-name&gt; <br> `namespace`=&lt;configmap-namespace&gt; | EXPERIMENTAL |

0 commit comments

Comments
 (0)