From 5570d555bfc4bbdcbfc66b2725d5352090e5b937 Mon Sep 17 00:00:00 2001 From: Moritz Wiesinger Date: Wed, 23 Aug 2023 08:15:22 +0200 Subject: [PATCH] docs: fix typos and grammar issues (#1925) --- .../docs/contribution-guidelines/_index.md | 2 +- .../contribute/docs/source-file-structure/_index.md | 1 - .../en/contribute/general/technologies/_index.md | 2 +- .../en/docs/concepts/architecture/cert-manager.md | 1 - .../components/metrics-operator/_index.md | 4 ++-- .../docs/concepts/architecture/keptn-apps/_index.md | 4 ++-- .../en/docs/crd-ref/lifecycle/v1alpha2/_index.md | 2 +- .../en/docs/crd-ref/lifecycle/v1alpha3/_index.md | 4 ++-- docs/content/en/docs/getting-started/_index.md | 4 ++-- docs/content/en/docs/implementing/_index.md | 1 - .../en/docs/implementing/add-app-awareness/index.md | 2 +- .../en/docs/implementing/integrate/_index.md | 13 ++++++------- docs/content/en/docs/implementing/otel.md | 4 ++-- .../restart-application-deployment/_index.md | 1 - docs/content/en/docs/implementing/tasks/_index.md | 5 ++--- docs/content/en/docs/install/k8s.md | 1 - docs/content/en/docs/install/upgrade.md | 3 +-- docs/content/en/docs/intro-klt/_index.md | 4 ++-- .../en/docs/intro-klt/usecase-orchestrate.md | 8 ++++---- docs/content/en/docs/intro-klt/usecase_metrics.md | 2 +- docs/content/en/docs/migrate/strategy/_index.md | 12 ++++++------ docs/content/en/docs/troubleshooting.md | 2 +- docs/content/en/docs/tutorials/_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 | 12 ++++++------ .../v1alpha2/keptnworkloadinstance_types.go | 2 +- .../lifecycle/v1alpha3/keptntaskdefinition_types.go | 10 +++++----- .../v1alpha3/keptnworkloadinstance_types.go | 2 +- 29 files changed, 53 insertions(+), 61 deletions(-) diff --git a/docs/content/en/contribute/docs/contribution-guidelines/_index.md b/docs/content/en/contribute/docs/contribution-guidelines/_index.md index d1aa4cd248..c85703db43 100644 --- a/docs/content/en/contribute/docs/contribution-guidelines/_index.md +++ b/docs/content/en/contribute/docs/contribution-guidelines/_index.md @@ -5,7 +5,7 @@ weight: 300 --- Before using the **Keptn Lifecycle Toolkit** -as a contributor to the Kepth Lifecycle Toolkit 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/contribute/docs/source-file-structure/_index.md b/docs/content/en/contribute/docs/source-file-structure/_index.md index 95ba58c72d..3ae25f4b08 100644 --- a/docs/content/en/contribute/docs/source-file-structure/_index.md +++ b/docs/content/en/contribute/docs/source-file-structure/_index.md @@ -18,7 +18,6 @@ As an example, the metadata section for the *Concepts* section of the documentat ```yaml title: Concepts description: Learn about underlying concepts of the keptn lifecycle toolkit. -icon: concepts layout: quickstart weight: 50 ``` diff --git a/docs/content/en/contribute/general/technologies/_index.md b/docs/content/en/contribute/general/technologies/_index.md index bf02cd943d..b9cafb4b65 100644 --- a/docs/content/en/contribute/general/technologies/_index.md +++ b/docs/content/en/contribute/general/technologies/_index.md @@ -22,7 +22,7 @@ please submit an issue. * [ ] [Philosophy](https://youtu.be/ZuIQurh_kDk) * [ ] [Kubernetes Deconstructed: Understanding Kubernetes by Breaking It Down](https://www.youtube.com/watch?v=90kZRyPcRZw) * **CRD** - * [ ] [Custom Resouce Definition (CRD)](https://www.youtube.com/watch?v=xGafiZEX0YA) + * [ ] [Custom Resource Definition (CRD)](https://www.youtube.com/watch?v=xGafiZEX0YA) * [ ] [Kubernetes Operator simply explained in 10 mins](https://www.youtube.com/watch?v=ha3LjlD6g7g) * [ ] [Writing Kubernetes Controllers for CRDs](https://www.youtube.com/watch?v=7wdUa4Ulwxg) * **Kube-builder Tutorial** diff --git a/docs/content/en/docs/concepts/architecture/cert-manager.md b/docs/content/en/docs/concepts/architecture/cert-manager.md index 2a402ed702..22772f339d 100644 --- a/docs/content/en/docs/concepts/architecture/cert-manager.md +++ b/docs/content/en/docs/concepts/architecture/cert-manager.md @@ -1,7 +1,6 @@ --- title: Keptn Certificate Manager description: Learn how the cert-manager works -icon: concepts layout: quickstart weight: 100 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html diff --git a/docs/content/en/docs/concepts/architecture/components/metrics-operator/_index.md b/docs/content/en/docs/concepts/architecture/components/metrics-operator/_index.md index eead99b1c1..2346e9454e 100644 --- a/docs/content/en/docs/concepts/architecture/components/metrics-operator/_index.md +++ b/docs/content/en/docs/concepts/architecture/components/metrics-operator/_index.md @@ -22,7 +22,7 @@ all your metrics data, regardless of its source, so you can use multiple instances of multiple observability platforms. Keptn metrics are integrated with the Kubernetes -[Custom Metrics API](https://github.com/kubernetes/metrics#custom-metrics-api) +[Custom Metrics API](https://github.com/kubernetes/metrics#custom-metrics-api), so they are compatible with the Kubernetes [HorizontalPodAutoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA), which enables the horizontal scaling of workloads @@ -52,7 +52,7 @@ where external monitoring and alerting tools can scrape them. It is an important component of the metrics operator as it allows for the collection and exposure of custom metrics, which can be used to gain insight into the behavior and performance -of applications running on a Kubenetes cluster. +of applications running on a Kubernetes cluster. The **Metrics controller** fetches metrics from an SLI provider. The controller reconciles a [`KeptnMetric`](../../../../yaml-crd-ref/metric.md) 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 ac9dfa2e37..69741216fe 100644 --- a/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md +++ b/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md @@ -112,11 +112,11 @@ KLT 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 poulated: +annotation/label is populated: resource for each defined group. that together constitute a single deployable Keptn Application. -* If either of these labels/allotations are populated, +* If either of these labels/annotations are populated, KLT 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/crd-ref/lifecycle/v1alpha2/_index.md b/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md index 12f43f676a..2ffbf44a27 100644 --- a/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md +++ b/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md @@ -153,7 +153,7 @@ _Appears in:_ | Field | Description | | --- | --- | -| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefiniton | +| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefinition | | `status` _KeptnState_ | | | `name` _string_ | Name is the name of the Evaluation/Task | | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | | 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 e6ac79ab04..905e43fe6e 100644 --- a/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md +++ b/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md @@ -112,7 +112,7 @@ _Appears in:_ | Field | Description | | --- | --- | -| `name` _string_ | Name is the name of the referenced KeptnTaksDefinition. | +| `name` _string_ | Name is the name of the referenced KeptnTaskDefinition. | #### FunctionStatus @@ -169,7 +169,7 @@ _Appears in:_ | Field | Description | | --- | --- | -| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefiniton | +| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefinition | | `status` _KeptnState_ | | | `name` _string_ | Name is the name of the Evaluation/Task | | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | StartTime represents the time at which the Item (Evaluation/Task) started. | diff --git a/docs/content/en/docs/getting-started/_index.md b/docs/content/en/docs/getting-started/_index.md index b1563d8c33..b666681e37 100644 --- a/docs/content/en/docs/getting-started/_index.md +++ b/docs/content/en/docs/getting-started/_index.md @@ -263,7 +263,7 @@ These metrics can then be visualised in Grafana. For example: - `keptn_app_active` tracks the number of applications that Keptn manages -- `keptn_deployment_active` tracks the currently live number of deployments occuring. +- `keptn_deployment_active` tracks the currently live number of deployments occurring. Expect this metric to be `0` when everything is currently deployed. It will occasionally rise to `n` during deployments and then fall back to `0` when deployments are completed. @@ -271,7 +271,7 @@ There are many other Keptn metrics. ## Step 7: Make DORA metrics more user friendly -It is much more user friendly to provide dashboards for metrics, logs and traces. +It is much more user-friendly to provide dashboards for metrics, logs and traces. So let's install new Observability components to help us: - [Cert manager](https://cert-manager.io): Jaeger requires cert-manager diff --git a/docs/content/en/docs/implementing/_index.md b/docs/content/en/docs/implementing/_index.md index 48267d02c0..5a3cb3c28c 100644 --- a/docs/content/en/docs/implementing/_index.md +++ b/docs/content/en/docs/implementing/_index.md @@ -1,7 +1,6 @@ --- title: Implementing Keptn applications description: Learn how to implement your KLT application -icon: concepts 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 92d50c8e32..63c16377b1 100644 --- a/docs/content/en/docs/implementing/add-app-awareness/index.md +++ b/docs/content/en/docs/implementing/add-app-awareness/index.md @@ -17,7 +17,7 @@ To get this working, we need to modify our application manifest with two things: ### TL;DR -You can also used the prepared manifest and apply it directly using: `kubectl apply -k sample-app/version-2/` and +You can also use the prepared manifest and apply it directly using: `kubectl apply -k sample-app/version-2/` and proceed [here](#watch-application-behavior). --- diff --git a/docs/content/en/docs/implementing/integrate/_index.md b/docs/content/en/docs/implementing/integrate/_index.md index 03ffb3ba48..a78dd06579 100644 --- a/docs/content/en/docs/implementing/integrate/_index.md +++ b/docs/content/en/docs/implementing/integrate/_index.md @@ -1,14 +1,13 @@ --- title: Integrate KLT with your applications description: How to integrate the Keptn Lifecycle Toolkit into your Kubernetes cluster -icon: concepts layout: quickstart weight: 45 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- The Keptn Lifecycle Toolkit works -on top of the default scheduler for the cluster +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 @@ -78,7 +77,7 @@ keptn.sh/version: myAwesomeWorkloadVersion keptn.sh/app: myAwesomeAppName ``` -Alternatively, you can use Kubernete keys for annotations or labels. +Alternatively, you can use Kubernetes keys for annotations or labels. These are part of the Kubernetes [Recommended Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/): @@ -166,8 +165,8 @@ In general, annotations are more appropriate than labels for integrating KLT 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 -and can accomodate the size restriction. +However, labels can be used if you specifically need them +and can accommodate the size restriction. ## Pre- and post-deployment checks @@ -201,7 +200,7 @@ do the following: [Working with Keptn tasks](../tasks) for more information. * Annotate your [Workloads](https://kubernetes.io/docs/concepts/workloads/) - ([Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/), + [Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/), [StatefulSets](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/), and [DaemonSets](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) @@ -242,7 +241,7 @@ The deployment is kept in a pending state until the infrastructure is capable of accepting deployments again. If everything is fine, the deployment continues and afterward, -a slack notification is sent with the result of the deployment +a Slack notification is sent with the result of the deployment ## Use Keptn automatic app discovery diff --git a/docs/content/en/docs/implementing/otel.md b/docs/content/en/docs/implementing/otel.md index 30e1572eb5..be2808f167 100644 --- a/docs/content/en/docs/implementing/otel.md +++ b/docs/content/en/docs/implementing/otel.md @@ -125,7 +125,7 @@ kubectl apply -f config/prometheus/ ### Integrate OpenTelemetry into the Keptn Lifecycle Toolkit -To integrate OpenTelementry into the Keptn Lifecycle Toolkit: +To integrate OpenTelemetry into the Keptn Lifecycle Toolkit: - Apply [basic annotations](../implementing/integrate/#basic-annotations) @@ -138,7 +138,7 @@ To integrate OpenTelementry into the Keptn Lifecycle Toolkit: The [otel-collector.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/examples/support/observability/config/otel-collector.yaml) -is the OpenTelementry manifest file for the PodtatoHead example, +is the OpenTelemetry manifest file for the PodtatoHead example, located in the `config` directory. To deploy and configure the OpenTelemetry collector using this manifest, the command is: diff --git a/docs/content/en/docs/implementing/restart-application-deployment/_index.md b/docs/content/en/docs/implementing/restart-application-deployment/_index.md index f1a3ba916d..faacecb9fc 100644 --- a/docs/content/en/docs/implementing/restart-application-deployment/_index.md +++ b/docs/content/en/docs/implementing/restart-application-deployment/_index.md @@ -1,7 +1,6 @@ --- title: Restart an Application Deployment description: Learn how to restart an unsuccessful Keptn Application Deployment. -icon: concepts layout: quickstart weight: 100 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html diff --git a/docs/content/en/docs/implementing/tasks/_index.md b/docs/content/en/docs/implementing/tasks/_index.md index c2a85ab321..5e692c7cca 100644 --- a/docs/content/en/docs/implementing/tasks/_index.md +++ b/docs/content/en/docs/implementing/tasks/_index.md @@ -58,7 +58,7 @@ defines the runner to use for the container: that you define to includes a runtime, an application and its runtime dependencies. This gives you the greatest flexibility - to define tasks using the lanugage and facilities of your choice + to define tasks using the language and facilities of your choice KLT also includes two "pre-defined" runners: @@ -212,8 +212,7 @@ spec: ### Pass secrets to a function -Kubernetes -[secrets](https://kubernetes.io/docs/concepts/configuration/secret/) +[Kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/) can be passed to the function using the `secureParameters` field. diff --git a/docs/content/en/docs/install/k8s.md b/docs/content/en/docs/install/k8s.md index 4e68455a88..229133ee86 100644 --- a/docs/content/en/docs/install/k8s.md +++ b/docs/content/en/docs/install/k8s.md @@ -1,7 +1,6 @@ --- title: Kubernetes cluster description: Bring or install a Kubernetes cluster -icon: concepts layout: quickstart weight: 25 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html diff --git a/docs/content/en/docs/install/upgrade.md b/docs/content/en/docs/install/upgrade.md index 2fcbbb4034..b0da60da9b 100644 --- a/docs/content/en/docs/install/upgrade.md +++ b/docs/content/en/docs/install/upgrade.md @@ -1,7 +1,6 @@ --- title: Upgrade description: How to upgrade to the latest version of the Lifecycle Toolkit -icon: concepts layout: quickstart weight: 45 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html @@ -19,7 +18,7 @@ helm upgrade --install keptn klt/klt \ ``` Use the `--set` flag or download and edit the `values.yaml` file -to modify the configuration as discused on the +to modify the configuration as discussed on the [Install the Lifecycle Toolkit](../install/) page. > **Warning** diff --git a/docs/content/en/docs/intro-klt/_index.md b/docs/content/en/docs/intro-klt/_index.md index 1c4733a799..358707a2f8 100644 --- a/docs/content/en/docs/intro-klt/_index.md +++ b/docs/content/en/docs/intro-klt/_index.md @@ -5,7 +5,7 @@ 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 Lifecyle Toolkit. +This section contains tutorials on how to use the Keptn Lifecycle Toolkit. When you understand the toolkit, begin with the [getting started guide](../getting-started/). @@ -148,7 +148,7 @@ the Keptn Lifecycle Toolkit: and the concepts that drive the Keptn Lifecycle Toolkit, then gives a simple demonstration of a Keptn Lifecycle Controller implementation. -* [Introducing Keptn Lifecyle Toolkit](https://youtu.be/449HAFYkUlY) +* [Introducing Keptn Lifecycle Toolkit](https://youtu.be/449HAFYkUlY) 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) diff --git a/docs/content/en/docs/intro-klt/usecase-orchestrate.md b/docs/content/en/docs/intro-klt/usecase-orchestrate.md index 50d8f8e17a..a78b441aac 100644 --- a/docs/content/en/docs/intro-klt/usecase-orchestrate.md +++ b/docs/content/en/docs/intro-klt/usecase-orchestrate.md @@ -4,7 +4,7 @@ description: How KLT orchestrates pre- and post-deployment evaluations and tasks weight: 20 --- -In this exercise, we will configure the Keptn Lifecyle Toolkit +In this exercise, we will configure the Keptn Lifecycle Toolkit 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`, @@ -13,7 +13,7 @@ the Lifecycle Toolkit can do the following: * Pre-deploy: Validate external dependencies, confirm that images are scanned, and so forth -* Post-deply: Execute tests, notify stakeholders, +* Post-deploy: Execute tests, notify stakeholders, promote to the next stage * Automatically validate against your SLO (Service Level Objectives) @@ -89,7 +89,7 @@ you need to do the following: An `evaluation` is a KeptnMetric that has a defined target value. Evaluations are resources that are defined in a -[KeptinEvaluationDefinition](../yaml-crd-ref/evaluationdefinition.md) +[KeptnEvaluationDefinition](../yaml-crd-ref/evaluationdefinition.md) yaml file. In our example, evaluations are defined in the [keptn-evaluations.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/keptn-evaluations.yaml) @@ -127,7 +127,7 @@ In our example, the tasks are defined in the [keptn-tasks.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/keptn-tasks.yaml) file. As an example, -we have a `notify` task that composes some markdown text +we have a `notify` task that composes some Markdown text to be sent as Slack notifications The `KeptnTaskDefinition` looks like this: diff --git a/docs/content/en/docs/intro-klt/usecase_metrics.md b/docs/content/en/docs/intro-klt/usecase_metrics.md index ddcd826b81..4338a878cb 100644 --- a/docs/content/en/docs/intro-klt/usecase_metrics.md +++ b/docs/content/en/docs/intro-klt/usecase_metrics.md @@ -131,7 +131,7 @@ metadata: spec: type: dynatrace targetServer: "https://hci34192.live.dynatrace.com" - secretKeyRef + secretKeyRef: name: dynatrace key: DT_TOKEN ... diff --git a/docs/content/en/docs/migrate/strategy/_index.md b/docs/content/en/docs/migrate/strategy/_index.md index b0da48def3..6b54796a48 100644 --- a/docs/content/en/docs/migrate/strategy/_index.md +++ b/docs/content/en/docs/migrate/strategy/_index.md @@ -86,7 +86,7 @@ Some key points: using Kubernetes capabilities. * KLT provides extensive observability data - using OpenTelementry and Prometheus + 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. @@ -151,7 +151,7 @@ For example: a `KeptnTask` using the `container-runner`. * A Keptn v1 service that runs a database can probably be translated - into a Kubenetes `StateFulSet` workload; see + into a Kubernetes `StateFulSet` workload; see [Workload Resources](https://kubernetes.io/docs/concepts/workloads/controllers/) for more information. * A Keptn v1 service that runs a webserver @@ -273,7 +273,7 @@ When migrating to KLT, 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 -and multiple instances of each data provider for your SLI's +and multiple instances of each data provider for your SLIs whereas Keptn v1 only allows you to use one SLI per project. The queries defined for the Keptn v1 SLIs @@ -286,7 +286,7 @@ resources. KLT 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 SLI's and scoring of the evaluation +Facilities such as weighting of SLIs and scoring of the evaluation do not currently exist. This functionality is under development; see [Epic 1646](https://github.com/keptn/lifecycle-toolkit/issues/1646). @@ -299,7 +299,7 @@ resources. KLT does not currently support the same level of [remediations](https://keptn.sh/docs/1.0.x/reference/files/remediation/) -as Keptn v1 does +as Keptn v1 does, but it does provide limited "Day 2" facilities: * Any query that is possible for your data provider post-deployment @@ -309,7 +309,7 @@ but it does provide limited "Day 2" facilities: * `KeptnMetricsDefinition` resources can be retrieved and used to implement the Kubernetes HorizontalPodAutoscaler (HPA), which can detect the need for additional resources - (more pods, memory, disk space, etc) + (more pods, memory, disk space, etc.) and automatically add those resources to your configuration based on the `ReplicaSet` resources you have defined. See diff --git a/docs/content/en/docs/troubleshooting.md b/docs/content/en/docs/troubleshooting.md index 941913c396..334ef7da03 100644 --- a/docs/content/en/docs/troubleshooting.md +++ b/docs/content/en/docs/troubleshooting.md @@ -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 +KLT 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 diff --git a/docs/content/en/docs/tutorials/_index.md b/docs/content/en/docs/tutorials/_index.md index 3bde26b11c..1f095f066c 100644 --- a/docs/content/en/docs/tutorials/_index.md +++ b/docs/content/en/docs/tutorials/_index.md @@ -5,6 +5,6 @@ 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 Lifecyle Toolkit. +This section contains tutorials on how to use the Keptn Lifecycle Toolkit. Begin with the [getting started guide](../getting-started/) first, then come back here to complete these tutorials. diff --git a/docs/content/en/docs/yaml-crd-ref/app.md b/docs/content/en/docs/yaml-crd-ref/app.md index 183b74f8d3..780bbb42ff 100644 --- a/docs/content/en/docs/yaml-crd-ref/app.md +++ b/docs/content/en/docs/yaml-crd-ref/app.md @@ -117,7 +117,7 @@ The Keptn Lifecycle Toolkit 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 -(ArgoCD, Flux, etc) +(ArgoCD, Flux, etc.) and is then deployed by that deployment engine. A `KeptnApp` resource is created automatically, using the diff --git a/docs/content/en/docs/yaml-crd-ref/metric.md b/docs/content/en/docs/yaml-crd-ref/metric.md index 074c9a62b0..848a7e08f6 100644 --- a/docs/content/en/docs/yaml-crd-ref/metric.md +++ b/docs/content/en/docs/yaml-crd-ref/metric.md @@ -130,7 +130,7 @@ Beginning with the `v1alpha3` API version, Keptn allows you to define multiple instances of the same data source. In earlier versions, you could use multiple data sources but only one instance of each. -Consequently the `v1alpha1` and `v1alpha2` API versions +Consequently, the `v1alpha1` and `v1alpha2` API versions define the `provider` field with the type of the data provider (`prometheus`, `dynatrace`, or `dql`) rather than the particular name assigned diff --git a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md index 8331f1d0b3..d87a538ac3 100644 --- a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md +++ b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md @@ -23,11 +23,11 @@ differentiated by the `spec` section: * The `custom-runtime` runner provides a standard Kubernetes application container - that is run as part of a Kubernetes job.. + that is run as part of a Kubernetes job. You define the runner, an application, and its runtime dependencies. This gives you the flexibility - to define tasks using the lanugage and facilities of your choice, + to define tasks using the language and facilities of your choice, although it is more complicated that using one of the pre-defined runtimes. See [Yaml synopsis for container-runtime](#yaml-synopsis-for-container-runtime) @@ -96,7 +96,7 @@ but timeouts seem to be measured in seconds. and code the functionality in Deno script, which is similar to JavaScript and Typescript. See - [Yaml synopsis for deno-runtime contailer](#yaml-synopsis-for-deno-runtime-container). + [Yaml synopsis for deno-runtime container](#yaml-synopsis-for-deno-runtime-container). * **python** -- Use a `python-runtime` function and code the functionality in Python 3. See @@ -107,7 +107,7 @@ but timeouts seem to be measured in seconds. for which you define the image, runner, runtime parameters, etc. and code the functionality to match the container you define. See - [Yaml synopsis for container-runtime contaier](#yaml-synopsis-for-container-runtime). + [Yaml synopsis for container-runtime container](#yaml-synopsis-for-container-runtime). * **retries** (optional) - specifies the number of times, a job executing the `KeptnTaskDefinition` should be restarted if an attempt is unsuccessful. @@ -407,7 +407,7 @@ the size of the volume is 50% of the memory allocated for the node. A task can be executed either pre-deployment or post-deployment as specified in the pod template specs of your Workloads -([Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/), +[Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/), [StatefulSets](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/), [DaemonSets](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/), and @@ -565,7 +565,7 @@ This task is then referenced in [app.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/examples/sample-app/version-3/app.yaml). -This is a a trivial example that just runs `busybox`, +This is a trivial example that just runs `busybox`, then spawns a shell and runs the `sleep 30` command. ## Examples for a python-runtime runner diff --git a/lifecycle-operator/apis/lifecycle/v1alpha2/keptnworkloadinstance_types.go b/lifecycle-operator/apis/lifecycle/v1alpha2/keptnworkloadinstance_types.go index 6757f88052..1e8922badc 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha2/keptnworkloadinstance_types.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha2/keptnworkloadinstance_types.go @@ -64,7 +64,7 @@ type KeptnWorkloadInstanceStatus struct { } type ItemStatus struct { - // DefinitionName is the name of the EvaluationDefinition/TaskDefiniton + // DefinitionName is the name of the EvaluationDefinition/TaskDefinition DefinitionName string `json:"definitionName,omitempty"` // +kubebuilder:default:=Pending Status common.KeptnState `json:"status,omitempty"` diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptntaskdefinition_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptntaskdefinition_types.go index 8c08761dc6..70f130b2cd 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha3/keptntaskdefinition_types.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha3/keptntaskdefinition_types.go @@ -86,7 +86,7 @@ type ConfigMapReference struct { } type FunctionReference struct { - // Name is the name of the referenced KeptnTaksDefinition. + // Name is the name of the referenced KeptnTaskDefinition. Name string `json:"name,omitempty"` } @@ -115,9 +115,9 @@ type FunctionStatus struct { ConfigMap string `json:"configMap,omitempty"` } -//+kubebuilder:object:root=true -//+kubebuilder:storageversion -//+kubebuilder:subresource:status +// +kubebuilder:object:root=true +// +kubebuilder:storageversion +// +kubebuilder:subresource:status // KeptnTaskDefinition is the Schema for the keptntaskdefinitions API type KeptnTaskDefinition struct { @@ -130,7 +130,7 @@ type KeptnTaskDefinition struct { Status KeptnTaskDefinitionStatus `json:"status,omitempty"` } -//+kubebuilder:object:root=true +// +kubebuilder:object:root=true // KeptnTaskDefinitionList contains a list of KeptnTaskDefinition type KeptnTaskDefinitionList struct { diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go index 28a1803959..0a5b721da3 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go @@ -86,7 +86,7 @@ type KeptnWorkloadInstanceStatus struct { } type ItemStatus struct { - // DefinitionName is the name of the EvaluationDefinition/TaskDefiniton + // DefinitionName is the name of the EvaluationDefinition/TaskDefinition DefinitionName string `json:"definitionName,omitempty"` // +kubebuilder:default:=Pending Status common.KeptnState `json:"status,omitempty"`