easylinux/kube-prometheus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

contrib/kube-prometheus: Update README.md for custom-metrics-api

Browse Source
This commit is contained in:
Matthias Loibl
2018-11-14 16:19:05 +01:00
parent d4089d7125
commit 1b495e7bcb
3 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
experimental/custom-metrics-api/README.md
View File

@@ -1,11 +1,21 @@
# Custom Metrics API # Custom Metrics API
The custom metrics API allows the HPA v2 to scale on arbirary metrics. The custom metrics API allows the HPA v2 to scale based on arbirary metrics.
This directory contains an example deployment of the custom metrics API adapter using Prometheus as the backing monitoring system. This directory contains an example deployment which extends the Prometheus Adapter, deployed with kube-prometheus, serve the [Custom Metrics API](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/instrumentation/custom-metrics-api.md) by talking to Prometheus running inside the cluster.
In order to deploy the custom metrics adapter for Prometheus you need to generate TLS certficates used to serve the API. An example of how these could be generated can be found in `./gencerts.sh`, note that this is _not_ recommended to be used in production. You need to employ a secure PKI strategy, this is merely an example to get started and try it out quickly. Make sure you have the Prometheus Adapter up and running in the `monitoring` namespace.
Once the generated `Secret` with the certificates is in place, you can deploy everything in the `monitoring` namespace using `./deploy.sh`. You can deploy everything in the `monitoring` namespace using `./deploy.sh`.
When you're done, you can teardown using the `./teardown.sh` script. When you're done, you can teardown using the `./teardown.sh` script.
### Sample App
Additionally, this directory contains a sample app that uses the [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) to scale the Deployment's replicas of Pods up and down as needed.
Deploy this app by running `kubectl apply -f sample-app.yaml`.
Make the app accessible on your system, for example by using `kubectl -n monitoring port-forward svc/sample-app 8080`. Next you need to put some load on its http endpoints.
A tool like [hey](https://github.com/rakyll/hey) is helpful for doing so: `hey -c 20 -n 100000000 http://localhost:8080/metrics`
There is an even more detailed information on this sample app at [luxas/kubeadm-workshop](https://github.com/luxas/kubeadm-workshop#deploying-the-prometheus-operator-for-monitoring-services-in-the-cluster).

2
experimental/custom-metrics-api/deploy.sh
View File

@@ -1,4 +1,4 @@
#!/usr/bin/env bash #!/usr/bin/env bash
kubectl apply -n monitoring custom-metrics-apiserver-resource-reader-cluster-role-binding.yaml kubectl apply -n monitoring custom-metrics-apiserver-resource-reader-cluster-role-binding.yaml
kubectl apply -n monitoring custom-metrics-apiservice.yaml kubectl apply -n monitoring custom-metrics-apiservice.yaml

2
experimental/custom-metrics-api/teardown.sh
View File

@@ -1,4 +1,4 @@
#!/usr/bin/env bash #!/usr/bin/env bash
kubectl delete -n monitoring custom-metrics-apiserver-resource-reader-cluster-role-binding.yaml kubectl delete -n monitoring custom-metrics-apiserver-resource-reader-cluster-role-binding.yaml
kubectl delete -n monitoring custom-metrics-apiservice.yaml kubectl delete -n monitoring custom-metrics-apiservice.yaml