Skip to content

Commit

Permalink
docs: add links to most workload word occurrences (#2327)
Browse files Browse the repository at this point in the history
  • Loading branch information
mowies committed Oct 25, 2023
1 parent 9f0e4aa commit 398ad06
Show file tree
Hide file tree
Showing 15 changed files with 44 additions and 39 deletions.
4 changes: 2 additions & 2 deletions docs/content/en/docs/architecture/deployment-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ AppPreDeployTasks
### Pre-deployment evaluation phase

Pre-deployment evaluation can be used to assert the status of the cluster
or of services the workload depends on,
or of services the [workload](https://kubernetes.io/docs/concepts/workloads/) depends on,
to assure it is deployed only if the specified prerequisites are met.

```shell
Expand All @@ -101,7 +101,7 @@ AppPreDeployEvaluations
### Deployment phase

The `AppDeploy` phase basically covers
the entire deployment and check phase of the workloads.
the entire deployment and check phase of the [workloads](https://kubernetes.io/docs/concepts/workloads/).
The `KeptnApp` just observes whether
all pre and post-deployment tasks/evaluation are successful
and that the pods are deployed successfully.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/getting-started/usecase_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ you may want to do the other exercises:
[Manage release lifecycle](../intro/usecase-orchestrate.md),
you learn how to implement
pre- and post-deployment tasks and evaluations
to orchestrate the flow of all the `workloads`
to orchestrate the flow of all the [workloads](https://kubernetes.io/docs/concepts/workloads/)
that are part of your `application`.

The steps to implement metrics in an existing cluster are:
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/docs/implementing/evaluatemetrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ to all metrics in the cluster
and allows you to define metrics based on multiple data platforms
and multiple instances of any data platform.
Metrics are fetched independently
and can be used for an evaluation at workload- and application-level, or for scaling your workloads.
and can be used for an evaluation at [workload-](https://kubernetes.io/docs/concepts/workloads/)
and application-level, or for scaling your [workloads](https://kubernetes.io/docs/concepts/workloads/).

This data can be displayed on Grafana
or another standard dashboard application that you configure
Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/docs/implementing/evaluations.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ file specifies the `app-pre-deploy-eval-2` evaluation as follows:

The `evaluationTarget` is set to be `>1`,
so this evaluation ensures that more than 1 CPU is available
before the workload or application is deployed.
before the [workload](https://kubernetes.io/docs/concepts/workloads/) or application is deployed.

This evaluation references the
[KeptnMetric](../yaml-crd-ref/metric.md) resource
Expand All @@ -35,9 +35,9 @@ or
[ReplicaSets](https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/),
you must:

* Annotate your `Workloads`
* Annotate your [workloads](https://kubernetes.io/docs/concepts/workloads/)
to identify the `KeptnEvaluationDefinition` resource you want to run
pre- and post-deployment for the specific workloads.
pre- and post-deployment for the specific [workloads](https://kubernetes.io/docs/concepts/workloads/).
* Manually edit all
[KeptnApp](../yaml-crd-ref/app.md) resources
to specify the `KeptnEvaluationDefinition` to be run
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/implementing/otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ of what Kubernetes does in the context of a Deployment.
To do this,
Keptn introduces the concept of an `application`,
which is an abstraction that connects multiple
Workloads that logically belong together,
[Workloads](https://kubernetes.io/docs/concepts/workloads/) that logically belong together,
even if they use different deployment strategies.

This means that:
Expand Down Expand Up @@ -55,7 +55,7 @@ DORA metrics provide information such as:
Keptn starts collecting these metrics
as soon as you apply
[basic annotations](integrate/#basic-annotations)
to the Workload resource.
to the [workload](https://kubernetes.io/docs/concepts/workloads/).
Metrics are collected only for the resources
that are annotated.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/implementing/tasks-non-k8s-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 95
---

Keptn Tasks running on a Kubernetes cluster
can be triggered for workloads and applications
can be triggered for [workloads](https://kubernetes.io/docs/concepts/workloads/) and applications
that are deployed outside of Kubernetes.
For example, Keptn could trigger load and performance tests
for an application that is deployed on a virtual machine.
Expand Down Expand Up @@ -66,7 +66,7 @@ for more information.

You must manually create the
[KeptnTask](../yaml-crd-ref/task.md) resource.
In the standard operating mode, when Keptn is managing workloads,
In the standard operating mode, when Keptn is managing [workloads](https://kubernetes.io/docs/concepts/workloads/),
the creation of the `KeptnTask` resource is automatic.

Moreover, each time you want to execute a `KeptnTask`,
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/install/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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.
and tracing all activities of all deployment [workloads](https://kubernetes.io/docs/concepts/workloads/) on the cluster.

Two methods are supported for installing Keptn:

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/install/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Some considerations for Keptn:
resources and
[KeptnApp](../yaml-crd-ref/app.md)
resources
that are activated and defined by annotations to each Workload.
that are activated and defined by annotations to each workload.
* [KeptnMetricsProvider](../yaml-crd-ref/metricsprovider.md)
resources need to be located
in the same namespace as the associated
Expand All @@ -158,4 +158,4 @@ So, possible namespace designs run the gamut:

* 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
* Create a separate namespace for each [workload](https://kubernetes.io/docs/concepts/workloads/)
8 changes: 4 additions & 4 deletions docs/content/en/docs/intro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ 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 resources
* 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)
resources (which connect logically related [workloads](https://kubernetes.io/docs/concepts/workloads/))
using different deployment strategies.

* Captures
Expand Down Expand Up @@ -128,10 +128,10 @@ The executables within a `KeptnTask` resource
run in sequential order.

Keptn tasks and evaluations can be run
for either a Kubernetes workload (single service) resource
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.
which is a single, cohesive unit that groups multiple [workloads](https://kubernetes.io/docs/concepts/workloads/).
For more information, see:

* [Keptn tasks](../implementing/tasks) guide
Expand Down
15 changes: 8 additions & 7 deletions docs/content/en/docs/intro/usecase-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ everything Kubernetes does in the context of a deployment.
To do this,
Keptn introduces the concept of an `application`,
which is an abstraction that connects multiple
Workloads that logically belong together,
workloads that logically belong together,
even if they use different deployment strategies.

This means that:
Expand Down Expand Up @@ -55,7 +55,7 @@ series:
[Manage release lifecycle](usecase-orchestrate.md),
you learn how to implement
pre- and post-deployment tasks and evaluations
to orchestrate the flow of all the `workloads`
to orchestrate the flow of all the [workloads](https://kubernetes.io/docs/concepts/workloads/)
that are part of your `application`.

This exercise shows how to standardize access
Expand All @@ -72,11 +72,11 @@ you need to do the following:
[Basic annotations](../implementing/integrate/#basic-annotations)
to integrate Keptn into your Kubernetes cluster
by applying basic annotations
to your workload and pod resources.
to your [workload](https://kubernetes.io/docs/concepts/workloads/) resources.
and to create appropriate
[KeptnApp](../yaml-crd-ref/app.md)
resources that aggregate
all the `workloads` for a logical deployment into a single resource.
all the [workloads](https://kubernetes.io/docs/concepts/workloads/) for a logical deployment into a single resource.

## DORA metrics

Expand Down Expand Up @@ -130,9 +130,10 @@ onto a dashboard of your choice:

Note that, from the `KeptnApp` YAML file,
you can either increment the version number of the application
(which causes all workloads to be rerun and produce observability data)
or you can increment the version number of a single workload,
(which causes just that workload to be rerun and produce observability data).
(which causes all [workloads](https://kubernetes.io/docs/concepts/workloads/) to be rerun and produce observability data)
or you can increment the version number of a single [workload](https://kubernetes.io/docs/concepts/workloads/),
(which causes just that [workload](https://kubernetes.io/docs/concepts/workloads/)
to be rerun and produce observability data).

The videos that go with this exercise show how the
DORA, OpenTelemetry, and Keptn metrics information
Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/docs/intro/usecase-orchestrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ and can do the following:
* 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.
or at the individual [workload](https://kubernetes.io/docs/concepts/workloads/) level.
* Validate any Keptn metric,
either pre- or post-deployment,
using the metrics from the Keptn Metrics Server introduced in
Expand Down Expand Up @@ -83,7 +83,7 @@ you need to do the following:
by applying basic annotations to your `Deployment` resource.
This also creates appropriate
[KeptnApp](../yaml-crd-ref/app.md) resources
which aggregate workloads that are combined into the released product,
which aggregate [workloads](https://kubernetes.io/docs/concepts/workloads/) that are combined into the released product,
regardless of the tools being used.

## Define evaluations to be performed pre- and post-deployment
Expand Down Expand Up @@ -167,7 +167,7 @@ For more information, see
You can view the actual JavaScript code for the task in the repository.
You see that "context" is important in this code.
This refers to the context in which this code executes --
for which application, for which version, for which Workload.
for which application, for which version, for which workload.

Because the slack server that is required to execute this task
is protected by a secret, the task definition also specifies that secret.
Expand Down
11 changes: 7 additions & 4 deletions docs/content/en/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,26 @@ weight: 100
Welcome to the Keptn troubleshooting guide.

This guide will help you address common issues that you might encounter while using Keptn
for managing your workloads.
for managing your [workloads](https://kubernetes.io/docs/concepts/workloads/).
Below are some common problems and their solutions:

## Keptn is installed but it is not aware of my workloads

If you are facing an issue where Keptn 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](https://kubernetes.io/docs/concepts/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).
2. Make sure your [workloads](https://kubernetes.io/docs/concepts/workloads/)
(e.g., Deployment manifests) have the [three required annotations](https://lifecycle.keptn.sh/docs/implementing/integrate/#annotate-workloads).

## Keptn is causing my pods to be pending

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:

The most probable reason is that a pre-deployment task in your workload is either failing or has not completed yet.
The most probable reason is that a pre-deployment task in your
[workload](https://kubernetes.io/docs/concepts/workloads/) is either failing or has not completed yet.

Failing pre-deployment evaluation tasks will prevent a pod from being scheduled.

Expand Down
10 changes: 5 additions & 5 deletions docs/content/en/docs/yaml-crd-ref/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: Define all workloads and checks associated with an application
weight: 10
---

A `KeptnApp` resource lists all the workloads
A `KeptnApp` resource lists all the [workloads](https://kubernetes.io/docs/concepts/workloads/)
that constitute a logical application.
It contains information about:

- All workloads and checks
- All [workloads](https://kubernetes.io/docs/concepts/workloads/) and checks
that are associated with a Keptn application
- A list of tasks and evaluations to be executed
pre- and post-deployment.
Expand Down Expand Up @@ -75,11 +75,11 @@ when the app discovery feature generates the `KeptnApp` resource:
- **name** - name of this Kubernetes
[workload](https://kubernetes.io/docs/concepts/workloads/).
Use the same naming rules listed above for the application name.
Provide one entry for each workload
Provide one entry for each [workload](https://kubernetes.io/docs/concepts/workloads/)
associated with this Keptn application.
- **version** -- version number for this workload.
- **version** -- version number for this [workload](https://kubernetes.io/docs/concepts/workloads/).
Changing this number causes a new execution
of checks for this workload only,
of checks for this [workload](https://kubernetes.io/docs/concepts/workloads/) only,
not the entire application.

The remaining fields are required only when implementing
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/yaml-crd-ref/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ spec:
This field must be populated
in order to export traces to the OpenTelemetry Collector.
* **keptnAppCreationRequestTimeoutSeconds** --
interval in which automatic app discovery searches for workloads
interval in which automatic app discovery searches for [workloads](https://kubernetes.io/docs/concepts/workloads/)
to put into the same auto-generated [KeptnApp](app.md).
The default value is 30 (seconds).

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A `KeptnEvaluationDefinition` assigns target values
to [KeptnMetric](metric.md) queries.
These are used as part of evaluation tasks
that Keptn runs
as part of pre- and post-analysis phases of a workload or application.
as part of pre- and post-analysis phases of a [workload](https://kubernetes.io/docs/concepts/workloads/) or application.

## Yaml Synopsis

Expand Down

0 comments on commit 398ad06

Please sign in to comment.