Skip to content

Commit

Permalink
docs: content for KeptnTaskDefinition ref and tasks guide (#1392)
Browse files Browse the repository at this point in the history
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
  • Loading branch information
4 people committed May 22, 2023
1 parent f0f7edf commit 13b0495
Show file tree
Hide file tree
Showing 5 changed files with 524 additions and 308 deletions.
177 changes: 0 additions & 177 deletions docs/content/en/docs/concepts/tasks/_index.md

This file was deleted.

44 changes: 28 additions & 16 deletions docs/content/en/docs/concepts/workloads/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,33 @@ weight: 10
hidechildren: true # this flag hides all sub-pages in the sidebar-multicard.html
---

A Workload contains information about which tasks should be performed during the `preDeployment` as well as
the `postDeployment`
phase of a deployment.
In its state it keeps track of the currently active `Workload Instances`, which are responsible
for doing those checks for
a particular instance of a Deployment/StatefulSet/ReplicaSet (e.g. a Deployment of a certain version).
A `KeptnWorkload`resource contains information about
which tasks should be performed during the `preDeployment`
or `postDeployment` phase of a deployment.
In its state,
it keeps track of the currently active `Workload Instances`,
which are responsible for doing those checks
for a particular instance of a Deployment/StatefulSet/ReplicaSet
(e.g. a Deployment of a certain version).

### Keptn Workload Instance
## KeptnWorkload

A Workload Instance is responsible for executing the pre- and post deployment checks of a workload.
In its state, it
keeps track of the current status of all checks, as well as the overall state of
the Pre Deployment phase, which can be used by the scheduler to tell that a pod can be allowed to be placed on a node.
Workload Instances have a reference to the respective Deployment/StatefulSet/ReplicaSet, to check if it has reached the
desired state.
If it detects that the referenced object has reached
its desired state (e.g. all pods of a deployment are up and running), it will be able to tell that
a `PostDeploymentCheck` can be triggered.
A `KeptnWorkload` resource augments a Kubernetes
[Workload](https://kubernetes.io/docs/concepts/workloads/)
with the ability to handle extra phases.
KLT generates the `KeptnWorkload` resource
from metadata information;
it is not necessary to manually create a YAML file that defines it.

A `KeptnWorkload` instance is responsible for executing
the pre- and post deployment checks of a workload.
In its state, it keeps track of the current status of all checks,
as well as the overall state of the Pre Deployment phase,
which the scheduler can use to determine
whether the deployment should proceed.
`KeptnWorkload` instances refer
to the respective Pod/DeamonSet/StatefulSet/ReplicaSet,
to check whether it has reached the desired state.
If it detects that the referenced object has reached its desired state
(e.g. all pods of a deployment are up and running),
it knows that a `PostDeploymentCheck` can be triggered.

0 comments on commit 13b0495

Please sign in to comment.