From 785de1023aef59bd1fc451ae7a83294da141932f Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 7 Sep 2023 05:19:13 -0700 Subject: [PATCH] docs: move "Architecture" section to top level (#2057) Signed-off-by: Meg McRoberts --- .../en/docs/{concepts => }/architecture/_index.md | 2 +- .../{concepts => }/architecture/cert-manager.md | 4 ++-- .../architecture/components/_index.md | 0 .../components/lifecycle-operator/_index.md | 0 .../components/metrics-operator/_index.md | 10 +++++----- .../architecture/components/scheduler/_index.md | 0 .../{concepts => }/architecture/deployment-flow.md | 2 +- .../architecture/keptn-apps/_index.md | 14 +++++++------- .../{concepts => }/architecture/working/_index.md | 0 docs/content/en/docs/concepts/_index.md | 6 ------ .../en/docs/implementing/integrate/_index.md | 2 +- docs/content/en/docs/intro/usecase_metrics.md | 2 +- docs/content/en/docs/migrate/strategy/_index.md | 2 +- docs/content/en/docs/operate/cert-manager.md | 2 +- docs/content/en/docs/yaml-crd-ref/app.md | 2 +- docs/content/en/docs/yaml-crd-ref/metric.md | 2 +- .../content/en/docs/yaml-crd-ref/taskdefinition.md | 2 +- 17 files changed, 23 insertions(+), 29 deletions(-) rename docs/content/en/docs/{concepts => }/architecture/_index.md (92%) rename docs/content/en/docs/{concepts => }/architecture/cert-manager.md (94%) rename docs/content/en/docs/{concepts => }/architecture/components/_index.md (100%) rename docs/content/en/docs/{concepts => }/architecture/components/lifecycle-operator/_index.md (100%) rename docs/content/en/docs/{concepts => }/architecture/components/metrics-operator/_index.md (89%) rename docs/content/en/docs/{concepts => }/architecture/components/scheduler/_index.md (100%) rename docs/content/en/docs/{concepts => }/architecture/deployment-flow.md (99%) rename docs/content/en/docs/{concepts => }/architecture/keptn-apps/_index.md (91%) rename docs/content/en/docs/{concepts => }/architecture/working/_index.md (100%) delete mode 100644 docs/content/en/docs/concepts/_index.md diff --git a/docs/content/en/docs/concepts/architecture/_index.md b/docs/content/en/docs/architecture/_index.md similarity index 92% rename from docs/content/en/docs/concepts/architecture/_index.md rename to docs/content/en/docs/architecture/_index.md index 6a3f768dce..258b0f1f24 100644 --- a/docs/content/en/docs/concepts/architecture/_index.md +++ b/docs/content/en/docs/architecture/_index.md @@ -2,7 +2,7 @@ title: Architecture linktitle: Architecture description: Understand the details of how Keptn works -weight: 80 +weight: 50 cascade: --- diff --git a/docs/content/en/docs/concepts/architecture/cert-manager.md b/docs/content/en/docs/architecture/cert-manager.md similarity index 94% rename from docs/content/en/docs/concepts/architecture/cert-manager.md rename to docs/content/en/docs/architecture/cert-manager.md index 794b3d0d70..8f1045984a 100644 --- a/docs/content/en/docs/concepts/architecture/cert-manager.md +++ b/docs/content/en/docs/architecture/cert-manager.md @@ -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 @@ -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 diff --git a/docs/content/en/docs/concepts/architecture/components/_index.md b/docs/content/en/docs/architecture/components/_index.md similarity index 100% rename from docs/content/en/docs/concepts/architecture/components/_index.md rename to docs/content/en/docs/architecture/components/_index.md diff --git a/docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md b/docs/content/en/docs/architecture/components/lifecycle-operator/_index.md similarity index 100% rename from docs/content/en/docs/concepts/architecture/components/lifecycle-operator/_index.md rename to docs/content/en/docs/architecture/components/lifecycle-operator/_index.md diff --git a/docs/content/en/docs/concepts/architecture/components/metrics-operator/_index.md b/docs/content/en/docs/architecture/components/metrics-operator/_index.md similarity index 89% rename from docs/content/en/docs/concepts/architecture/components/metrics-operator/_index.md rename to docs/content/en/docs/architecture/components/metrics-operator/_index.md index 2346e9454e..1edb268f11 100644 --- a/docs/content/en/docs/concepts/architecture/components/metrics-operator/_index.md +++ b/docs/content/en/docs/architecture/components/metrics-operator/_index.md @@ -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: @@ -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. @@ -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 diff --git a/docs/content/en/docs/concepts/architecture/components/scheduler/_index.md b/docs/content/en/docs/architecture/components/scheduler/_index.md similarity index 100% rename from docs/content/en/docs/concepts/architecture/components/scheduler/_index.md rename to docs/content/en/docs/architecture/components/scheduler/_index.md diff --git a/docs/content/en/docs/concepts/architecture/deployment-flow.md b/docs/content/en/docs/architecture/deployment-flow.md similarity index 99% rename from docs/content/en/docs/concepts/architecture/deployment-flow.md rename to docs/content/en/docs/architecture/deployment-flow.md index 841df8331a..9a9c88d14e 100644 --- a/docs/content/en/docs/concepts/architecture/deployment-flow.md +++ b/docs/content/en/docs/architecture/deployment-flow.md @@ -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. diff --git a/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md b/docs/content/en/docs/architecture/keptn-apps/_index.md similarity index 91% rename from docs/content/en/docs/concepts/architecture/keptn-apps/_index.md rename to docs/content/en/docs/architecture/keptn-apps/_index.md index 1c15e3045f..2d13d72a7f 100644 --- a/docs/content/en/docs/concepts/architecture/keptn-apps/_index.md +++ b/docs/content/en/docs/architecture/keptn-apps/_index.md @@ -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. @@ -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 @@ -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. @@ -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. @@ -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: diff --git a/docs/content/en/docs/concepts/architecture/working/_index.md b/docs/content/en/docs/architecture/working/_index.md similarity index 100% rename from docs/content/en/docs/concepts/architecture/working/_index.md rename to docs/content/en/docs/architecture/working/_index.md diff --git a/docs/content/en/docs/concepts/_index.md b/docs/content/en/docs/concepts/_index.md deleted file mode 100644 index d2ec6ce665..0000000000 --- a/docs/content/en/docs/concepts/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Concepts -description: Learn about underlying concepts of the keptn lifecycle toolkit. -weight: 50 -hidechildren: true # this flag hides all sub-pages in the sidebar-multicard.html ---- diff --git a/docs/content/en/docs/implementing/integrate/_index.md b/docs/content/en/docs/implementing/integrate/_index.md index 9068cb3bd2..ccd2efda31 100644 --- a/docs/content/en/docs/implementing/integrate/_index.md +++ b/docs/content/en/docs/implementing/integrate/_index.md @@ -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. diff --git a/docs/content/en/docs/intro/usecase_metrics.md b/docs/content/en/docs/intro/usecase_metrics.md index 2bed2f146f..6c8a8815ae 100644 --- a/docs/content/en/docs/intro/usecase_metrics.md +++ b/docs/content/en/docs/intro/usecase_metrics.md @@ -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) diff --git a/docs/content/en/docs/migrate/strategy/_index.md b/docs/content/en/docs/migrate/strategy/_index.md index 6b00374de8..5b6d84fc90 100644 --- a/docs/content/en/docs/migrate/strategy/_index.md +++ b/docs/content/en/docs/migrate/strategy/_index.md @@ -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 diff --git a/docs/content/en/docs/operate/cert-manager.md b/docs/content/en/docs/operate/cert-manager.md index 9d455e8799..9f1470ce95 100644 --- a/docs/content/en/docs/operate/cert-manager.md +++ b/docs/content/en/docs/operate/cert-manager.md @@ -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`, diff --git a/docs/content/en/docs/yaml-crd-ref/app.md b/docs/content/en/docs/yaml-crd-ref/app.md index baab768097..341537d8e3 100644 --- a/docs/content/en/docs/yaml-crd-ref/app.md +++ b/docs/content/en/docs/yaml-crd-ref/app.md @@ -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) diff --git a/docs/content/en/docs/yaml-crd-ref/metric.md b/docs/content/en/docs/yaml-crd-ref/metric.md index 77dfb8d12b..af4e3862ca 100644 --- a/docs/content/en/docs/yaml-crd-ref/metric.md +++ b/docs/content/en/docs/yaml-crd-ref/metric.md @@ -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) diff --git a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md index e1a5b32f55..a1846a6963 100644 --- a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md +++ b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md @@ -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)