Skip to content

Commit

Permalink
docs: add required labels to required CRD fields (KeptnApp, KeptnConf…
Browse files Browse the repository at this point in the history
…ig, KeptnEvaluationDefinition) (#2390)

Signed-off-by: odubajDT <ondrej.dubaj@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Co-authored-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
  • Loading branch information
3 people committed Oct 31, 2023
1 parent 92a5578 commit 5c7b0cd
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/content/en/docs/yaml-crd-ref/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ when the app discovery feature generates the `KeptnApp` resource:
specification.

- **spec**
- **version** -- version of the Keptn application.
- **version** (required) -- version of the Keptn application.
Changing this version number causes a new execution
of all application-level checks
- **revision** -- revision of a `version`.
Expand All @@ -72,12 +72,12 @@ when the app discovery feature generates the `KeptnApp` resource:
[Restart an Application Deployment](../implementing/restart-application-deployment/)
for a longer discussion of this.
- **workloads**
- **name** - name of this Kubernetes
- **name** (required) -- name of this Kubernetes
[workload](https://kubernetes.io/docs/concepts/workloads/).
Use the same naming rules listed above for the application name.
Provide one entry for each [workload](https://kubernetes.io/docs/concepts/workloads/)
associated with this Keptn application.
- **version** -- version number for this [workload](https://kubernetes.io/docs/concepts/workloads/).
- **version** (required) -- version number for this [workload](https://kubernetes.io/docs/concepts/workloads/).
Changing this number causes a new execution
of checks for this [workload](https://kubernetes.io/docs/concepts/workloads/) only,
not the entire application.
Expand Down
6 changes: 5 additions & 1 deletion docs/content/en/docs/yaml-crd-ref/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ metadata:
spec:
OTelCollectorUrl: '<otelurl:port>'
keptnAppCreationRequestTimeoutSeconds: <#-seconds>
cloudEventsEndpoint: <endpoint>
```

## Fields
Expand All @@ -35,9 +36,11 @@ spec:
This field must be populated
in order to export traces to the OpenTelemetry Collector.
* **keptnAppCreationRequestTimeoutSeconds** --
interval in which automatic app discovery searches for [workloads](https://kubernetes.io/docs/concepts/workloads/)
Interval in which automatic app discovery searches for [workloads](https://kubernetes.io/docs/concepts/workloads/)
to put into the same auto-generated [KeptnApp](app.md).
The default value is 30 (seconds).
* **cloudEventsEndpoint** --
Endpoint where the lifecycle operator posts Cloud Events.

## Usage

Expand All @@ -59,6 +62,7 @@ metadata:
spec:
OTelCollectorUrl: 'otel-collector:4317'
keptnAppCreationRequestTimeoutSeconds: 40
cloudEventsEndpoint: 'http://endpoint.com'
```

## Files
Expand Down
16 changes: 11 additions & 5 deletions docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,20 @@ spec:

* **spec**

* **objectives** -- define the evaluations to be performed.
* **objectives** (required) -- define the evaluations to be performed.
Each objective is expressed as a `keptnMetricRef`
and an `evaluationTarget` value.

* **KeptnMetricRef** -- A reference to the
[KeptnMetric](metric.md) object that contains the value,
identified by `name` and `namespace`
* **evaluationTarget** -- Desired value of the query,
* **keptnMetricRef** (required) -- A reference to the
[KeptnMetric](metric.md) object

* **name** (required) -- Name of the referenced
[KeptnMetric](metric.md) object

* **namespace** -- Name of the referenced
[KeptnMetric](metric.md) object

* **evaluationTarget** (required) -- Desired value of the query,
expressed as an arithmetic formula,
usually less than (`<`) or greater than (`>`)
This is used to define success or failure criteria
Expand Down

0 comments on commit 5c7b0cd

Please sign in to comment.