docs: Add user guide for Gateway API State Metrics #1871
Conversation
david-martin
force-pushed
the
gateway-api-state-metrics-guide
branch
3 times, most recently
from
75f4bbe to
0ffc6c2
Compare
| Once Kustomize is installed, run the following commands to install the metrics stack, with the Gateway API State Metrics configuration, on your kubernetes cluster. | ||
|
|
||
| ```shell | ||
| kustomize build github.com/kuadrant/gateway-api-state-metrics.git/examples/kube-prometheus | docker run --rm -i ryane/kfilt -i kind=CustomResourceDefinition | kubectl apply --server-side -f - |
There was a problem hiding this comment.
It is possible to release the yaml in upstream, so that people can use it easier
There was a problem hiding this comment.
Hey @Xunzhuo
Do you mean avoid using kustomize, or something else?
There was a problem hiding this comment.
There was a problem hiding this comment.
Good idea.
I'll use the kustomize cmds to generate yaml and commit that.
That should avoid potential errors (like in the screenshot above) and remove the dependency on kustomize for installing.
There was a problem hiding this comment.
@Xunzhuo I've updated the docs to simplify things (no kustomize or docker run needed) by referencing bundle yaml files.
This should also fix the error you were seeing.
Codecov Report
@@ Coverage Diff @@
## main #1871 +/- ##
==========================================
+ Coverage 65.31% 65.36% +0.04%
==========================================
Files 86 86
Lines 12526 12526
==========================================
+ Hits 8181 8187 +6
+ Misses 3827 3822 -5
+ Partials 518 517 -1 |
Signed-off-by: David Martin <davmarti@redhat.com>
david-martin
force-pushed
the
gateway-api-state-metrics-guide
branch
from
0ffc6c2 to
cfcffeb
Compare
What type of PR is this?
Docs, new user guide
What this PR does / why we need it:
This PR adds a new User Guide for installing and using Gateway API State Metrics (metrics, dashboards and alerts).
Which issue(s) this PR fixes:
Fixes #1823