Skip to content

Commit

Permalink
Added new section for custom-metrics API details (knative#1566)
Browse files Browse the repository at this point in the history
* Added new section for custom-metrics API details

* Minor update

* Updated based on Sam's comments
  • Loading branch information
abrennan89 authored and knative-prow-robot committed Sep 17, 2019
1 parent e97cd70 commit 54fc95d
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/serving/custom-metrics-API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Custom-metrics API"
weight: 10
type: "docs"
---

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.
>
>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.

0 comments on commit 54fc95d

Please sign in to comment.