Skip to content

Commit

Permalink
docs: fix Synopsis for KeptnTask CRD reference page (#2945)
Browse files Browse the repository at this point in the history
  • Loading branch information
StackScribe authored Feb 5, 2024
1 parent f2f8c29 commit c72bde4
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions docs/docs/reference/crd-reference/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,15 @@ spec:
taskDefinition: <name-of-KeptnTaskDefinition resource>
context:
appName: "<name-of-KeptnApp-resource>"
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"
<custom-info1>: "<custom-info1-value>"
<custom-info2>: "<custom-info2-value>"
...
parameters: <parameters to pass to job>
secureParameters: <secure parameters to pass to job>
checkType: ""
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c72bde4

Please sign in to comment.