From 550ff125aa079cab255b6a1116b4ebd53f6ebc60 Mon Sep 17 00:00:00 2001 From: abrennan Date: Mon, 1 Jul 2019 07:01:19 -0500 Subject: [PATCH 1/3] Added new section for custom-metrics API details --- docs/serving/using-custom-metrics-API.md | 29 ++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/serving/using-custom-metrics-API.md diff --git a/docs/serving/using-custom-metrics-API.md b/docs/serving/using-custom-metrics-API.md new file mode 100644 index 00000000000..edf733f493c --- /dev/null +++ b/docs/serving/using-custom-metrics-API.md @@ -0,0 +1,29 @@ +--- +title: "Using the custom-metrics API" +weight: 10 +type: "docs" +--- + +The `custom-metrics` API is installed by default when you install Knative Serving. + +>**IMPORTANT:** If you already have an existing `custom-metrics` API implementation in your cluster, you must disable this so that Knative Serving can use the default Knative Serving installation of the `custom-metrics` API. Enabling both implementations can cause issues. +> +>If you intend to use an existing `custom-metrics` API implementation in your cluster, you will not be able to use custom metrics or HPA concurrency metrics on that cluster. These features require the Knative Serving `custom-metrics` API implementation. + +# Checking for existing custom-metrics API implementations + +To check if your cluster has an existing `custom-metrics` API implementation, use the following command. + +``` +kubectl get apiservice | grep v1beta1.custom.metrics.k8s.io +``` + +# Deleting existing custom-metrics API installations + +If you have an existing `custom-metrics` API implementation in your cluster, you must delete this using the following command. + +``` +kubectl delete apiservice v1beta1.custom.metrics.k8s.io +``` + +**IMPORTANT:** This step is not required for inexperienced users, as it is possible to break consumers of a custom-metrics API by deleting this. Only delete API implementations if you are sure that it is safe to do so. From 382c3698cbeaca89ae5d0c20fbe70c132975ae78 Mon Sep 17 00:00:00 2001 From: abrennan Date: Mon, 1 Jul 2019 07:05:12 -0500 Subject: [PATCH 2/3] Minor update --- docs/serving/using-custom-metrics-API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/using-custom-metrics-API.md b/docs/serving/using-custom-metrics-API.md index edf733f493c..bd3002d2652 100644 --- a/docs/serving/using-custom-metrics-API.md +++ b/docs/serving/using-custom-metrics-API.md @@ -6,7 +6,7 @@ type: "docs" The `custom-metrics` API is installed by default when you install Knative Serving. ->**IMPORTANT:** If you already have an existing `custom-metrics` API implementation in your cluster, you must disable this so that Knative Serving can use the default Knative Serving installation of the `custom-metrics` API. Enabling both implementations can cause issues. +>**IMPORTANT:** If you already have an existing `custom-metrics` API implementation in your cluster, you must delete this so that Knative Serving can use the default Knative Serving installation of the `custom-metrics` API. Enabling both implementations can cause issues. > >If you intend to use an existing `custom-metrics` API implementation in your cluster, you will not be able to use custom metrics or HPA concurrency metrics on that cluster. These features require the Knative Serving `custom-metrics` API implementation. From 852f13f14254f10e43508e8c44d000c0e113fa04 Mon Sep 17 00:00:00 2001 From: abrennan Date: Thu, 11 Jul 2019 16:19:06 -0500 Subject: [PATCH 3/3] Updated based on Sam's comments --- .../{using-custom-metrics-API.md => custom-metrics-API.md} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename docs/serving/{using-custom-metrics-API.md => custom-metrics-API.md} (89%) diff --git a/docs/serving/using-custom-metrics-API.md b/docs/serving/custom-metrics-API.md similarity index 89% rename from docs/serving/using-custom-metrics-API.md rename to docs/serving/custom-metrics-API.md index bd3002d2652..22556753bc0 100644 --- a/docs/serving/using-custom-metrics-API.md +++ b/docs/serving/custom-metrics-API.md @@ -1,10 +1,10 @@ --- -title: "Using the custom-metrics API" +title: "Custom-metrics API" weight: 10 type: "docs" --- -The `custom-metrics` API is installed by default when you install Knative Serving. +The `custom-metrics` API is installed by default when you install Knative Serving, and allows users to configure concurrency based scaling when using the Horizontal Pod Autoscaler (HPA). >**IMPORTANT:** If you already have an existing `custom-metrics` API implementation in your cluster, you must delete this so that Knative Serving can use the default Knative Serving installation of the `custom-metrics` API. Enabling both implementations can cause issues. >