docs: add KeptnTask ref page; enhance guide chapter for keptn-no-k8s #2103

StackScribe · 2023-09-15T04:38:11Z

This PR and #2089 replace #2086 .

This PR:

Expands the content of the "Keptn for non-Kubernetes Applications" guide chapter a bit.
Creates a reference page for KeptnTask in the yaml-crd-ref section. Normally, KeptnTask is generated automatically but, in this case, the user must populate and maintain it manually so we need to document the YAML syntax.
The reference page no longer has an example but instead links to the guide chapter. We do not need to be maintaining two examples and, in this case, it makes more sense to have the KeptnTask example presented in the context of running a KeptnTask for a non-k8s deployment.

28 September review notes:

The initial draft was based on outdated API info. That has been corrected.
Please verify that I got the descriptions of the fields correct on the reference page. I improved a bit.
I think some steps are missing from the guide procedure:
- When I apply my KeptnTask resource from my KinD cluster, how does it know which VM/whatever to target?
- Instructions say nothing about populating KeptnApp or workload resources yet the KeptnTask yaml file does have fields for these. How does the user know what value to use for those fields? Or maybe some of these fields are ignored in this case? We need to clarify this.
- What about KeptnTask fields (such as timeout) that are also in KeptnTaskDefintion? If the user uses these, do they need to be sure that KeptnTask and the corresponding KeptnTaskDefinition assign the same value to that field or does Keptn reconcile them or does one of them take precedence over the other?

Signed-off-by: Meg McRoberts <[email protected]>

netlify · 2023-09-15T04:38:50Z

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name	Link
🔨 Latest commit	`9b4c76a`
🔍 Latest deploy log	https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/652e5bc9fbd79d000805be7a
😎 Deploy Preview	https://deploy-preview-2103--keptn-lifecycle-toolkit.netlify.app/docs/yaml-crd-ref/task
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Meg McRoberts <[email protected]>

docs/content/en/docs/implementing/tasks-non-k8s-apps.md

docs/content/en/docs/yaml-crd-ref/task.md

Signed-off-by: Meg McRoberts <[email protected]>

docs/content/en/docs/implementing/tasks-non-k8s-apps.md

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: RealAnna <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Signed-off-by: Meg McRoberts <[email protected]>

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Signed-off-by: Meg McRoberts <[email protected]>

docs/content/en/docs/implementing/tasks-non-k8s-apps.md

Signed-off-by: Meg McRoberts <[email protected]>

docs/content/en/docs/implementing/tasks-non-k8s-apps.md

docs/content/en/docs/yaml-crd-ref/task.md

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

sonarcloud · 2023-10-17T10:03:11Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

docs/content/en/docs/implementing/tasks-non-k8s-apps.md

mowies · 2023-10-18T06:59:26Z

docs/content/en/docs/implementing/tasks-non-k8s-apps.md

+Keptn Tasks can be triggered for workloads and applications
+that are deployed outside of Kubernetes.
+For example, Keptn could trigger load and performance tests
+for an application that is deployed on a virtual machine.


I would add a sentence here to underline the fact that keptn still needs to be installed on a k8s cluster. I think that would make the general scenario a little easier to understand.

I made it "Keptn Tasks running on a Kubernetes cluster..." and some other adjustments to make this more explicit.

mowies · 2023-10-18T07:53:54Z

docs/content/en/docs/implementing/tasks-non-k8s-apps.md

-For example:
+When you have Keptn installed, create a
+YAML file that defines what you want to execute
+as a `KeptnTaskDefinition` resource..


Suggested change

as a `KeptnTaskDefinition` resource..

as a `KeptnTaskDefinition` resource.

mowies · 2023-10-18T07:54:33Z

docs/content/en/docs/implementing/tasks-non-k8s-apps.md


-Here though, we must create it ourselves.
+Moreover, each time you want to execute a `KeptnTask`,
+you must manually create a a new (and uniquely named) `KeptnTask` resource.


Suggested change

you must manually create a a new (and uniquely named) `KeptnTask` resource.

you must manually create a new (and uniquely named) `KeptnTask` resource.

mowies · 2023-10-18T07:56:51Z

docs/content/en/docs/yaml-crd-ref/task.md

+When using Keptn to run tasks for software
+that is deployed outside of Kubernetes,
+you must create the `KeptnTask` resource manually
+and modify it manually for each new run.
+Keptn automatically populates the `KeptnTask` resource
+for tasks that deploy software on Kubernetes.


