From e089a5dd58dd39dee5f38583f4ccb2de891dd269 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 2 Mar 2023 01:03:02 -0800 Subject: [PATCH 1/4] k8s doc references on landing page Signed-off-by: Meg McRoberts --- docs/content/en/docs/crd-ref/_index.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/content/en/docs/crd-ref/_index.md b/docs/content/en/docs/crd-ref/_index.md index 23e517ce9c..b1838abd9c 100644 --- a/docs/content/en/docs/crd-ref/_index.md +++ b/docs/content/en/docs/crd-ref/_index.md @@ -13,3 +13,21 @@ that are defined for the Keptn Lifecycle Toolkit. Information that is published here has been reviewed for technical accuracy but the format and content is still evolving. We welcome your input!** + +Each CRD is an object of an API library. +Keptn APIs follow the Kubernetes API versioning scheme. +and is itself composed of objects and sub-objects. + +For more information, see the Kubernetes documentation: + +* [API Overview](https://kubernetes.io/docs/reference/using-api/) + +* [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#:~:text=A%20resource%20is%20an%20endpoint,in%20a%20default%20Kubernetes%20installation.) + +* [API versioning](https://kubernetes.io/docs/reference/using-api/#api-versioning) + +* [Understanding Kubernetes Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) + + + + From 3246ac609d6b424125873304c508f351e4e3e32a Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 2 Mar 2023 01:24:22 -0800 Subject: [PATCH 2/4] process go.mod file --- docs/go.mod | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/go.mod b/docs/go.mod index 7ae5fbaa06..bb69a32b84 100644 --- a/docs/go.mod +++ b/docs/go.mod @@ -4,7 +4,4 @@ go 1.19 require github.com/keptn-sandbox/lifecycle-toolkit-docs v0.0.0-20230209144724-01b35a6cfc44 // indirect= -require ( - github.com/google/docsy/dependencies v0.6.0 // indirect - github.com/keptn-sandbox/lifecycle-toolkit-docs v0.0.0-20230209144724-01b35a6cfc44 // indirect -) +require github.com/google/docsy/dependencies v0.6.0 // indirect From bceae867055ef2e08fefb5a437dd43eb9e8737eb Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 24 Mar 2023 04:51:21 -0700 Subject: [PATCH 3/4] split line Signed-off-by: Meg McRoberts --- docs/content/en/docs/crd-ref/_index.md | 2 -- docs/content/en/docs/intro-klt.md | 50 +++++++++++++++++++------- 2 files changed, 38 insertions(+), 14 deletions(-) diff --git a/docs/content/en/docs/crd-ref/_index.md b/docs/content/en/docs/crd-ref/_index.md index 13ab97bf81..b96035fe53 100644 --- a/docs/content/en/docs/crd-ref/_index.md +++ b/docs/content/en/docs/crd-ref/_index.md @@ -30,5 +30,3 @@ For more information, see the Kubernetes documentation: * [API versioning](https://kubernetes.io/docs/reference/using-api/#api-versioning) * [Understanding Kubernetes Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) - - diff --git a/docs/content/en/docs/intro-klt.md b/docs/content/en/docs/intro-klt.md index 46a88b2d60..47e8eb9ca7 100644 --- a/docs/content/en/docs/intro-klt.md +++ b/docs/content/en/docs/intro-klt.md @@ -21,7 +21,7 @@ The Keptn Lifecycle Toolkit "wraps" a standard Kubernetes GitOps deployment with the capability to automatically handle issues before and after the actual deployment. -Pre-deployment issues: +Pre-deployment issues that Keptn Lifecycle Toolkit can handle: * Send appropriate notifications that this deployment is about to happen * Check that downstream services meet their SLOs @@ -29,13 +29,14 @@ Pre-deployment issues: * Ensure that your infrastructure has the resources necessary for a successful deployment -Post-deployment issues: +Post-deployment issues that Keptn Lifecycle Toolkit can handle: * Integrate with tooling beyond the standard Kubernetes probes * Automatically test the deployment * Ensure that the deployment is meeting its SLOs * Identify any downstream issues that may be caused by this deployment -* Send appropriate notifications about whether the deployment was successful or unsuccessful +* Send appropriate notifications + about whether the deployment was successful or unsuccessful KLT can evaluate both workload (single service) tests and SLO evaluations before and after the actual deployment. @@ -58,8 +59,7 @@ It supports the following steps: * Post-Deployment Evaluations: e.g. evaluate the deployment, evaluate the test results, etc. -All of these things can be executed for a workload or for a KeptnApp, -which is a collection of multiple workloads. +All of these things can be executed for a workload or for a KeptnApp. ## Compare Keptn Lifecycle Toolkit and Keptn LTS @@ -77,6 +77,13 @@ can accomodate 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 +that can be implemented independently or together. +Different features are at different levels of stability. +See the [Keptn Lifecycle Toolkit README file] +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 @@ -86,15 +93,34 @@ View the recording: ## Overviews of Keptn Lifecycle Toolkit -A number of presentations are available to give an overview -of the Keptn Lifecycle Toolkit: +A number of presentations are available to help you understand +the Keptn Lifecycle Toolkit: -* [What is keptn, how it works, and how to get started!](https://www.dynatrace.com/news/blog/what-is-keptn-how-it-works-and-how-to-get-started/) +* [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. -* [Observability and Orchestration of your Deployment](https://www.youtube.com/watch?v=0nCbrG_RFos) +* [Keptn Lifecycle Toolkit in a Nutshell](https://www.youtube.com/watch?v=K-cvnZ8EtGc) + gives an overview of what KLT 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) - -* The "IsItObservable Tutorial for KLT" will be released to YouTube soon. + is a short video demonstration of how the Keptn Lifecycle Toolkit 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. + 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 + with your existing cloud native cluster. + +* [Keptn Lifecycle Toolkit: Installation and KeptnTask Creation in Mintes](https://www.youtube.com/watch?v=Hh01bBwZ_qM) + demonstrates how to install KLT and create your first KeptnTask in less than ten minutes. + * You can explore the [GitHub repository](https://github.com/isItObservable/keptn-lifecycle-Toolkit) -* that accompanies this video in the meantime. + for more information. From eb393de1b3539dcc20a66c107bd4d542918cbb75 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Fri, 24 Mar 2023 15:05:10 -0700 Subject: [PATCH 4/4] fix long line for markdownlint Signed-off-by: Meg McRoberts --- docs/content/en/docs/intro-klt.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/en/docs/intro-klt.md b/docs/content/en/docs/intro-klt.md index 47e8eb9ca7..673bb1fafb 100644 --- a/docs/content/en/docs/intro-klt.md +++ b/docs/content/en/docs/intro-klt.md @@ -111,8 +111,8 @@ the Keptn Lifecycle Toolkit: 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. +* [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. This links to: * [What is Keptn Lifecycle Toolkit?](https://www.youtube.com/watch?v=Uvg4uG8AbFg)