Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: restructure content #2522

Merged
merged 12 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ hidechildren
homedata
homeobservability
homeorchestrate
horizontalpodautoscaler
horizontalpodautoscalers
hpa
hreflang
htmltest
Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Gain confidence in your work with pre-/post-deployment checks
{{% readfile "partials/_index-observability-right.md" %}}
</div>
</div>
<a class="btn -bg-green" href="./docs/intro/#observability">
<a class="btn -bg-green" href="./docs/core-concepts/#observability">
Get Started!
</a>
</div>
Expand All @@ -119,7 +119,7 @@ Gain confidence in your work with pre-/post-deployment checks
{{% readfile "partials/_index-gather-metrics-right.md" %}}
</div>
</div>
<a class="btn -bg-green" href="./docs/intro/#metrics">
<a class="btn -bg-green" href="./docs/core-concepts/#metrics">
Get Started!
</a>
</div>
Expand All @@ -137,7 +137,7 @@ Gain confidence in your work with pre-/post-deployment checks
{{% readfile "partials/_index-deployment-checks-right.md" %}}
</div>
</div>
<a class="btn -bg-green" href="./docs/intro/#release-lifecycle-management">
<a class="btn -bg-green" href="./docs/core-concepts/#release-lifecycle-management">
Get Started!
</a>
</div>
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
10 changes: 5 additions & 5 deletions docs/content/en/contribute/software/dev-environ/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To prepare to contribute to the Keptn project, we recommend that you:
* [klt-cert-manager](https://github.com/keptn/lifecycle-toolkit/tree/main/klt-cert-manager)

Each of these is described in the
[Architecture](../../../docs/architecture/)
[Architecture](../../../docs/components/)
section of the documentation
and most include a *README* file with more information.
* Study the material in
Expand All @@ -43,7 +43,7 @@ When you view the
[lifecycle-toolkit](https://github.com/keptn/lifecycle-toolkit)
repository, you see that Keptn is composed of multiple components,
each of which is discussed in the Architecture
[Architecture](../../../docs/architecture/)
[Architecture](../../../docs/components/)
documentation:

* Three Kubernetes operators
Expand All @@ -57,7 +57,7 @@ you also see the `runtimes` directory.
This defines the runners that you can use when defining
tasks to be run either pre- or post-deployment.
These are discussed in
[Runners and containers](../../../docs/implementing/tasks.md#runners-and-containers).
[Runners and containers](../../../docs/guides/tasks.md#runners-and-containers).

## Install software

Expand All @@ -68,13 +68,13 @@ 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/install/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.
This is adequate for developing software for Keptn.
See
[Kubernetes cluster](../../../docs/install/k8s.md/#create-local-kubernetes-cluster)
[Kubernetes cluster](../../../docs/installation/k8s.md/#create-local-kubernetes-cluster)
for instructions.
* [**kubectl**](https://kubernetes.io/docs/tasks/tools/):
a command-line interface tool used for deploying
Expand Down
8 changes: 0 additions & 8 deletions docs/content/en/docs/architecture/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
title: Keptn Components
linktitle: Components
description: Basic understanding of Keptn Components
weight: 20
title: Components
description: Understand the details of how Keptn works
weight: 50
---

### Keptn Components

Keptn consists of two main components:

* Keptn Lifecycle Operator, which splits into two separate operators
in Release 0.7.0 and later:
in Release 0.7.0 and later:
* Lifecycle-Operator
* Metrics-Operator
* Keptn Lifecycle Scheduler
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
@@ -1,10 +1,11 @@
---
title: CRD Reference
description: Reference pages for the manifest files that must be populated
weight: 100
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
description: CRD Reference for Keptn Lifecycle Operator
weight: 10
---

## CRD Reference

This section provides comprehensive reference information about the
manifest files that must be populated for Keptn
[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: KeptnApp
description: Define all workloads and checks associated with an application
weight: 10
weight: 20
---

A `KeptnApp` resource lists all the [workloads](https://kubernetes.io/docs/concepts/workloads/)
Expand Down 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](../implementing/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](../implementing/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](../implementing/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](../implementing/tasks.md)
- [Architecture of KeptnWorkloads and KeptnTasks](../architecture/keptn-apps.md)
- [Pre- and post-deployment tasks](../implementing/integrate.md#pre--and-post-deployment-checks)
- [Orchestrate deployment checks](../intro/usecase-orchestrate.md)
- [Use Keptn automatic app discovery](../implementing/integrate.md#use-keptn-automatic-app-discovery)
- [Restart an Application Deployment](../implementing/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
@@ -1,7 +1,7 @@
---
title: KeptnConfig
description: Define configuration values
weight: 20
weight: 10
---

`KeptnConfig` defines Keptn configuration values.
Expand Down 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](../implementing/otel.md)
* [Keptn automatic app discovery](../implementing/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
@@ -1,12 +1,11 @@
---
title: KeptnEvaluationDefinition
description: Define an evaluation query

weight: 20
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 @@ -47,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 @@ -65,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 @@ -112,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 @@ -133,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
@@ -1,12 +1,12 @@
---
title: KeptnTask
description: Define a run of a KeptnTaskDefinition
weight: 85
weight: 40
---

Keptn uses KeptnTask resources internally
to manage tasks (and their underlying Kubernetes Job resources)
that are run before and after deployment of your workloads
that are run before and after deployment of your workloads
(pre- and post-deployment tasks).
You do not need to create this resource yourself except in special situations,
like using Keptn to manage workloads that are outside of the k8s cluster.
Expand Down 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](../implementing/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](../implementing/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](../implementing/tasks-non-k8s-apps.md)
* [Keptn for Non-Kubernetes Applications](../../../use-cases/non-k8s.md)
Loading
Loading