Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: content for KeptnTaskDefinition ref and tasks guide #1392

Merged
merged 35 commits into from
May 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
6d9ad45
markdownlint-fix
StackScribe May 9, 2023
26215e6
fix xref
StackScribe May 10, 2023
2a4e327
fix xref
StackScribe May 10, 2023
806b0c3
Update docs/content/en/docs/yaml-crd-ref/taskdefinition.md
StackScribe May 16, 2023
29b6a97
Update docs/content/en/docs/yaml-crd-ref/taskdefinition.md
StackScribe May 17, 2023
0254a84
Flo/Ondrej comments, move stuff from taskdefinition ref page
StackScribe May 17, 2023
29bef8f
fix xref
StackScribe May 17, 2023
19f5205
Merge branch 'main' into 0509-taskref
StackScribe May 17, 2023
9adaf8b
Merge branch 'main' into 0509-taskref
StackScribe May 17, 2023
8fb9ba2
Merge branch 'main' into 0509-taskref
StackScribe May 17, 2023
8c8b359
polishing
StackScribe May 17, 2023
a89cbdd
Merge branch '0509-taskref' of github.com:StackScribe/lifecycle-toolk…
StackScribe May 17, 2023
e7786bb
Update docs/content/en/docs/concepts/workloads/_index.md
StackScribe May 19, 2023
2be83fa
Update docs/content/en/docs/concepts/workloads/_index.md
StackScribe May 19, 2023
8e3880c
Update docs/content/en/docs/yaml-crd-ref/taskdefinition.md
StackScribe May 19, 2023
306128c
KeptnWorkload
StackScribe May 19, 2023
8ddf427
Update _index.md
StackScribe May 19, 2023
e971b12
Update _index.md
StackScribe May 19, 2023
4ef5c2e
Update _index.mdSigned-off-by: Meg McRoberts meg.mcroberts@dynatrace.com
StackScribe May 19, 2023
7d1f872
Update taskdefinition.md
StackScribe May 19, 2023
648ab26
Update _index.md
StackScribe May 19, 2023
6bd8d7e
Update docs/content/en/docs/implementing/tasks/_index.md
StackScribe May 22, 2023
86efff5
Update docs/content/en/docs/yaml-crd-ref/taskdefinition.md
StackScribe May 22, 2023
1caf6d4
Update docs/content/en/docs/implementing/tasks/_index.md
StackScribe May 22, 2023
887e4e1
Update docs/content/en/docs/concepts/workloads/_index.md
StackScribe May 22, 2023
19231d9
Update docs/content/en/docs/concepts/workloads/_index.md
StackScribe May 22, 2023
316948a
Update docs/content/en/docs/implementing/tasks/_index.md
StackScribe May 22, 2023
58a1398
Update docs/content/en/docs/implementing/tasks/_index.md
StackScribe May 22, 2023
a25c72d
Update docs/content/en/docs/yaml-crd-ref/taskdefinition.md
StackScribe May 22, 2023
15775bd
Update docs/content/en/docs/concepts/workloads/_index.md
StackScribe May 22, 2023
c93ca56
Update docs/content/en/docs/concepts/workloads/_index.md
StackScribe May 22, 2023
73e74e1
Update taskdefinition.md
StackScribe May 22, 2023
bb2e42e
Update _index.md
StackScribe May 22, 2023
db3cdc2
clarify "More examples"
StackScribe May 22, 2023
da56752
markdownlint
StackScribe May 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
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.
Loading
Loading