From e35b110bd53c3cd61127086ee90b813cbf0cf70e Mon Sep 17 00:00:00 2001 From: Moritz Wiesinger Date: Tue, 31 Oct 2023 14:18:41 +0100 Subject: [PATCH] add required labels to keptn task and metrics provider Signed-off-by: Moritz Wiesinger --- .../en/docs/yaml-crd-ref/metricsprovider.md | 4 ++-- docs/content/en/docs/yaml-crd-ref/task.md | 24 +++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/content/en/docs/yaml-crd-ref/metricsprovider.md b/docs/content/en/docs/yaml-crd-ref/metricsprovider.md index add79364c5..4493814d55 100644 --- a/docs/content/en/docs/yaml-crd-ref/metricsprovider.md +++ b/docs/content/en/docs/yaml-crd-ref/metricsprovider.md @@ -60,8 +60,8 @@ spec: * **spec** - * **type** -- The type of data provider for this instance - * **targetServer** -- URL of the data provider, enclosed in double quotes + * **type** (required) -- The type of data provider for this instance + * **targetServer** (required) -- URL of the data provider, enclosed in double quotes * **secretKeyRef** * **name:** -- Name of the token for this data provider * **key:** -- Key for this data provider diff --git a/docs/content/en/docs/yaml-crd-ref/task.md b/docs/content/en/docs/yaml-crd-ref/task.md index 4b052b5e18..b615ddc979 100644 --- a/docs/content/en/docs/yaml-crd-ref/task.md +++ b/docs/content/en/docs/yaml-crd-ref/task.md @@ -50,17 +50,17 @@ spec: [Kubernetes Object Names and IDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) specification. * **spec** - Defines the speficication of this `KeptnTask` resource - * **taskDefinition** - Name of the corresponding `KeptnTaskDefinition` resource. + * **taskDefinition** (required) -- Name of the corresponding `KeptnTaskDefinition` resource. This `KeptnTaskDefinition` can be located in the same namespace or in the Keptn installation namespace. - * **context** - Contextual information about the task execution - * **appName** - Name of the + * **context** (required) -- Contextual information about the task execution + * **appName** (required) -- Name of the [KeptnApp](../yaml-crd-ref/app.md) resource for which the `KeptnTask` is being executed. - * **appVersion** - Version of the `KeptnApp` resource + * **appVersion** (required) -- Version of the `KeptnApp` resource for which the `KeptnTask` is being executed. - * **objectType** - Indicates whether this `KeptnTask` + * **objectType** (required) -- Indicates whether this `KeptnTask` is being executed for a `KeptnApp` or a `KeptnWorkload` resource. When populating this resource manually to run a task for a non-Kubernetes deployment, @@ -68,7 +68,7 @@ spec: Keptn populates this field based on annotations to the `KeptnWorkload` and `KeptnApp` resources. - * **taskType** Indicates whether this `KeptnTask` + * **taskType** (required) -- Indicates whether this `KeptnTask` is part of the pre- or post-deployment phase. When populating this resource manually to run a task for a non-Kubernetes deployment, @@ -76,13 +76,13 @@ spec: Keptn populates this field based on annotations to the `KeptnWorkload` and `KeptnApp` resources. - * **workloadName** - Name of the `KeptnWorkload` + * **workloadName** (required) -- Name of the `KeptnWorkload` for which the `KeptnTask` is being executed. - * **workloadVersion** - Version of the `KeptnWorkload` + * **workloadVersion** (required) -- Version of the `KeptnWorkload` for which the `KeptnTask` is being executed. - * **parameters** (optional) -- Parameters that are passed to the job + * **parameters** -- Parameters that are passed to the job that executes the `KeptnTask`. - * **secureParameters** (optional) -- Secure parameters that are passed + * **secureParameters** -- Secure parameters that are passed to the job that executes the `KeptnTask`. These are stored and accessed as Kubernetes `Secrets` in the cluster. See [Working with secrets](../implementing/tasks/#working-with-secrets) @@ -90,10 +90,10 @@ spec: * **checkType** -- Defines whether task is part of pre- or post-deployment phase. Keptn populates this field based on annotations to the `KeptnWorkload` and `KeptnApp` resources. - * **retries** (optional) -- If errors occur, + * **retries** -- If errors occur, this defines the number of attempts made before the `KeptnTask` is considered to be failed. - * **timeout** (optional) -- Specifies the time, in seconds, + * **timeout** -- Specifies the time, in seconds, to wait for the `KeptnTask` to complete successfully. If the `KeptnTask` does not complete successfully in this timeframe, it is considered to be failed.