docs: reference pages for Evaluation and Metrics definitions and providers #1224
Conversation
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]
Signed-off-by: Meg McRoberts [email protected]
Signed-off-by: Meg McRoberts [email protected]
Signed-off-by: Meg McRoberts [email protected]
Signed-off-by: Meg McRoberts [email protected]
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
StackScribe
requested review from
thisthat,
thschue and
bacherfl
as code owners
github-actions
bot
added
the
documentation
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Signed-off-by: Meg McRoberts <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
Signed-off-by: Meg McRoberts [email protected] Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
…kit into 0412-eval-ref Signed-off-by: Meg McRoberts <[email protected]>
|
|
||
| * Observability | ||
|
|
||
| * Evaluations |
There was a problem hiding this comment.
Evaluations are not part of Observability. I would add it at the main level and say that Evaluation allows to implement quality gates for your deployments. You can reuse most of the content from https://keptn.sh/docs/concepts/quality_gates/#keptn-quality-gate-process
| However, the Kubernetes metrics servers | ||
| only allow you to release a single service on a API; | ||
| you cannot use multiple observability platforms | ||
| in one namespace for one API. |
There was a problem hiding this comment.
I think this stems from the limitation of the Kubernetes API where you can register a single custom or external metric server through the Metric APIs.
I would not add this text since it is very deep into the details of K8s. I would rather start directly with the following up paragraph that explains the benefits of our metric server
| ## Fields | ||
|
|
||
| * **apiVersion** -- API version being used. | ||
| Must be `v1alpha3` or later for this syntax. |
There was a problem hiding this comment.
This will be painful to maintain. At each new API release, we would need to change it. I suggest creating a pointer towards the autogenerated docs of the CRDs to find the right version.
| [Kubernetes Object Names and IDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) | ||
| specification. | ||
|
|
||
| * **spec** |
There was a problem hiding this comment.
I have mixed feelings about having this manually maintained. The APIs will change continuously and we need to keep this section aligned with the implementation. For the fields, we generate the documentation automatically in the API reference page: https://lifecycle.keptn.sh/docs/crd-ref/
I would rather keep it there so we don't have to maintain the fields in multiple places
Signed-off-by: Meg McRoberts [email protected] Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected] Co-authored-by: Giovanni Liva <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected] Co-authored-by: Giovanni Liva <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected] Co-authored-by: Giovanni Liva <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected] Co-authored-by: Giovanni Liva <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected] Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by Meg McRoberts meg.mcroberts@dynatrace Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
…kit into 0412-eval-ref Signed-off-by: Meg Mcroberts [email protected]
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected] Co-authored-by: Giovanni Liva <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected] Co-authored-by: Giovanni Liva <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
|
This PR is corrupted and so I am deleting it. |
Closes #1080