Skip to content

Commit

Permalink
docs: analysis feature in 0.9.0 (#2424)
Browse files Browse the repository at this point in the history
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Co-authored-by: Florian Bacher <florian.bacher@dynatrace.com>
  • Loading branch information
StackScribe and bacherfl committed Nov 9, 2023
1 parent fb1f4ac commit a6e6a60
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 11 deletions.
6 changes: 6 additions & 0 deletions docs/content/en/docs/implementing/slo.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ For more information,see:
The Analysis result is exposed as an OpenTelemetry metric
and can be displayed on dashboard tools, such as Grafana.

> **Note** A preliminary release of the Keptn Analysis feature
is included in Keptn v0.8.3 and v0.9.0 but is hidden behind a feature flag.
See the
[Analysis](../yaml-crd-ref/analysis.md/#differences-between-versions)
reference page for instructions to activate the preview of this feature.

## Keptn Analysis basics

A Keptn Analysis is implemented with three resources:
Expand Down
23 changes: 19 additions & 4 deletions docs/content/en/docs/yaml-crd-ref/analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,10 +330,25 @@ API reference: [Analysis](../crd-ref/metrics/v1alpha3/#analysis)

## Differences between versions

Keptn v.0.8.3 includes a preliminary release of the Keptn Analysis feature
but is hidden behind a feature flag.
To preview these features, set the environment `ENABLE_ANALYSIS` to `true`
in the `metrics-operator` deployment.
Keptn v0.8.3 and v0.9.0 include a preliminary release
of the Keptn Analysis feature
but it is hidden behind a feature flag.
To preview these features, do one of the following for your Keptn cluster:

* Set the environment variable `ENABLE_ANALYSIS` to `true`
in the `metrics-operator` deployment
* Add the following to your `helm upgrade` command line:

```shell
--set metricsOperator.env.enableKeptnAnalysis=true
```
* Set `enableKeptnAnalysis: "true"` in the
[keptn-metrics-operator/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-metrics-operator/values.yaml)
file

See
[Modify Helm configuration options](../install/install.md/#modify-helm-configuration-options)
for more information.

## See also

Expand Down
7 changes: 4 additions & 3 deletions docs/content/en/docs/yaml-crd-ref/analysisdefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,10 @@ API reference:
## Differences between versions

A preliminary release of the Keptn Analysis feature
is included in Keptn v.0.8.3 but is hidden behind a feature flag.
To preview these features, set the environment `ENABLE_ANALYSIS` to `true`
in the `metrics-operator` deployment.
is included in Keptn v0.8.3 and v0.9.0 but is hidden behind a feature flag.
See the
[Analysis](analysis.md/#differences-between-versions)
reference page for instructions to activate the preview of this feature.

## See also

Expand Down
9 changes: 5 additions & 4 deletions docs/content/en/docs/yaml-crd-ref/analysisvaluetemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,11 @@ API reference:

## Differences between versions

Keptn v0.8.3 includes a preliminary release of the Keptn Analysis feature
but is hidden behind a feature flag.
To preview these features, set the environment `ENABLE_ANALYSIS` to `true`
in the `metrics-operator` deployment.
A preliminary release of the Keptn Analysis feature
is included in Keptn v0.8.3 and v0.9.0 but is hidden behind a feature flag.
See the
[Analysis](analysis.md/#differences-between-versions)
reference page for instructions to activate the preview of this feature.

## See also

Expand Down

0 comments on commit a6e6a60

Please sign in to comment.