From 2316740f6d48e2f6e44fd218e13f9b8601b58825 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 18 Oct 2023 03:43:19 -0700 Subject: [PATCH 1/4] docs: more comments for tasks-non-k8s-apps Signed-off-by: Meg McRoberts --- .../en/docs/implementing/tasks-non-k8s-apps.md | 13 +++++++------ docs/content/en/docs/yaml-crd-ref/task.md | 10 +++++----- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/content/en/docs/implementing/tasks-non-k8s-apps.md b/docs/content/en/docs/implementing/tasks-non-k8s-apps.md index 4337150611..184f8f6b64 100644 --- a/docs/content/en/docs/implementing/tasks-non-k8s-apps.md +++ b/docs/content/en/docs/implementing/tasks-non-k8s-apps.md @@ -4,21 +4,22 @@ 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 enable a Kubernetes cluster and [install](../install/install.md/#use-helm-chart) Keptn on a Kubernetes cluster, but this can be a very lightweight, single-node KinD cluster; see @@ -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 @@ -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 diff --git a/docs/content/en/docs/yaml-crd-ref/task.md b/docs/content/en/docs/yaml-crd-ref/task.md index ced30b39fd..34ea160397 100644 --- a/docs/content/en/docs/yaml-crd-ref/task.md +++ b/docs/content/en/docs/yaml-crd-ref/task.md @@ -4,12 +4,12 @@ description: Define a run of a KeptnTaskDefinition weight: 85 --- -When using Keptn to run tasks for software +Keptn automatically populates the `KeptnTask` resource +for tasks that deploy software on Kubernetes. +However, 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. ## Synopsis @@ -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. From e206c13518f991ea00236e670d7f3d65e2dbd0a0 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 18 Oct 2023 04:07:36 -0700 Subject: [PATCH 2/4] Update docs/content/en/docs/implementing/tasks-non-k8s-apps.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Signed-off-by: Meg McRoberts --- docs/content/en/docs/implementing/tasks-non-k8s-apps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/implementing/tasks-non-k8s-apps.md b/docs/content/en/docs/implementing/tasks-non-k8s-apps.md index 184f8f6b64..6218d123df 100644 --- a/docs/content/en/docs/implementing/tasks-non-k8s-apps.md +++ b/docs/content/en/docs/implementing/tasks-non-k8s-apps.md @@ -21,7 +21,7 @@ To do this: You must enable 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 From bc5bcacc18de5f7d6eec88a8a7d44fafe1c801a6 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Mon, 23 Oct 2023 05:24:11 -0700 Subject: [PATCH 3/4] improve intro to task.md ref page Signed-off-by: Meg McRoberts --- docs/content/en/docs/yaml-crd-ref/task.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/content/en/docs/yaml-crd-ref/task.md b/docs/content/en/docs/yaml-crd-ref/task.md index 34ea160397..4b052b5e18 100644 --- a/docs/content/en/docs/yaml-crd-ref/task.md +++ b/docs/content/en/docs/yaml-crd-ref/task.md @@ -4,12 +4,12 @@ description: Define a run of a KeptnTaskDefinition weight: 85 --- -Keptn automatically populates the `KeptnTask` resource -for tasks that deploy software on Kubernetes. -However, 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 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 From 052f943f7a4aaa66da1fa5087765114a4f56de96 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 24 Oct 2023 04:53:38 -0700 Subject: [PATCH 4/4] Update docs/content/en/docs/implementing/tasks-non-k8s-apps.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Signed-off-by: Meg McRoberts --- docs/content/en/docs/implementing/tasks-non-k8s-apps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/implementing/tasks-non-k8s-apps.md b/docs/content/en/docs/implementing/tasks-non-k8s-apps.md index 6218d123df..65a4bf65e4 100644 --- a/docs/content/en/docs/implementing/tasks-non-k8s-apps.md +++ b/docs/content/en/docs/implementing/tasks-non-k8s-apps.md @@ -19,7 +19,7 @@ To do this: ## Install Keptn on a Kubernetes cluster -You must enable a Kubernetes cluster and +You must set up a Kubernetes cluster and [install](../install/install.md/#use-helm-chart) Keptn on it, but this can be a very lightweight, single-node KinD cluster; see