Skip to content

Commit

Permalink
docs: move "Architecture" section to top level (#2057)
Browse files Browse the repository at this point in the history
Signed-off-by: Meg McRoberts <[email protected]>
  • Loading branch information
StackScribe authored Sep 7, 2023
1 parent a6e4d65 commit 785de10
Show file tree
Hide file tree
Showing 17 changed files with 23 additions and 29 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Architecture
linktitle: Architecture
description: Understand the details of how Keptn works
weight: 80
weight: 50
cascade:
---

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
[configure Keptn to use cert-manager.io](../../operate/cert-manager.md)
[configure Keptn to use cert-manager.io](../operate/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](../operate/cert-manager.md)
for instructions.

## Invalid certificate errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ so they are compatible with the Kubernetes
(HPA), which enables the horizontal scaling of workloads
based on metrics collected from multiple observability platforms.
See
[Using the HorizontalPodAutoscaler](../../../../implementing/evaluatemetrics.md/#using-the-horizontalpodautoscaler)
[Using the HorizontalPodAutoscaler](../../../implementing/evaluatemetrics.md/#using-the-horizontalpodautoscaler)
for instructions.

The Metrics Operator consists of the following components:
Expand All @@ -55,18 +55,18 @@ which can be used to gain insight into the behavior and performance
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)
The controller reconciles a [`KeptnMetric`](../../../yaml-crd-ref/metric.md)
resource and updates its status with the metric value
provided by the selected metric provider.
Each `KeptnMetric` is identified by `name`
and is associated with an instance of an observability platform
that is defined in a
[KeptnMetricsProvider](../../../../yaml-crd-ref/metricsprovider.md)
[KeptnMetricsProvider](../../../yaml-crd-ref/metricsprovider.md)
resource.

The steps in which the controller fetches metrics are given below:

1. When a [`KeptnMetric`](../../../../yaml-crd-ref/metric.md)
1. When a [`KeptnMetric`](../../../yaml-crd-ref/metric.md)
resource is found or modified,
the controller checks whether the metric has been updated
within the interval that is defined in the `spec.fetchintervalseconds` field.
Expand All @@ -86,7 +86,7 @@ The steps in which the controller fetches metrics are given below:
in the `status` field of the `KeptnMetric` object.
* If the evaluation fails,
the error and reason is written to the
[KeptnMetricStatus](../../../../crd-ref/metrics/v1alpha3/#keptnmetricstatus)
[KeptnMetricStatus](../../../crd-ref/metrics/v1alpha3/#keptnmetricstatus)
resource.
The error is described in both human-readable language
and as raw data to help identify the source of the problem
Expand Down
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](../yaml-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
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cascade:
## 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 @@ -32,7 +32,7 @@ as soon as the workload manifest is applied.

## Keptn Applications

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

* The annotations described in
[Basic annotations](../../../implementing/integrate/#basic-annotations)
[Basic annotations](../../implementing/integrate/#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](../../../implementing/integrate/#pre--and-post-deployment-checks)
[Pre- and post-deployment checks](../../implementing/integrate/#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 @@ -87,12 +87,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](../../yaml-crd-ref/config.md)
resource.

## How basic annotations are implemented

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

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

Keptn automatically generates appropriate
[KeptnApp](../../../yaml-crd-ref/app.md)
[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 populated:
Expand Down
6 changes: 0 additions & 6 deletions docs/content/en/docs/concepts/_index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/en/docs/implementing/integrate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ annotation/label is populated:
but not the combined workloads that constitute your deployed application.

See
[Keptn Applications and Keptn Workloads](../../concepts/architecture/keptn-apps/)
[Keptn Applications and Keptn Workloads](../../architecture/keptn-apps/)
for architectural information about how `KeptnApp` and `KeptnWorkloads`
are implemented.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/intro/usecase_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,6 @@ for detailed information.
To learn more about the Keptn Metrics Server, see:

- Architecture:
[Keptn Metrics Operator](../concepts/architecture/components/metrics-operator/_index.md)
[Keptn Metrics Operator](../architecture/components/metrics-operator/_index.md)
- More information about implementing Keptn Metrics:
[Keptn Metrics](../implementing/evaluatemetrics.md)
2 changes: 1 addition & 1 deletion docs/content/en/docs/migrate/strategy/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Some key points:

For in-depth information about Keptn components
and how they work, see the
[Architecture](../../concepts/architecture)
[Architecture](../../architecture)
section.

## Disposition of Keptn v1 components in Keptn
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/operate/cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Bundling the cert-manager simplifies the installation for new users
and provides the functionality Keptn needs
without the overhead of other cert-managers.
For a description of the architecture, see
[Keptn Certificate Manager](../concepts/architecture/cert-manager.md).
[Keptn Certificate Manager](../architecture/cert-manager.md).

Keptn also works well with `cert-manager.io`.
If you are already using `cert-manager.io`,
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/yaml-crd-ref/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ spec:
- [KeptnTaskDefinition](taskdefinition.md)
- [KeptnEvaluationDefinition](evaluationdefinition.md)
- [Working with tasks](../implementing/tasks)
- [Architecture of KeptnWorkloads and KeptnTasks](../concepts/architecture/keptn-apps/)
- [Architecture of KeptnWorkloads and KeptnTasks](../architecture/keptn-apps/)
- [Pre- and post-deployment tasks](../implementing/integrate/#pre--and-post-deployment-checks)
- [Orchestrate deployment checks](../intro/usecase-orchestrate.md)
- [Use Keptn automatic app discovery](../implementing/integrate/#use-keptn-automatic-app-discovery)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/yaml-crd-ref/metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,4 @@ spec:
* [KeptnMetricsProvider](metricsprovider.md)
* Implementing [Keptn Metrics](../implementing/evaluatemetrics.md)
* [Getting started with Keptn metrics](../intro/usecase_metrics.md)
* Architecture of the [Keptn Metrics Operator](../concepts/architecture/components/metrics-operator/_index.md)
* Architecture of the [Keptn Metrics Operator](../architecture/components/metrics-operator/_index.md)
2 changes: 1 addition & 1 deletion docs/content/en/docs/yaml-crd-ref/taskdefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -662,5 +662,5 @@ is allowed per `KeptnTaskDefinition`.
* [KeptnApp](app.md)
* [Working with tasks](../implementing/tasks)
* [Pre- and post-deployment tasks](../implementing/integrate/#pre--and-post-deployment-checks)
* [KeptnApp and KeptnWorkload resources](../concepts/architecture/keptn-apps/).
* [KeptnApp and KeptnWorkload resources](../architecture/keptn-apps/).
* [Orchestrate deployment checks](../intro/usecase-orchestrate.md)

0 comments on commit 785de10

Please sign in to comment.