From 7dd44f323f0cfd8e90a902e8d10adf0b44705d4a Mon Sep 17 00:00:00 2001 From: Amishakumari544 Date: Tue, 14 Mar 2023 11:09:37 +0530 Subject: [PATCH] docs: add the klt components with latest doc Signed-off-by: Amishakumari544 --- docs/config/_default/params.yaml | 17 +++-- .../architecture/components/_index.md | 63 +++++++++++++++++++ .../concepts/architecture/working/_index.md | 9 +++ 3 files changed, 83 insertions(+), 6 deletions(-) create mode 100644 docs/content/en/docs/concepts/architecture/components/_index.md create mode 100644 docs/content/en/docs/concepts/architecture/working/_index.md diff --git a/docs/config/_default/params.yaml b/docs/config/_default/params.yaml index 37a74cc826..df7ef3e1dd 100644 --- a/docs/config/_default/params.yaml +++ b/docs/config/_default/params.yaml @@ -3,10 +3,15 @@ github_project_repo: https://github.com/keptn/lifecycle-toolkit github_repo: https://github.com/keptn/lifecycle-toolkit github_subdir: docs + versions: - - url: /docs/ - version: branch-preview - - url: https://main.lifecycle.keptn.sh/docs - version: development - - url: https://lifecycle.keptn.sh/docs - version: latest + - url: /docs/ + version: branch-preview + - url: https://main.lifecycle.keptn.sh/docs + version: development + - url: https://lifecycle.keptn.sh/docs + version: latest + + +mermaid: + enable: true \ No newline at end of file diff --git a/docs/content/en/docs/concepts/architecture/components/_index.md b/docs/content/en/docs/concepts/architecture/components/_index.md new file mode 100644 index 0000000000..ccd23c4ff6 --- /dev/null +++ b/docs/content/en/docs/concepts/architecture/components/_index.md @@ -0,0 +1,63 @@ +--- +title: Lifecycle Toolkit Components +linktitle: KLT Components +description: Basic understanding of Keptn Lifecycle Toolkit Components +weight: 80 +cascade: +--- + +### Keptn Lifecycle Toolkit Components + +The Keptn Lifecycle Toolkit consists of two main components: + +* Keptn Lifecycle Operator, which splits into two separate operators +in Release 0.7.0 and later: + * Lifecycle-Operator + * Metrics-Operator +* Keptn Lifecycle Scheduler + +```mermaid +graph TD; + KLTComponents-->Operators; + KLTComponents-->Scheduler + Operators-->Lifecycle-Operator + Operators-->Metrics-Operator +style KLTComponents fill:#006bb8,stroke:#fff,stroke-width:px,color:#fff +style Operators fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8 +style Scheduler fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8 +style Lifecycle-Operator fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8 +style Metrics-Operator fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8 +``` + +**Keptn's Lifecycle Operator** is +a Kubernetes [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) +that automates the deployment and management +of the Keptn Lifecycle Controller components in a Kubernetes cluster. +The Keptn Lifecycle Operator contains several controllers for **Keptn CRDs** +and a **Mutating Webhook**. + +Here's a brief overview: + +**Keptn CRDs:** Keptn Lifecycle Operator contains +several controllers that manage and reconcile different types of Keptn CRDs +such as the Project Controller, Service Controller, and Stage Controller. + +**Mutating Webhook:** automatically injects Keptn labels +and annotations into Kubernetes resources, +such as deployments and services. +These labels and annotations are used to enable Keptn's automation +and monitoring capabilities. + +**Keptn's Lifecycle Metrics Operator** +collects, processes, and analyzes metrics data from a variety of sources. +Once collected, this data, can be used to generate a variety of reports +and dashboards that provide insights into the health and performance of the application and infrastructure. + +**Keptn's Lifecycle Scheduler** replaces the +[Kubernetes scheduler](https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/) +to allow users to schedule events and tasks to occur +at specific times during the application lifecycle. +The Lifecycle Scheduler can trigger events such as +deployment, testing, and remediation at specific times or intervals. +The Keptn Scheduler guarantees that Pods are initiated only after +the Pre-Deployment checks are completed. \ No newline at end of file diff --git a/docs/content/en/docs/concepts/architecture/working/_index.md b/docs/content/en/docs/concepts/architecture/working/_index.md new file mode 100644 index 0000000000..dc5ad8ddb9 --- /dev/null +++ b/docs/content/en/docs/concepts/architecture/working/_index.md @@ -0,0 +1,9 @@ +--- +title: Lifecycle Toolkit Working +linktitle: KLT Working +description: Understand How Keptn Lifecycle Toolkit Works +weight: 80 +cascade: +--- + +### How Keptn Lifecycle Toolkit Works? \ No newline at end of file