From cfb26ceeba607eb71382b6345f10f35f8cefa6b9 Mon Sep 17 00:00:00 2001 From: Mario Constanti Date: Tue, 10 Jan 2023 13:20:08 +0100 Subject: [PATCH] replace kube_crd with kube_customresource in docs Signed-off-by: Mario Constanti --- docs/customresourcestate-metrics.md | 16 ++++++++-------- docs/verticalpodautoscaler-metrics.md | 6 +++--- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/customresourcestate-metrics.md b/docs/customresourcestate-metrics.md index d21fe37b30..acda6eda2d 100644 --- a/docs/customresourcestate-metrics.md +++ b/docs/customresourcestate-metrics.md @@ -117,7 +117,7 @@ spec: Produces the metric: ```prometheus -kube_crd_uptime{group="myteam.io", kind="Foo", version="v1"} 43.21 +kube_customresource_uptime{group="myteam.io", kind="Foo", version="v1"} 43.21 ``` #### Multiple Metrics/Kitchen Sink @@ -169,8 +169,8 @@ spec: Produces the following metrics: ```prometheus -kube_crd_ready_count{group="myteam.io", kind="Foo", version="v1", active="1",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-a"} 2 -kube_crd_ready_count{group="myteam.io", kind="Foo", version="v1", active="3",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-b"} 4 +kube_customresource_ready_count{group="myteam.io", kind="Foo", version="v1", active="1",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-a"} 2 +kube_customresource_ready_count{group="myteam.io", kind="Foo", version="v1", active="3",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-b"} 4 ``` ### Metric types @@ -205,7 +205,7 @@ spec: Produces the metric: ```prometheus -kube_crd_uptime{group="myteam.io", kind="Foo", version="v1"} 43.21 +kube_customresource_uptime{group="myteam.io", kind="Foo", version="v1"} 43.21 ``` #### StateSet @@ -237,9 +237,9 @@ The value will be 1, if the value matches the one in list. Produces the metric: ```prometheus -kube_crd_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Pending"} 1 -kube_crd_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Bar"} 0 -kube_crd_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Baz"} 0 +kube_customresource_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Pending"} 1 +kube_customresource_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Bar"} 0 +kube_customresource_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Baz"} 0 ``` #### Info @@ -269,7 +269,7 @@ spec: Produces the metric: ```prometheus -kube_crd_version{group="myteam.io", kind="Foo", version="v1", version="v1.2.3"} 1 +kube_customresource_version{group="myteam.io", kind="Foo", version="v1", version="v1.2.3"} 1 ``` ### Naming diff --git a/docs/verticalpodautoscaler-metrics.md b/docs/verticalpodautoscaler-metrics.md index 49d380de99..75d60bc5c6 100644 --- a/docs/verticalpodautoscaler-metrics.md +++ b/docs/verticalpodautoscaler-metrics.md @@ -30,9 +30,9 @@ spec: gauge: path: [metadata, annotations] # This will output the following metric: -# HELP kube_crd_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations Kubernetes annotations converted to Prometheus labels. -# TYPE kube_crd_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations gauge -# kube_crd_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations{namespace="default",target_api_version="autoscaling.k8s.io/v1",target_kind="Deployment",target_name="hamster",verticalpodautoscaler="hamster-vpa"} 123 +# HELP kube_customresource_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations Kubernetes annotations converted to Prometheus labels. +# TYPE kube_customresource_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations gauge +# kube_customresource_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations{namespace="default",target_api_version="autoscaling.k8s.io/v1",target_kind="Deployment",target_name="hamster",verticalpodautoscaler="hamster-vpa"} 123 ``` PS. The above configuration was tested on [this](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/examples/hamster.yaml) VPA configuration, with an added annotation (`foo: 123`). ***