Skip to content

Commit 54fc95d

Browse files
abrennan89knative-prow-robot
authored andcommitted
Added new section for custom-metrics API details (#1566)
* Added new section for custom-metrics API details * Minor update * Updated based on Sam's comments
1 parent e97cd70 commit 54fc95d

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/serving/custom-metrics-API.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Custom-metrics API"
3+
weight: 10
4+
type: "docs"
5+
---
6+
7+
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).
8+
9+
>**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.
10+
>
11+
>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.
12+
13+
# Checking for existing custom-metrics API implementations
14+
15+
To check if your cluster has an existing `custom-metrics` API implementation, use the following command.
16+
17+
```
18+
kubectl get apiservice | grep v1beta1.custom.metrics.k8s.io
19+
```
20+
21+
# Deleting existing custom-metrics API installations
22+
23+
If you have an existing `custom-metrics` API implementation in your cluster, you must delete this using the following command.
24+
25+
```
26+
kubectl delete apiservice v1beta1.custom.metrics.k8s.io
27+
```
28+
29+
**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.

0 commit comments

Comments
 (0)