Skip to content

Added new section for custom-metrics API details #1566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 17, 2019
Merged

Added new section for custom-metrics API details #1566

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
550ff12
Added new section for custom-metrics API details
abrennan89 Jul 1, 2019
382c369
Minor update
abrennan89 Jul 1, 2019
852f13f
Updated based on Sam's comments
abrennan89 Jul 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/serving/custom-metrics-API.md
View file
Open in desktop
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.