From db822760367075abeaec83016e17ea4ba9a1c954 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 7 Nov 2023 04:56:10 -0800 Subject: [PATCH 01/17] docs: add installation tips and tricks page Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 163 ++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 docs/content/en/docs/install/tips-tricks.md diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md new file mode 100644 index 0000000000..ca9c597351 --- /dev/null +++ b/docs/content/en/docs/install/tips-tricks.md @@ -0,0 +1,163 @@ +--- +title: Installation Tips and Tricks +description: Supplemental installation information +weight: 38 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- + +The +[Install Keptn](install.md) +page documents how to install Keptn. +This page provides some background and more examples +that supplement that information. + +## Umbrella chart + +Keptn v0.9.0 and later is installed using a Helm umbrella chart. +This means that the Helm Chart that installs all of Keptn +actually groups subcharts for individual services +and you can install individual services +without installing all of Keptn. + +Keptn is installed using the +[keptn/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/values.yaml) +umbrella chart. +Each subchart has its own `values.yaml` file +with parameters that are documented in the README file for each, +but configuration changes for the subcharts +are added to the umbrella chart. +See +[Customizing the configuration of components](install.md/#customizing-the-configuration-of-components) +for an example. + +## Installing older versions of Keptn + +Installation of Keptn v0.9.0 has two significant differences +compared to installation of earlier releases: + +* Keptn v0.9.0 and later releases use + the umbrella charts whereas earlier versions did not +* Keptn v0.9.0 and later releases use + `keptn` as the value to the `NAME` option to the + [helm repo add](https://helm.sh/docs/helm/helm_repo_add/) + command whereas earlier releases used `klt`. + +To install a version prior to v0.9.0, +use the install command sequence that is documented for that release. +Use the same command sequence documented for v0.9.0 +to determine the CHART version for the release you want to install: + +```shell +helm repo add keptn https://charts.lifecycle.keptn.sh +helm repo update +helm search repo keptn +``` + +Then specify that CHART version to the `--version` flag +in the `helm update` command documented for the release you are installing. + +## Example configurations by use-case + +[Control what components are installed](install/#customizing-the-configuration-of-components) +discusses how to configure Keptn to include only the components you want. +The following sections summarize and give examples +of the configurations needed for different use cases. + +### Enable Keptn Lifecycle Operator (Observability and/or Release Lifecycle Management) + +If you only want to run the Keptn Observability +and/or Release Lifecycle Management use-cases in your cluster, +you do not need to install the Keptn Metrics Operator. +To disable it, set the `metricsOperator.enabled` value +to `false` as in the following: + +{{< embed path="/docs/content/en/docs/install/assets/values-only-lifecycle.yaml" >}} + +Note that, if you want to run pre- and/or post-deployment +[evaluations](../implementing/evaluations.md) +as part of the Release Lifecycle Management use-case, +you need to run the Keptn Metrics Operator. + +You must also enable Keptn for each +[namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) +on which you want to run either +the Observability or Release Lifecycle Management use-case. +This is because Keptn communicates with the Kubernetes scheduling mechanism +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](https://kubernetes.io/docs/concepts/workloads/) +on the cluster. + +To enable Keptn in your namespace, +annotate the appropriate `Namespace` resource(s). +For example, for the `simplenode-dev` namespace, +the annotation looks like this: + +```yaml +apiVersion: v1 +kind: Namespace +metadata: + name: simplenode-dev + annotations: + keptn.sh/lifecycle-toolkit: "enabled" +``` + +You see the annotation line `keptn.sh/lifecycle-toolkit: "enabled"`. +This annotation tells the webhook to handle the namespace. + +After enabling Keptn for your namespace(s), +you are ready to +[Integrate Keptn with your applications](../implementing/integrate.md). + +For more information about implementing Observability, see the +[Observability User Guide](../implementing/otel.md). + +For more information about implementing Keptn Release Management, see the +[Deployment tasks](../implementing/tasks.md) +and +[Evaluations](../implementing/evaluations.md) +User Guides. + +### Enable Keptn Metrics Operator (Metrics) + +If you are only interested in Metrics, +you do not need the Keptn Lifecycle Operator. +Disable it using the following values.yaml: + +{{< embed path="/docs/content/en/docs/install/assets/values-only-metrics.yaml" >}} + +For more information about implementing Metrics, see the +[Metrics User Guide](../implementing/evaluatemetrics.md). + +### Enable Keptn Analysis (SLOs/SLIs) + +To enable Keptn Analysis in your cluster, +you again do not need the Keptn Lifcycle Operator. +Disable it using the following values.yaml: + +{{< embed path="/docs/content/en/docs/install/assets/values-only-metrics.yaml" >}} + +> **Note** A preliminary release of the Keptn Analysis feature + is included in Keptn v0.8.3 and v0.9.0 but is hidden behind a feature flag. + See the + [Analysis](../yaml-crd-ref/analysis.md/#differences-between-versions) + reference page for how to activate the preview of this feature. +> + +For more information about implementing Keptn Analysis, see the +[Analysis User Guide](../implementing/slo.md). + +### Disable Keptn Certificate Manager (Certificates) + +If you wish to use your own custom certificate manager, +you can disable the Keptn `cert-manager` by using the +`--set "certificateManager.enabled=false"` argument +to the `helm upgrade` command line +or you can modify the `keptn/values.yaml` file: + +{{< embed path="/docs/content/en/docs/install/assets/values-remove-certmanager.yaml" >}} + +For more information about using `cert-manager` with Keptn, see +[Use Keptn with cert-manager.io](../operate/cert-manager.md). From 3197eba871810c1d6a242273cbaec2efd29558b7 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 7 Nov 2023 05:08:24 -0800 Subject: [PATCH 02/17] install.md xref Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index ca9c597351..d3b00353bf 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -58,7 +58,7 @@ in the `helm update` command documented for the release you are installing. ## Example configurations by use-case -[Control what components are installed](install/#customizing-the-configuration-of-components) +[Control what components are installed](install.md/#customizing-the-configuration-of-components) discusses how to configure Keptn to include only the components you want. The following sections summarize and give examples of the configurations needed for different use cases. From d5478bd7d7b04932c66fbf975f7304c25d7c0f2d Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 7 Nov 2023 05:18:05 -0800 Subject: [PATCH 03/17] small edits Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 24 ++++++++++----------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index d3b00353bf..1fd333b2c6 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -23,9 +23,8 @@ Keptn is installed using the [keptn/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/values.yaml) umbrella chart. Each subchart has its own `values.yaml` file -with parameters that are documented in the README file for each, -but configuration changes for the subcharts -are added to the umbrella chart. +with parameters that are documented in its README file, +but configuration changes for the subcharts are added to the umbrella chart. See [Customizing the configuration of components](install.md/#customizing-the-configuration-of-components) for an example. @@ -33,12 +32,12 @@ for an example. ## Installing older versions of Keptn Installation of Keptn v0.9.0 has two significant differences -compared to installation of earlier releases: +compared to the installation of earlier releases: * Keptn v0.9.0 and later releases use the umbrella charts whereas earlier versions did not * Keptn v0.9.0 and later releases use - `keptn` as the value to the `NAME` option to the + `keptn` as the value to the `NAME` option of the [helm repo add](https://helm.sh/docs/helm/helm_repo_add/) command whereas earlier releases used `klt`. @@ -53,8 +52,9 @@ helm repo update helm search repo keptn ``` -Then specify that CHART version to the `--version` flag -in the `helm update` command documented for the release you are installing. +To install an older release, +specify that CHART version to the `--version` flag +in the `helm update` command for the release you are installing. ## Example configurations by use-case @@ -63,10 +63,10 @@ discusses how to configure Keptn to include only the components you want. The following sections summarize and give examples of the configurations needed for different use cases. -### Enable Keptn Lifecycle Operator (Observability and/or Release Lifecycle Management) +### Enable Keptn Lifecycle Operator (Observability and/or Release Lifecycle) If you only want to run the Keptn Observability -and/or Release Lifecycle Management use-cases in your cluster, +and/or Release Lifecycle use-cases in your cluster, you do not need to install the Keptn Metrics Operator. To disable it, set the `metricsOperator.enabled` value to `false` as in the following: @@ -75,13 +75,13 @@ to `false` as in the following: Note that, if you want to run pre- and/or post-deployment [evaluations](../implementing/evaluations.md) -as part of the Release Lifecycle Management use-case, +as part of the Release Lifecycle use-case, you need to run the Keptn Metrics Operator. You must also enable Keptn for each [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) on which you want to run either -the Observability or Release Lifecycle Management use-case. +the Observability or Release Lifecycle use-case. This is because Keptn communicates with the Kubernetes scheduling mechanism for tasks such as enforcing checks natively, stopping a deployment from proceeding when criteria are not met, @@ -114,7 +114,7 @@ you are ready to For more information about implementing Observability, see the [Observability User Guide](../implementing/otel.md). -For more information about implementing Keptn Release Management, see the +For more information about implementing Keptn Release Lifecycle, see the [Deployment tasks](../implementing/tasks.md) and [Evaluations](../implementing/evaluations.md) From e69de7d95095a22455d8c7ff23042ebd2e474845 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 00:58:01 -0800 Subject: [PATCH 04/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index 1fd333b2c6..6665ee5ec4 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -15,7 +15,7 @@ that supplement that information. Keptn v0.9.0 and later is installed using a Helm umbrella chart. This means that the Helm Chart that installs all of Keptn -actually groups subcharts for individual services +actually groups subcharts for individual components and you can install individual services without installing all of Keptn. From 06e040f8a146dd63b8c1441bff6a37a9e93bc042 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 00:58:14 -0800 Subject: [PATCH 05/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index 6665ee5ec4..42cca1eebb 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -16,7 +16,7 @@ that supplement that information. Keptn v0.9.0 and later is installed using a Helm umbrella chart. This means that the Helm Chart that installs all of Keptn actually groups subcharts for individual components -and you can install individual services +and you can install individual components without installing all of Keptn. Keptn is installed using the From fd2d2b1ab7e5b312506c0314711ef2d5e8f6db43 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 00:58:44 -0800 Subject: [PATCH 06/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index 42cca1eebb..2d824b4867 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -22,9 +22,8 @@ without installing all of Keptn. Keptn is installed using the [keptn/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/values.yaml) umbrella chart. -Each subchart has its own `values.yaml` file -with parameters that are documented in its README file, -but configuration changes for the subcharts are added to the umbrella chart. +Each subchart has its own README file describing possible configuration options, +but configuration changes for the subcharts are added to a single `values.yaml` file. See [Customizing the configuration of components](install.md/#customizing-the-configuration-of-components) for an example. From e2755db98fe1e23ff61241118da096b36968f439 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 00:59:00 -0800 Subject: [PATCH 07/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index 2d824b4867..8efda1b970 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -52,7 +52,7 @@ helm search repo keptn ``` To install an older release, -specify that CHART version to the `--version` flag +specify the version with the chart `--version` flag in the `helm update` command for the release you are installing. ## Example configurations by use-case From e82578a846d9a9e63b74effd6cb3094ced4a8724 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 00:59:19 -0800 Subject: [PATCH 08/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index 8efda1b970..1758d08eaf 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -42,8 +42,7 @@ compared to the installation of earlier releases: To install a version prior to v0.9.0, use the install command sequence that is documented for that release. -Use the same command sequence documented for v0.9.0 -to determine the CHART version for the release you want to install: +To install the latest version use: ```shell helm repo add keptn https://charts.lifecycle.keptn.sh From 21f14f7ac90a495ccc9540132e68c90ea9aa8eac Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 00:59:32 -0800 Subject: [PATCH 09/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index 1758d08eaf..ffe238b7a4 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -74,7 +74,7 @@ to `false` as in the following: Note that, if you want to run pre- and/or post-deployment [evaluations](../implementing/evaluations.md) as part of the Release Lifecycle use-case, -you need to run the Keptn Metrics Operator. +you need to have the Keptn Metrics Operator installed. You must also enable Keptn for each [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) From 00ad2af60ef5292dbb1f7580403b7a3025cf44ac Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 01:11:10 -0800 Subject: [PATCH 10/17] remove scheduling jabber for enable Keptn Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index ffe238b7a4..ad386d2f06 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -80,16 +80,8 @@ You must also enable Keptn for each [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) on which you want to run either the Observability or Release Lifecycle use-case. -This is because Keptn communicates with the Kubernetes scheduling mechanism -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](https://kubernetes.io/docs/concepts/workloads/) -on the cluster. - -To enable Keptn in your namespace, -annotate the appropriate `Namespace` resource(s). + +To enable Keptn, annotate the appropriate `Namespace` resource(s). For example, for the `simplenode-dev` namespace, the annotation looks like this: From d0ac018a0569c2218acec2d0685f7696e8800933 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 01:14:56 -0800 Subject: [PATCH 11/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index ad386d2f06..cb88827a95 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -143,7 +143,7 @@ For more information about implementing Keptn Analysis, see the If you wish to use your own custom certificate manager, you can disable the Keptn `cert-manager` by using the -`--set "certificateManager.enabled=false"` argument +`--set certificateManager.enabled=false` argument to the `helm upgrade` command line or you can modify the `keptn/values.yaml` file: From 73dd2c72a6f8ddd793a8a3a308c29602cf49f543 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 01:15:17 -0800 Subject: [PATCH 12/17] Update docs/content/en/docs/install/tips-tricks.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index cb88827a95..eb8bbf6d53 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -145,7 +145,7 @@ If you wish to use your own custom certificate manager, you can disable the Keptn `cert-manager` by using the `--set certificateManager.enabled=false` argument to the `helm upgrade` command line -or you can modify the `keptn/values.yaml` file: +or you can modify the `values.yaml` file: {{< embed path="/docs/content/en/docs/install/assets/values-remove-certmanager.yaml" >}} From f84df9b4c490df00e16d9f2245829d0f1333934c Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 01:22:47 -0800 Subject: [PATCH 13/17] remove webhook ref from enable Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/tips-tricks.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/content/en/docs/install/tips-tricks.md b/docs/content/en/docs/install/tips-tricks.md index eb8bbf6d53..74a9900409 100644 --- a/docs/content/en/docs/install/tips-tricks.md +++ b/docs/content/en/docs/install/tips-tricks.md @@ -95,7 +95,6 @@ metadata: ``` You see the annotation line `keptn.sh/lifecycle-toolkit: "enabled"`. -This annotation tells the webhook to handle the namespace. After enabling Keptn for your namespace(s), you are ready to From 67d8b64148e1a5b1399d58fa2a57ba7c1bc409ac Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 9 Nov 2023 10:33:13 +0000 Subject: [PATCH 14/17] Update metadata check-spelling run (pull_request_target) for 1107-tips Signed-off-by: check-spelling-bot on-behalf-of: @check-spelling --- .github/actions/spelling/expect.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 9c859e4acd..2337936cfa 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -568,7 +568,7 @@ stdouttrace storageclasses storageversion sts -subcharts +subchart subdir subjectaccessreviews substitue From 697760a8157e17d5c51581d0e67d3231f8cb00fc Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Mon, 13 Nov 2023 22:58:59 -0800 Subject: [PATCH 15/17] docs: add spell checker info to contrib guide --- .../docs/linter-requirements/_index.md | 2 +- .../contribute/docs/local-building/_index.md | 2 +- .../contribute/docs/spell-checker/_index.md | 9 ++ docs/content/en/docs/intro/_index-bad.md | 144 ++++++++++++++++++ 4 files changed, 155 insertions(+), 2 deletions(-) create mode 100644 docs/content/en/contribute/docs/spell-checker/_index.md create mode 100644 docs/content/en/docs/intro/_index-bad.md diff --git a/docs/content/en/contribute/docs/linter-requirements/_index.md b/docs/content/en/contribute/docs/linter-requirements/_index.md index 2ea8d4b754..4b2ede49f7 100644 --- a/docs/content/en/contribute/docs/linter-requirements/_index.md +++ b/docs/content/en/contribute/docs/linter-requirements/_index.md @@ -1,7 +1,7 @@ --- title: Linter Requirements description: To maintain optimal code quality, this project employs linters which require a specific IDE configuration for effective utilization. -weight: 400 +weight: 350 --- ## Linter Requirements diff --git a/docs/content/en/contribute/docs/local-building/_index.md b/docs/content/en/contribute/docs/local-building/_index.md index 73d360856a..2418e49d65 100644 --- a/docs/content/en/contribute/docs/local-building/_index.md +++ b/docs/content/en/contribute/docs/local-building/_index.md @@ -1,7 +1,7 @@ --- title: Build Documentation Locally description: This guide explains how to create a local version of the documentation -weight: 400 +weight: 300 --- ## Building the documentation locally diff --git a/docs/content/en/contribute/docs/spell-checker/_index.md b/docs/content/en/contribute/docs/spell-checker/_index.md new file mode 100644 index 0000000000..14ba7ff93b --- /dev/null +++ b/docs/content/en/contribute/docs/spell-checker/_index.md @@ -0,0 +1,9 @@ +--- +title: Spell checker +description: How to work with the spell checker +weight: 375 +--- + +All PRs that are pushed to a Keptn repository +are run through a spell checker that is based on + diff --git a/docs/content/en/docs/intro/_index-bad.md b/docs/content/en/docs/intro/_index-bad.md new file mode 100644 index 0000000000..b3a9076332 --- /dev/null +++ b/docs/content/en/docs/intro/_index-bad.md @@ -0,0 +1,144 @@ +--- +title: Bad Introduction to Keptn +description: A bad copy of this file to play with spell-check +weight: 10 +--- + +Keptn integrates seamlessly with cloud-native deployment tools +such as ArgoCD, Flux, and Gitlab +to bring application awareness to your Kubernetes cluster. +Keptn supplements hte standard deployment tools +with features to help you ensure that your deployments are in +a healthy state. + +One never knows how behaviours will be affected in a theatre. +You may need to make some adjustments manuall. + +For information about the history of the Keptn project, see the +[Keptn Lifecycle Toolkit is now Keptn!](https://medium.com/keptn/keptn-lifecycle-toolkit-is-now-keptn-e0812217bf46) +blog. + +Keptn includes multiple features +that can be implemented independently or together. +It targets three main use cases: +Metrics, Observability, and Release lifecycle management. + +## Metrics + +The Keptn metrics feature extends the functionality of +[Kubernetes metrics](https://kubernetes.io/docs/concepts/cluster-administration/system-metrics/): + +* Allows you to define metrics + from multiple data sources in your Kubernetes cluster. + +* Supports deployment tools like Argo, Flux, KEDA, HPA, or + Keptn for automated decision-making based on observability data. + +* Handles observability data from multiple instances + of multiple observability solutions + – Prometheus, Dynatrace, Datadog and others – + as well as data that comes directly from your cloud provider + such as AWS, Google, or Azure. + +* Enhances the Kubernetes + [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) + facility. + +The Keptn metrics server unifies and standardizes +access to data from various sources, +simplifying configuration and integration into a single set of metrics. + +To learn more, see: + +* [Getting started with Keptn metrics](../getting-started/metrics.md) +* [Keptn Metrics](../implementing/evaluatemetrics.md) User Guide + +## Observability + +Keptn ensures observability for Kubernetes deployments +by creating a comprehensive trace +of all Kubernetes activities within a deployment. +Keptn observability makes it easy to understand +deployment durations and failures across multiple deployment strategies. + +* Provides observability data for standard Kubernetes [workload](https://kubernetes.io/docs/concepts/workloads/) resources + as well as + [KeptnApp](https://lifecycle.keptn.sh/docs/yaml-crd-ref/app/) + resources (which connect logically related [workloads](https://kubernetes.io/docs/concepts/workloads/)) + using different deployment strategies. + +* Captures + [DORA metrics](../implementing/dora.md) + and exposes them as OpenTelemetry metrics out of the box. + +* Reports traces and custom Keptn metrics from configured data providers + using OpenTelemetry. + +* Enables monitoring of new logs from log monitoring solutions. + +* Information can be displayed on standard dashboard tools + like Grafana. + +Keptn is tool- and vendor neutral +and does not depend on particular tooling. +Keptn emits signals at every stage +([Kubernetes events](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/), +[CloudEvents](https://cloudevents.io/), and +OpenTelemetry metrics and traces) +to ensure that your deployments are observable. + +To learn more, see: + +* [Getting started with Keptn Observability](../getting-started/observability.md) +* [Standardize observability](usecase-observability.md/) +* [DORA metrics](../implementing/dora.md) User Guide +* [OpenTelemetry observability](../implementing/otel.md) User Guide + +## Release lifecycle management + +The Release lifecycle management tools run in conjunction +with the standard Kubernetes deployment tools +to make deployments more robust. +Keptn "wraps" a standard Kubernetes deployment +with the capability to automatically handle issues +before and after the actual deployment. + +These tools run checks and tasks before or after deployment initiation. + +* Pre-deployment tasks such as checking for dependent services, + image scanning, and setting the cluster to be ready for the deployment. + +* Pre-deployment evaluations such as checking whether the cluster + has enough resources for the deployment. + +* Post-deployment tasks such as triggering tests, + triggering a deployment to another cluster, + or sending notifications that the deployment succeeded or failed. + +* Post-deployment evaluations to evaluate the deployment, + evaluate test results, + or confirm software health against SLOs + like performance and user experience. + +All `KeptnTask` resources that are defined by `KeptnTaskDefinition` resources +at the same level (either pre-deployment or post-deployment) run in parallel. +Task sequences that are not part of the lifecycle workflow +should be handled by the pipeline engine tools rather than Keptn. +A `KeptnTask` resource can be defined to run multiple executables +(functions, programs, and scripts) +that are part of the lifecycle workflow. +The executables within a `KeptnTask` resource +run in sequential order. + +Keptn tasks and evaluations can be run +for either a Kubernetes [workload](https://kubernetes.io/docs/concepts/workloads/) (single service) resource +or a +[KeptnApp](../yaml-crd-ref/app.md) resource, +which is a single, cohesive unit that groups multiple [workloads](https://kubernetes.io/docs/concepts/workloads/). +For more information, see: + +* [Getting started with release lifecycle management](../getting-started/lifecycle-management.md) +* [Deployment tasks](../implementing/tasks.md) User Guide +* [Evaluations](../implementing/evaluations.md) User Guide +* [Manage release lifecycle](usecase-orchestrate.md) +* [KeptnApp and KeptnWorkload resources](../architecture/keptn-apps.md) From 07854410eeadc5ce14aabd3cedad20293ba61b8b Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 14 Nov 2023 17:56:56 -0800 Subject: [PATCH 16/17] fix bogus spell errors in _index-bad.md Signed-off-by: Meg McRoberts --- .../contribute/docs/spell-checker/_index.md | 32 +++++++++++++++++++ docs/content/en/docs/intro/_index-bad.md | 4 +-- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/docs/content/en/contribute/docs/spell-checker/_index.md b/docs/content/en/contribute/docs/spell-checker/_index.md index 14ba7ff93b..52ac05b856 100644 --- a/docs/content/en/contribute/docs/spell-checker/_index.md +++ b/docs/content/en/contribute/docs/spell-checker/_index.md @@ -6,4 +6,36 @@ weight: 375 All PRs that are pushed to a Keptn repository are run through a spell checker that is based on +[check-spelling](https://github.com/check-spelling/check-spelling) +Github action. +Note, however, that you are still resposible for reading your text carefully. +The tool does not flag if you used a real word that is not the right word, +if you misuse "setup" versus "set up", and so forth. + +## Handling Spell Checker errors + +If you get a Spell Checker error: + +1. Right-click the `details` link for Spell Checker. +1. If you do not want to read through the whole (and rather verbose) log, + type `unrecognized words` in the search box at the top. +1. This shows the word(s) that caused Spell Checker to fail. + + - If these are genuine misspellings, + correct the spelling in your local branch + or using the github editor + and push the new commit to resolve the errors. + + - If a word that is flagged is a legitimate word, + follow the instructions in the repor + to propose adding it to our dictionary. + This request will be added to your PR for review + and, if approved, will be merged when the PR is merged. + + - If your PR includes a file that should not be spell-checked, + you can add it to the + [excludes.txt](https://github.com/check-spelling/check-spelling/blob/main/.github/actions/spelling/excludes.txt) file + as part of your PR. + It will be reviewed and, if approved, + merged as part of your PR. diff --git a/docs/content/en/docs/intro/_index-bad.md b/docs/content/en/docs/intro/_index-bad.md index b3a9076332..4b21ead863 100644 --- a/docs/content/en/docs/intro/_index-bad.md +++ b/docs/content/en/docs/intro/_index-bad.md @@ -7,12 +7,12 @@ weight: 10 Keptn integrates seamlessly with cloud-native deployment tools such as ArgoCD, Flux, and Gitlab to bring application awareness to your Kubernetes cluster. -Keptn supplements hte standard deployment tools +Keptn supplements the standard deployment tools with features to help you ensure that your deployments are in a healthy state. One never knows how behaviours will be affected in a theatre. -You may need to make some adjustments manuall. +You may need to make some adjustments manually. For information about the history of the Keptn project, see the [Keptn Lifecycle Toolkit is now Keptn!](https://medium.com/keptn/keptn-lifecycle-toolkit-is-now-keptn-e0812217bf46) From 57f506582bd469a3305b9b5c240f7e24bebcd6aa Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Tue, 14 Nov 2023 18:01:52 -0800 Subject: [PATCH 17/17] more spell errors Signed-off-by: Meg McRoberts --- docs/content/en/contribute/docs/spell-checker/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/en/contribute/docs/spell-checker/_index.md b/docs/content/en/contribute/docs/spell-checker/_index.md index 52ac05b856..345d5aec5c 100644 --- a/docs/content/en/contribute/docs/spell-checker/_index.md +++ b/docs/content/en/contribute/docs/spell-checker/_index.md @@ -9,7 +9,7 @@ are run through a spell checker that is based on [check-spelling](https://github.com/check-spelling/check-spelling) Github action. -Note, however, that you are still resposible for reading your text carefully. +Note, however, that you are still responsible for reading your text carefully. The tool does not flag if you used a real word that is not the right word, if you misuse "setup" versus "set up", and so forth. @@ -28,7 +28,7 @@ If you get a Spell Checker error: and push the new commit to resolve the errors. - If a word that is flagged is a legitimate word, - follow the instructions in the repor + follow the instructions in the report to propose adding it to our dictionary. This request will be added to your PR for review and, if approved, will be merged when the PR is merged.