Skip to content

Commit

Permalink
add infromation about non-blocking behavior to other places
Browse files Browse the repository at this point in the history
Signed-off-by: odubajDT <[email protected]>
  • Loading branch information
odubajDT committed Feb 27, 2024
1 parent a300e9c commit 2af20a1
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 6 deletions.
6 changes: 5 additions & 1 deletion docs/docs/getting-started/lifecycle-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/guides/evaluations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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,
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/installation/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 6 additions & 2 deletions docs/docs/reference/crd-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ spec:
OTelCollectorUrl: '<otelurl:port>'
keptnAppCreationRequestTimeoutSeconds: <#-seconds>
cloudEventsEndpoint: <endpoint>
blockDeployment: <bool>
blockDeployment: <true|false>
```
## Fields
Expand All @@ -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).

Expand Down

0 comments on commit 2af20a1

Please sign in to comment.