From b796e5ce9b1627d929d18ebafb6c1b37b02a7d93 Mon Sep 17 00:00:00 2001 From: realanna Date: Tue, 31 Oct 2023 14:37:34 +0100 Subject: [PATCH] chore: lint Signed-off-by: realanna --- .../yaml-crd-ref/analysisvaluetemplate.md | 70 +++++++++---------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/content/en/docs/yaml-crd-ref/analysisvaluetemplate.md b/docs/content/en/docs/yaml-crd-ref/analysisvaluetemplate.md index 811c6ed1b00..de524a1e919 100644 --- a/docs/content/en/docs/yaml-crd-ref/analysisvaluetemplate.md +++ b/docs/content/en/docs/yaml-crd-ref/analysisvaluetemplate.md @@ -31,42 +31,42 @@ spec: * **kind** -- Resource type. Must be set to `AnalysisValueTemplate` * **metadata** - * **labels** -- The Analysis feature uses the - `name` and `part-of` labels that are discussed in - [Basic annotations](../implementing/integrate/#basic-annotations) - plus the following: - * **app.kubernetes.io/instance** analysis-sample - * **app.kuberentes.io/managed-by** -- Tool used to manage - the operation of the application. - Valid values are `helm` and `kustomize`. - * **app.kubernetes.io/created-by** metrics-operator - - TODO: Need to clarify how to use these annotations - * **name** -- Unique name of this template. - Names must comply with the - [Kubernetes Object Names and IDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) - specification. - * **namespace** (optional) -- Namespace where this template lives. - `Analysis` resources must specify this namespace - when referencing this definition, - unless it resides in the same namespace as the `Analysis` resource. + * **labels** -- The Analysis feature uses the + `name` and `part-of` labels that are discussed in + [Basic annotations](../implementing/integrate/#basic-annotations) + plus the following: + * **app.kubernetes.io/instance** analysis-sample + * **app.kuberentes.io/managed-by** -- Tool used to manage + the operation of the application. + Valid values are `helm` and `kustomize`. + * **app.kubernetes.io/created-by** metrics-operator + + TODO: Need to clarify how to use these annotations + * **name** -- Unique name of this template. + Names must comply with the + [Kubernetes Object Names and IDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) + specification. + * **namespace** -- Namespace where this template lives. + `Analysis` resources must specify this namespace + when referencing this definition, + unless it resides in the same namespace as the `Analysis` resource. * **spec** - * **provider** (required) -- the KeptnMetricProvider - * **name** -- The `spec.name` value of the - [KeptnMetricsProvider](metricsprovider.md) resource to use. - Note that each `AnalysisValueTemplate` resource - can use only one data source. - However, an `Analysis` resource - can use multiple `AnalysisValueTemplate` resources, - each of which uses a different data source. - * **query** (required) -- query to be made. - This is done in the data provider's query language. - It can include variables that use the go templating syntax - to insert a placeholder in the query. - For example, the query might include `{{.nodename}}'}`; - the value to substitute for that variable for this Analysis - is defined in the `spec.args` section of the `AnalysisTemplate` resource, - which might be set to `nodename: test`. + * **provider** (required) -- the KeptnMetricProvider + * **name** -- The `spec.name` value of the + [KeptnMetricsProvider](metricsprovider.md) resource to use. + Note that each `AnalysisValueTemplate` resource + can use only one data source. + However, an `Analysis` resource + can use multiple `AnalysisValueTemplate` resources, + each of which uses a different data source. + * **query** (required) -- query to be made. + This is done in the data provider's query language. + It can include variables that use the go templating syntax + to insert a placeholder in the query. + For example, the query might include `{{.nodename}}'}`; + the value to substitute for that variable for this Analysis + is defined in the `spec.args` section of the `AnalysisTemplate` resource, + which might be set to `nodename: test`. ## Usage