Skip to content

Commit

Permalink
docs: more comments for tasks-non-k8s-apps (#2293)
Browse files Browse the repository at this point in the history
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
  • Loading branch information
StackScribe committed Oct 24, 2023
1 parent ec11ffb commit 9f0e4aa
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
15 changes: 8 additions & 7 deletions docs/content/en/docs/implementing/tasks-non-k8s-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,24 @@ description: Using Keptn with Non-Kubernetes Applications
weight: 95
---

Keptn Tasks can be triggered for workloads and applications
Keptn Tasks running on a Kubernetes cluster
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.

To do this:

1. [Install and enable a Kubernetes cluster](#install-and-enable-a-kubernetes-cluster)
1. [Install Keptn on a Kubernetes cluster](#install-keptn-on-a-kubernetes-cluster)
1. [Create a KeptnTaskDefinition](#create-a-keptntaskdefinition)
1. [Create and apply a KeptnTask](#create-and-apply-a-keptntask)
1. [Re-run the KeptnTask](#re-run-the-keptntask)

## Install and enable a Kubernetes cluster
## Install Keptn on a Kubernetes cluster

You must still
You must set up a Kubernetes cluster and
[install](../install/install.md/#use-helm-chart)
Keptn on a Kubernetes cluster,
Keptn on it,
but this can be a very lightweight, single-node KinD cluster; see
[Create local Kubernetes cluster](../install/k8s.md/#create-local-kubernetes-cluster).
Keptn only triggers on-demand `KeptnTask` resources
Expand All @@ -30,7 +31,7 @@ so resource utilization is minimal.

When you have Keptn installed, create a
YAML file that defines what you want to execute
as a `KeptnTaskDefinition` resource..
as a `KeptnTaskDefinition` resource.
See
[Deployment tasks](../implementing/tasks/)
and the
Expand Down Expand Up @@ -69,7 +70,7 @@ In the standard operating mode, when Keptn is managing workloads,
the creation of the `KeptnTask` resource is automatic.

Moreover, each time you want to execute a `KeptnTask`,
you must manually create a a new (and uniquely named) `KeptnTask` resource.
you must manually create a new (and uniquely named) `KeptnTask` resource.

The `KeptnTask` resource references the `KeptnTaskDefinition`
that you created above
Expand Down
16 changes: 8 additions & 8 deletions docs/content/en/docs/yaml-crd-ref/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ description: Define a run of a KeptnTaskDefinition
weight: 85
---

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.
Keptn uses KeptnTask resources internally
to manage tasks (and their underlying Kubernetes Job resources)
that are run before and after deployment of your workloads
(pre- and post-deployment tasks).
You do not need to create this resource yourself except in special situations,
like using Keptn to manage workloads that are outside of the k8s cluster.

## Synopsis

Expand Down Expand Up @@ -37,9 +37,9 @@ spec:
## Fields

* **apiVersion** -- API version being used.
`

* **kind** -- Resource type.
Must be set to `KeptnTask`
Must be set to `KeptnTask`

* **metadata**
* **name** -- Unique name of this run of the task.
Expand Down

0 comments on commit 9f0e4aa

Please sign in to comment.