diff --git a/docs/content/en/docs/yaml-crd-ref/app.md b/docs/content/en/docs/yaml-crd-ref/app.md index bfbf662222..632203c50d 100644 --- a/docs/content/en/docs/yaml-crd-ref/app.md +++ b/docs/content/en/docs/yaml-crd-ref/app.md @@ -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`. @@ -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. diff --git a/docs/content/en/docs/yaml-crd-ref/config.md b/docs/content/en/docs/yaml-crd-ref/config.md index 9fea394fab..d3b722ca22 100644 --- a/docs/content/en/docs/yaml-crd-ref/config.md +++ b/docs/content/en/docs/yaml-crd-ref/config.md @@ -16,6 +16,7 @@ metadata: spec: OTelCollectorUrl: '' keptnAppCreationRequestTimeoutSeconds: <#-seconds> + cloudEventsEndpoint: ``` ## Fields @@ -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 @@ -59,6 +62,7 @@ metadata: spec: OTelCollectorUrl: 'otel-collector:4317' keptnAppCreationRequestTimeoutSeconds: 40 + cloudEventsEndpoint: 'http://endpoint.com' ``` ## Files diff --git a/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md b/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md index cd09379f2e..69e0099218 100644 --- a/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md +++ b/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md @@ -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