Skip to content

Commit

Permalink
clean
Browse files Browse the repository at this point in the history
Signed-off-by: Giovanni Liva <[email protected]>
  • Loading branch information
thisthat committed Nov 17, 2023
1 parent 311268e commit 3bb6ff2
Show file tree
Hide file tree
Showing 44 changed files with 212 additions and 218 deletions.
6 changes: 0 additions & 6 deletions .github/workflows/release-docs.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
name: Release Documentation

on:
workflow_dispatch:
inputs:
tag_name:
description: "Release Tag to use"
type: "string"
required: true
workflow_call:
inputs:
tag_name:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/contribute/docs/word-list/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ It is important to use the related terminology correctly:
Most of the time, we recommend just using the term "resource".

* The first occurence of a CRD name in a section should be a link to the
[CRD YAML Reference](../../../docs/yaml-crd-ref)
CRD YAML Reference under the right [component](../../../docs/components)
page if there is one.
Otherwise, it should be a link to the appropriate spot in the
[API Reference](../../../docs/crd-ref)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/contribute/software/dev-environ/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ you need to install the following on your system:
which allows software applications to run in isolated environments
and makes it easier to deploy and manage them.
* A Kubernetes cluster running an appropriate version of Kubernetes.
See [Supported Kubernetes versions](../../../docs/installation/reqs.md/#supported-kubernetes-versions)
See [Supported Kubernetes versions](../../../docs/installation/_index.md#supported-kubernetes-versions)
for details.
Most contributors create a local
Kubernetes-in-Docker(KinD) cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.htm
The Keptn Cert Manager automatically configures TLS certificates to
[secure communication with the Kubernetes API](https://kubernetes.io/docs/concepts/security/controlling-access/#transport-security).
You can instead
[use cert-manager.io](../operate/cert-manager.md)
[use cert-manager.io](../../installation/configuration/cert-manager.md)
for this purpose.

Keptn includes a Mutating Webhook
Expand All @@ -38,7 +38,7 @@ It is included to simplify installation for new users
and because it is much smaller than most standard certificate managers.
However, Keptn is compatible with most certificate managers
and can be configured to use another certificate manager if you prefer.
See [Use Keptn with cert-manager.io](../operate/cert-manager.md)
See [Use Keptn with cert-manager.io](../../installation/configuration/cert-manager.md)
for instructions.

## Invalid certificate errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ when the app discovery feature generates the `KeptnApp` resource:
that failed to deploy, perhaps because a
`preDeploymentEvaluation` or `preDeploymentTask` failed.
See
[Restart an Application Deployment](../guides/restart-application-deployment.md)
[Restart an Application Deployment](../../../guides/restart-application-deployment.md)
for a longer discussion of this.
- **workloads**
- **name** (required) -- name of this Kubernetes
Expand Down Expand Up @@ -121,10 +121,10 @@ into the repository of the deployment engine
and is then deployed by that deployment engine.

A `KeptnApp` resource is created automatically, using the
[automatic application discovery](../guides/integrate.md#use-keptn-automatic-app-discovery)
[automatic application discovery](../../../guides/auto-app-discovery.md)
feature to generate a `KeptnApp` resource
based on the
[basic annotations](../guides/integrate.md#basic-annotations)
[basic annotations](../../../guides/integrate.md#basic-annotations)
that are applied to any of the workload resources.
This allows you to use the Keptn observability features for existing resources
without manually populating any Keptn related resources.
Expand Down Expand Up @@ -170,9 +170,9 @@ spec:

- [KeptnTaskDefinition](taskdefinition.md)
- [KeptnEvaluationDefinition](evaluationdefinition.md)
- [Working with tasks](../guides/tasks.md)
- [Architecture of KeptnWorkloads and KeptnTasks](../components/keptn-apps.md)
- [Pre- and post-deployment tasks](../guides/integrate.md#pre--and-post-deployment-checks)
- [Orchestrate deployment checks](../core-concepts/usecase-orchestrate.md)
- [Use Keptn automatic app discovery](../guides/integrate.md#use-keptn-automatic-app-discovery)
- [Restart an Application Deployment](../guides/restart-application-deployment.md)
- [Working with tasks](../../../guides/tasks.md)
- [Architecture of KeptnWorkloads and KeptnTasks](../keptn-apps.md)
- [Pre- and post-deployment tasks](../../../guides/integrate.md#pre--and-post-deployment-checks)
- [Orchestrate deployment checks](../../../core-concepts/usecase-orchestrate.md)
- [Use Keptn automatic app discovery](../../../guides/auto-app-discovery.md)
- [Restart an Application Deployment](../../../guides/restart-application-deployment.md)
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ spec:

API Reference:

* [KeptnTaskDefinition](../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinition)
* [KeptnTaskDefinition](../../../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinition)

## Differences between versions

## See also

* [KeptnApp](../yaml-crd-ref/app.md)
* [OpenTelemetry observability](../guides/otel.md)
* [Keptn automatic app discovery](../guides/integrate.md/#use-keptn-automatic-app-discovery)
* [KeptnApp](./app.md)
* [OpenTelemetry observability](../../../guides/otel.md)
* [Keptn automatic app discovery](../../../guides/auto-app-discovery.md)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 50
---

A `KeptnEvaluationDefinition` assigns target values
to [KeptnMetric](metric.md) queries.
to [KeptnMetric](../../metrics-operator/crd-ref/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](https://kubernetes.io/docs/concepts/workloads/) or application.
Expand Down Expand Up @@ -46,13 +46,13 @@ spec:
and an `evaluationTarget` value.

* **keptnMetricRef** (required) -- A reference to the
[KeptnMetric](metric.md) object
[KeptnMetric](../../metrics-operator/crd-ref/metric.md) object

* **name** (required) -- Name of the referenced
[KeptnMetric](metric.md) object
[KeptnMetric](../../metrics-operator/crd-ref/metric.md) object

* **namespace** -- Name of the referenced
[KeptnMetric](metric.md) object
[KeptnMetric](../../metrics-operator/crd-ref/metric.md) object

* **evaluationTarget** (required) -- Desired value of the query,
expressed as an arithmetic formula,
Expand All @@ -64,13 +64,13 @@ spec:
## Usage

A `KeptnEvaluationDefinition` references one or more
[KeptnMetric](metric.md) resources.
[KeptnMetric](../../metrics-operator/crd-ref/metric.md) resources.
When multiple `KeptnMetric`s are used,
Keptn considers the evaluation successful
if **all** metrics meet their `evaluationTarget`.

The `KeptnMetric` resource and associated
[KeptnMetricsProvider](metricsprovider.md)
[KeptnMetricsProvider](../../metrics-operator/crd-ref/metricsprovider.md)
resource must be located in the same namespace
but the `KeptnEvaluationDefinition` resources
can reference metrics from any namespace in the cluster.
Expand Down Expand Up @@ -111,7 +111,7 @@ In the `v1alpha1` and `v1alpha2` API versions,
`KeptnEvaluationDefinition` referenced the `KeptnEvaluationProvider` CR
to identify the data source associated with this definition
and itself contained the queries
that are now taken from the specified [KeptnMetric](metric.md) CRD.
that are now taken from the specified [KeptnMetric](../../metrics-operator/crd-ref/metric.md) CRD.
The synopsis was:

```yaml
Expand All @@ -132,11 +132,11 @@ spec:

Beginning with `v1alpha3` API version,
`KeptnEvaluationDefinition` references a `keptnMetricRef`
that points to a [KeptnMetric](metric.md) CR,
that points to a [KeptnMetric](../../metrics-operator/crd-ref/metric.md) CR,
that defines the data source, the query and the namespace to use.
The `KeptnEvaluationDefinition` merely specifies the evaluation target.

## See also

* [KeptnMetricsProvider](metricsprovider.md)
* [KeptnMetric](metric.md)
* [KeptnMetricsProvider](../../metrics-operator/crd-ref/metricsprovider.md)
* [KeptnMetric](../../metrics-operator/crd-ref/metric.md)
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ spec:
or in the Keptn installation namespace.
* **context** (required) -- Contextual information about the task execution
* **appName** (required) -- Name of the
[KeptnApp](../yaml-crd-ref/app.md) resource
[KeptnApp](./app.md) resource
for which the `KeptnTask` is being executed.
* **appVersion** (required) -- Version of the `KeptnApp` resource
for which the `KeptnTask` is being executed.
Expand Down Expand Up @@ -85,7 +85,7 @@ spec:
* **secureParameters** -- Secure parameters that are passed
to the job that executes the `KeptnTask`.
These are stored and accessed as Kubernetes `Secrets` in the cluster.
See [Working with secrets](../guides/tasks.md#working-with-secrets)
See [Working with secrets](../../../guides/tasks.md#working-with-secrets)
for more information.
* **checkType** -- Defines whether task is part of pre- or post-deployment phase.
Keptn populates this field based on annotations
Expand Down Expand Up @@ -117,11 +117,11 @@ so `helloworldtask-1` becomes `helloworldtask-2`, etc.

For a full example of how to create a `KeptnTask` resource
to use for a deployment being done outside of Kubernetes, see
[Keptn for Non-Kubernetes Applications](../guides/tasks-non-k8s-apps.md).
[Keptn for Non-Kubernetes Applications](../../../use-cases/non-k8s.md).

## Files

[API reference](../crd-ref/lifecycle/v1alpha3/#keptntaskspec)
[API reference](../../../crd-ref/lifecycle/v1alpha3/#keptntaskspec)

## Differences between versions

Expand All @@ -131,4 +131,4 @@ in Keptn v0.8.0.
## See also

* [KeptnTaskDefinition](taskdefinition.md)
* [Keptn for Non-Kubernetes Applications](../guides/tasks-non-k8s-apps.md)
* [Keptn for Non-Kubernetes Applications](../../../use-cases/non-k8s.md)
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 30
A `KeptnTaskDefinition` defines tasks
that Keptn runs as part of the pre- and post-deployment phases of a
[KeptnApp](./app.md) or
[KeptnWorkload](../crd-ref/lifecycle/v1alpha3/#keptnworkload).
[KeptnWorkload](../../../crd-ref/lifecycle/v1alpha3/#keptnworkload).

A Keptn task executes as a
[runner](https://docs.gitlab.com/runner/executors/kubernetes.html#how-the-runner-creates-kubernetes-pods)
Expand Down Expand Up @@ -156,7 +156,7 @@ spec:
[image concepts](https://kubernetes.io/docs/concepts/containers/images/)
and pushed to a registry
* **other fields** -- The full list of valid fields is available at
[ContainerSpec](../crd-ref/lifecycle/v1alpha3/#containerspec),
[ContainerSpec](../../../crd-ref/lifecycle/v1alpha3/#containerspec),
with additional information in the Kubernetes
[Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container)
spec documentation.
Expand Down Expand Up @@ -305,7 +305,7 @@ spec:
See
[Passing secrets, environment variables, and modifying the python command](#passing-secrets-environment-variables-and-modifying-the-python-command)
and
[Parameterized functions](../guides/tasks.md#parameterized-functions)
[Parameterized functions](../../../guides/tasks.md#parameterized-functions)
for more information.

* **deno example:**
Expand All @@ -321,7 +321,7 @@ spec:
Note that, currently, only one secret can be passed
per `KeptnTaskDefinition` resource.

See [Create secret text](../guides/tasks.md#create-secret-text)
See [Create secret text](../../../guides/tasks.md#create-secret-text)
for details.

* **deno example:**
Expand All @@ -333,7 +333,7 @@ spec:

A Task executes the TaskDefinition of a
[KeptnApp](app.md) or a
[KeptnWorkload](../crd-ref/lifecycle/v1alpha3/#keptnworkload).
[KeptnWorkload](../../../crd-ref/lifecycle/v1alpha3/#keptnworkload).
The execution is done by spawning a Kubernetes
[Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/)
to handle a single Task.
Expand All @@ -358,7 +358,7 @@ and
and in the
[KeptnApp](app.md) resource.
See
[Pre- and post-deployment tasks](../guides/integrate.md#pre--and-post-deployment-checks)
[Pre- and post-deployment tasks](../../../guides/integrate.md#pre--and-post-deployment-checks)
for details.
Note that the annotation identifies the task by `name`.
This means that you can modify the `function` code in the resource definition
Expand All @@ -371,7 +371,7 @@ either by using the `inline` syntax for a pre-defined container image
or by creating your own image
and running it in the Keptn `container-runtime` runner.
See
[Executing sequential tasks](../guides/tasks.md#executing-sequential-tasks)
[Executing sequential tasks](../../../guides/tasks.md#executing-sequential-tasks)
for more information.

## Examples for a container-runtime runner
Expand Down Expand Up @@ -567,14 +567,14 @@ directory for more example `KeptnTaskDefinition` YAML files.

API Reference:

* [KeptnTaskDefinition](../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinition)
* [KeptnTaskDefinitionList](../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinitionlist)
* [KeptnTaskDefinitionSpec](../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinitionspec)
* [FunctionReference](../crd-ref/lifecycle/v1alpha3/_index.md#functionreference)
* [FunctionSpec](../crd-ref/lifecycle/v1alpha3/_index.md#runtimespec)
* [FunctionStatus](../crd-ref/lifecycle/v1alpha3/_index.md#functionstatus)
* [HttpReference](../crd-ref/lifecycle/v1alpha3/_index.md#httpreference)
* [Inline](../crd-ref/lifecycle/v1alpha3/_index.md#inline)
* [KeptnTaskDefinition](../../../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinition)
* [KeptnTaskDefinitionList](../../../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinitionlist)
* [KeptnTaskDefinitionSpec](../../../crd-ref/lifecycle/v1alpha3/_index.md#keptntaskdefinitionspec)
* [FunctionReference](../../../crd-ref/lifecycle/v1alpha3/_index.md#functionreference)
* [FunctionSpec](../../../crd-ref/lifecycle/v1alpha3/_index.md#runtimespec)
* [FunctionStatus](../../../crd-ref/lifecycle/v1alpha3/_index.md#functionstatus)
* [HttpReference](../../../crd-ref/lifecycle/v1alpha3/_index.md#httpreference)
* [Inline](../../../crd-ref/lifecycle/v1alpha3/_index.md#inline)

## Differences between versions

Expand Down Expand Up @@ -608,8 +608,8 @@ This modifies the synopsis in the following ways:
## See also

* [KeptnApp](app.md)
* [Working with tasks](../guides/tasks.md)
* [Pre- and post-deployment tasks](../guides/integrate.md#pre--and-post-deployment-checks)
* [KeptnApp and KeptnWorkload resources](../components/keptn-apps.md).
* [Orchestrate deployment checks](../core-concepts/usecase-orchestrate.md)
* [Executing sequential tasks](../guides/tasks.md#executing-sequential-tasks)
* [Working with tasks](../../../guides/tasks.md)
* [Pre- and post-deployment tasks](../../../guides/integrate.md#pre--and-post-deployment-checks)
* [KeptnApp and KeptnWorkload resources](../../../components/lifecycle-operator/keptn-apps.md).
* [Orchestrate deployment checks](../../../core-concepts/usecase-orchestrate.md)
* [Executing sequential tasks](../../../guides/tasks.md#executing-sequential-tasks)
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Within each phase, all tasks and evaluations for each phase
are executed in parallel.
They are not affected by the order
in which evaluations and tasks are listed in the
[KeptnApp](../yaml-crd-ref/app.md/)
[KeptnApp](./crd-ref/app.md)
resource
or in the order of the pre/post-tasks and pre/post-evaluations
that are listed in the Workflow manifests.
Expand Down
14 changes: 7 additions & 7 deletions docs/content/en/docs/components/lifecycle-operator/keptn-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 110
## Keptn Workloads

A
[KeptnWorkload](../crd-ref/lifecycle/v1alpha3/#keptnworkload)
[KeptnWorkload](../../crd-ref/lifecycle/v1alpha3/#keptnworkload)
resource augments a Kubernetes
[Workload](https://kubernetes.io/docs/concepts/workloads/)
with the ability to handle extra phases.
Expand All @@ -31,7 +31,7 @@ as soon as the workload manifest is applied.

## Keptn Applications

A [KeptnApp](../yaml-crd-ref/app.md)
A [KeptnApp](./crd-ref/app.md)
resource combines multiple Kubernetes
[workloads](https://kubernetes.io/docs/concepts/workloads/)
into a single entity
Expand Down Expand Up @@ -64,12 +64,12 @@ plus specific tasks and evaluations that you define
for the `KeptnApp` resource itself:

* The annotations described in
[Basic annotations](../guides/integrate.md#basic-annotations)
[Basic annotations](../../guides/integrate.md#basic-annotations)
are used to automatically generate `KeptnApp` resources
that contain the identifications required
to run the Keptn observability features.
* You must manually add the annotations described in
[Pre- and post-deployment checks](../guides/integrate.md#pre--and-post-deployment-checks)
[Pre- and post-deployment checks](../../guides/integrate.md#pre--and-post-deployment-checks)
to the basic `KeptnApp` manifest to define
the evaluations and tasks you want to run pre- and post-deployment.

Expand All @@ -86,12 +86,12 @@ The timeout is provided because it may take some time
to apply all `KeptnWorkload` resources to the cluster.
This interval can be modified for the cluster by changing the value
of the `keptnAppCreationRequestTimeoutSeconds` field in the
[KeptnConfig](../yaml-crd-ref/config.md)
[KeptnConfig](./crd-ref/config.md)
resource.

## How basic annotations are implemented

The [Basic annotations](../guides/integrate.md#basic-annotations)
The [Basic annotations](../../guides/integrate.md#basic-annotations)
page gives instructions for applying the annotations or labels
that identify the pods that Keptn should manage.

Expand All @@ -108,7 +108,7 @@ In other words:
again first in the annotations, then in the labels.

Keptn automatically generates appropriate
[KeptnApp](../yaml-crd-ref/app.md)
[KeptnApp](./crd-ref/app.md)
resources that are used for observability,
based on whether the `keptn.sh/app` or `app.kubernetes.io/part-of`
annotation/label is populated:
Expand Down
Loading

0 comments on commit 3bb6ff2

Please sign in to comment.