Skip to content

Commit

Permalink
docs: add KLT components diagram (#1016)
Browse files Browse the repository at this point in the history
Signed-off-by: Amishakumari544 <amishakumari544@gmail.com>
  • Loading branch information
Amishakumari544 committed Mar 15, 2023
1 parent a3aa4e5 commit dcf49cf
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ versions:
version: development
- url: https://lifecycle.keptn.sh/docs
version: latest


mermaid:
enable: true
1 change: 1 addition & 0 deletions docs/content/en/docs/concepts/architecture/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ weight: 80
cascade:
---

### Keptn Lifecycle Toolkit Components
63 changes: 63 additions & 0 deletions docs/content/en/docs/concepts/architecture/components/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Lifecycle Toolkit Components
linktitle: 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.
9 changes: 9 additions & 0 deletions docs/content/en/docs/concepts/architecture/working/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Lifecycle Toolkit Working
linktitle: How it works
description: Understand How Keptn Lifecycle Toolkit Works
weight: 80
cascade:
---

### How Keptn Lifecycle Toolkit Works?

0 comments on commit dcf49cf

Please sign in to comment.