From 4832f94a4dd24f6d146d826757d44cf72895a714 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 15 Dec 2023 02:28:09 -0800 Subject: [PATCH] Delete docs-new/docs/core-concepts/usecase-orchestrate.md This file was deleted in another PR Signed-off-by: Meg McRoberts --- .../docs/core-concepts/usecase-orchestrate.md | 180 ------------------ 1 file changed, 180 deletions(-) delete mode 100644 docs-new/docs/core-concepts/usecase-orchestrate.md diff --git a/docs-new/docs/core-concepts/usecase-orchestrate.md b/docs-new/docs/core-concepts/usecase-orchestrate.md deleted file mode 100644 index c73f7185a5..0000000000 --- a/docs-new/docs/core-concepts/usecase-orchestrate.md +++ /dev/null @@ -1,180 +0,0 @@ -# Manage release lifecycle - -In this exercise, we will configure Keptn -to run deployment checks as part of your deployment. -Whether you are deploying your software with -Argo, Flux, another deployment engine, or even `kubectl apply`, -Keptn can do the following: - -* Pre-deploy: Validate external dependencies, - confirm that images are scanned, and so forth - -* Post-deploy: Execute tests, notify stakeholders, - promote to the next stage - -* Automatically validate against your SLO (Service Level Objectives) - -Keptn sits on top of the Kubernetes scheduler -and can do the following: - -* Trace the deployment from start to end -* Keptn is application aware, - so can extend the deployment with tasks and evaluations that - are run either before or after your whole application starts the deployment - or at the individual [workload](https://kubernetes.io/docs/concepts/workloads/) level. -* Validate any Keptn metric, - either pre- or post-deployment, - using the metrics from the Keptn Metrics Server introduced in - [Getting started with Keptn metrics](../getting-started/metrics.md). - -This means that you can be sure that the environment is healthy -and has adequate resources before you begin the deployment. -After the deployment succeeds, -use Keptn metrics to confirm that your deployed software is really healthy -- -not just that the pods are running but validate against SLOs -such as performance and user experience. -You can also check for new logs that came in from a log monitoring solution. - -## Using this exercise - -This exercise shows how to implement -pre- and post-deployment evaluations and tasks -for your application. -It is based on the -[simplenode-dev](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd) -example. - -The steps to implement pre- and post-deployment orchestration are: - -* [Using this exercise](#using-this-exercise) -* [Define evaluations to be performed pre- and post-deployment](#define-evaluations-to-be-performed-prepost-deployment) -* [Define tasks to be performed pre- and post-deployment](#define-tasks-to-be-performed-prepost-deployment) -* [Integrate evaluations and tasks into the cluster](#integrate-evaluations-and-tasks-into-the-cluster) - -This is the third of three exercises in the -Introducing Keptn series. -You may want to complete the other exercises before doing this exercise -although that is not required: - -* In the - [Getting started with Keptn metrics](../getting-started/metrics.md) - exercise, you learn how to define and use Keptn metrics. -* In [Standardize observability](usecase-observability.md), - you learn how to standardize access - to the observability data for your cluster. - -If you are installing Keptn on an existing cluster -or in a local cluster you are creating for this exercise -and did not previously set up your cluster for the -[Standardize observability](usecase-observability.md) exercise, -you need to do the following: - -1. Follow the instructions in - [Install and update](../installation/index.md) - to install and enable Keptn on your cluster. -1. Follow the instructions in - [Annotate workload](../guides/integrate.md#basic-annotations) - to integrate Keptn into your Kubernetes cluster - by applying basic annotations to your `Deployment` resource. - This also creates appropriate - [KeptnApp](../reference/crd-reference/app.md) resources - which aggregate [workloads](https://kubernetes.io/docs/concepts/workloads/) that are combined into the released product, - regardless of the tools being used. - -## Define evaluations to be performed pre/post deployment - -An `evaluation` is a KeptnMetric that has a defined target value. -Evaluations are resources that are defined in a -[KeptnEvaluationDefinition](../reference/crd-reference/evaluationdefinition.md) -yaml file. -In our example, evaluations are defined in the -[keptn-evaluations.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/keptn-evaluations.yaml) -file. -For example, the definition of the `evaluate-dependencies` evaluation -looks like this: - -```yaml -apiVersion: lifecycle.keptn.sh/v1alpha3 -kind: KeptnEvaluationDefinition -metadata: - name: evaluate-dependencies - namespace: simplenode-dev -spec: - objectives: - - keptnMetricRef: - name: available-cpus - namespace: simplenode-dev - evaluationTarget: ">4" -``` - -You see that the `available-cpus` metric is defined in the -[keptn-metric.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/keptn-metric.yaml) -file. -The `evaluationTarget` is set to be `>4`, -so this evaluation makes sure that more than 4 CPUs are available. -You could include objectives and additional metrics in this evaluation. - -## Define tasks to be performed pre/post deployment - -Tasks are resources that are defined in a -[KeptnTaskDefinition](../reference/crd-reference/taskdefinition.md) -file. -In our example, the tasks are defined in the -[keptn-tasks.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/keptn-tasks.yaml) -file. -As an example, -we have a `notify` task that composes some Markdown text -to be sent as Slack notifications -The `KeptnTaskDefinition` looks like this: - -```yaml -apiVersion: lifecycle.keptn.sh/v1alpha3 -kind: KeptnTaskDefinition -metadata: - name: notify -spec: - function: - inline: - code: | - - secureParameters: - secret: slack-notification -``` - -The code to be executed is expressed as a -[Deno](https://deno.com) -script, which uses JavaScript syntax. -It can be embedded in the definition file -or pulled in from a remote webserver that is specified. -For this example, the code to be executed is embedded in this file -although, in practice, -this script would probably be located on a remote webserver. - -Note that, beginning with Keptn 0.8.0, -you can also use Python 3 to define your task, -or you can define a standard Kubernetes container -that uses the image, runner, and runtime dependencies that you choose. -For more information, see -[Working with Keptn tasks](../guides/tasks.md). - -You can view the actual JavaScript code for the task in the repository. -You see that "context" is important in this code. -This refers to the context in which this code executes -- -for which application, for which version, for which workload. - -Because the slack server that is required to execute this task -is protected by a secret, the task definition also specifies that secret. - -## Integrate evaluations and tasks into the cluster - -You must integrate the evaluations and tasks you defined -into the cluster -by applying annotations to the `Deployment` resource. -Follow the instructions in the guides: - -* [Deployment tasks](../guides/tasks.md/#annotations-to-keptnapp) -* [Evaluations](../guides/evaluations.md/#annotate-the-keptnapp-resource) - -See the -[simplenode-dev-deployment.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/simplenode-dev-deployment.yaml) -file for an example.