diff --git a/docs/docs/reference/crd-reference/task.md b/docs/docs/reference/crd-reference/task.md index 0085889dd5..70fffaab69 100644 --- a/docs/docs/reference/crd-reference/task.md +++ b/docs/docs/reference/crd-reference/task.md @@ -22,13 +22,15 @@ spec: taskDefinition: context: appName: "" - appVersion: "1.0.0" + appVersion: "KeptnApp-version" objectType: "" taskType: "" - workloadName: "my-workload" - workloadVersion: "1.0.0" + workloadName: "name-of-KeptnWorkload resource"" + workloadVersion: "version-of-KeptnWorkload resource" metadata: - commit-id: "1234" + : "" + : "" + ... parameters: secureParameters: checkType: "" @@ -60,10 +62,22 @@ spec: * **appVersion** (required) -- Version of the `KeptnApp` resource for which the `KeptnTask` is being executed. * **metadata** -- Additional key-value pairs with contextual information for the `KeptnTask`. - Keptn populates this field based on the `spec.metadata` field of - the `KeptnWorkloadVersion` and `KeptnAppVersion` resources. - See [Context metadata](../../guides/metadata.md) for information on how to set - user defined values for those fields. + Keptn populates this field based on the `spec.metadata` field of the + [KeptnWorkloadVersion](../api-reference/lifecycle/v1beta1/index.md#keptnworkloadversion) + and + [KeptnAppVersion](../api-reference/lifecycle/v1beta1/index.md#keptnappversion) + resources. + + For example, the following lines reference the commit ID and user ID: + + ```yaml + commit-id: "1234" + user-id: "person3" + ``` + + See [Context metadata](../../guides/metadata.md) + for information about setting user defined values for those fields. + * **objectType** (required) -- Indicates whether this `KeptnTask` is being executed for a `KeptnApp` or a `KeptnWorkload` resource. When populating this resource manually