Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Sep 3, 2024
1 parent 20247f2 commit 1989441
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions helm-charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,11 @@ node(s). Otherwise they never reach ready state.

Too large requests would not be a problem as long as pods still fit to available nodes, but too
small requests would be an issue:
* Multiple inferencing instances interfere / slow down each other, especially if there are no

- Multiple inferencing instances interfere / slow down each other, especially if there are no
[NRI policies](https://github.com/opea-project/GenAIEval/tree/main/doc/platform-optimization)
that provide further isolation
* Containers can become non-functional when their actual resource usage crosses the specified limits
- Containers can become non-functional when their actual resource usage crosses the specified limits

If cluster does not run [Prometheus operator](https://github.com/prometheus-operator/kube-prometheus)
yet, it SHOULD be be installed before enabling HPA, e.g. by using:
Expand All @@ -100,19 +101,19 @@ custom metrics Helm template (in top-level Helm chart).

Names of the _Prometheus-operator_ related objects depend on where it is installed from.
Default ones are:
* "kube-prometheus" upstream manifests:
* Namespace: `monitoring`
* Metrics service: `prometheus-k8s`
* Adapter configMap: `adapter-config`
* Helm chart for "kube-prometheus" (linked above):
* Namespace: `monitoring`
* Metrics service: `prom-kube-prometheus-stack-prometheus`
* Adapter configMap: `prom-adapter-prometheus-adapter`

- "kube-prometheus" upstream manifests:
- Namespace: `monitoring`
- Metrics service: `prometheus-k8s`
- Adapter configMap: `adapter-config`
- Helm chart for "kube-prometheus" (linked above):
- Namespace: `monitoring`
- Metrics service: `prom-kube-prometheus-stack-prometheus`
- Adapter configMap: `prom-adapter-prometheus-adapter`

Make sure correct "configMap" name is used in top-level (e.g. `chatqna`) Helm chart `values.yaml`,
and commands below!


### Gotchas

Why HPA is opt-in:
Expand Down Expand Up @@ -142,6 +143,7 @@ To verify that horizontalPodAutoscaler options work, it's better to check that b
services metrics, and HPA rules using custom metrics generated from them work.

Use k8s object names matching your Prometheus installation:

```console
prom_svc=prom-kube-prometheus-stack-prometheus # Metrics service
prom_ns=monitoring; # Prometheus namespace
Expand Down

0 comments on commit 1989441

Please sign in to comment.