Skip to content

Commit

Permalink
chore: lint
Browse files Browse the repository at this point in the history
Signed-off-by: realanna <[email protected]>
  • Loading branch information
RealAnna committed Oct 31, 2023
1 parent f6f1874 commit b796e5c
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions docs/content/en/docs/yaml-crd-ref/analysisvaluetemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit b796e5c

Please sign in to comment.