I would switch this paragraph around so that it first tells users the "happy path" which is that they don't need to anything manually with KeptnTasks. And then afterwards, I would add the info about handling apps outside of k8s.

mowies · 2023-10-18T07:57:49Z

docs/content/en/docs/yaml-crd-ref/task.md

+* **apiVersion** -- API version being used.
+`
+* **kind** -- Resource type.
+   Must be set to `KeptnTask`


Suggested change

Must be set to `KeptnTask`

Must be set to `KeptnTask`

mowies · 2023-10-18T07:59:26Z

docs/content/en/docs/yaml-crd-ref/task.md

+## Fields
+
+* **apiVersion** -- API version being used.
+`


Suggested change

`

StackScribe · 2023-10-18T10:47:39Z

Some comments came in after this PR was merged. These are applied in #2293 .

docs: KeptnTask ref page; enhance guide chap for keptn-no-k8s

76b6a97

Signed-off-by: Meg McRoberts <[email protected]>

StackScribe added the documentation Improvements or additions to documentation label Sep 15, 2023

StackScribe added this to the 0.9 milestone Sep 15, 2023

StackScribe self-assigned this Sep 15, 2023

StackScribe requested review from a team as code owners September 15, 2023 04:38

StackScribe mentioned this pull request Sep 15, 2023

docs: move/expand "Keptn for Non-Kubernetes applications" #2086

Closed

StackScribe added 2 commits September 14, 2023 21:42

markdownlint-fix

180a242

Signed-off-by: Meg McRoberts <[email protected]>

xrefs

bc597a8

Signed-off-by: Meg McRoberts <[email protected]>

StackScribe changed the title ~~docs: KeptnTask ref page; enhance guide chap for keptn-no-k8s~~ docs: add KeptnTask ref page; enhance guide chap for keptn-no-k8s Sep 15, 2023

StackScribe added 4 commits September 14, 2023 22:58

another xref

4cac4a0

Signed-off-by: Meg McRoberts <[email protected]>

more xrefs

f25c8b7

Signed-off-by: Meg McRoberts <[email protected]>

xref

2855565

Signed-off-by: Meg McRoberts <[email protected]>

small typo

c153b6d

Signed-off-by: Meg McRoberts <[email protected]>

agardnerIT requested changes Sep 21, 2023

View reviewed changes

adam comment

0b7b6e0

Signed-off-by: Meg McRoberts <[email protected]>

StackScribe marked this pull request as draft September 26, 2023 07:35

updates

2ec4aea

Signed-off-by: Meg McRoberts <[email protected]>

mowies changed the title ~~docs: add KeptnTask ref page; enhance guide chap for keptn-no-k8s~~ docs: add KeptnTask ref page; enhance guide chapter for keptn-no-k8s Sep 26, 2023

reconcile guide and ref page with new API syntax

fb1181b

Signed-off-by: Meg McRoberts <[email protected]>

StackScribe marked this pull request as ready for review September 28, 2023 08:04

xref error

78d2e5c

Signed-off-by: Meg McRoberts <[email protected]>

RealAnna reviewed Sep 28, 2023

View reviewed changes

docs/content/en/docs/implementing/tasks-non-k8s-apps.md Outdated Show resolved Hide resolved

RealAnna reviewed Sep 28, 2023

View reviewed changes

docs/content/en/docs/implementing/tasks-non-k8s-apps.md Outdated Show resolved Hide resolved

StackScribe and others added 5 commits September 29, 2023 00:44

Update docs/content/en/docs/implementing/tasks-non-k8s-apps.md

f6754db

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: RealAnna <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Update docs/content/en/docs/implementing/tasks-non-k8s-apps.md

6483ce6

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: RealAnna <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

trivial change to force rebuild

3dc3b69

Signed-off-by: Meg McRoberts <[email protected]>

markdownlint-fix

e03d368

Signed-off-by: Meg McRoberts <[email protected]>

remove TODO's

39a144f

Signed-off-by: Meg McRoberts <[email protected]>

StackScribe and others added 6 commits October 15, 2023 17:41

Update docs/content/en/docs/yaml-crd-ref/task.md

2b0a44c

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Update docs/content/en/docs/yaml-crd-ref/task.md

32f9921

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Update docs/content/en/docs/yaml-crd-ref/task.md

3fcedc5

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Update docs/content/en/docs/yaml-crd-ref/task.md

e46996b

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Update docs/content/en/docs/implementing/tasks-non-k8s-apps.md

45aae5d

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

xref for runners

2796c7e

Signed-off-by: Meg McRoberts <[email protected]>

agardnerIT previously approved these changes Oct 16, 2023

View reviewed changes

bacherfl reviewed Oct 16, 2023

View reviewed changes

docs/content/en/docs/implementing/tasks-non-k8s-apps.md Outdated Show resolved Hide resolved

no need to enable Keptn for non-k8s tasks

63bf6ac

Signed-off-by: Meg McRoberts <[email protected]>

StackScribe dismissed agardnerIT’s stale review via 63bf6ac October 16, 2023 08:45

StackScribe requested a review from bacherfl October 16, 2023 09:00

bacherfl previously approved these changes Oct 16, 2023

View reviewed changes

odubajDT reviewed Oct 17, 2023

View reviewed changes

docs/content/en/docs/implementing/tasks-non-k8s-apps.md Outdated Show resolved Hide resolved

odubajDT reviewed Oct 17, 2023

View reviewed changes

docs/content/en/docs/yaml-crd-ref/task.md Outdated Show resolved Hide resolved

odubajDT reviewed Oct 17, 2023

View reviewed changes

docs/content/en/docs/yaml-crd-ref/task.md Outdated Show resolved Hide resolved

StackScribe dismissed bacherfl’s stale review via 81c6578 October 17, 2023 10:01

StackScribe and others added 3 commits October 17, 2023 03:01

Update docs/content/en/docs/implementing/tasks-non-k8s-apps.md

81c6578

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Update docs/content/en/docs/yaml-crd-ref/task.md

ee99e23

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

Update docs/content/en/docs/yaml-crd-ref/task.md

9b4c76a

Signed-off-by: Meg McRoberts [email protected] Co-authored-by: odubajDT <[email protected]> Signed-off-by: Meg McRoberts <[email protected]>

odubajDT approved these changes Oct 17, 2023

View reviewed changes

RealAnna reviewed Oct 17, 2023

View reviewed changes

docs/content/en/docs/implementing/tasks-non-k8s-apps.md Show resolved Hide resolved

RealAnna approved these changes Oct 18, 2023

View reviewed changes

RealAnna merged commit 066be3e into keptn:main Oct 18, 2023
17 checks passed

keptn-bot mentioned this pull request Oct 18, 2023

chore: release klt 0.9.0 #2056

Merged

mowies reviewed Oct 18, 2023

View reviewed changes

StackScribe mentioned this pull request Oct 18, 2023

docs: more comments for tasks-non-k8s-apps #2293

Merged

StackScribe deleted the 0914-non-k8s-apps branch October 18, 2023 11:05

keptn-bot mentioned this pull request Jan 23, 2024

chore: release keptn 0.10.0 #2563

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add KeptnTask ref page; enhance guide chapter for keptn-no-k8s #2103

docs: add KeptnTask ref page; enhance guide chapter for keptn-no-k8s #2103

StackScribe commented Sep 15, 2023 •

edited

Loading

netlify bot commented Sep 15, 2023 •

edited

Loading

sonarcloud bot commented Oct 17, 2023

mowies Oct 18, 2023

StackScribe Oct 18, 2023

mowies Oct 18, 2023

StackScribe Oct 18, 2023

mowies Oct 18, 2023

StackScribe Oct 18, 2023

mowies Oct 18, 2023

StackScribe Oct 18, 2023

mowies Oct 18, 2023

StackScribe Oct 18, 2023

mowies Oct 18, 2023

StackScribe Oct 18, 2023

StackScribe commented Oct 18, 2023

	as a `KeptnTaskDefinition` resource..
	as a `KeptnTaskDefinition` resource.

	you must manually create a a new (and uniquely named) `KeptnTask` resource.
	you must manually create a new (and uniquely named) `KeptnTask` resource.

docs: add KeptnTask ref page; enhance guide chapter for keptn-no-k8s #2103

docs: add KeptnTask ref page; enhance guide chapter for keptn-no-k8s #2103

Conversation

StackScribe commented Sep 15, 2023 • edited Loading

netlify bot commented Sep 15, 2023 • edited Loading

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

sonarcloud bot commented Oct 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StackScribe commented Oct 18, 2023

StackScribe commented Sep 15, 2023 •

edited

Loading

netlify bot commented Sep 15, 2023 •

edited

Loading