From 1b2f232657ef165d1de32bb1332d1fc8b6785920 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 31 Aug 2023 23:27:44 -0700 Subject: [PATCH 01/31] docs: implement KLT -> Keptn name change Signed-off-by: Meg McRoberts --- .../content/en/docs/getting-started/_index.md | 22 +++++----- docs/content/en/docs/install/_index.md | 2 +- docs/content/en/docs/install/install.md | 40 +++++++++---------- docs/content/en/docs/install/k8s.md | 28 ++++++------- docs/content/en/docs/install/reqs.md | 10 ++--- docs/content/en/docs/install/upgrade.md | 12 +++--- docs/content/en/docs/operate/_index.md | 6 +-- docs/content/en/docs/operate/cert-manager.md | 18 ++++----- 8 files changed, 69 insertions(+), 69 deletions(-) diff --git a/docs/content/en/docs/getting-started/_index.md b/docs/content/en/docs/getting-started/_index.md index f982b8dcf2..968d815f1c 100644 --- a/docs/content/en/docs/getting-started/_index.md +++ b/docs/content/en/docs/getting-started/_index.md @@ -1,11 +1,11 @@ --- -title: Getting started with KLT -description: Get started with the Keptn Lifecycle Toolkit +title: Getting started with Keptn +description: Get started with Keptn weight: 10 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -Keptn Lifecycle Toolkit works whether or not you use a GitOps strategy. +Keptn works whether or not you use a GitOps strategy. The following is an imperative walkthrough. ## Prerequisites @@ -18,8 +18,8 @@ The following is an imperative walkthrough. ## Objectives -- Install Keptn Lifecycle Toolkit on your cluster -- Annotate a namespace and deployment to enable Keptn Lifecycle Toolkit +- Install Keptn on your cluster +- Annotate a namespace and deployment to enable Keptn - Install Grafana and Observability tooling to view DORA metrics and OpenTelemetry traces ## System Overview @@ -45,9 +45,9 @@ Keptn will monitor the deployment and generate: Notice though that the metrics and traces have nowhere to go. That will be fixed in a subsequent step. -## Step 1: Install Keptn Lifecycle Toolkit +## Step 1: Install Keptn -Install the Keptn Lifecycle Toolkit using Helm: +Install Keptn using Helm: ```shell helm repo add klt https://charts.lifecycle.keptn.sh @@ -74,7 +74,7 @@ spec: keptnAppCreationRequestTimeoutSeconds: 30 ``` -Apply the file and restart KLT to pick up the new config: +Apply the file and restart Keptn to pick up the new config: ```shell kubectl apply -f collectorconfig.yaml @@ -87,7 +87,7 @@ kubectl rollout status deployment -n keptn-lifecycle-toolkit-system -l component ## Step 2: Create Namespace for Demo Application Save this file as `namespace.yaml`. -The annotation means that Keptn Lifecycle Toolkit is active for workloads in this namespace. +The annotation means that Keptn is active for workloads in this namespace. ```yaml apiVersion: v1 @@ -165,7 +165,7 @@ Keptn looks for these 3 labels: - `app.kubernetes.io/version` These are [Kubernetes recommended labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/#labels) -but if you want to use different labels, you can swap them for these KLT specific labels: +but if you want to use different labels, you can swap them for these Keptn specific labels: - `keptn.sh/app` instead of `app.kubernetes.io/part-of` - `keptn.sh/workload` instead of `app.kubernetes.io/name` @@ -474,7 +474,7 @@ View the Keptn Applications Dashboard and you should see the DORA metrics and an ## Step 14: More control over KeptnApp -You may have noticed that the `KeptnApp` Custom Resources are created automatically by KLT. +You may have noticed that the `KeptnApp` Custom Resources are created automatically by Keptn. The lifecycle toolkit automatically groups workloads into `KeptnApp`s by looking for matching `app.kubernetes.io/part-of` annotations. diff --git a/docs/content/en/docs/install/_index.md b/docs/content/en/docs/install/_index.md index d0b740dadc..6a2fc2c522 100644 --- a/docs/content/en/docs/install/_index.md +++ b/docs/content/en/docs/install/_index.md @@ -1,6 +1,6 @@ --- title: Installation and Upgrade -description: Learn how to install and upgrade the Keptn Lifecycle Toolkit +description: Learn how to install and upgrade Keptn weight: 30 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- diff --git a/docs/content/en/docs/install/install.md b/docs/content/en/docs/install/install.md index 35e435f600..eb7a0111a1 100644 --- a/docs/content/en/docs/install/install.md +++ b/docs/content/en/docs/install/install.md @@ -1,19 +1,19 @@ --- -title: Install and enable KLT -description: Install the Keptn Lifecycle Toolkit +title: Install and enable Keptn +description: Install Keptn weight: 35 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -The Keptn Lifecycle Toolkit must be installed, enabled, and integrated +Keptn must be installed, enabled, and integrated into each cluster you want to monitor. -This is because KLT communicates with the Kubernetes scheduler +This is because Keptn communicates with the Kubernetes scheduler for tasks such as enforcing checks natively, stopping a deployment from proceeding when criteria are not met, doing post-deployment evaluations and tracing all activities of all deployment workloads on the cluster. -Two methods are supported for installing the Keptn Lifecycle Toolkit (KLT): +Two methods are supported for installing Keptn: * Releases v0.7.0 and later can be installed using the [Helm Chart](#use-helm-chart). @@ -22,16 +22,16 @@ Two methods are supported for installing the Keptn Lifecycle Toolkit (KLT): * See the [use manifests](#use-manifests) section for more information on installing via manifest. This is the less-preferred way because it does not support customization. -After KLT is installed, you must -[Enable KLT for your cluster](#enable-klt-for-your-cluster) -in order to run some KLT functionality. +After Keptn is installed, you must +[Enable Keptn for your cluster](#enable-keptn-for-your-cluster) +in order to run some Keptn functionality. You are then ready to -[Integrate KLT with your applications](../implementing/integrate). +[Integrate Keptn with your applications](../implementing/integrate). ## Use Helm Chart -Version v0.7.0 and later of the Lifecycle Toolkit +Version v0.7.0 and later of Keptn should be installed using Helm Charts. The command sequence to fetch and install the latest release is: @@ -48,7 +48,7 @@ as well as for upgrades. Some helpful hints: * Use the `--version ` flag on the - `helm upgrade --install` command line to specify a different KLT version. + `helm upgrade --install` command line to specify a different Keptn version. * Use the following command sequence to see a list of available versions: @@ -57,7 +57,7 @@ Some helpful hints: helm search repo klt ``` -* To verify that the KLT components are installed in your cluster, +* To verify that the Keptn components are installed in your cluster, run the following command: ```shell @@ -75,7 +75,7 @@ or if you need to change the size of the installation. To modify configuration options, download a copy of the [helm/chart/values.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/helm/chart/values.yaml) -file, modify some values, and use the modified file to install KLT: +file, modify some values, and use the modified file to install Keptn: 1. Download the `values.yaml` file: @@ -85,7 +85,7 @@ file, modify some values, and use the modified file to install KLT: 1. Edit your local copy to modify some values -1. Install KLT by adding the following string to your `helm upgrade` command line: +1. Install Keptn by adding the following string to your `helm upgrade` command line: ```shell --values=values.yaml @@ -108,7 +108,7 @@ For more information,see ## Use manifests -Versions v0.10.0 and earlier of the Lifecycle Toolkit can be installed using manifests, +Versions v0.10.0 and earlier of Keptn can be installed using manifests, although we recommend that you use Helm Charts because they allow you to easily customize your configuration. @@ -125,7 +125,7 @@ kubectl wait \ ``` Use a command sequence like the following -to install the Lifecycle Toolkit from the manifest, +to install Keptn from the manifest, specifying the version you want to install. ```shell @@ -135,9 +135,9 @@ kubectl wait --for=condition=Available deployment/lifecycle-operator \ -n keptn-lifecycle-toolkit-system --timeout=120s ``` -The Lifecycle Toolkit and its dependencies are now installed and ready to use. +Keptn and its dependencies are now installed and ready to use. -## Enable KLT for your cluster +## Enable Keptn for your cluster To enable the Keptn Lifecycle Controller in your cluster, annotate the Kubernetes @@ -159,6 +159,6 @@ metadata: You see the annotation line `keptn.sh/lifecycle-toolkit: "enabled"`. This annotation tells the webhook to handle the namespace. -After enabling KLT for your namespace(s), +After enabling Keptn for your namespace(s), you are ready to -[Integrate KLT with your applications](../implementing/integrate). +[Integrate Keptn with your applications](../implementing/integrate). diff --git a/docs/content/en/docs/install/k8s.md b/docs/content/en/docs/install/k8s.md index c965eeff97..dfc28c2263 100644 --- a/docs/content/en/docs/install/k8s.md +++ b/docs/content/en/docs/install/k8s.md @@ -6,7 +6,7 @@ weight: 25 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -The Keptn Lifecycle Toolkit is meant to be installed +Keptn is meant to be installed into an existing Kubernetes cluster that runs your deployment software. See [Requirements](reqs.md) for information about supported releases @@ -20,7 +20,7 @@ You can also create a local cluster using packages such as [k3s](https://k3s.io/), and [Minikube](https://minikube.sigs.k8s.io/docs/) to set up a local, lightweight Kubernetes cluster -where you can install the Keptn Lifecycle Toolkit +where you can install Keptn for personal study, demonstrations, and testing. For more information, see the Kubernetes [Install Tools](https://kubernetes.io/docs/tasks/tools/) @@ -28,7 +28,7 @@ documentation. The [Keptn Lifecycle Toolkit: Installation and KeptnTask Creation in Minutes](https://www.youtube.com/watch?v=Hh01bBwZ_qM) video demonstrates how to create a KinD cluster. -on which you can install the Lifecycle Toolkit. +on which you can install Keptn. The basic steps are: 1. Download, install, and run [Docker](https://docs.docker.com/get-docker/) @@ -52,11 +52,11 @@ The basic steps are: kubectl version --short ``` -## Prepare your cluster for KLT +## Prepare your cluster for Keptn -The Keptn Lifecycle Toolkit installs into an existing Kubernetes cluster. +Keptn installs into an existing Kubernetes cluster. When setting up a local Kubernetes cluster -to study or demonstrate the Lifecycle Toolkit, +to study or demonstrate Keptn, you need to provide these components. Your cluster should include the following: @@ -78,7 +78,7 @@ Your cluster should include the following: such as [Argo CD](https://argo-cd.readthedocs.io/en/stable/) or [Flux](https://fluxcd.io/). - Alternatively, KLT also works with just `kubctl apply` for deployment. + Alternatively, Keptn also works with just `kubctl apply` for deployment. * If you want to use the standardized observability feature, you must have an OpenTelemetry collector @@ -92,11 +92,11 @@ Your cluster should include the following: For more information, see [Requirements for Open Telemetry](../implementing/otel.md/#requirements-for-opentelemetry). -Also note that the Keptn Lifecycle Toolkit includes +Also note that Keptn includes a light-weight cert-manager that, by default, is installed -as part of the KLT software. +as part of the Keptn software. If you are using another cert-manager in the cluster, -you can configure KLT to instead use your cert-manager. +you can configure Keptn to instead use your cert-manager. See [Use Keptn with cert-manager.io](../operate/cert-manager.md) for detailed instructions. @@ -110,9 +110,9 @@ documentation for some basic information. You can also search and find lots of "Best Practices for Namespaces" documents published on the web. -Some considerations for KLT: +Some considerations for Keptn: -* KLT primarily operates on Kubernetes +* Keptn primarily operates on Kubernetes [Workload](https://kubernetes.io/docs/concepts/workloads/) resources and [KeptnApp](../yaml-crd-ref/app.md) @@ -142,6 +142,6 @@ Some considerations for KLT: So, possible namespace designs run the gamut: -* Run all your KLT work in a single namespace -* Create a separate namespace for each logical grouping of your KLT work +* Run all your Keptn work in a single namespace +* Create a separate namespace for each logical grouping of your Keptn work * Create a separate namespace for each workload diff --git a/docs/content/en/docs/install/reqs.md b/docs/content/en/docs/install/reqs.md index b86b215cfe..db4f436b0e 100644 --- a/docs/content/en/docs/install/reqs.md +++ b/docs/content/en/docs/install/reqs.md @@ -7,12 +7,12 @@ hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.htm ## Supported Kubernetes versions -The Keptn Lifecycle Controller requires Kubernetes v1.24.0 or later. +Keptn requires Kubernetes v1.24.0 or later. Run the following to ensure that both client and server versions are running Kubernetes versions greater than or equal to v1.24. In this example, both client and server are at v1.24.0 -so the Keptn Lifecycle Toolkit will work. +so Keptn will work. ```shell kubectl version --short @@ -24,16 +24,16 @@ Kustomize Version: v4.5.4 Server Version: v1.24.0 ``` -KLT is not currently compatible with +Keptn is not currently compatible with [vcluster](). ## Resource requirements ## cert-manager -KLT includes a lightweight cert-manager +Keptn includes a lightweight cert-manager that is used for installation and Webhooks. You can configure a different cert-manager -before you install KLT. +before you install Keptn. See [Implement your own cert-manager](../operate/cert-manager.md) for instructions. diff --git a/docs/content/en/docs/install/upgrade.md b/docs/content/en/docs/install/upgrade.md index b0da60da9b..947a715c01 100644 --- a/docs/content/en/docs/install/upgrade.md +++ b/docs/content/en/docs/install/upgrade.md @@ -1,14 +1,14 @@ --- title: Upgrade -description: How to upgrade to the latest version of the Lifecycle Toolkit +description: How to upgrade to the latest version of Keptn layout: quickstart weight: 45 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -If you installed the previous version of the Lifecycle Toolkit using `helm`, +If you installed the previous version of Keptn using `helm`, you can upgrade to the latest version -by running the same command sequence used to install KLT: +by running the same command sequence used to install Keptn: ```shell helm repo add klt https://charts.lifecycle.keptn.sh @@ -19,16 +19,16 @@ helm upgrade --install keptn klt/klt \ Use the `--set` flag or download and edit the `values.yaml` file to modify the configuration as discussed on the -[Install the Lifecycle Toolkit](../install/) page. +[Install Keptn](../install/) page. > **Warning** -If you installed your Lifecycle Toolkit instance from the Manifest, +If you installed your Keptn instance from the Manifest, additional steps are required to use the Helm Chart to upgrade. Contact us on Slack for assistance. ## Migrate from v0.6.0 to v0.7.0 -Keptn Lifecycle Toolkit Version v0.7.0 +Keptn Version v0.7.0 introduces the `metrics-operator`, which is now separate from the `lifecycle-operator`. Some functionality and behavior has been moved, changed, or renamed. diff --git a/docs/content/en/docs/operate/_index.md b/docs/content/en/docs/operate/_index.md index a17fd4a0bf..8be4e6bd4b 100644 --- a/docs/content/en/docs/operate/_index.md +++ b/docs/content/en/docs/operate/_index.md @@ -1,6 +1,6 @@ --- -title: Operate KLT -description: This section contains various content on operating KLT day-to-day +title: Operate Keptn +description: This section contains various content on operating Keptn day-to-day weight: 30 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html ---- \ No newline at end of file +--- diff --git a/docs/content/en/docs/operate/cert-manager.md b/docs/content/en/docs/operate/cert-manager.md index c58c833692..9d455e8799 100644 --- a/docs/content/en/docs/operate/cert-manager.md +++ b/docs/content/en/docs/operate/cert-manager.md @@ -1,28 +1,28 @@ --- title: Use Keptn with cert-manager.io (optional) -description: Replace the default KLT cert-manager +description: Replace the default Keptn cert-manager weight: 30 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -The Keptn Lifecycle Toolkit includes +Keptn includes a light-weight, customized cert-manager that is used to register Webhooks to the [KubeAPI](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/). Bundling the cert-manager simplifies the installation for new users -and provides the functionality KLT needs +and provides the functionality Keptn needs without the overhead of other cert-managers. For a description of the architecture, see [Keptn Certificate Manager](../concepts/architecture/cert-manager.md). -KLT also works well with `cert-manager.io`. +Keptn also works well with `cert-manager.io`. If you are already using `cert-manager.io`, you can continue to use it for other components -and use the KLT cert-manager just for KLT activities -or you can disable the KLT cert-manager -and configure KLT to use `cert-manager.io`. +and use the Keptn cert-manager just for Keptn activities +or you can disable the Keptn cert-manager +and configure Keptn to use `cert-manager.io`. -If you want KLT to use `cert-manager.io`, -you must configure it *before* you install KLT. +If you want Keptn to use `cert-manager.io`, +you must configure it *before* you install Keptn. The steps are: * Install `cert-manager.io` if it is not already installed. From 6e09bb5b2615ec9020072f6b369067909082727f Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 1 Sep 2023 01:08:55 -0700 Subject: [PATCH 02/31] implementing section Signed-off-by: Meg McRoberts --- docs/content/en/docs/implementing/_index.md | 2 +- .../implementing/add-app-awareness/index.md | 14 +++--- .../en/docs/implementing/dora/_index.md | 4 +- .../en/docs/implementing/evaluatemetrics.md | 8 +-- .../en/docs/implementing/integrate/_index.md | 50 +++++++++---------- docs/content/en/docs/implementing/otel.md | 24 ++++----- 6 files changed, 52 insertions(+), 50 deletions(-) diff --git a/docs/content/en/docs/implementing/_index.md b/docs/content/en/docs/implementing/_index.md index 5a3cb3c28c..19f62e8354 100644 --- a/docs/content/en/docs/implementing/_index.md +++ b/docs/content/en/docs/implementing/_index.md @@ -1,6 +1,6 @@ --- title: Implementing Keptn applications -description: Learn how to implement your KLT application +description: Learn how to implement your Keptn application layout: quickstart weight: 40 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html diff --git a/docs/content/en/docs/implementing/add-app-awareness/index.md b/docs/content/en/docs/implementing/add-app-awareness/index.md index 63c16377b1..e6c88048ff 100644 --- a/docs/content/en/docs/implementing/add-app-awareness/index.md +++ b/docs/content/en/docs/implementing/add-app-awareness/index.md @@ -1,11 +1,13 @@ # Add Application Awareness -In the previous step, we installed the demo application without any application awareness. -This means that the Lifecycle -Toolkit assumed that every workload is a single-service application at the moment and created the Application resources -for you. - -To get the overall state of an application, we need a grouping of workloads, called KeptnApp in the Lifecycle Toolkit. +In the previous step, we installed the demo application +without any application awareness. +This means that Keptn assumed +that every workload is a single-service application at the moment +and created the Application resources for you. + +To get the overall state of an application, +we need a grouping of workloads, called KeptnApp. To get this working, we need to modify our application manifest with two things: * Add an "app.kubernetes.io/part-of" or "keptn.sh/app" label to the deployment diff --git a/docs/content/en/docs/implementing/dora/_index.md b/docs/content/en/docs/implementing/dora/_index.md index db4c831ac4..285a9d2063 100644 --- a/docs/content/en/docs/implementing/dora/_index.md +++ b/docs/content/en/docs/implementing/dora/_index.md @@ -5,7 +5,7 @@ weight: 65 --- DORA metrics are an industry-standard set of measurements -that are included in the Keptn Lifecycle Toolkit. +that are included in Keptn; see the following for a description: - [What are DORA Metrics and Why Do They Matter?](https://codeclimate.com/blog/dora-metrics) @@ -19,7 +19,7 @@ DORA metrics provide information such as: - Deployment time between versions - Average time between versions. -The Keptn Lifecycle Toolkit starts collecting these metrics +Keptn starts collecting these metrics as soon as you apply [basic annotations](../integrate/#basic-annotations) to the diff --git a/docs/content/en/docs/implementing/evaluatemetrics.md b/docs/content/en/docs/implementing/evaluatemetrics.md index 2e39f7cafb..182e346b97 100644 --- a/docs/content/en/docs/implementing/evaluatemetrics.md +++ b/docs/content/en/docs/implementing/evaluatemetrics.md @@ -46,18 +46,18 @@ Note the following: in a centralized namespace such as `keptn-lifecycle-toolkit-system`. -To configure a data provider into your KLT cluster: +To configure a data provider into your Keptn cluster: 1. Create a secret if your data provider uses one. See [Create secret text](../implementing/tasks/#create-secret-text). 1. Install and configure each instance of each data provider - into your KLT cluster, + into your Keptn cluster, following the instructions provided by the data source provider. See - [Prepare your cluster for KLT](../install/k8s.md/#prepare-your-cluster-for-klt) + [Prepare your cluster for Keptn](../install/k8s.md/#prepare-your-cluster-for-keptn) for links. - KLT supports using multiple instances of multiple data providers. + Keptn supports using multiple instances of multiple data providers. 1. Define a [KeptnMetricsProvider](../yaml-crd-ref/metricsprovider.md) resource for each data source. diff --git a/docs/content/en/docs/implementing/integrate/_index.md b/docs/content/en/docs/implementing/integrate/_index.md index a78dd06579..8f89993332 100644 --- a/docs/content/en/docs/implementing/integrate/_index.md +++ b/docs/content/en/docs/implementing/integrate/_index.md @@ -1,40 +1,40 @@ --- -title: Integrate KLT with your applications -description: How to integrate the Keptn Lifecycle Toolkit into your Kubernetes cluster +title: Integrate Keptn with your applications +description: How to integrate Keptn into your Kubernetes cluster layout: quickstart weight: 45 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -The Keptn Lifecycle Toolkit works +Keptn works on top of the default scheduler for the cluster, so it can trace all activities of all deployment workloads on the cluster, no matter what tool is used for the deployment. -This same mechanism allows KLT to inject pre- and post-deployment checks +This same mechanism allows Keptn to inject pre- and post-deployment checks into all deployment workloads. -KLT monitors resources +Keptn monitors resources that have been applied into the Kubernetes cluster and reacts if it finds a workload with special annotations/labels. -The Keptn Lifecycle Toolkit uses metadata +Keptn uses metadata that is added to the Kubernetes workloads to identify the workloads of interest. -To integrate KLT with your applications: +To integrate Keptn with your applications: * You must first [install](../../install/install.md) and [enable](../../install/install.md//#enable-klt-for-your-cluster) -KLT. +Keptn. * Annotate or label your workloads with either Keptn or Kubernetes keys. * [Basic annotations](#basic-annotations) or labels - are required for all KLT features except Keptn metrics. + are required for all Keptn features except Keptn metrics. * [Pre- and post-deployment checks](#basic-annotations) are required only for the Release lifecycle management feature. -KLT uses these annotations to the Kubernetes workloads to create the +Keptn uses these annotations to the Kubernetes workloads to create the [KeptnWorkload](../../crd-ref/lifecycle/v1alpha3/#keptnworkload) and [KeptnApp](../../yaml-crd-ref/app.md) @@ -42,26 +42,26 @@ resources that it uses to provide observability and release lifecycle management. > Note: Annotations are not required if you are only using the - `metrics-operator` component of KLT + `metrics-operator` component of Keptn to observe Keptn metrics. ## Basic annotations -The Keptn Lifecycle Toolkit automatically discovers `KeptnApp` resources, +Keptn automatically discovers `KeptnApp` resources, based on the annotations or labels. -This enables the KLT observability features +This enables the Keptn observability features (based on OpenTelemetry) for existing applications, without additional Keptn configuration. -KLT monitors your +Keptn monitors your [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/), [StatefulSets](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/), and [ReplicaSets](https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/), and [DaemonSets](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) -resources in the namespaces where KLT is enabled. -If KLT finds any of these resources and the resource has either +resources in the namespaces where Keptn is enabled. +If Keptn finds any of these resources and the resource has either the `keptn.sh` or the `kubernetes` annotations/labels, it creates appropriate [KeptnWorkload](../../crd-ref/lifecycle/v1alpha3/#keptnworkload) @@ -98,28 +98,28 @@ These keys are defined as: that represents the Workload. If the Workload has no `version` annotation/labels and the pod has only one container, - the Lifecycle Toolkit takes the image tag as version + Keptn takes the image tag as version (unless it is "latest"). * `keptn.sh/app` or `app.kubernetes.io/part-of`: Determines the name of the generated `KeptnApp` representing your Application. All Workloads that share the same value for this label are consolidated into the same `KeptnApp` resource. -KLT automatically generates appropriate +Keptn automatically generates appropriate [KeptnApp](../../yaml-crd-ref/app.md) resources that are used for observability, based on whether the `keptn.sh/app` or `app.kubernetes.io/part-of` annotation/label is populated: * If either of these annotations/labels are populated, - KLT automatically generates a `KeptnApp` resource + Keptn automatically generates a `KeptnApp` resource that includes all workloads that have the same annotation/label, thus creating a `KeptnApp` resource for each defined grouping * If only the `workload` and `version` annotations/labels are available (in other words, neither the `keptn.sh/app` or `app.kubernetes.io/part-of` annotation/label is populated), - KLT creates a `KeptnApp` resource for each `KeptnWorkload` + Keptn creates a `KeptnApp` resource for each `KeptnWorkload` and your observability output traces the individual `Keptnworkload` resources but not the combined workloads that constitute your deployed application. @@ -162,7 +162,7 @@ In other words: again first in the annotations, then in the labels. In general, annotations are more appropriate than labels -for integrating KLT with your applications +for integrating Keptn with your applications because they store references, names, and version information so the 63 char limitation is quite restrictive. However, labels can be used if you specifically need them @@ -248,7 +248,7 @@ a Slack notification is sent with the result of the deployment The automatically generated `KeptnApp` file aggregates the workloads to include in the application, based on annotations made to the workloads themselves. -This enables you to run KLT observability features on your cluster. +This enables you to run Keptn observability features on your cluster. Afterward, you can monitor the status of the deployment using a command like the following: @@ -275,10 +275,10 @@ but this is not required for observability. As an example, consider the following application, consisting of multiple deployments, -which is going to be deployed into a KLT-enabled namespace. +which is going to be deployed into a Keptn-enabled namespace. Note that: -1. KLT is enabled for the namespace where your application runs. +1. Keptn is enabled for the namespace where your application runs. 1. The `Deployment` workloads are annotated appropriately. This example does not use other workloads. @@ -350,7 +350,7 @@ spec: With the `KeptnApp` resource created, you get observability of your application's deployments by using the OpenTelemetry tracing features -that are provided by the Keptn Lifecycle Toolkit: +that are provided by Keptn: ![Application deployment trace](assets/trace.png) diff --git a/docs/content/en/docs/implementing/otel.md b/docs/content/en/docs/implementing/otel.md index be2808f167..df0fab95d6 100644 --- a/docs/content/en/docs/implementing/otel.md +++ b/docs/content/en/docs/implementing/otel.md @@ -5,7 +5,7 @@ weight: 140 --- -The Keptn Lifecycle Toolkit (KLT) makes any Kubernetes deployment observable. +Keptn makes any Kubernetes deployment observable. In other words, it creates a distributed, end-to-end trace of what Kubernetes does in the context of a Deployment. To do this, @@ -18,12 +18,12 @@ This means that: - You can readily see why a deployment takes so long or why it fails, even when using multiple deployment strategies. -- KLT can capture DORA metrics and expose them as OpenTelemetry metrics +- Keptn can capture DORA metrics and expose them as OpenTelemetry metrics The observability data is an amalgamation of the following: - DORA metrics are collected out of the box - when the Lifecycle Toolkit is enabled + when Keptn is enabled - OpenTelemetry runs traces that show everything that happens in the Kubernetes cluster - Custom Keptn metrics that you can use to monitor @@ -52,7 +52,7 @@ DORA metrics provide information such as: - Deployment time between versions - Average time between versions. -The Keptn Lifecycle Toolkit starts collecting these metrics +Keptn starts collecting these metrics as soon as you apply [basic annotations](integrate/#basic-annotations) to the Workload resource. @@ -86,7 +86,7 @@ or whatever dashboard application you choose. ### Requirements for OpenTelemetry -To access OpenTelemetry metrics with the Keptn Lifecycle Toolkit, +To access OpenTelemetry metrics with Keptn, you must have the following on your cluster: - An OpenTelemetry collector. @@ -113,7 +113,7 @@ you need: [Jaeger Setup](https://github.com/jaegertracing/jaeger-operator#getting-started). To install Prometheus into the `monitoring` namespace, -using the default configuration included with KLT, +using the default configuration included with Keptn, use the following commands. Use similar commands if you define a different configuration:: @@ -123,14 +123,14 @@ kubectl apply --server-side -f config/prometheus/setup kubectl apply -f config/prometheus/ ``` -### Integrate OpenTelemetry into the Keptn Lifecycle Toolkit +### Integrate OpenTelemetry into Keptn -To integrate OpenTelemetry into the Keptn Lifecycle Toolkit: +To integrate OpenTelemetry into Keptn: - Apply [basic annotations](../implementing/integrate/#basic-annotations) for your `Deployment` resource - to integrate the Lifecycle Toolkit into your Kubernetes cluster. + to integrate Keptn into your Kubernetes cluster. - To expose OpenTelemetry metrics, define a [KeptnConfig](../yaml-crd-ref/config.md) resource that has the `spec.OTelCollectorUrl` field populated @@ -177,14 +177,14 @@ kubectl rollout restart deployment \ -n keptn-lifecycle-toolkit-system keptn-scheduler lifecycle-operator ``` -KLT begins to collect OpenTelemetry metrics +Keptn begins to collect OpenTelemetry metrics as soon as the `Deployment` resource -has the basic annotations to integrate KLT in the cluster. +has the basic annotations to integrate Keptn in the cluster. ## Access Keptn metrics as OpenTelemetry metrics Keptn metrics can be exposed as OpenTelemetry (OTel) metrics -via port `9999` of the KLT metrics-operator. +via port `9999` of the Keptn metrics-operator. To access the metrics, use the following command: From 426b5241d1ba8525f094764ade5ba40d5bed8484 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 1 Sep 2023 01:27:13 -0700 Subject: [PATCH 03/31] tutorials, architecture Signed-off-by: Meg McRoberts --- .../en/docs/concepts/architecture/_index.md | 4 ++-- .../en/docs/concepts/architecture/cert-manager.md | 14 +++++++------- .../concepts/architecture/components/_index.md | 8 ++++---- .../components/lifecycle-operator/_index.md | 2 +- .../architecture/components/scheduler/_index.md | 4 ++-- .../docs/concepts/architecture/deployment-flow.md | 10 +++++----- .../concepts/architecture/keptn-apps/_index.md | 10 +++++----- .../docs/concepts/architecture/working/_index.md | 8 ++++---- docs/content/en/docs/tutorials/_index.md | 4 ++-- docs/content/en/docs/tutorials/add-tasks.md | 4 ++-- 10 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/content/en/docs/concepts/architecture/_index.md b/docs/content/en/docs/concepts/architecture/_index.md index eb2b6a4648..6a3f768dce 100644 --- a/docs/content/en/docs/concepts/architecture/_index.md +++ b/docs/content/en/docs/concepts/architecture/_index.md @@ -1,9 +1,9 @@ --- title: Architecture linktitle: Architecture -description: Understand the details of how Keptn Lifecycle Toolkit works +description: Understand the details of how Keptn works weight: 80 cascade: --- -### Keptn Lifecycle Toolkit Components +### Keptn Components diff --git a/docs/content/en/docs/concepts/architecture/cert-manager.md b/docs/content/en/docs/concepts/architecture/cert-manager.md index 22772f339d..7cbebf9f07 100644 --- a/docs/content/en/docs/concepts/architecture/cert-manager.md +++ b/docs/content/en/docs/concepts/architecture/cert-manager.md @@ -14,7 +14,7 @@ You can instead [configure your own certificate manager](https://lifecycle.keptn.sh/docs/install/cert-manager/) for this purpose. -The Lifecycle Toolkit includes a Mutating Webhook +Keptn includes a Mutating Webhook that requires TLS certificates to be mounted as a volume in its pod. In version 0.6.0 and later, the certificate creation is handled automatically by @@ -28,15 +28,15 @@ with a renewal threshold of 12 hours. * If the certificate expires, the [klt-cert-manager](https://github.com/keptn/lifecycle-toolkit/blob/main/klt-cert-manager/README.md) renews it. -* The Lifecycle Toolkit operator waits for a valid certificate to be ready. +* The Keptn operator waits for a valid certificate to be ready. * When the certificate is ready, it is mounted on an empty dir volume in the operator. `klt-cert-manager` is a customized certificate manager -that is installed with the Lifecycle Toolkit by default. +that is installed with Keptn by default. It is included to simplify installation for new users and because it is much smaller than most standard certificate managers. -However, KLT is compatible with most certificate managers +However, Keptn is compatible with most certificate managers and can be configured to use another certificate manager if you prefer. See [Use Keptn with cert-manager.io](../../operate/cert-manager.md) for instructions. @@ -48,7 +48,7 @@ the webhook or the operator may generate errors because of an invalid certificate. To solve this, delete the certificate and restart the operator. -The KLT cert-manager certificate is stored as a secret in the `klt` namespace. +The Keptn cert-manager certificate is stored as a secret in the `klt` namespace. To retrieve it: ```shell @@ -62,8 +62,8 @@ NAME TYPE DATA AGE klt-certs Opaque 5 4d23h ``` -Specify the `NAME` of the KLT certificate (`klt-certs` in this case) -to delete the KLT certificate: +Specify the `NAME` of the Keptn certificate (`klt-certs` in this case) +to delete the Keptn certificate: ```shell kubectl delete secret klt-certs -n keptn-lifecycle-toolkit-system diff --git a/docs/content/en/docs/concepts/architecture/components/_index.md b/docs/content/en/docs/concepts/architecture/components/_index.md index 89afb27d3a..9e82499d64 100644 --- a/docs/content/en/docs/concepts/architecture/components/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/_index.md @@ -1,14 +1,14 @@ --- -title: Lifecycle Toolkit Components +title: Keptn Components linktitle: Components -description: Basic understanding of Keptn Lifecycle Toolkit Components +description: Basic understanding of Keptn Components weight: 20 cascade: --- -### Keptn Lifecycle Toolkit Components +### Keptn Components -The Keptn Lifecycle Toolkit consists of two main components: +Keptn consists of two main components: * Keptn Lifecycle Operator, which splits into two separate operators in Release 0.7.0 and later: diff --git a/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md b/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md index e064671db5..3592bb1c21 100644 --- a/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md @@ -1,7 +1,7 @@ --- title: Keptn Lifecycle Operator linktitle: Lifecycle Operator -description: Basic understanding of Keptn's Lifecycle Operator +description: Basic understanding of the Keptn Lifecycle Operator weight: 80 cascade: --- diff --git a/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md b/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md index 6fb6d7bf9a..10d5587623 100644 --- a/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md @@ -1,12 +1,12 @@ --- title: Keptn Lifecycle Scheduler linktitle: Scheduler -description: Basic understanding of Keptn's Lifecycle Scheduler +description: Basic understanding of the Keptn Lifecycle Scheduler weight: 80 cascade: --- -The **Keptn Scheduler** is an integral component of the Keptn Lifecycle Toolkit that orchestrates +The **Keptn Scheduler** is an integral component of Keptn that orchestrates the deployment process. The **Keptn Scheduler** works by registering itself as a Permit plugin within the Kubernetes scheduling cycle that ensures that Pods are scheduled to a node until and unless the diff --git a/docs/content/en/docs/concepts/architecture/deployment-flow.md b/docs/content/en/docs/concepts/architecture/deployment-flow.md index 4fbe7753f9..841df8331a 100644 --- a/docs/content/en/docs/concepts/architecture/deployment-flow.md +++ b/docs/content/en/docs/concepts/architecture/deployment-flow.md @@ -5,7 +5,7 @@ description: Understand the execution flow of a deployment weight: 35 --- -The Keptn Lifecycle Toolkit (KLT) deploys a +Keptn deploys a [Kubernetes Workload](https://kubernetes.io/docs/concepts/workloads/) by passing through a well-defined execution flow. @@ -34,7 +34,7 @@ and [CloudEvents](https://cloudevents.io/) are emitted at each phase to provide additional Observability of the execution flow. -The Keptn Lifecycle Toolkit implements a +Keptn implements a [Permit Scheduler Plugin](https://kubernetes.io/docs/concepts/scheduling-eviction/scheduling-framework/#permit) that blocks the binding of the pods to a node until all the pre-conditions are fulfilled. @@ -48,9 +48,9 @@ or can be started by the following command: kubectl apply -f deployment.yaml ``` -KLT does not care how a deployment manifest is applied to the cluster. +Keptn does not care how a deployment manifest is applied to the cluster. Both `kubectl` and Flux/Argo send the manifest to the Kubernetes API -so KLT does not differentiate the actual deployment options. +so Keptn does not differentiate the actual deployment options. This also means that one Keptn Application can include services that are deployed with different methods. @@ -171,7 +171,7 @@ such as those that describe what happens when something fails. Whenever something in the system happens (we create a new resource, etc.) a Kubernetes event is generated. -The following events are defined as part of the Keptn Lifecycle Toolkit +The following events are defined as part of Keptn but they are not part of the deployment flow. These include: diff --git a/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md b/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md index 69741216fe..1c15e3045f 100644 --- a/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md +++ b/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md @@ -68,14 +68,14 @@ for the `KeptnApp` resource itself: [Basic annotations](../../../implementing/integrate/#basic-annotations) are used to automatically generate `KeptnApp` resources that contain the identifications required - to run the KLT observability features. + to run the Keptn observability features. * You must manually add the annotations described in [Pre- and post-deployment checks](../../../implementing/integrate/#pre--and-post-deployment-checks) to the basic `KeptnApp` manifest to define the evaluations and tasks you want to run pre- and post-deployment. The `KeptnApp` resources that are generated automatically -contain the identifications required to run the KLT observability features. +contain the identifications required to run the Keptn observability features. The `spec.workloads.name` and a `spec.workloads.version` fields that define evaluations and tasks to be run pre- and post-deployment are not generated automatically @@ -94,7 +94,7 @@ resource. The [Basic annotations](../../../implementing/integrate/#basic-annotations) page gives instructions for applying the annotations or labels -that identify the pods that KLT should manage. +that identify the pods that Keptn should manage. Three `keptn.sh` and three `app.kubernetes.io` keys are recognized. They are equivalent; you can use either of them @@ -108,7 +108,7 @@ In other words: * If neither is the case, it looks for the `app.kubernetes.io/` equivalent, again first in the annotations, then in the labels. -KLT automatically generates appropriate +Keptn automatically generates appropriate [KeptnApp](../../../yaml-crd-ref/app.md) resources that are used for observability, based on whether the `keptn.sh/app` or `app.kubernetes.io/part-of` @@ -117,7 +117,7 @@ resource for each defined group. that together constitute a single deployable Keptn Application. * If either of these labels/annotations are populated, - KLT automatically generates a `KeptnApp` resource + Keptn automatically generates a `KeptnApp` resource that includes all workloads that have the same annotation/label, thus creating a `KeptnApp` resource for each defined grouping diff --git a/docs/content/en/docs/concepts/architecture/working/_index.md b/docs/content/en/docs/concepts/architecture/working/_index.md index f7411eba1e..2180fc716f 100644 --- a/docs/content/en/docs/concepts/architecture/working/_index.md +++ b/docs/content/en/docs/concepts/architecture/working/_index.md @@ -1,9 +1,9 @@ --- -title: Lifecycle Toolkit Working -linktitle: How it works -description: Understand How Keptn Lifecycle Toolkit Works +title: How Keptn works +linktitle: How Keptn works +description: Understand How Keptn Works weight: 30 cascade: --- -### How Keptn Lifecycle Toolkit Works? +### How Keptn Works? diff --git a/docs/content/en/docs/tutorials/_index.md b/docs/content/en/docs/tutorials/_index.md index 1f095f066c..0739d7b0a6 100644 --- a/docs/content/en/docs/tutorials/_index.md +++ b/docs/content/en/docs/tutorials/_index.md @@ -1,10 +1,10 @@ --- title: Tutorials -description: Learn how to use the Keptn Lifecycle Toolkit +description: Learn how to use Keptn weight: 40 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -This section contains tutorials on how to use the Keptn Lifecycle Toolkit. +This section contains tutorials on how to use Keptn. Begin with the [getting started guide](../getting-started/) first, then come back here to complete these tutorials. diff --git a/docs/content/en/docs/tutorials/add-tasks.md b/docs/content/en/docs/tutorials/add-tasks.md index 1e2f82774f..95561b3b18 100644 --- a/docs/content/en/docs/tutorials/add-tasks.md +++ b/docs/content/en/docs/tutorials/add-tasks.md @@ -8,9 +8,9 @@ hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.htm > This tutorial assumes you have already completed the [getting started guide](../getting-started/). > Please ensure you've finished that before attempting this guide. -## KLT Pre and Post Deployment Tasks +## Keptn Pre and Post Deployment Tasks -When KLT is successfully monitoring your deployments, it can also run arbitrary tasks and SLO evaluations: +When Keptn is successfully monitoring your deployments, it can also run arbitrary tasks and SLO evaluations: - pre-deployment (before the pod is scheduled) and - post-deployment (after the post is scheduled) From 2bf25485ed6b575515dada7dd5f0de073c7e956e Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 1 Sep 2023 17:02:59 -0700 Subject: [PATCH 04/31] apis/lifecycle-operator Signed-off-by: Meg McRoberts --- .../apis/lifecycle/v1alpha3/keptnapp_types.go | 8 ++++---- .../apis/lifecycle/v1alpha3/keptnevaluation_types.go | 2 +- .../apis/lifecycle/v1alpha3/keptntask_types.go | 2 +- .../apis/lifecycle/v1alpha3/keptnworkload_types.go | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnapp_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnapp_types.go index 7904465006..8e407c8ae1 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnapp_types.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnapp_types.go @@ -41,21 +41,21 @@ type KeptnAppSpec struct { Workloads []KeptnWorkloadRef `json:"workloads,omitempty"` // PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp. // The items of this list refer to the names of KeptnTaskDefinitions - // located in the same namespace as the KeptnApp, or in the KLT namespace. + // located in the same namespace as the KeptnApp, or in the Keptn namespace. PreDeploymentTasks []string `json:"preDeploymentTasks,omitempty"` // PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp. // The items of this list refer to the names of KeptnTaskDefinitions - // located in the same namespace as the KeptnApp, or in the KLT namespace. + // located in the same namespace as the KeptnApp, or in the Keptn namespace. PostDeploymentTasks []string `json:"postDeploymentTasks,omitempty"` // PreDeploymentEvaluations is a list of all evaluations to be performed // during the pre-deployment phase of the KeptnApp. // The items of this list refer to the names of KeptnEvaluationDefinitions - // located in the same namespace as the KeptnApp, or in the KLT namespace. + // located in the same namespace as the KeptnApp, or in the Keptn namespace. PreDeploymentEvaluations []string `json:"preDeploymentEvaluations,omitempty"` // PostDeploymentEvaluations is a list of all evaluations to be performed // during the post-deployment phase of the KeptnApp. // The items of this list refer to the names of KeptnEvaluationDefinitions - // located in the same namespace as the KeptnApp, or in the KLT namespace. + // located in the same namespace as the KeptnApp, or in the Keptn namespace. PostDeploymentEvaluations []string `json:"postDeploymentEvaluations,omitempty"` } diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnevaluation_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnevaluation_types.go index 132461510e..b9866962ba 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnevaluation_types.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnevaluation_types.go @@ -43,7 +43,7 @@ type KeptnEvaluationSpec struct { // EvaluationDefinition refers to the name of the KeptnEvaluationDefinition // which includes the objectives for the KeptnEvaluation. // The KeptnEvaluationDefinition can be - // located in the same namespace as the KeptnEvaluation, or in the KLT namespace. + // located in the same namespace as the KeptnEvaluation, or in the Keptn namespace. EvaluationDefinition string `json:"evaluationDefinition"` // Retries indicates how many times the KeptnEvaluation can be attempted in the case of an error or // missed evaluation objective, before considering the KeptnEvaluation to be failed. diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptntask_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptntask_types.go index ff91d9d1ea..207d11fa8d 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha3/keptntask_types.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha3/keptntask_types.go @@ -35,7 +35,7 @@ type KeptnTaskSpec struct { // TaskDefinition refers to the name of the KeptnTaskDefinition // which includes the specification for the task to be performed. // The KeptnTaskDefinition can be - // located in the same namespace as the KeptnTask, or in the KLT namespace. + // located in the same namespace as the KeptnTask, or in the Keptn namespace. TaskDefinition string `json:"taskDefinition"` // Context contains contextual information about the task execution. // +optional diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkload_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkload_types.go index 1bc1d4ddd4..38e031457e 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkload_types.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkload_types.go @@ -39,21 +39,21 @@ type KeptnWorkloadSpec struct { Version string `json:"version"` // PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnWorkload. // The items of this list refer to the names of KeptnTaskDefinitions - // located in the same namespace as the KeptnApp, or in the KLT namespace. + // located in the same namespace as the KeptnApp, or in the Keptn namespace. PreDeploymentTasks []string `json:"preDeploymentTasks,omitempty"` // PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnWorkload. // The items of this list refer to the names of KeptnTaskDefinitions - // located in the same namespace as the KeptnWorkload, or in the KLT namespace. + // located in the same namespace as the KeptnWorkload, or in the Keptn namespace. PostDeploymentTasks []string `json:"postDeploymentTasks,omitempty"` // PreDeploymentEvaluations is a list of all evaluations to be performed // during the pre-deployment phase of the KeptnWorkload. // The items of this list refer to the names of KeptnEvaluationDefinitions - // located in the same namespace as the KeptnWorkload, or in the KLT namespace. + // located in the same namespace as the KeptnWorkload, or in the Keptn namespace. PreDeploymentEvaluations []string `json:"preDeploymentEvaluations,omitempty"` // PostDeploymentEvaluations is a list of all evaluations to be performed // during the post-deployment phase of the KeptnWorkload. // The items of this list refer to the names of KeptnEvaluationDefinitions - // located in the same namespace as the KeptnWorkload, or in the KLT namespace. + // located in the same namespace as the KeptnWorkload, or in the Keptn namespace. PostDeploymentEvaluations []string `json:"postDeploymentEvaluations,omitempty"` // ResourceReference is a reference to the Kubernetes resource // (Deployment, DaemonSet, StatefulSet or ReplicaSet) the KeptnWorkload is representing. From d400d8173bbc189defbbe079cc18300cbb9cd5dc Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 1 Sep 2023 17:36:51 -0700 Subject: [PATCH 05/31] regenerate API docs Signed-off-by: Meg McRoberts --- .../docs/crd-ref/lifecycle/v1alpha3/_index.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md b/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md index 7587d7c60c..d7b00afdb5 100644 --- a/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md +++ b/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md @@ -273,10 +273,10 @@ _Appears in:_ | `version` _string_ | Version defines the version of the application. For automatically created KeptnApps, the version is a function of all KeptnWorkloads that are part of the KeptnApp. | | `revision` _integer_ | Revision can be modified to trigger another deployment of a KeptnApp of the same version. This can be used for restarting a KeptnApp which failed to deploy, e.g. due to a failed preDeploymentEvaluation/preDeploymentTask. | | `workloads` _[KeptnWorkloadRef](#keptnworkloadref) array_ | Workloads is a list of all KeptnWorkloads that are part of the KeptnApp. | -| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | +| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | #### KeptnAppStatus @@ -341,10 +341,10 @@ _Appears in:_ | `version` _string_ | Version defines the version of the application. For automatically created KeptnApps, the version is a function of all KeptnWorkloads that are part of the KeptnApp. | | `revision` _integer_ | Revision can be modified to trigger another deployment of a KeptnApp of the same version. This can be used for restarting a KeptnApp which failed to deploy, e.g. due to a failed preDeploymentEvaluation/preDeploymentTask. | | `workloads` _[KeptnWorkloadRef](#keptnworkloadref) array_ | Workloads is a list of all KeptnWorkloads that are part of the KeptnApp. | -| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | +| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnApp. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | | `appName` _string_ | AppName is the name of the KeptnApp. | | `previousVersion` _string_ | PreviousVersion is the version of the KeptnApp that has been deployed prior to this version. | | `traceId` _object (keys:string, values:string)_ | TraceId contains the OpenTelemetry trace ID. | @@ -524,7 +524,7 @@ _Appears in:_ | `workloadVersion` _string_ | WorkloadVersion defines the version of the KeptnWorkload for which the KeptnEvaluation is done. | | `appName` _string_ | AppName defines the KeptnApp for which the KeptnEvaluation is done. | | `appVersion` _string_ | AppVersion defines the version of the KeptnApp for which the KeptnEvaluation is done. | -| `evaluationDefinition` _string_ | EvaluationDefinition refers to the name of the KeptnEvaluationDefinition which includes the objectives for the KeptnEvaluation. The KeptnEvaluationDefinition can be located in the same namespace as the KeptnEvaluation, or in the KLT namespace. | +| `evaluationDefinition` _string_ | EvaluationDefinition refers to the name of the KeptnEvaluationDefinition which includes the objectives for the KeptnEvaluation. The KeptnEvaluationDefinition can be located in the same namespace as the KeptnEvaluation, or in the Keptn namespace. | | `retries` _integer_ | Retries indicates how many times the KeptnEvaluation can be attempted in the case of an error or missed evaluation objective, before considering the KeptnEvaluation to be failed. | | `retryInterval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#duration-v1-meta)_ | RetryInterval specifies the interval at which the KeptnEvaluation is retried in the case of an error or a missed objective. | | `failAction` _string_ | | @@ -676,7 +676,7 @@ _Appears in:_ | Field | Description | | --- | --- | -| `taskDefinition` _string_ | TaskDefinition refers to the name of the KeptnTaskDefinition which includes the specification for the task to be performed. The KeptnTaskDefinition can be located in the same namespace as the KeptnTask, or in the KLT namespace. | +| `taskDefinition` _string_ | TaskDefinition refers to the name of the KeptnTaskDefinition which includes the specification for the task to be performed. The KeptnTaskDefinition can be located in the same namespace as the KeptnTask, or in the Keptn namespace. | | `context` _[TaskContext](#taskcontext)_ | Context contains contextual information about the task execution. | | `parameters` _[TaskParameters](#taskparameters)_ | Parameters contains parameters that will be passed to the job that executes the task. | | `secureParameters` _[SecureParameters](#secureparameters)_ | SecureParameters contains secure parameters that will be passed to the job that executes the task. These will be stored and accessed as secrets in the cluster. | @@ -769,10 +769,10 @@ _Appears in:_ | --- | --- | | `app` _string_ | AppName is the name of the KeptnApp containing the KeptnWorkload. | | `version` _string_ | Version defines the version of the KeptnWorkload. | -| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnWorkload, or in the KLT namespace. | -| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the KLT namespace. | -| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the KLT namespace. | +| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnWorkload, or in the Keptn namespace. | +| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the Keptn namespace. | +| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the Keptn namespace. | | `resourceReference` _[ResourceReference](#resourcereference)_ | ResourceReference is a reference to the Kubernetes resource (Deployment, DaemonSet, StatefulSet or ReplicaSet) the KeptnWorkload is representing. | | `workloadName` _string_ | WorkloadName is the name of the KeptnWorkload. | | `previousVersion` _string_ | PreviousVersion is the version of the KeptnWorkload that has been deployed prior to this version. | @@ -853,10 +853,10 @@ _Appears in:_ | --- | --- | | `app` _string_ | AppName is the name of the KeptnApp containing the KeptnWorkload. | | `version` _string_ | Version defines the version of the KeptnWorkload. | -| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the KLT namespace. | -| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnWorkload, or in the KLT namespace. | -| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the KLT namespace. | -| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the KLT namespace. | +| `preDeploymentTasks` _string array_ | PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnApp, or in the Keptn namespace. | +| `postDeploymentTasks` _string array_ | PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnTaskDefinitions located in the same namespace as the KeptnWorkload, or in the Keptn namespace. | +| `preDeploymentEvaluations` _string array_ | PreDeploymentEvaluations is a list of all evaluations to be performed during the pre-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the Keptn namespace. | +| `postDeploymentEvaluations` _string array_ | PostDeploymentEvaluations is a list of all evaluations to be performed during the post-deployment phase of the KeptnWorkload. The items of this list refer to the names of KeptnEvaluationDefinitions located in the same namespace as the KeptnWorkload, or in the Keptn namespace. | | `resourceReference` _[ResourceReference](#resourcereference)_ | ResourceReference is a reference to the Kubernetes resource (Deployment, DaemonSet, StatefulSet or ReplicaSet) the KeptnWorkload is representing. | From 946dd560b3c678079b35f5474509aaf428ff9288 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 1 Sep 2023 18:07:20 -0700 Subject: [PATCH 06/31] fix xref to "Enabling Keptn" Signed-off-by: Meg McRoberts --- docs/content/en/docs/implementing/integrate/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/implementing/integrate/_index.md b/docs/content/en/docs/implementing/integrate/_index.md index 8f89993332..9068cb3bd2 100644 --- a/docs/content/en/docs/implementing/integrate/_index.md +++ b/docs/content/en/docs/implementing/integrate/_index.md @@ -24,7 +24,7 @@ To integrate Keptn with your applications: * You must first [install](../../install/install.md) and -[enable](../../install/install.md//#enable-klt-for-your-cluster) +[enable](../../install/install.md//#enable-keptn-for-your-cluster) Keptn. * Annotate or label your workloads with either Keptn or Kubernetes keys. From 5edc7cdf1445e18f10c12840ed5e3f89030da237 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sat, 2 Sep 2023 23:10:55 -0700 Subject: [PATCH 07/31] yaml-crd-ref Signed-off-by: Meg McRoberts --- docs/content/en/docs/yaml-crd-ref/_index.md | 3 +-- docs/content/en/docs/yaml-crd-ref/app.md | 4 ++-- docs/content/en/docs/yaml-crd-ref/config.md | 2 +- .../content/en/docs/yaml-crd-ref/evaluationdefinition.md | 4 ++-- docs/content/en/docs/yaml-crd-ref/metric.md | 2 +- docs/content/en/docs/yaml-crd-ref/taskdefinition.md | 9 ++++----- 6 files changed, 11 insertions(+), 13 deletions(-) diff --git a/docs/content/en/docs/yaml-crd-ref/_index.md b/docs/content/en/docs/yaml-crd-ref/_index.md index 589530b8eb..0c97fcb83a 100644 --- a/docs/content/en/docs/yaml-crd-ref/_index.md +++ b/docs/content/en/docs/yaml-crd-ref/_index.md @@ -6,8 +6,7 @@ hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.htm --- This section provides comprehensive reference information about the -manifest files that must be populated -for the Keptn Lifecycle Toolkit +manifest files that must be populated for Keptn [Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). Each CRD is an object of an API library. diff --git a/docs/content/en/docs/yaml-crd-ref/app.md b/docs/content/en/docs/yaml-crd-ref/app.md index 780bbb42ff..1880891d5d 100644 --- a/docs/content/en/docs/yaml-crd-ref/app.md +++ b/docs/content/en/docs/yaml-crd-ref/app.md @@ -113,7 +113,7 @@ If used, these fields must be populated manually: Kubernetes defines [workloads](https://kubernetes.io/docs/concepts/workloads/) but does not define applications. -The Keptn Lifecycle Toolkit adds the concept of applications +Keptn adds the concept of applications defined as a set of workloads that can be executed. A `KeptnApp` resource is added into the repository of the deployment engine @@ -126,7 +126,7 @@ feature to generate a `KeptnApp` resource based on the [basic annotations](../implementing/integrate/#basic-annotations) that are applied to any of the workload resources. -This allows you to use the KLT observability features for existing resources +This allows you to use the Keptn observability features for existing resources without manually populating any Keptn related resources. The release lifecycle management feature diff --git a/docs/content/en/docs/yaml-crd-ref/config.md b/docs/content/en/docs/yaml-crd-ref/config.md index 0e308a3968..64e7433351 100644 --- a/docs/content/en/docs/yaml-crd-ref/config.md +++ b/docs/content/en/docs/yaml-crd-ref/config.md @@ -4,7 +4,7 @@ description: Define configuration values weight: 20 --- -`KeptnConfig` defines configuration values for the Keptn Lifecycle Toolkit. +`KeptnConfig` defines Keptn configuration values. ## Yaml Synopsis diff --git a/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md b/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md index 6d34fa9f5b..650ab998db 100644 --- a/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md +++ b/docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md @@ -8,7 +8,7 @@ weight: 20 A `KeptnEvaluationDefinition` assigns target values to [KeptnMetric](metric.md) queries. These are used as part of evaluation tasks -that can be run by the Keptn Lifecycle Toolkit +that Keptn runs as part of pre- and post-analysis phases of a workload or application. ## Yaml Synopsis @@ -61,7 +61,7 @@ spec: A `KeptnEvaluationDefinition` references one or more [KeptnMetric](metric.md) resources. When multiple `KeptnMetric`s are used, -the Keptn Lifecycle Toolkit considers the evaluation successful +Keptn considers the evaluation successful if **all** metrics meet their `evaluationTarget`. The `KeptnMetric` resource and associated diff --git a/docs/content/en/docs/yaml-crd-ref/metric.md b/docs/content/en/docs/yaml-crd-ref/metric.md index 848a7e08f6..79eab874b6 100644 --- a/docs/content/en/docs/yaml-crd-ref/metric.md +++ b/docs/content/en/docs/yaml-crd-ref/metric.md @@ -72,7 +72,7 @@ spec: Defaults to 5m. * **status** - * KLT fills in this information when the metric is evaluated. + * Keptn fills in this information when the metric is evaluated. It always records the time the metric was last evaluated. If the evaluation is successful, this stores the result in both human-readable and raw format. diff --git a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md index 3d011bd8a3..dbca310e32 100644 --- a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md +++ b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md @@ -5,8 +5,7 @@ weight: 89 --- A `KeptnTaskDefinition` defines tasks -that are run by the Keptn Lifecycle Toolkit -as part of the pre- and post-deployment phases of a +that Keptn runs as part of the pre- and post-deployment phases of a [KeptnApp](./app.md) or [KeptnWorkload](../crd-ref/lifecycle/v1alpha3/#keptnworkload). @@ -205,7 +204,7 @@ spec: resource that contains the function to be executed. * **parameters** - An optional field to supply input parameters to a function. - The Lifecycle Toolkit passes the values defined inside the `map` field + Keptn passes the values defined inside the `map` field as a JSON object. For example: @@ -280,7 +279,7 @@ The `python-runtime` runner provides a way to easily define a task using Python 3. You do not need to specify the image, volumes, and so forth. Instead, just provide a Python script -and KLT sets up the container and runs the script as part of the task. +and Keptn sets up the container and runs the script as part of the task. ```yaml apiVersion: lifecycle.keptn.sh/v?alpha? @@ -355,7 +354,7 @@ The `python-runtime` runner is used to define tasks using Python 3 code. resource that contains the function to be executed. * **parameters** - An optional field to supply input parameters to a function. - The Lifecycle Toolkit passes the values defined inside the `map` field + Keptn passes the values defined inside the `map` field as a JSON object. For example: From 1983d2442c92315d556796bbef154cbdd8d08c9f Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sat, 2 Sep 2023 23:33:49 -0700 Subject: [PATCH 08/31] migrate Signed-off-by: Meg McRoberts --- docs/content/en/docs/migrate/_index.md | 15 ++-- .../en/docs/migrate/metrics-observe/_index.md | 18 ++--- .../en/docs/migrate/strategy/_index.md | 70 +++++++++---------- 3 files changed, 51 insertions(+), 52 deletions(-) diff --git a/docs/content/en/docs/migrate/_index.md b/docs/content/en/docs/migrate/_index.md index 501837400d..1a67dfd5c1 100644 --- a/docs/content/en/docs/migrate/_index.md +++ b/docs/content/en/docs/migrate/_index.md @@ -1,12 +1,11 @@ --- -title: Migrating to the Keptn Lifecycle Toolkit -description: Notes to help you migrate from Keptn v1 to KLT +title: Migrating to Keptn +description: Notes to help you migrate from Keptn v1 to Keptn weight: 900 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -The Keptn Lifecycle Toolkit uses a different paradigm -than that used for Keptn v1 +Keptn uses a different paradigm than that used for Keptn v1 and so migration from Keptn v1 will not be a straight-forward process. In this section, we will assemble information to help people who want to move from Keptn v1 as it becomes available. @@ -19,10 +18,10 @@ We hope you will contribute your experiences and questions that you have. These instructions mostly assume that you want to utilize -the full Keptn Lifecycle Toolkit. +all Keptn features. Note, however, that you can install and use some functionality such as Keptn Metrics and Observability -without implementing all KLT features. +without implementing all Keptn features. This section currently includes the following topics: @@ -31,8 +30,8 @@ This section currently includes the following topics: * [Set up metrics and observability](metrics-observe) -- When you identify the data-sources being used - and provide KLT with information about your OpenTelemetry collector, - KLT begins to accumulate information that you can view + and provide Keptn with information about your OpenTelemetry collector, + Keptn begins to accumulate information that you can view for your deployment. * [Migrate Quality Gates to Keptn Evaluations](evaluations) diff --git a/docs/content/en/docs/migrate/metrics-observe/_index.md b/docs/content/en/docs/migrate/metrics-observe/_index.md index 77ee19fa64..4d76e590d6 100644 --- a/docs/content/en/docs/migrate/metrics-observe/_index.md +++ b/docs/content/en/docs/migrate/metrics-observe/_index.md @@ -1,5 +1,5 @@ --- -title: Migrate Quality Gates to KLT metrics and evaluations +title: Migrate Quality Gates to Keptn metrics and evaluations description: How to translate Quality Gates into Keptn Metrics and evaluations weight: 40 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html @@ -13,25 +13,25 @@ We hope you will contribute your experiences and questions that you have. The SLIs and SLOs used for Keptn v1 quality gates can be ported to -KLT KeptnMetrics and KeptnEvaluationDefintions. +Keptn KeptnMetrics and KeptnEvaluationDefintions. -By default, KLT includes additional observability features +By default, Keptn includes additional observability features that are not included in Keptn v1: * [DORA metrics](../../implementing/dora) * [OpenTelemetry observability](../../implementing/otel.md) -Keptn v1 Quality Gates can be migrated into KLT metrics -and KLT evaluations. +Keptn v1 Quality Gates can be migrated into Keptn metrics +and Keptn evaluations. > **Note** The full SLO capabilities provided by Keptn v1 such as weighting and scoring -are currently under development for KLT. +are currently under development for Keptn. You can follow and participate in the design and implementation process at [GitHub Epic 1646](https://github.com/keptn/lifecycle-toolkit/issues/1646). -Notice the paradigm differences when implementing KLT evaluations: +Notice the paradigm differences when implementing Keptn evaluations: * Data providers are installed and configured into your Kubernetes cluster using Helm charts and standard practices. @@ -40,13 +40,13 @@ Notice the paradigm differences when implementing KLT evaluations: for each instance of each data provider. This resource specifies the URL and namespace for the data provider and gives it a unique `name` that can be referenced by other resources. - This is the only KLT specific configuration that is required. + This is the only Keptn specific configuration that is required. * Each query that is specified in your Keptn v1 [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/) file should be converted into its own [KeptnMetric](../../yaml-crd-ref/metric.md) resource if you are using it for an evaluation. - Note that KLT supports using multiple instances of multiple data providers. + Note that Keptn supports using multiple instances of multiple data providers. * Simple Keptn v1 comparisons that are defined in [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/) files can be converted to diff --git a/docs/content/en/docs/migrate/strategy/_index.md b/docs/content/en/docs/migrate/strategy/_index.md index 6b54796a48..438a047767 100644 --- a/docs/content/en/docs/migrate/strategy/_index.md +++ b/docs/content/en/docs/migrate/strategy/_index.md @@ -15,29 +15,29 @@ and questions that you have. Before you begin the migration project, we suggest that you run through the exercises in [Getting started](../../getting-started/) -to familiarize yourself with how the Keptn Lifecycle Toolkit works. +to familiarize yourself with how Keptn works. When you are ready to begin the migration, follow the instructions in [Installation and upgrade](../../install) to set up your Kubernetes cluster -and install KLT on it. +and install Keptn on it. On this page, we discuss some of the major paradigm shifts -in KLT relative to Keptn v1 +in Keptn relative to Keptn v1 and then discuss how elements of your Keptn v1 can be implemented -for the Keptn Lifecycle Toolkit. +for Keptn. -## The Keptn Lifecycle Toolkit paradigm +## The Keptn paradigm -The Keptn Lifecycle Toolkit uses a different paradigm +Keptn uses a different paradigm than Keptn v1 and so migration requires technical adjustments. Much of the logic and functionality of your Keptn v1 projects -can be migrated to KLT -but must be rewritten to utilize KLT components. +can be migrated to Keptn +but must be rewritten to utilize Keptn components. Some key points: -* KLT uses native Kubernetes CRDs +* Keptn uses native Kubernetes CRDs to configure SLIs/SLOs, tasks, and other elements that are part of the environment where the application deployment lives rather than using its own Git repo and its @@ -46,21 +46,21 @@ Some key points: * See the [CRD Reference](../../yaml-crd-ref) section for pages that describe the Keptn manifests - that you populate manually for KLT. + that you populate manually for Keptn. * See the [API Reference](../../crd-ref) for a comprehensive reference to all resources defined for Keptn. -* KLT is not a delivery tool +* Keptn is not a delivery tool because it does not provide promotion. Instead, it works with standard deployment tools such as ArgoCD, Flux, even `kubectl -- apply`. - KLT then prevents the scheduling and deployment + Keptn then prevents the scheduling and deployment of workflows if the environment does not meet the user-defined requirements. -* KLT operates on a +* Keptn operates on a [KeptnApp](../../yaml-crd-ref/app.md) resource that is an amalgamation of multiple Kubernetes workloads, @@ -68,13 +68,13 @@ Some key points: Each workload deploys a separate microservice, which can be deployed at different times using different tools. -* KLT integrates with continuous delivery tools +* Keptn integrates with continuous delivery tools to insures that a `KeptnApp` is not deployed if it does not meet the user-defined requirements for all the associated workloads. It also exposes metrics to evaluate the success/status of a deployment. -* KLT provides an operator +* Keptn provides an operator that can observe and orchestrate application-aware workload life cycles. This operator leverages Kubernetes webhooks and extends the Kubernetes scheduler @@ -85,22 +85,22 @@ Some key points: it can execute pre- and post-deployment evaluations and tasks using Kubernetes capabilities. -* KLT provides extensive observability data +* Keptn provides extensive observability data using OpenTelemetry and Prometheus rather than storing the data in a special Keptn database. This data can be displayed using Grafana and Jaeger or the dashboard of your choice. -For in-depth information about KLT components +For in-depth information about Keptn components and how they work, see the [Architecture](../../concepts/architecture) section. -## Disposition of Keptn v1 components in KLT +## Disposition of Keptn v1 components in Keptn To help you wrap your mind around the migration process, this lists Keptn v1 components -and identifies their possible disposition when you migrate to KLT. +and identifies their possible disposition when you migrate to Keptn. ### project @@ -109,7 +109,7 @@ A project is defined by a [shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/) file. -KLT does not recognize projects. +Keptn does not recognize projects. Many Keptn v1 projects may translate into `KeptnApp` resources but others will not. For example, if your Keptn v1 project has a large number of services, @@ -119,8 +119,8 @@ but, since few applications are stored in a mono-repo, it is difficult to implement a project-as-application paradigm. In general, the Keptn v1 project is a useful as a reference list -when migrating to KLT -but may not directly translate to a KLT resource. +when migrating to Keptn. +but may not directly translate to a Keptn resource. ### service @@ -131,8 +131,8 @@ a service may represent a micro-service but it could instead be a wrapper for something else, like "the entire public website" -KLT does not have the concept of a service. -When migrating to KLT, +Keptn does not have the concept of a service. +When migrating to Keptn, you need to analyze what each service is doing and translate that into an appropriate resource. The closest analogy is a Kubernetes @@ -161,7 +161,7 @@ For example: ### stage A stage is a subsection of a project. -Because KLT is not a delivery tool, +Because Keptn is not a delivery tool, it has no concept of a `stage` but rather depends on a deployment engine. However, the logic of the stages can be useful @@ -177,7 +177,7 @@ when architecting the migration: Stage functionality could be implemented in many different ways. Some functionality might be implemented in different namespaces -or even in different KLT-enabled clusters, +or even in different Keptn-enabled clusters, allowing a tool such as ArgoCD to handle promotion. ### sequence @@ -214,16 +214,16 @@ to trigger a data encryption and backup operation, or a file movement over a network, or other arbitrary activities that may or may not have anything to do with an application's lifecycle. -When migrating to KLT, +When migrating to Keptn, sequences that are not part of the lifecycle workflow -should not be handled by KLT +should not be handled by Keptn but should instead be handled by the pipeline engine tools being used such as Jenkins, Argo Workflows, Flux, and Tekton. ### task Keptn v1 defines some specific types of tasks, -each of which is translated to a KLT resource +each of which is translated to a Keptn resource that is appropriate for the activity: * A Keptn v1 **deployment task** becomes a @@ -258,7 +258,7 @@ whereas Keptn v1 sequences and tasks can not execute in parallel. * If you have actions that need to execute sequentially, create a single `KeptnTaskDefinition` that calls each action in order. * If you have tasks that can execute in parallel, - migrating to KLT may improve the performance of the deployment. + migrating to Keptn may improve the performance of the deployment. ### SLIs @@ -269,10 +269,10 @@ represent queries from the data provider such as Prometheus, Dynatrace, or Datadog, which is configured as a Keptn integration. -When migrating to KLT, you need to define a +When migrating to Keptn, you need to define a [KeptnMetricsProvider](../../yaml-crd-ref/metricsprovider.md) resource for the data provider(s) you are using. -Note that KLT allows you to support multiple data providers +Note that Keptn allows you to support multiple data providers and multiple instances of each data provider for your SLIs whereas Keptn v1 only allows you to use one SLI per project. @@ -283,7 +283,7 @@ resources. ### SLOs -KLT at this time does not support the full range +Keptn at this time does not support the full range of Quality Gates evaluations that are represented by [SLOs](https://keptn.sh/docs/1.0.x/reference/files/slo/). Facilities such as weighting of SLIs and scoring of the evaluation @@ -297,7 +297,7 @@ resources. ### Remediation -KLT does not currently support the same level of +Keptn does not currently support the same level of [remediations](https://keptn.sh/docs/1.0.x/reference/files/remediation/) as Keptn v1 does, but it does provide limited "Day 2" facilities: @@ -329,5 +329,5 @@ you may be able to use the `deno-runtime` runner. If the JES container code is written in Python 3, you may be able to use the `python-runtime` runner. -Note that there is no need for integrations for data providers in KLT; +Note that there is no need for integrations for data providers in Keptn; these are configured as `KeptnMetricsProvider` resources. From c425c4cf2e6c00e6144f8a8c84a337672368826b Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 3 Sep 2023 00:14:00 -0700 Subject: [PATCH 09/31] contributing guide Signed-off-by: Meg McRoberts --- docs/content/en/contribute/_index.md | 2 +- .../docs/source-file-structure/_index.md | 24 +++++++++---------- .../general/contrib-guidelines-gen/_index.md | 8 +++---- .../general/git/pr-create/_index.md | 2 +- .../contribute/general/technologies/_index.md | 4 ++-- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/content/en/contribute/_index.md b/docs/content/en/contribute/_index.md index 2819bd6ff6..cc77f6dff9 100644 --- a/docs/content/en/contribute/_index.md +++ b/docs/content/en/contribute/_index.md @@ -1,6 +1,6 @@ --- title: Contributing to Keptn -description: How to contribute to the Keptn projects +description: How to contribute to the Keptn project linktitle: Contributing weight: 400 menu: diff --git a/docs/content/en/contribute/docs/source-file-structure/_index.md b/docs/content/en/contribute/docs/source-file-structure/_index.md index 4b26ff357c..3aaeca389b 100644 --- a/docs/content/en/contribute/docs/source-file-structure/_index.md +++ b/docs/content/en/contribute/docs/source-file-structure/_index.md @@ -4,7 +4,7 @@ description: Structure source files with Metadata weight: 400 --- -The source files for the KLT documentation +The source files for the Keptn documentation are stored in the same github repository as the source code. This page explains how the documentation source files are organized. @@ -24,25 +24,25 @@ The subdirectories correspond to the contents listed in the right frame. In the order they appear in the rendered docs, the subdirectories are: * **intro-klt** (Introduction to the Keptn Lifecycle Toolkit): - A brief overview of KLT, its features and use cases, and its history + A brief overview of Keptn, its features and use cases, and its history * **getting-started** (Getting started): - A hands-on exercise that demonstrates the capabilities of KLT + A hands-on exercise that demonstrates the capabilities of Keptn * **tutorials** (Tutorials): - Additional hands-on exercises to introduce new users to KLT + Additional hands-on exercises to introduce new users to Keptn * **install** (Installation and Upgrade): - Requirements and instructions for installing and enabling KLT -* **operate** (Operate KLT): - Guides about running and managing the KLT cluster + Requirements and instructions for installing and enabling Keptn +* **operate** (Operate Keptn): + Guides about running and managing the Keptn cluster * **implementing** (Implementing Keptn applications): This is currently a catch-all section for guides and how-to material about implementing Keptn features. It needs to be restructured and subdivided * **troubleshooting.md** (Troubleshooting Guide): - How to diagnose and solve common problems with KLT + How to diagnose and solve common problems with Keptn * **architecture** (Architecture): - Information about how KLT actually works + Information about how Keptn actually works * **crd-ref** (API Reference): - Comprehensive information about all the APIs that define the KLT CRDs. + Comprehensive information about all the APIs that define the Keptn CRDs. This section is auto-generated from source code and should never be modified in the *docs* directory. The source for the authored text can be modified @@ -51,7 +51,7 @@ In the order they appear in the rendered docs, the subdirectories are: Reference pages for the CRs that users must populate. This is a subset of the CRDs documented in the *API Reference* section * **migrate** (Migrating to the Keptn Lifecycle Toolkit): - Information to help users who are migrating to KLT + Information to help users who are migrating to Keptn from Keptn V1 ## Contributing guide @@ -131,7 +131,7 @@ The system for assigning weights for the docs landing page allows for maximum flexibility as we create new sections: * General introductory material uses weight values under 100. -* Guide material about using specific KLT features +* Guide material about using specific Keptn features use weight value of 2**. * Reference material uses weight values of 5**. * Other documents use weight values of 7**. diff --git a/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md b/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md index ca4aa2dec9..8075e174fb 100644 --- a/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md +++ b/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md @@ -1,11 +1,11 @@ --- title: Contribution Guidelines -description: Guidelines for contributing to Keptn Lifecycle Toolkit -weight: 50 +description: Guidelines for contributing towards Keptn +weight: 300 --- -Before using the **Keptn Lifecycle Toolkit** -as a contributor to the Keptn Lifecycle Toolkit repository, +Before using Keptn +as a contributor to the Keptn `lifecycle-controller` repository, it is expected that you comply with the guidelines while making contributions towards the repository. diff --git a/docs/content/en/contribute/general/git/pr-create/_index.md b/docs/content/en/contribute/general/git/pr-create/_index.md index 75e6a9dee7..2817b740ca 100644 --- a/docs/content/en/contribute/general/git/pr-create/_index.md +++ b/docs/content/en/contribute/general/git/pr-create/_index.md @@ -25,7 +25,7 @@ to the repository are: 1. Switch back to the `main` branch in your repository, and ensure that it is up to date - with the `main` branch of the Keptn Lifecycle Toolkit: + with the `main` Keptn branch: ```bash git remote add upstream https://github.com/keptn/lifecycle-toolkit.git diff --git a/docs/content/en/contribute/general/technologies/_index.md b/docs/content/en/contribute/general/technologies/_index.md index b9cafb4b65..2b3f2dca0f 100644 --- a/docs/content/en/contribute/general/technologies/_index.md +++ b/docs/content/en/contribute/general/technologies/_index.md @@ -1,13 +1,13 @@ --- title: Technologies to get familiar -description: Technologies to get familiar before working with Keptn lifecycle toolkit +description: Technologies to get familiar before working with Keptn weight: 100 --- ### Related Technologies You should understand some related technologies -to effectively use and contribute to the Keptn lifecycle-toolkit. +to effectively use and contribute to Keptn. This section provides links to some materials that can help your learning. The information has been gathered from the community and is subject to alteration. If you have suggestions about additional content that should be included in this list, From daf975a4ade183c40d80603dbfa1b74bcc7f57c8 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 3 Sep 2023 14:29:24 -0700 Subject: [PATCH 10/31] first readmes Signed-off-by: Meg McRoberts --- README.md | 49 +++++++++++++----------- examples/sample-app/README.md | 2 +- examples/support/argo/README.md | 8 ++-- examples/support/observability/README.md | 2 +- 4 files changed, 33 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 3e0c80bdb8..5eefdd51c5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Keptn Lifecycle Toolkit +# Keptn ![build](https://img.shields.io/github/actions/workflow/status/keptn/lifecycle-toolkit/CI.yaml?branch=main) ![Codecov](https://img.shields.io/codecov/c/github/keptn/lifecycle-toolkit?token=KPGfrBb2sA) @@ -7,18 +7,21 @@ [![GitHub Discussions](https://img.shields.io/github/discussions/keptn/lifecycle-toolkit)](https://github.com/keptn/lifecycle-toolkit/discussions) This is the primary repository for -the Keptn Lifecycle Toolkit (KLT) software and documentation. -KLT provides a “cloud-native” approach +the Keptn software and documentation. +Keptn provides a “cloud-native” approach for managing the application release lifecycle metrics, observability, health checks, with pre- and post-deployment evaluations and tasks. It is an incubating project, under the umbrella of the [Keptn Application Lifecycle working group](https://github.com/keptn/wg-app-lifecycle). +> **Note:** Keptn was developed under the code name of + "Keptn Lifecycle Controller" or "KLT" for short. + The source code contains many vestiges of these names. + ## Goals -The Keptn Lifecycle Toolkit provides Cloud Native teams with -the following capabilities: +Keptn provides Cloud Native teams with the following capabilities: - Pre-requisite evaluation before deploying workloads and applications - Finding out when an application (not just a workload) is ready and working @@ -28,10 +31,10 @@ the following capabilities: ![Operator Maturity Model with third level circled in](./assets/operator-maturity.jpg) -The Keptn Lifecycle Toolkit can be seen as a general purpose and declarative +Keptn can be seen as a general purpose and declarative [Level 3 operator](https://operatorframework.io/operator-capabilities/) for your Application. -For this reason, the Keptn Lifecycle Toolkit is agnostic to deployment tools +For this reason, Keptn is agnostic to deployment tools that are used and works with any GitOps solution. ## Status @@ -61,13 +64,13 @@ The status follows the ## Installation -The Keptn Lifecycle Toolkit can be installed on any Kubernetes cluster +Keptn can be installed on any Kubernetes cluster running Kubernetes >=1.24. -Note that the Lifecycle Toolkit is not currently compatible with +Note that Keptn is not currently compatible with [vcluster](https://github.com/loft-sh/vcluster). Use the following command sequence -to install the latest release of the Keptn Lifecycle Toolkit: +to install the latest release of Keptn: ```shell helm repo add klt https://charts.lifecycle.keptn.sh @@ -80,32 +83,34 @@ helm upgrade --install keptn klt/klt -n keptn-lifecycle-toolkit-system --create- For more info about Keptn, please see our [documentation](https://lifecycle.keptn.sh/docs/), specifically: -- [Introduction to Keptn Lifecycle Toolkit](https://lifecycle.keptn.sh/docs/intro-klt/) - gives an overview of the KLT facilities. +- [Introduction to Keptn](https://lifecycle.keptn.sh/docs/intro-klt/) + gives an overview of the Keptn facilities. - [Getting started](https://lifecycle.keptn.sh/docs/getting-started/) - includes some short exercises to introduce you to KLT. + includes some short exercises to introduce you to Keptn. - [Installation and upgrade](https://lifecycle.keptn.sh/docs/install/) provides information about preparing your Kubernetes cluster - then installing and enabling KLT. -- [Implementing KLT applications](https://lifecycle.keptn.sh/docs/implementing/) - documents how to integrate KLT to work with your existing deployment engine + then installing and enabling Keptn. +- [Implementing Keptn applications](https://lifecycle.keptn.sh/docs/implementing/) + documents how to integrate Keptn to work with your existing deployment engine and implement its variouos features. - [Architecture](https://lifecycle.keptn.sh/docs/concepts/architecture/) provides detailed technical information - about how KLT works. + about how Keptn works. - [CRD Reference](https://lifecycle.keptn.sh/docs/yaml-crd-ref/) and [API Reference](https://lifecycle.keptn.sh/docs/crd-ref/) provide detailed reference material for the custom resources - used to configure KLT. + used to configure Keptn. - [Contributing to Keptn](https://lifecycle.keptn.sh/contribute/) provides information about how to contribute to the Keptn project. You can also find a number of video presentations and demos -about the Keptn Lifecycle Toolkit on the +about Keptn on the [YouTube Keptn channel](https://www.youtube.com/@keptn). +Videos that refer to the "Keptn Lifecycle Controller" +are relevant for the Keptn project. ## Architecture -The Keptn Lifecycle Toolkit is composed of the following components: +Keptn is composed of the following components: - Keptn Lifecycle Operator - Keptn Scheduler @@ -132,11 +137,11 @@ After the Post-Deployment checks, SLOs can be validated using an interface for retrieving SLI data from a provider e.g, [Prometheus](https://prometheus.io/). -Finally, the Keptn Lifecycle Toolkit exposes Metrics and Traces +Finally, Keptn exposes Metrics and Traces of the entire Deployment cycle with [OpenTelemetry](https://opentelemetry.io/). -![KLT Architecture](./assets/architecture.png) +![Keptn Architecture](./assets/architecture.png) ### Webhook diff --git a/examples/sample-app/README.md b/examples/sample-app/README.md index e814855f02..46da3f5855 100644 --- a/examples/sample-app/README.md +++ b/examples/sample-app/README.md @@ -1,6 +1,6 @@ # Sample Application -This example should demonstrate the capabilities of the lifecycle toolkit as illustrated here: +This example demonstrates the Keptn capabilities as illustrated here: ![img.png](assets/big-picture.png) diff --git a/examples/support/argo/README.md b/examples/support/argo/README.md index 5560b18cd7..bd07bd3a93 100644 --- a/examples/support/argo/README.md +++ b/examples/support/argo/README.md @@ -1,7 +1,7 @@ # Deploying an application using the Keptn Lifecycle Controller and ArgoCD -In this example, we will show you how to install our sample application *podtatohead* using the Keptn Lifecycle -Controller and [ArgoCD](https://argo-cd.readthedocs.io/en/stable/). +In this example, we will show you how to install our sample application *podtatohead* +using Keptn and [ArgoCD](https://argo-cd.readthedocs.io/en/stable/). ## TL;DR @@ -17,8 +17,8 @@ Controller and [ArgoCD](https://argo-cd.readthedocs.io/en/stable/). ## Prerequisites -This tutorial assumes, that you already installed the Keptn Lifecycle Controller ( -see ). +This tutorial assumes, that you already installed Keptn +(see ). The installation instructions can be found [here](https://github.com/keptn/lifecycle-toolkit#deploy-the-latest-release). Furthermore, you have to install diff --git a/examples/support/observability/README.md b/examples/support/observability/README.md index 7dc9a1646d..50909f010b 100644 --- a/examples/support/observability/README.md +++ b/examples/support/observability/README.md @@ -78,7 +78,7 @@ you should see an entry for the otel-collector: Also, in the [Graph](http://localhost:9090/graph?g0.expr=&g0.tab=1&g0.stacked=0&g0.show_exemplars=0&g0.range_input=1h) -section, you can retrieve metrics reported by the Keptn Lifecycle Controller +section, you can retrieve metrics reported by Keptn (all of the available metrics start with the `keptn` prefix): ![Screenshot of the auto-complete menu in a Prometheus query](./assets/metrics.png) From 67501d72f6a81e09b34ca91826a4d61f4fb860ba Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 3 Sep 2023 16:52:37 -0700 Subject: [PATCH 11/31] intro-klt Signed-off-by: Meg McRoberts --- docs/content/en/docs/intro-klt/_index.md | 73 ++++++++++++------------ 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/docs/content/en/docs/intro-klt/_index.md b/docs/content/en/docs/intro-klt/_index.md index 1181036412..cd70bca0d5 100644 --- a/docs/content/en/docs/intro-klt/_index.md +++ b/docs/content/en/docs/intro-klt/_index.md @@ -1,17 +1,17 @@ --- -title: Introduction to Keptn Lifecycle Toolkit -description: An introduction to KLT and the usecases. +title: Introduction to Keptn +description: An introduction to Keptn and the usecases. weight: 20 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- -This section contains tutorials on how to use the Keptn Lifecycle Toolkit. +This section contains tutorials on how to use Keptn. When you understand the toolkit, begin with the [getting started guide](../getting-started/). ---- -The Keptn Lifecycle Toolkit (KLT) implements observability +Keptn implements observability for deployments and seamlessly integrates with GitOps tools such as ArgoCD, Flux, and Gitlab and brings application awareness to your Kubernetes cluster. @@ -20,11 +20,11 @@ These standard GitOps deployment tools do an excellent job at deploying applications but do not handle all issues that are required to ensure that your deployment is usable. -The Keptn Lifecycle Toolkit "wraps" a standard Kubernetes GitOps deployment +Keptn "wraps" a standard Kubernetes GitOps deployment with the capability to automatically handle issues before and after the actual deployment. -Pre-deployment issues that Keptn Lifecycle Toolkit can handle: +Pre-deployment issues that Keptn can handle: * Send appropriate notifications that this deployment is about to happen * Check that downstream services meet their SLOs @@ -32,7 +32,7 @@ Pre-deployment issues that Keptn Lifecycle Toolkit can handle: * Ensure that your infrastructure has the resources necessary for a successful deployment -Post-deployment issues that Keptn Lifecycle Toolkit can handle: +Post-deployment issues that Keptn can handle: * Integrate with tooling beyond the standard Kubernetes probes * Automatically test the deployment @@ -41,14 +41,14 @@ Post-deployment issues that Keptn Lifecycle Toolkit can handle: * Send appropriate notifications about whether the deployment was successful or unsuccessful -KLT can evaluate both workload (single service) tests +Keptn can evaluate both workload (single service) tests and SLO evaluations before and after the actual deployment. Multiple workloads can also be logically grouped and evaluated as a single cohesive unit called a `KeptnApp`. In other words, a `KeptnApp` is a collection of multiple workloads. -KLT is tool- and vendor neutral and does not depend on particular GitOps tooling. -KLT emits signals at every stage +Keptn is tool- and vendor neutral and does not depend on particular GitOps tooling. +Keptn emits signals at every stage (Kubernetes events, OpenTelemetry metrics and traces) to ensure that your deployments are observable. It supports the following steps: @@ -66,8 +66,8 @@ All of these things can be executed for a workload or for a [KeptnApp](https://l ## Main features of : Metrics, Observability and Release lifecycle -* **Custom Metrics:** The Custom Keptn Metrics feature in the -Keptn Lifecycle Toolkit allows you to define metrics from +* **Custom Metrics:** The Custom Keptn Metrics feature in +Keptn allows you to define metrics from multiple data sources in your Kubernetes cluster. It supports deployment tools like Argo, Flux, KEDA, HPA, or Keptn for automated decision-making based on observability data. @@ -78,19 +78,19 @@ The Keptn Metrics Server unifies and standardizes access to data from various sources, simplifying configuration and integration into a single set of metrics. -* **Observability:** The Keptn Lifecycle Toolkit (KLT) ensures observability +* **Observability:** Keptn ensures observability for Kubernetes deployments by creating a comprehensive trace of all Kubernetes activities within a deployment. It introduces the concept of applications, which connect logically related workloads using different deployment strategies. -With KLT, you can easily understand deployment durations and failures across +With Keptn, you can easily understand deployment durations and failures across multiple strategies. It captures DORA metrics and exposes them as OpenTelemetry metrics. The observability data includes out-of-the-box DORA metrics, traces from OpenTelemetry, and custom Keptn metrics from configured data providers. Visualizing this information is possible using dashboard tools like Grafana. -* **Release Lifecycle:** The Lifecycle Toolkit offers versatile functionalities +* **Release Lifecycle:** Keptn offers versatile functionalities for deployment scenarios, including pre-deployment validation, image scanning, and post-deployment tasks like test execution and stakeholder notification. It automatically validates against Service Level Objectives (SLOs) and provides @@ -102,72 +102,73 @@ environment and confirming software health against SLOs like performance and user experience. Additionally, it enables monitoring of new logs from log monitoring solutions. -To get started with Keptn Lifecycle Toolkit, refer to the +To get started with Keptn, refer to the [Getting Started Exercises](https://lifecycle.keptn.sh/docs/getting-started/) for detailed instructions and examples. This guide will walk you through the installation process and help you set up -your environment for using KLT effectively. +your environment for using Keptn effectively. -## Compare Keptn Lifecycle Toolkit and Keptn LTS +## Keptn and Keptn V1 -The Keptn Lifecycle Controller (KLT) is a Keptn subproject -whose design reflects lessons we learned while developing Keptn LTS. -KLT recognizes that tools such as Argo and Flux +Keptn is a Keptn subproject +whose design reflects lessons we learned while developing Keptn V1. +Keptn recognizes that tools such as Argo and Flux are very good at deploying applications. However, these deployment tools do not provide pre-deployment and post-deployment evaluations and actions; -this is what KLT adds. +this is what Keptn adds. -Keptn LTS is a long-term support release +Keptn V1 is a long-term support release that can deploy applications on platforms other than Kubernetes, can accommodate complex scoring algorithms for SLO evaluations, and can implement remediations (self-healing) for problems discovered on the production site. -Keptn Lifecycle Toolkit includes multiple features +Keptn includes multiple features that can be implemented independently or together. Different features are at different levels of stability. -See the [Keptn Lifecycle Toolkit README file](https://github.com/keptn/lifecycle-toolkit/blob/main/README.md) +See the [Keptn README file](https://github.com/keptn/lifecycle-toolkit/blob/main/README.md) for a list of the features that have been implemented to date and their level of stability. In a December 2022 Keptn Community meeting, we discussed the differences and similarities -between Keptn and the Keptn Lifecycle Toolkit +between Keptn V1 and Keptn to help you decide which best fits your needs. View the recording: [Compare Keptn V1 and the Keptn Lifecycle Toolkit](https://www.youtube.com/watch?v=-cKyUKFjtwE&t=170s) -## Overviews of Keptn Lifecycle Toolkit +## Overviews of Keptn -A number of presentations are available to help you understand -the Keptn Lifecycle Toolkit: +A number of presentations are available to help you understand Keptn. +Note that many of these refer to the "Keptn Lifecycle Controller", +which was the development code name for Keptn. * [Orchestrating and Observing GitOps Deployments with Keptn](https://www.youtube.com/watch?v=-cKyUKFjtwE&t=11s) discusses the evolution of Keptn - and the concepts that drive the Keptn Lifecycle Toolkit, - then gives a simple demonstration of a Keptn Lifecycle Controller implementation. + and the concepts that it, + then gives a simple demonstration of a Keptn implementation. * [Introducing Keptn Lifecycle Toolkit](https://youtu.be/449HAFYkUlY) - gives an overview of what KLT does and how to implement it. + gives an overview of what Keptn does and how to implement it. * [Keptn Lifecycle Toolkit Demo Tutorial on k3s, with ArgoCD for GitOps, OTel, Prometheus and Grafana](https://www.youtube.com/watch?v=6J_RzpmXoCc) - is a short video demonstration of how the Keptn Lifecycle Toolkit works. + is a short video demonstration of how Keptn works. You can download the exercise and run it for yourself; notes below the video give a link to the github repo. The README file in that repo gives instructions for installing the software either automatically or manually. * [What is the Keptn Lifecycle Toolkit?](https://isitobservable.io/observability/kubernetes/what-is-the-keptn-lifecycle-toolkit) - blog discusses KLT as part of the "Is It Observable?" series. + blog discusses Keptn as part of the "Is It Observable?" series. This links to: * [What is Keptn Lifecycle Toolkit?](https://www.youtube.com/watch?v=Uvg4uG8AbFg) - is a video that steps through the process of integrating KLT + is a video that steps through the process of integrating Keptn with your existing cloud native cluster. * [Keptn Lifecycle Toolkit: Installation and KeptnTask Creation in Minutes](https://www.youtube.com/watch?v=Hh01bBwZ_qM) - demonstrates how to install KLT and create your first KeptnTask in less than ten minutes. + demonstrates how to install Keptn and create your first KeptnTask in less than ten minutes. * You can explore the [GitHub repository](https://github.com/isItObservable/keptn-lifecycle-Toolkit) for more information. From edb30e7322362271f7b165f54ce871bcfd8d075b Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 3 Sep 2023 22:22:04 -0700 Subject: [PATCH 12/31] more READMEs Signed-off-by: Meg McRoberts --- helm/chart/README.md | 6 +++--- runtimes/deno-runtime/README.md | 6 +++--- runtimes/python-runtime/README.md | 6 +++--- scheduler/README.md | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/helm/chart/README.md b/helm/chart/README.md index 192403a86c..e55e85d37b 100644 --- a/helm/chart/README.md +++ b/helm/chart/README.md @@ -1,7 +1,7 @@ -# Keptn Lifecycle Toolkit +# Keptn -KLT introduces a more cloud-native approach for pre- and post-deployment, as well as the concept of application health -checks +Keptn introduces a more cloud-native approach for pre- and post-deployment, +as well as the concept of application health checks ## Parameters diff --git a/runtimes/deno-runtime/README.md b/runtimes/deno-runtime/README.md index 51792db243..a861c7acbf 100644 --- a/runtimes/deno-runtime/README.md +++ b/runtimes/deno-runtime/README.md @@ -10,9 +10,9 @@ docker build -t keptnsandbox/klc-runtime:${VERSION} . The Keptn deno runtime uses [Deno](https://deno.com/) to execute Javascript/Typescript code. -The Keptn Lifecycle Toolkit uses this runtime to run [KeptnTask](https://lifecycle.keptn.sh/docs/tasks/write-tasks/) +Keptn uses this runtime to run [KeptnTask](https://lifecycle.keptn.sh/docs/tasks/write-tasks/) for pre- and post-checks. -The Keptn Lifecycle Toolkit passes parameters of `KeptnTask`s and +Keptn passes parameters of `KeptnTask`s and [Context](https://lifecycle.keptn.sh/docs/concepts/tasks/#context) information to the runtime via the special environmental variable `DATA`. It also supports mounting Kubernetes secrets making them accessible via the `SECURE_DATA` env var. @@ -26,7 +26,7 @@ console.log(secret); ``` `KeptnTask`s can be tested locally with the runtime using the following command. -Replace `${VERSION}` with the KLT version of your choice. +Replace `${VERSION}` with the Keptn version of your choice. ```sh docker run -v $(pwd)/test.ts:/test.ts -e SCRIPT=/test.ts -e DATA='{ "url":"http://localhost:9090" }' -e SECURE_DATA='{ "token": "myToken"}' -it ghcr.io/keptn/deno-runtime:${VERSION} diff --git a/runtimes/python-runtime/README.md b/runtimes/python-runtime/README.md index 7e9548e5ea..ca64db829a 100644 --- a/runtimes/python-runtime/README.md +++ b/runtimes/python-runtime/README.md @@ -1,4 +1,4 @@ -# Keptn Lifecycle Controller - Python Runtime +# Keptn Python Runtime ## Build @@ -11,13 +11,13 @@ docker build -t lifecycle-toolkit/runtimes/python-runtime:${VERSION} . The Keptn `python-runtime` runner uses python3 and enables the following packages: requests, json, git, yaml -The Keptn Lifecycle Toolkit uses this runner to execute tasks defined as +Keptn uses this runner to execute tasks defined as [KeptnTaskDefinition](https://lifecycle.keptn.sh/docs/yaml-crd-ref/taskdefinition/) resources. for pre- and post-checks. `KeptnTask`s can be tested locally with the runtime using the following commands. -Replace `${VERSION}` with the KLT version of your choice. +Replace `${VERSION}` with the Keptn version of your choice. `SCRIPT` should refer to either a python file mounted locally in the container or to a url containing the file. ### mounting a python file diff --git a/scheduler/README.md b/scheduler/README.md index c46a0ceb7e..4b87ddf81b 100644 --- a/scheduler/README.md +++ b/scheduler/README.md @@ -1,9 +1,9 @@ # Scheduler -The **scheduler** is a pivotal component within the -[Keptn Lifecycle Toolkit](https://main.lifecycle.keptn.sh/) that plays a crucial role in orchestrating the deployment process. +The **scheduler** is a pivotal component within +[Keptn](https://main.lifecycle.keptn.sh/) that plays a crucial role in orchestrating the deployment process. By ensuring that Pods are scheduled onto nodes only after successful pre-deployment checks, the scheduler minimizes errors and downtimes. For detailed information about scheduler's functionality and how it works, please refer to -the [Keptn Lifecycle Toolkit Scheduler Documentation](https://main.lifecycle.keptn.sh/docs/concepts/architecture/components/scheduler/). +the [Keptn Scheduler Architecture](https://main.lifecycle.keptn.sh/docs/concepts/architecture/components/scheduler/) section. From 253a0c901a9625ad5d9bf3ae2b2684f270e46f4a Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 3 Sep 2023 22:32:09 -0700 Subject: [PATCH 13/31] troubleshooting Signed-off-by: Meg McRoberts --- .../architecture/components/_index.md | 2 +- docs/content/en/docs/troubleshooting.md | 24 +++++++++---------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/content/en/docs/concepts/architecture/components/_index.md b/docs/content/en/docs/concepts/architecture/components/_index.md index 9e82499d64..f4c0d868c7 100644 --- a/docs/content/en/docs/concepts/architecture/components/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/_index.md @@ -18,7 +18,7 @@ in Release 0.7.0 and later: ```mermaid graph TD; - KLTComponents-->Operators; + KLTComponentKeptn-->Operators; KLTComponents-->Scheduler Operators-->Lifecycle-Operator Operators-->Metrics-Operator diff --git a/docs/content/en/docs/troubleshooting.md b/docs/content/en/docs/troubleshooting.md index 334ef7da03..b689521e93 100644 --- a/docs/content/en/docs/troubleshooting.md +++ b/docs/content/en/docs/troubleshooting.md @@ -1,26 +1,26 @@ --- title: Troubleshooting Guide linktitle: Troubleshooting Guide -description: Troubleshoot common problems with KLT +description: Troubleshoot common problems with Keptn weight: 100 --- -Welcome to the troubleshooting guide for KLT (Keptn Lifecycle Toolkit). +Welcome to the Keptn troubleshooting guide. -This guide will help you address common issues that you might encounter while using KLT +This guide will help you address common issues that you might encounter while using Keptn for managing your workloads. Below are some common problems and their solutions: -## KLT is installed but it is not aware of my workloads +## Keptn is installed but it is not aware of my workloads -If you are facing an issue where KLT is installed but does not seem to be aware of your workloads, follow these steps: +If you are facing an issue where Keptn is installed but does not seem to be aware of your workloads, follow these steps: 1. Ensure that the namespace you wish to target is [annotated correctly](https://lifecycle.keptn.sh/docs/install/install/#enable-klt-for-your-cluster). 2. Make sure your workloads (e.g., Deployment manifests) have the [three required annotations](https://lifecycle.keptn.sh/docs/implementing/integrate/#annotate-workloads). -## KLT is causing my pods to be pending +## Keptn is causing my pods to be pending -If your pods are stuck in a pending state and KLT seems to be the cause, it might be due +If your pods are stuck in a pending state and Keptn seems to be the cause, it might be due to a pre-deployment task or evaluation. Follow these steps: @@ -38,18 +38,18 @@ kubectl -n prod get pods kubectl -n prod logs job/... ``` -## I have pending Pods after KLT is uninstalled +## I have pending Pods after Keptn is uninstalled > **Note**_ This section particularly affects clusters managed by ArgoCD. -If you have uninstalled Keptn Lifecycle Toolkit and are now facing issues scheduling or deleting pods, follow these steps: +If you have uninstalled Keptn and are now facing issues scheduling or deleting pods, follow these steps: ArgoCD does not delete various CRDs and webhooks, when uninstalling applications, causing lingering resources. ### For cleanup instructions -1. Install KLT & CRDs w/ Argo -2. Uninstall KLT via Argo +1. Install Keptn & CRDs w/ Argo +2. Uninstall Keptn via Argo 3. Cluster is frozen, Pods cannot be deleted or scheduled Trying to schedule a new pod results an `mpod.keptn.sh` error. @@ -61,7 +61,7 @@ to get further information refer to this [issue](https://github.com/keptn/lifecy ## I cannot see DORA metrics or OpenTelemetry traces -KLT will automatically generate DORA metrics and OTel traces for every deployment, but +Keptn will automatically generate DORA metrics and OTel traces for every deployment, but by default it does not know where to send them. You need an OpenTelemetry collector From 4af842b1a1a096f2f5c2fecffac1e32fd7bab6e9 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 3 Sep 2023 23:37:09 -0700 Subject: [PATCH 14/31] another KLT Signed-off-by: Meg McRoberts --- docs/content/en/docs/migrate/cicd/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/en/docs/migrate/cicd/_index.md b/docs/content/en/docs/migrate/cicd/_index.md index eb02b323d3..8302b61e02 100644 --- a/docs/content/en/docs/migrate/cicd/_index.md +++ b/docs/content/en/docs/migrate/cicd/_index.md @@ -1,6 +1,6 @@ --- -title: Migrate CI/CD functionality to KLT -description: Translate Keptn v1 CI/CD funtionality to KLT resources +title: Migrate CI/CD functionality to Keptn +description: Translate Keptn v1 CI/CD funtionality to Keptn resources weight: 60 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- From 4fa00fe079c38b6751f540910c0fea6a857d04ba Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Sun, 3 Sep 2023 23:54:30 -0700 Subject: [PATCH 15/31] toolkit Signed-off-by: Meg McRoberts --- docs/content/en/docs/intro-klt/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/intro-klt/_index.md b/docs/content/en/docs/intro-klt/_index.md index cd70bca0d5..acc7d67d35 100644 --- a/docs/content/en/docs/intro-klt/_index.md +++ b/docs/content/en/docs/intro-klt/_index.md @@ -95,7 +95,7 @@ for deployment scenarios, including pre-deployment validation, image scanning, and post-deployment tasks like test execution and stakeholder notification. It automatically validates against Service Level Objectives (SLOs) and provides end-to-end deployment traceability. -The toolkit extends deployments with application-aware tasks and evaluations, +Keptn extends deployments with application-aware tasks and evaluations, allowing checks before or after deployment initiation. It validates Keptn metrics using the Keptn Metrics Server, ensuring a healthy environment and confirming software health against SLOs like performance and From 1fd469af768e660e994723c53443c4f268297229 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Mon, 4 Sep 2023 07:39:53 -0700 Subject: [PATCH 16/31] old gs guides Signed-off-by: Meg McRoberts --- .../docs/intro-klt/usecase-observability.md | 21 +++++++++--------- .../en/docs/intro-klt/usecase-orchestrate.md | 22 +++++++++---------- .../en/docs/intro-klt/usecase_metrics.md | 10 ++++----- 3 files changed, 26 insertions(+), 27 deletions(-) diff --git a/docs/content/en/docs/intro-klt/usecase-observability.md b/docs/content/en/docs/intro-klt/usecase-observability.md index a174c23d8a..fac1f15e9e 100644 --- a/docs/content/en/docs/intro-klt/usecase-observability.md +++ b/docs/content/en/docs/intro-klt/usecase-observability.md @@ -1,10 +1,10 @@ --- title: Standardize observability -description: How the KLT standardizes access to observability data for Kubernetes deployments +description: How Keptn standardizes access to observability data for Kubernetes deployments weight: 10 --- -The Keptn Lifecycle Toolkit (KLT) makes any Kubernetes deployment observable. +Keptn makes any Kubernetes deployment observable. In other words, it creates a distributed, end-to-end trace of everything Kubernetes does in the context of a Deployment. It provides this information @@ -21,12 +21,11 @@ This means that: - You can readily see why a deployment takes so long or why it fails, even when using multiple deployment strategies. -- KLT can capture DORA metrics and expose them as OpenTelemetry metrics +- Keptn can capture DORA metrics and expose them as OpenTelemetry metrics The observability data is an amalgamation of the following: -- DORA metrics are collected out of the box - when the Lifecycle Toolkit is enabled +- DORA metrics are collected out of the box when Keptn is enabled - OpenTelemetry runs traces that show everything that happens in the Kubernetes cluster - Custom Keptn metrics that you can use to monitor @@ -44,7 +43,7 @@ It is based on the example. This is the second of three exercises in the -[Introducing the Keptn Lifecycle Toolkit](_index.md) +[Introducing Keptn](_index.md) series: - In the @@ -62,16 +61,16 @@ series: This exercise shows how to standardize access to the observability data for your cluster. -If you are installing the Keptn Lifecycle Toolkit on an existing cluster +If you are installing Keptn on an existing cluster or on a local cluster you are creating for this exercise, you need to do the following: 1. Follow the instructions in [Install and update](../install) - to install and enable KLT on your cluster. + to install and enable Keptn on your cluster. 1. Follow the instructions in [Basic annotations](../implementing/integrate/#basic-annotations) - to integrate the Lifecycle Toolkit into your Kubernetes cluster + to integrate Keptn into your Kubernetes cluster by applying basic annotations to your workload and pod resources. and to create appropriate @@ -84,7 +83,7 @@ you need to do the following: DORA metrics are an industry-standard set of measurements about your deployments. -The Keptn Lifecycle Toolkit starts collecting these metrics +Keptn starts collecting these metrics as soon as you annotate the `Deployment` resource. See [DORA metrics](../implementing/dora) @@ -92,7 +91,7 @@ for more details. ## Using OpenTelemetry -The Keptn Lifecycle Toolkit extends the Kubernetes +Keptn extends the Kubernetes primitives to create OpenTelemetry data that connects all your deployment and observability tools without worrying about where it is stored and where it is managed. diff --git a/docs/content/en/docs/intro-klt/usecase-orchestrate.md b/docs/content/en/docs/intro-klt/usecase-orchestrate.md index eb2917db47..7c1e95193b 100644 --- a/docs/content/en/docs/intro-klt/usecase-orchestrate.md +++ b/docs/content/en/docs/intro-klt/usecase-orchestrate.md @@ -1,14 +1,14 @@ --- title: Manage release lifecycle -description: How KLT orchestrates pre- and post-deployment evaluations and tasks +description: How Keptn orchestrates pre- and post-deployment evaluations and tasks weight: 20 --- -In this exercise, we will configure the Keptn Lifecycle Toolkit +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`, -the Lifecycle Toolkit can do the following: +Keptn can do the following: * Pre-deploy: Validate external dependencies, confirm that images are scanned, and so forth @@ -18,11 +18,11 @@ the Lifecycle Toolkit can do the following: * Automatically validate against your SLO (Service Level Objectives) -KLT sits on top of the Kubernetes scheduler +Keptn sits on top of the Kubernetes scheduler and can do the following: * Trace the deployment from start to end -* KLT is application aware, +* 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 level. @@ -56,7 +56,7 @@ The steps to implement pre- and post-deployment orchestration are: * [Integrate evaluations and tasks into the cluster](#integrate-evaluations-and-tasks-into-the-cluster) This is the third of three exercises in the -[Introducing the Keptn Lifecycle Toolkit](_index.md) +[Introducing Keptn](_index.md) series. You may want to complete the other exercises before doing this exercise although that is not required: @@ -68,7 +68,7 @@ although that is not required: you learn how to standardize access to the observability data for your cluster. -If you are installing the Keptn Lifecycle Toolkit on an existing 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, @@ -76,10 +76,10 @@ you need to do the following: 1. Follow the instructions in [Install and update](../install/_index.md) - to install and enable KLT on your cluster. + to install and enable Keptn on your cluster. 1. Follow the instructions in [Annotate workload](../implementing/integrate/#basic-annotations) - to integrate the Lifecycle Toolkit into your Kubernetes cluster + to integrate Keptn into your Kubernetes cluster by applying basic annotations to your `Deployment` resource. This also creates appropriate [KeptnApp](../yaml-crd-ref/app.md) resources @@ -146,7 +146,7 @@ spec: secret: slack-notification ``` -For more information about sending Slack notifications with KLT, see +For more information about sending Slack notifications with Keptn, see [Implement Slack notifications](../implementing/slack.md). The code to be executed is expressed as a [Deno](https://deno.com) @@ -157,7 +157,7 @@ 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 KLT 0.8.0, +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. diff --git a/docs/content/en/docs/intro-klt/usecase_metrics.md b/docs/content/en/docs/intro-klt/usecase_metrics.md index 4338a878cb..2bed2f146f 100644 --- a/docs/content/en/docs/intro-klt/usecase_metrics.md +++ b/docs/content/en/docs/intro-klt/usecase_metrics.md @@ -4,7 +4,7 @@ description: Enhance your deployment with custom Keptn metrics weight: 30 --- -The Custom Keptn metrics component of the Keptn Lifecycle Toolkit +The Custom Keptn metrics component allows you to define any type of metric from multiple instances of any type of data source in your Kubernetes cluster. @@ -19,7 +19,7 @@ or may be data that comes directly from your cloud provider such as AWS, Google, or Azure. The Keptn Metrics Server unifies and standardizes access to all this data. Minimal configuration is required -because the Keptn Lifecycle Toolkit hooks directly into Kubernetes primitives. +because Keptn hooks directly into Kubernetes primitives. The [Kubernetes metric server](https://github.com/kubernetes-sigs/metrics-server) @@ -43,7 +43,7 @@ as you implement the functionality "from scratch" on your local Kubernetes deployment cluster. This is the first of three exercises in the -[Introducing the Keptn Lifecycle Toolkit](_index.md) +[Introducing Keptn](_index.md) series. After completing this exercise, you may want to do the other exercises: @@ -60,7 +60,7 @@ you may want to do the other exercises: The steps to implement metrics in an existing cluster are: -1. [Install the Keptn Lifecycle Toolkit](../install/install.md) +1. [Install Keptn](../install/install.md) 1. Configure the metrics you want to use: - [Define metrics providers](#define-metrics-providers) - [Define KeptnMetric information](#define-keptnmetric-information) @@ -213,7 +213,7 @@ simplenode-dev available-cpus dev-prometheus sum(kube_node_status_capacity{r ## Run the metrics As soon as you define your `KeptnMetricsProvider` and `KeptnMetric` resources, -the Lifecycle Toolkit begins collecting the metrics you defined. +Keptn begins collecting the metrics you defined. You do not need to do anything else. ## Observing the metrics From bddae636fa911fcd315c1d7dcef6010f2c6eecb7 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Mon, 4 Sep 2023 07:44:05 -0700 Subject: [PATCH 17/31] KLTComponents Signed-off-by: Meg McRoberts --- .../en/docs/concepts/architecture/components/_index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/en/docs/concepts/architecture/components/_index.md b/docs/content/en/docs/concepts/architecture/components/_index.md index f4c0d868c7..b9c1cb0b4c 100644 --- a/docs/content/en/docs/concepts/architecture/components/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/_index.md @@ -18,11 +18,11 @@ in Release 0.7.0 and later: ```mermaid graph TD; - KLTComponentKeptn-->Operators; - KLTComponents-->Scheduler + KeptnComponentKeptn-->Operators; + KeptnComponents-->Scheduler Operators-->Lifecycle-Operator Operators-->Metrics-Operator -style KLTComponents fill:#006bb8,stroke:#fff,stroke-width:px,color:#fff +style KeptnComponents fill:#006bb8,stroke:#fff,stroke-width:px,color:#fff style Operators fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8 style Scheduler fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8 style Lifecycle-Operator fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8 From 03fa1cd3619d2a09e0af9317d455adf5f79c474b Mon Sep 17 00:00:00 2001 From: Giovanni Liva Date: Tue, 5 Sep 2023 10:00:34 +0200 Subject: [PATCH 18/31] rename folder Signed-off-by: Giovanni Liva --- docs/content/en/docs/{intro-klt => intro}/_index.md | 0 .../assets/dynatrace_dora_dashboard.png | Bin .../{intro-klt => intro}/usecase-observability.md | 0 .../{intro-klt => intro}/usecase-orchestrate.md | 0 .../en/docs/{intro-klt => intro}/usecase_metrics.md | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename docs/content/en/docs/{intro-klt => intro}/_index.md (100%) rename docs/content/en/docs/{intro-klt => intro}/assets/dynatrace_dora_dashboard.png (100%) rename docs/content/en/docs/{intro-klt => intro}/usecase-observability.md (100%) rename docs/content/en/docs/{intro-klt => intro}/usecase-orchestrate.md (100%) rename docs/content/en/docs/{intro-klt => intro}/usecase_metrics.md (100%) diff --git a/docs/content/en/docs/intro-klt/_index.md b/docs/content/en/docs/intro/_index.md similarity index 100% rename from docs/content/en/docs/intro-klt/_index.md rename to docs/content/en/docs/intro/_index.md diff --git a/docs/content/en/docs/intro-klt/assets/dynatrace_dora_dashboard.png b/docs/content/en/docs/intro/assets/dynatrace_dora_dashboard.png similarity index 100% rename from docs/content/en/docs/intro-klt/assets/dynatrace_dora_dashboard.png rename to docs/content/en/docs/intro/assets/dynatrace_dora_dashboard.png diff --git a/docs/content/en/docs/intro-klt/usecase-observability.md b/docs/content/en/docs/intro/usecase-observability.md similarity index 100% rename from docs/content/en/docs/intro-klt/usecase-observability.md rename to docs/content/en/docs/intro/usecase-observability.md diff --git a/docs/content/en/docs/intro-klt/usecase-orchestrate.md b/docs/content/en/docs/intro/usecase-orchestrate.md similarity index 100% rename from docs/content/en/docs/intro-klt/usecase-orchestrate.md rename to docs/content/en/docs/intro/usecase-orchestrate.md diff --git a/docs/content/en/docs/intro-klt/usecase_metrics.md b/docs/content/en/docs/intro/usecase_metrics.md similarity index 100% rename from docs/content/en/docs/intro-klt/usecase_metrics.md rename to docs/content/en/docs/intro/usecase_metrics.md From f2c41ce4852394f70183c0b47d556af558fbce16 Mon Sep 17 00:00:00 2001 From: Giovanni Liva Date: Tue, 5 Sep 2023 11:00:49 +0200 Subject: [PATCH 19/31] more changes Signed-off-by: Giovanni Liva --- README.md | 4 ++-- assets/logo/README.md | 4 ++-- .../en/contribute/docs/contrib-guidelines-docs/_index.md | 2 +- .../contribute/general/contrib-guidelines-gen/_index.md | 2 +- .../architecture/components/lifecycle-operator/_index.md | 2 +- docs/content/en/docs/install/install.md | 2 +- examples/sample-app/base/python-task.yaml | 2 +- examples/sample-app/version-2/app-pre-deploy.yaml | 2 +- examples/sample-app/version-3/app-pre-deploy.yaml | 2 +- examples/support/argo/README.md | 2 +- examples/support/observability/README.md | 2 +- .../observability/assets/grafana_dasboard_import_ui.json | 2 +- .../support/observability/assets/grafana_dashboard.json | 2 +- .../webhooks/pod_mutator/pod_mutating_webhook.go | 8 ++++---- runtimes/deno-runtime/README.md | 2 +- 15 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 5eefdd51c5..c950d8baab 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ with pre- and post-deployment evaluations and tasks. It is an incubating project, under the umbrella of the [Keptn Application Lifecycle working group](https://github.com/keptn/wg-app-lifecycle). -> **Note:** Keptn was developed under the code name of - "Keptn Lifecycle Controller" or "KLT" for short. +> **Note** Keptn was developed under the code name of + "Keptn Lifecycle Toolkit" or "KLT" for short. The source code contains many vestiges of these names. ## Goals diff --git a/assets/logo/README.md b/assets/logo/README.md index 8f7da127c4..1da7992c6f 100644 --- a/assets/logo/README.md +++ b/assets/logo/README.md @@ -1,6 +1,6 @@ -# Keptn Lifecycle Controller Logos +# Keptn Logos -This directory contains the Keptn Lifecycle Controller logos in different formats and colors. +This directory contains the Keptn logos in different formats and colors. ## Logos diff --git a/docs/content/en/contribute/docs/contrib-guidelines-docs/_index.md b/docs/content/en/contribute/docs/contrib-guidelines-docs/_index.md index 73659cacbc..2ff534451b 100644 --- a/docs/content/en/contribute/docs/contrib-guidelines-docs/_index.md +++ b/docs/content/en/contribute/docs/contrib-guidelines-docs/_index.md @@ -44,7 +44,7 @@ that are relevant only to documentation For usability considerations, we make the following exceptions: - * The main `README.md` file for the lifecycle-controller repository + * The main `README.md` file for the lifecycle-toolkit repository includes this basic information as well as a link to the full installation documentation which has more details. * The Getting Started Guide also includes this information diff --git a/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md b/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md index 8075e174fb..27b611a44a 100644 --- a/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md +++ b/docs/content/en/contribute/general/contrib-guidelines-gen/_index.md @@ -5,7 +5,7 @@ weight: 300 --- Before using Keptn -as a contributor to the Keptn `lifecycle-controller` repository, +as a contributor to the Keptn `lifecycle-toolkit` repository, it is expected that you comply with the guidelines while making contributions towards the repository. diff --git a/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md b/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md index 3592bb1c21..07c26f10d4 100644 --- a/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md @@ -10,7 +10,7 @@ cascade: **Keptn's Lifecycle Operator** is a Kubernetes [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) that automates the deployment and management -of the Keptn Lifecycle Controller components in a Kubernetes cluster. +of the Keptn components in a Kubernetes cluster. The Keptn Lifecycle Operator contains several controllers for **Keptn CRDs** and a **Mutating Webhook**. diff --git a/docs/content/en/docs/install/install.md b/docs/content/en/docs/install/install.md index eb7a0111a1..2a1037c373 100644 --- a/docs/content/en/docs/install/install.md +++ b/docs/content/en/docs/install/install.md @@ -139,7 +139,7 @@ Keptn and its dependencies are now installed and ready to use. ## Enable Keptn for your cluster -To enable the Keptn Lifecycle Controller in your cluster, +To enable the Keptn in your cluster, annotate the Kubernetes [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) resource for each namespace in the cluster. diff --git a/examples/sample-app/base/python-task.yaml b/examples/sample-app/base/python-task.yaml index 334f2ec393..a611df4db3 100644 --- a/examples/sample-app/base/python-task.yaml +++ b/examples/sample-app/base/python-task.yaml @@ -6,7 +6,7 @@ metadata: spec: python: httpRef: - url: https://raw.githubusercontent.com/keptn/lifecycle-controller/main/runtimes/python-runtime/samples/secrets.py + url: https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/runtimes/python-runtime/samples/secrets.py parameters: map: user: "myuser" diff --git a/examples/sample-app/version-2/app-pre-deploy.yaml b/examples/sample-app/version-2/app-pre-deploy.yaml index 36a243ec2e..b5ad3c760a 100644 --- a/examples/sample-app/version-2/app-pre-deploy.yaml +++ b/examples/sample-app/version-2/app-pre-deploy.yaml @@ -6,7 +6,7 @@ metadata: spec: function: httpRef: - url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-controller/main/runtimes/deno-runtime/samples/ts/http.ts + url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts parameters: map: url: http://podtato-head-frontend.podtato-kubectl.svc.cluster.local:8080 diff --git a/examples/sample-app/version-3/app-pre-deploy.yaml b/examples/sample-app/version-3/app-pre-deploy.yaml index 36a243ec2e..b5ad3c760a 100644 --- a/examples/sample-app/version-3/app-pre-deploy.yaml +++ b/examples/sample-app/version-3/app-pre-deploy.yaml @@ -6,7 +6,7 @@ metadata: spec: function: httpRef: - url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-controller/main/runtimes/deno-runtime/samples/ts/http.ts + url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts parameters: map: url: http://podtato-head-frontend.podtato-kubectl.svc.cluster.local:8080 diff --git a/examples/support/argo/README.md b/examples/support/argo/README.md index bd07bd3a93..6e2d84f50e 100644 --- a/examples/support/argo/README.md +++ b/examples/support/argo/README.md @@ -1,4 +1,4 @@ -# Deploying an application using the Keptn Lifecycle Controller and ArgoCD +# Deploying an application using Keptn and ArgoCD In this example, we will show you how to install our sample application *podtatohead* using Keptn and [ArgoCD](https://argo-cd.readthedocs.io/en/stable/). diff --git a/examples/support/observability/README.md b/examples/support/observability/README.md index 50909f010b..947a3e7f5d 100644 --- a/examples/support/observability/README.md +++ b/examples/support/observability/README.md @@ -47,7 +47,7 @@ kubectl port-forward -n keptn-lifecycle-toolkit-system svc/jaeger-query 16686 Afterwards, you can view the Jaeger UI in the browser at [localhost:16686](http://localhost:16686). -There you should see the traces generated by the lifecycle controller, +There you should see the traces generated by the lifecycle operator, which should look like this: ### Traces overview diff --git a/examples/support/observability/assets/grafana_dasboard_import_ui.json b/examples/support/observability/assets/grafana_dasboard_import_ui.json index 5bdb13b3a6..8e62923b93 100644 --- a/examples/support/observability/assets/grafana_dasboard_import_ui.json +++ b/examples/support/observability/assets/grafana_dasboard_import_ui.json @@ -879,7 +879,7 @@ }, "timepicker": {}, "timezone": "", - "title": "Keptn Lifecycle Controller Metrics", + "title": "Keptn Metrics", "uid": "wlo2MpIVk", "version": 13, "weekStart": "" diff --git a/examples/support/observability/assets/grafana_dashboard.json b/examples/support/observability/assets/grafana_dashboard.json index 817eef75b4..1f5222a16a 100644 --- a/examples/support/observability/assets/grafana_dashboard.json +++ b/examples/support/observability/assets/grafana_dashboard.json @@ -880,7 +880,7 @@ }, "timepicker": {}, "timezone": "", - "title": "Keptn Lifecycle Controller Metrics", + "title": "Keptn Metrics", "uid": "wlo2MpIVk", "version": 13, "weekStart": "" diff --git a/lifecycle-operator/webhooks/pod_mutator/pod_mutating_webhook.go b/lifecycle-operator/webhooks/pod_mutator/pod_mutating_webhook.go index c291fe5616..b43a3deae4 100644 --- a/lifecycle-operator/webhooks/pod_mutator/pod_mutating_webhook.go +++ b/lifecycle-operator/webhooks/pod_mutator/pod_mutating_webhook.go @@ -69,7 +69,7 @@ func (a *PodMutatingWebhook) Handle(ctx context.Context, req admission.Request) return admission.Errored(http.StatusBadRequest, err) } - // check if Lifecycle Controller is enabled for this namespace + // check if Lifecycle Operator is enabled for this namespace namespace := &corev1.Namespace{} if err = a.Client.Get(ctx, types.NamespacedName{Name: req.Namespace}, namespace); err != nil { logger.Error(err, "could not get namespace", "namespace", req.Namespace) @@ -77,15 +77,15 @@ func (a *PodMutatingWebhook) Handle(ctx context.Context, req admission.Request) } if namespace.GetAnnotations()[apicommon.NamespaceEnabledAnnotation] != "enabled" { - logger.Info("namespace is not enabled for lifecycle controller", "namespace", req.Namespace) - return admission.Allowed("namespace is not enabled for lifecycle controller") + logger.Info("namespace is not enabled for lifecycle operator", "namespace", req.Namespace) + return admission.Allowed("namespace is not enabled for lifecycle operator") } // check the OwnerReference of the pod to see if it is supported and intended to be managed by KLT ownerRef := a.getOwnerReference(pod.ObjectMeta) if ownerRef.Kind == "" { - msg := "owner of pod is not supported by lifecycle controller" + msg := "owner of pod is not supported by lifecycle operator" logger.Info(msg, "namespace", req.Namespace, "pod", req.Name) return admission.Allowed(msg) } diff --git a/runtimes/deno-runtime/README.md b/runtimes/deno-runtime/README.md index a861c7acbf..3dec2525e4 100644 --- a/runtimes/deno-runtime/README.md +++ b/runtimes/deno-runtime/README.md @@ -1,4 +1,4 @@ -# Keptn Lifecycle Controller - Deno Runtime +# Keptn - Deno Runtime ## Build From 69f9294940ed25c2aa5478a0894209a3564885fc Mon Sep 17 00:00:00 2001 From: Giovanni Liva Date: Tue, 5 Sep 2023 11:02:57 +0200 Subject: [PATCH 20/31] adapt graph Signed-off-by: Giovanni Liva --- docs/content/en/docs/concepts/architecture/cert-manager.md | 2 +- docs/content/en/docs/concepts/architecture/components/_index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/en/docs/concepts/architecture/cert-manager.md b/docs/content/en/docs/concepts/architecture/cert-manager.md index 7cbebf9f07..db7f653bd5 100644 --- a/docs/content/en/docs/concepts/architecture/cert-manager.md +++ b/docs/content/en/docs/concepts/architecture/cert-manager.md @@ -28,7 +28,7 @@ with a renewal threshold of 12 hours. * If the certificate expires, the [klt-cert-manager](https://github.com/keptn/lifecycle-toolkit/blob/main/klt-cert-manager/README.md) renews it. -* The Keptn operator waits for a valid certificate to be ready. +* The Keptn `lifecycle-operator` waits for a valid certificate to be ready. * When the certificate is ready, it is mounted on an empty dir volume in the operator. diff --git a/docs/content/en/docs/concepts/architecture/components/_index.md b/docs/content/en/docs/concepts/architecture/components/_index.md index b9c1cb0b4c..16f7161b7c 100644 --- a/docs/content/en/docs/concepts/architecture/components/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/_index.md @@ -18,7 +18,7 @@ in Release 0.7.0 and later: ```mermaid graph TD; - KeptnComponentKeptn-->Operators; + KeptnComponents-->Operators; KeptnComponents-->Scheduler Operators-->Lifecycle-Operator Operators-->Metrics-Operator From c20f7a746be7db320eae33e026fa02d7e2f328f0 Mon Sep 17 00:00:00 2001 From: Giovanni Liva Date: Tue, 5 Sep 2023 11:10:20 +0200 Subject: [PATCH 21/31] typos Signed-off-by: Giovanni Liva --- docs/content/en/docs/concepts/architecture/working/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/concepts/architecture/working/_index.md b/docs/content/en/docs/concepts/architecture/working/_index.md index 2180fc716f..d1df06f13e 100644 --- a/docs/content/en/docs/concepts/architecture/working/_index.md +++ b/docs/content/en/docs/concepts/architecture/working/_index.md @@ -6,4 +6,4 @@ weight: 30 cascade: --- -### How Keptn Works? +### How does Keptn Work? From 5c039d9d2ec776f0806508559fb1201802900176 Mon Sep 17 00:00:00 2001 From: Giovanni Liva Date: Tue, 5 Sep 2023 11:14:52 +0200 Subject: [PATCH 22/31] more polishing Signed-off-by: Giovanni Liva --- docs/content/en/docs/intro/_index.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/content/en/docs/intro/_index.md b/docs/content/en/docs/intro/_index.md index acc7d67d35..e9a49fb486 100644 --- a/docs/content/en/docs/intro/_index.md +++ b/docs/content/en/docs/intro/_index.md @@ -108,17 +108,17 @@ for detailed instructions and examples. This guide will walk you through the installation process and help you set up your environment for using Keptn effectively. -## Keptn and Keptn V1 +## Differences between Keptn and Keptn v1 -Keptn is a Keptn subproject -whose design reflects lessons we learned while developing Keptn V1. +Keptn is a subproject +whose design reflects lessons we learned while developing Keptn v1. Keptn recognizes that tools such as Argo and Flux are very good at deploying applications. However, these deployment tools do not provide pre-deployment and post-deployment evaluations and actions; this is what Keptn adds. -Keptn V1 is a long-term support release +Keptn v1 is a long-term support release that can deploy applications on platforms other than Kubernetes, can accommodate complex scoring algorithms for SLO evaluations, and can implement remediations (self-healing) for problems discovered @@ -133,20 +133,19 @@ and their level of stability. In a December 2022 Keptn Community meeting, we discussed the differences and similarities -between Keptn V1 and Keptn +between Keptn v1 and Keptn to help you decide which best fits your needs. View the recording: -[Compare Keptn V1 and the Keptn Lifecycle Toolkit](https://www.youtube.com/watch?v=-cKyUKFjtwE&t=170s) +[Compare Keptn v1 and the Keptn Lifecycle Toolkit](https://www.youtube.com/watch?v=-cKyUKFjtwE&t=170s) ## Overviews of Keptn A number of presentations are available to help you understand Keptn. -Note that many of these refer to the "Keptn Lifecycle Controller", -which was the development code name for Keptn. +Note that many of these refer to the "Keptn Lifecycle Controller" +or "Keptn Lifecycle Toolkit", which was the development code name for Keptn. * [Orchestrating and Observing GitOps Deployments with Keptn](https://www.youtube.com/watch?v=-cKyUKFjtwE&t=11s) - discusses the evolution of Keptn - and the concepts that it, + discusses the evolution of Keptn and the concepts that drive it, then gives a simple demonstration of a Keptn implementation. * [Introducing Keptn Lifecycle Toolkit](https://youtu.be/449HAFYkUlY) @@ -163,9 +162,9 @@ which was the development code name for Keptn. blog discusses Keptn as part of the "Is It Observable?" series. This links to: - * [What is Keptn Lifecycle Toolkit?](https://www.youtube.com/watch?v=Uvg4uG8AbFg) - is a video that steps through the process of integrating Keptn - with your existing cloud native cluster. +* [What is Keptn Lifecycle Toolkit?](https://www.youtube.com/watch?v=Uvg4uG8AbFg) + is a video that steps through the process of integrating Keptn + with your existing cloud native cluster. * [Keptn Lifecycle Toolkit: Installation and KeptnTask Creation in Minutes](https://www.youtube.com/watch?v=Hh01bBwZ_qM) demonstrates how to install Keptn and create your first KeptnTask in less than ten minutes. From 6c622c3f1dbccdb6b4736b10f0bb36f69f1ef3a4 Mon Sep 17 00:00:00 2001 From: Giovanni Liva Date: Tue, 5 Sep 2023 11:22:56 +0200 Subject: [PATCH 23/31] fix links Signed-off-by: Giovanni Liva --- README.md | 2 +- .../en/contribute/docs/source-file-structure/_index.md | 4 ++-- docs/content/en/docs/implementing/evaluatemetrics.md | 2 +- docs/content/en/docs/implementing/otel.md | 2 +- docs/content/en/docs/migrate/strategy/_index.md | 2 +- docs/content/en/docs/yaml-crd-ref/app.md | 2 +- docs/content/en/docs/yaml-crd-ref/metric.md | 2 +- docs/content/en/docs/yaml-crd-ref/taskdefinition.md | 2 +- examples/sample-app/base/app-post-deploy.yaml | 2 +- examples/sample-app/version-1/app-pre-deploy.yaml | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c950d8baab..cf2e5cb7bd 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ helm upgrade --install keptn klt/klt -n keptn-lifecycle-toolkit-system --create- For more info about Keptn, please see our [documentation](https://lifecycle.keptn.sh/docs/), specifically: -- [Introduction to Keptn](https://lifecycle.keptn.sh/docs/intro-klt/) +- [Introduction to Keptn](https://lifecycle.keptn.sh/docs/intro/) gives an overview of the Keptn facilities. - [Getting started](https://lifecycle.keptn.sh/docs/getting-started/) includes some short exercises to introduce you to Keptn. diff --git a/docs/content/en/contribute/docs/source-file-structure/_index.md b/docs/content/en/contribute/docs/source-file-structure/_index.md index 3aaeca389b..36a9a2cf8d 100644 --- a/docs/content/en/contribute/docs/source-file-structure/_index.md +++ b/docs/content/en/contribute/docs/source-file-structure/_index.md @@ -23,7 +23,7 @@ the *docs/content/en/docs* directory in the repository. The subdirectories correspond to the contents listed in the right frame. In the order they appear in the rendered docs, the subdirectories are: -* **intro-klt** (Introduction to the Keptn Lifecycle Toolkit): +* **intro** (Introduction to the Keptn Lifecycle Toolkit): A brief overview of Keptn, its features and use cases, and its history * **getting-started** (Getting started): A hands-on exercise that demonstrates the capabilities of Keptn @@ -52,7 +52,7 @@ In the order they appear in the rendered docs, the subdirectories are: This is a subset of the CRDs documented in the *API Reference* section * **migrate** (Migrating to the Keptn Lifecycle Toolkit): Information to help users who are migrating to Keptn - from Keptn V1 + from Keptn v1 ## Contributing guide diff --git a/docs/content/en/docs/implementing/evaluatemetrics.md b/docs/content/en/docs/implementing/evaluatemetrics.md index 182e346b97..5d5723cc19 100644 --- a/docs/content/en/docs/implementing/evaluatemetrics.md +++ b/docs/content/en/docs/implementing/evaluatemetrics.md @@ -16,7 +16,7 @@ or another standard dashboard application that you configure or can be retrieved using standard Kubernetes commands. For an introduction to Keptn metrics, see -[Getting started with Keptn metrics](../intro-klt/usecase_metrics.md). +[Getting started with Keptn metrics](../intro/usecase_metrics.md). ## Keptn metric basics diff --git a/docs/content/en/docs/implementing/otel.md b/docs/content/en/docs/implementing/otel.md index df0fab95d6..b1e0675ad1 100644 --- a/docs/content/en/docs/implementing/otel.md +++ b/docs/content/en/docs/implementing/otel.md @@ -33,7 +33,7 @@ All this information can be displayed with dashboard tools such as Grafana. For an introduction to using OpenTelemetry with Keptn metrics, see the -[Standardize observability](../intro-klt/usecase-observability.md) +[Standardize observability](../intro/usecase-observability.md) getting started guide. ## DORA metrics diff --git a/docs/content/en/docs/migrate/strategy/_index.md b/docs/content/en/docs/migrate/strategy/_index.md index 438a047767..8e62b776d6 100644 --- a/docs/content/en/docs/migrate/strategy/_index.md +++ b/docs/content/en/docs/migrate/strategy/_index.md @@ -42,7 +42,7 @@ Some key points: that are part of the environment where the application deployment lives rather than using its own Git repo and its [shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/) - file as Keptn V1 does. + file as Keptn v1 does. * See the [CRD Reference](../../yaml-crd-ref) section for pages that describe the Keptn manifests diff --git a/docs/content/en/docs/yaml-crd-ref/app.md b/docs/content/en/docs/yaml-crd-ref/app.md index 1880891d5d..baab768097 100644 --- a/docs/content/en/docs/yaml-crd-ref/app.md +++ b/docs/content/en/docs/yaml-crd-ref/app.md @@ -173,6 +173,6 @@ spec: - [Working with tasks](../implementing/tasks) - [Architecture of KeptnWorkloads and KeptnTasks](../concepts/architecture/keptn-apps/) - [Pre- and post-deployment tasks](../implementing/integrate/#pre--and-post-deployment-checks) -- [Orchestrate deployment checks](../intro-klt/usecase-orchestrate.md) +- [Orchestrate deployment checks](../intro/usecase-orchestrate.md) - [Use Keptn automatic app discovery](../implementing/integrate/#use-keptn-automatic-app-discovery) - [Restart an Application Deployment](../implementing/restart-application-deployment/) diff --git a/docs/content/en/docs/yaml-crd-ref/metric.md b/docs/content/en/docs/yaml-crd-ref/metric.md index 79eab874b6..77dfb8d12b 100644 --- a/docs/content/en/docs/yaml-crd-ref/metric.md +++ b/docs/content/en/docs/yaml-crd-ref/metric.md @@ -156,5 +156,5 @@ spec: * [KeptnEvaluationDefinition](evaluationdefinition.md) * [KeptnMetricsProvider](metricsprovider.md) * Implementing [Keptn Metrics](../implementing/evaluatemetrics.md) -* [Getting started with Keptn metrics](../intro-klt/usecase_metrics.md) +* [Getting started with Keptn metrics](../intro/usecase_metrics.md) * Architecture of the [Keptn Metrics Operator](../concepts/architecture/components/metrics-operator/_index.md) diff --git a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md index dbca310e32..e1a5b32f55 100644 --- a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md +++ b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md @@ -663,4 +663,4 @@ is allowed per `KeptnTaskDefinition`. * [Working with tasks](../implementing/tasks) * [Pre- and post-deployment tasks](../implementing/integrate/#pre--and-post-deployment-checks) * [KeptnApp and KeptnWorkload resources](../concepts/architecture/keptn-apps/). -* [Orchestrate deployment checks](../intro-klt/usecase-orchestrate.md) +* [Orchestrate deployment checks](../intro/usecase-orchestrate.md) diff --git a/examples/sample-app/base/app-post-deploy.yaml b/examples/sample-app/base/app-post-deploy.yaml index f939eba920..4de8979baf 100644 --- a/examples/sample-app/base/app-post-deploy.yaml +++ b/examples/sample-app/base/app-post-deploy.yaml @@ -6,6 +6,6 @@ metadata: spec: function: httpRef: - url: https://raw.githubusercontent.com/keptn/lifecycle-controller/main/runtimes/deno-runtime/samples/ts/slack.ts + url: https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/slack.ts secureParameters: secret: slack-secret diff --git a/examples/sample-app/version-1/app-pre-deploy.yaml b/examples/sample-app/version-1/app-pre-deploy.yaml index 36a243ec2e..b5ad3c760a 100644 --- a/examples/sample-app/version-1/app-pre-deploy.yaml +++ b/examples/sample-app/version-1/app-pre-deploy.yaml @@ -6,7 +6,7 @@ metadata: spec: function: httpRef: - url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-controller/main/runtimes/deno-runtime/samples/ts/http.ts + url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts parameters: map: url: http://podtato-head-frontend.podtato-kubectl.svc.cluster.local:8080 From 1d24ac8dfa6dd810caa2766a25f09fed8988e706 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 02:32:42 -0700 Subject: [PATCH 24/31] Update docs/content/en/docs/concepts/architecture/components/scheduler/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- .../docs/concepts/architecture/components/scheduler/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md b/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md index 10d5587623..c7928b9f4f 100644 --- a/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md @@ -1,7 +1,7 @@ --- title: Keptn Lifecycle Scheduler linktitle: Scheduler -description: Basic understanding of the Keptn Lifecycle Scheduler +description: Basic understanding of the Keptn Scheduler weight: 80 cascade: --- From 6179da22bdd09371ed76c2d5602fe406c7c62ebf Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 02:33:23 -0700 Subject: [PATCH 25/31] Update docs/content/en/docs/migrate/strategy/_index.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- docs/content/en/docs/migrate/strategy/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/migrate/strategy/_index.md b/docs/content/en/docs/migrate/strategy/_index.md index 8e62b776d6..6b00374de8 100644 --- a/docs/content/en/docs/migrate/strategy/_index.md +++ b/docs/content/en/docs/migrate/strategy/_index.md @@ -27,7 +27,7 @@ in Keptn relative to Keptn v1 and then discuss how elements of your Keptn v1 can be implemented for Keptn. -## The Keptn paradigm +## The Keptn cloud native paradigm Keptn uses a different paradigm than Keptn v1 and so migration requires technical adjustments. From 937472430b61fe61c4b080f119cc1ab073c2384b Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 02:34:11 -0700 Subject: [PATCH 26/31] Update examples/sample-app/README.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- examples/sample-app/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/sample-app/README.md b/examples/sample-app/README.md index 46da3f5855..7a3b3b84f1 100644 --- a/examples/sample-app/README.md +++ b/examples/sample-app/README.md @@ -1,6 +1,6 @@ # Sample Application -This example demonstrates the Keptn capabilities as illustrated here: +This example demonstrates Keptn's capabilities as illustrated here: ![img.png](assets/big-picture.png) From 5338911df86eea0f9d1326d79dea3915f2667f77 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 02:34:39 -0700 Subject: [PATCH 27/31] Update scheduler/README.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- scheduler/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scheduler/README.md b/scheduler/README.md index 4b87ddf81b..7223132636 100644 --- a/scheduler/README.md +++ b/scheduler/README.md @@ -1,7 +1,7 @@ # Scheduler The **scheduler** is a pivotal component within -[Keptn](https://main.lifecycle.keptn.sh/) that plays a crucial role in orchestrating the deployment process. +[Keptn](https://lifecycle.keptn.sh/) that plays a crucial role in orchestrating the deployment process. By ensuring that Pods are scheduled onto nodes only after successful pre-deployment checks, the scheduler minimizes errors and downtimes. From 0434731fc6fafd34326a107f8297a80aabd400ae Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 02:35:11 -0700 Subject: [PATCH 28/31] Update scheduler/README.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- scheduler/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scheduler/README.md b/scheduler/README.md index 7223132636..2d2324171f 100644 --- a/scheduler/README.md +++ b/scheduler/README.md @@ -6,4 +6,4 @@ By ensuring that Pods are scheduled onto nodes only after successful pre-deploym the scheduler minimizes errors and downtimes. For detailed information about scheduler's functionality and how it works, please refer to -the [Keptn Scheduler Architecture](https://main.lifecycle.keptn.sh/docs/concepts/architecture/components/scheduler/) section. +the [Keptn Scheduler Architecture](https://lifecycle.keptn.sh/docs/concepts/architecture/components/scheduler/) section. From e50752bfcb842274c1fce3df79e90b8367ef5c95 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 04:00:09 -0700 Subject: [PATCH 29/31] Update examples/sample-app/version-1/app-pre-deploy.yaml Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- examples/sample-app/version-1/app-pre-deploy.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/sample-app/version-1/app-pre-deploy.yaml b/examples/sample-app/version-1/app-pre-deploy.yaml index b5ad3c760a..a2dfd4c6ca 100644 --- a/examples/sample-app/version-1/app-pre-deploy.yaml +++ b/examples/sample-app/version-1/app-pre-deploy.yaml @@ -6,7 +6,7 @@ metadata: spec: function: httpRef: - url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts + url: https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts parameters: map: url: http://podtato-head-frontend.podtato-kubectl.svc.cluster.local:8080 From a05673573f64973d1f0a7d7361478e4fb4e0a3a9 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 04:00:33 -0700 Subject: [PATCH 30/31] Update examples/sample-app/version-2/app-pre-deploy.yaml Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- examples/sample-app/version-2/app-pre-deploy.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/sample-app/version-2/app-pre-deploy.yaml b/examples/sample-app/version-2/app-pre-deploy.yaml index b5ad3c760a..a2dfd4c6ca 100644 --- a/examples/sample-app/version-2/app-pre-deploy.yaml +++ b/examples/sample-app/version-2/app-pre-deploy.yaml @@ -6,7 +6,7 @@ metadata: spec: function: httpRef: - url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts + url: https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts parameters: map: url: http://podtato-head-frontend.podtato-kubectl.svc.cluster.local:8080 From 0b59468645afbd2632ad65942842b12d8b3ad14e Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 5 Sep 2023 04:01:19 -0700 Subject: [PATCH 31/31] Update examples/sample-app/version-3/app-pre-deploy.yaml Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Moritz Wiesinger Signed-off-by: Meg McRoberts --- examples/sample-app/version-3/app-pre-deploy.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/sample-app/version-3/app-pre-deploy.yaml b/examples/sample-app/version-3/app-pre-deploy.yaml index b5ad3c760a..a2dfd4c6ca 100644 --- a/examples/sample-app/version-3/app-pre-deploy.yaml +++ b/examples/sample-app/version-3/app-pre-deploy.yaml @@ -6,7 +6,7 @@ metadata: spec: function: httpRef: - url: https://raw.githubusercontent.com/keptn-sandbox/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts + url: https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/runtimes/deno-runtime/samples/ts/http.ts parameters: map: url: http://podtato-head-frontend.podtato-kubectl.svc.cluster.local:8080