From 2af20a182fb2ee8b8461e5af6ebaf56475472a1f Mon Sep 17 00:00:00 2001 From: odubajDT Date: Tue, 27 Feb 2024 09:52:33 +0100 Subject: [PATCH] add infromation about non-blocking behavior to other places Signed-off-by: odubajDT --- docs/docs/getting-started/lifecycle-management.md | 6 +++++- docs/docs/guides/evaluations.md | 6 +++--- docs/docs/installation/troubleshooting.md | 9 +++++++++ docs/docs/reference/crd-reference/config.md | 8 ++++++-- 4 files changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/docs/getting-started/lifecycle-management.md b/docs/docs/getting-started/lifecycle-management.md index d36ae24cba..b848493a8d 100644 --- a/docs/docs/getting-started/lifecycle-management.md +++ b/docs/docs/getting-started/lifecycle-management.md @@ -184,7 +184,7 @@ Here is a full version of the new YAML: Keptn Tasks can also be executed pre-deployment (before the Pods are scheduled). Do this by using the `keptn.sh/pre-deployment-tasks` label or annotation. -> Note: If a pre-deployment task fails, the `Pod` remains in a Pending state. +> Note: If a pre-deployment task fails, by default, the `Pod` remains in a Pending state. ## More control over the application @@ -234,6 +234,10 @@ See the [Deployment tasks](../guides/tasks.md) page to find out more. +To learn more about the non-blocking deployment functionality +please see the +[Keptn non-blocking deployment section](./keptn-non-blocking.md). + ## What's next? Keptn can also run simple pre- and post-deployment SLO evaluations. diff --git a/docs/docs/guides/evaluations.md b/docs/docs/guides/evaluations.md index a4d00252d8..9f14131b3c 100644 --- a/docs/docs/guides/evaluations.md +++ b/docs/docs/guides/evaluations.md @@ -10,7 +10,7 @@ or "Is my remote database accessible?" or check for other problems in your infrastructure. It can be defined to run before or after your software is deployed. -When an evaluation is run pre-deployment, +When a pre-deployment evaluation is run, by default, the deployment is kept in a pending state until the evaluation passes with a successful result. @@ -101,8 +101,8 @@ Note the following: that are required for the deployment. - The `KeptnMetric` resources that are referenced in a `KeptnEvaluationDefinition` resource - - can be defined on different namespaces in the cluster - - can query different instances of different types of metric providers + - can be defined on different namespaces in the cluster + - can query different instances of different types of metric providers - All objectives within a `KeptnEvaluationDefinition` resource are evaluated in order. If the evaluation of any objective fails, diff --git a/docs/docs/installation/troubleshooting.md b/docs/docs/installation/troubleshooting.md index cccc27712b..7180f80bd6 100644 --- a/docs/docs/installation/troubleshooting.md +++ b/docs/docs/installation/troubleshooting.md @@ -40,6 +40,15 @@ kubectl -n prod get pods kubectl -n prod logs job/... ``` +> **Note** +This blocking behavior can be changed by enabling the non-blocking +deployment functionality by populating a +[KeptnConfig](../../reference/crd-reference/config.md) resource and +setting the `.spec.blockDeployment` parameter to `false`. +More about the non-blocking deployment functionality +can be found in the +[Keptn non-blocking deployment section](./keptn-non-blocking.md). + ## I have pending Pods after Keptn is uninstalled > **Note** This section particularly affects clusters managed by ArgoCD. diff --git a/docs/docs/reference/crd-reference/config.md b/docs/docs/reference/crd-reference/config.md index 9e1cb0b889..e713a85180 100644 --- a/docs/docs/reference/crd-reference/config.md +++ b/docs/docs/reference/crd-reference/config.md @@ -17,7 +17,7 @@ spec: OTelCollectorUrl: '' keptnAppCreationRequestTimeoutSeconds: <#-seconds> cloudEventsEndpoint: - blockDeployment: + blockDeployment: ``` ## Fields @@ -40,8 +40,12 @@ spec: 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. - * **blockDeployment** -- An option used to block the deployment of the application until the + * **blockDeployment** -- If set to `true` (default), application deployment is blocked until the pre-deployment tasks and evaluations succeed. + You can set this field to `false` when building up + your pre-deployment tasks and evaluations + so that your application is deployed + even if the pre-deployment tasks and/or evaluations fail. For more information see the [non-blocking deployment section](../../components/lifecycle-operator/keptn-non-blocking.md).