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: implement KLT -> Keptn name change #2001

Merged
merged 31 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
1b2f232
docs: implement KLT -> Keptn name change
StackScribe Sep 1, 2023
6e09bb5
implementing section
StackScribe Sep 1, 2023
426b524
tutorials, architecture
StackScribe Sep 1, 2023
2bf2548
apis/lifecycle-operator
StackScribe Sep 2, 2023
d400d81
regenerate API docs
StackScribe Sep 2, 2023
946dd56
fix xref to "Enabling Keptn"
StackScribe Sep 2, 2023
5edc7cd
yaml-crd-ref
StackScribe Sep 3, 2023
1983d24
migrate
StackScribe Sep 3, 2023
c425c4c
contributing guide
StackScribe Sep 3, 2023
daf975a
first readmes
StackScribe Sep 3, 2023
67501d7
intro-klt
StackScribe Sep 3, 2023
edb30e7
more READMEs
StackScribe Sep 4, 2023
253a0c9
troubleshooting
StackScribe Sep 4, 2023
4af842b
another KLT
StackScribe Sep 4, 2023
4fa00fe
toolkit
StackScribe Sep 4, 2023
1fd469a
old gs guides
StackScribe Sep 4, 2023
bddae63
KLTComponents
StackScribe Sep 4, 2023
03fa1cd
rename folder
thisthat Sep 5, 2023
f2c41ce
more changes
thisthat Sep 5, 2023
69f9294
adapt graph
thisthat Sep 5, 2023
c20f7a7
typos
thisthat Sep 5, 2023
5c039d9
more polishing
thisthat Sep 5, 2023
6c622c3
fix links
thisthat Sep 5, 2023
1d24ac8
Update docs/content/en/docs/concepts/architecture/components/schedule…
StackScribe Sep 5, 2023
6179da2
Update docs/content/en/docs/migrate/strategy/_index.md
StackScribe Sep 5, 2023
9374724
Update examples/sample-app/README.md
StackScribe Sep 5, 2023
5338911
Update scheduler/README.md
StackScribe Sep 5, 2023
0434731
Update scheduler/README.md
StackScribe Sep 5, 2023
e50752b
Update examples/sample-app/version-1/app-pre-deploy.yaml
StackScribe Sep 5, 2023
a056735
Update examples/sample-app/version-2/app-pre-deploy.yaml
StackScribe Sep 5, 2023
0b59468
Update examples/sample-app/version-3/app-pre-deploy.yaml
StackScribe Sep 5, 2023
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
49 changes: 27 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Keptn Lifecycle Toolkit
# Keptn

![build](https://img.shields.io/github/actions/workflow/status/keptn/lifecycle-toolkit/CI.yaml?branch=main)
![Codecov](https://img.shields.io/codecov/c/github/keptn/lifecycle-toolkit?token=KPGfrBb2sA)
Expand All @@ -7,18 +7,21 @@
[![GitHub Discussions](https://img.shields.io/github/discussions/keptn/lifecycle-toolkit)](https://github.com/keptn/lifecycle-toolkit/discussions)

This is the primary repository for
the Keptn Lifecycle Toolkit (KLT) software and documentation.
KLT provides a “cloud-native” approach
the Keptn software and documentation.
Keptn provides a “cloud-native” approach
for managing the application release lifecycle
metrics, observability, health checks,
with pre- and post-deployment evaluations and tasks.
It is an incubating project, under the umbrella of the
[Keptn Application Lifecycle working group](https://github.com/keptn/wg-app-lifecycle).

> **Note** Keptn was developed under the code name of
"Keptn Lifecycle Toolkit" or "KLT" for short.
The source code contains many vestiges of these names.

## Goals

The Keptn Lifecycle Toolkit provides Cloud Native teams with
the following capabilities:
Keptn provides Cloud Native teams with the following capabilities:

- Pre-requisite evaluation before deploying workloads and applications
- Finding out when an application (not just a workload) is ready and working
Expand All @@ -28,10 +31,10 @@ the following capabilities:

![Operator Maturity Model with third level circled in](./assets/operator-maturity.jpg)

The Keptn Lifecycle Toolkit can be seen as a general purpose and declarative
Keptn can be seen as a general purpose and declarative
[Level 3 operator](https://operatorframework.io/operator-capabilities/)
for your Application.
For this reason, the Keptn Lifecycle Toolkit is agnostic to deployment tools
For this reason, Keptn is agnostic to deployment tools
that are used and works with any GitOps solution.

## Status
Expand Down Expand Up @@ -61,13 +64,13 @@ The status follows the

## Installation

The Keptn Lifecycle Toolkit can be installed on any Kubernetes cluster
Keptn can be installed on any Kubernetes cluster
running Kubernetes >=1.24.
Note that the Lifecycle Toolkit is not currently compatible with
Note that Keptn is not currently compatible with
[vcluster](https://github.com/loft-sh/vcluster).

Use the following command sequence
to install the latest release of the Keptn Lifecycle Toolkit:
to install the latest release of Keptn:

```shell
helm repo add klt https://charts.lifecycle.keptn.sh
Expand All @@ -80,32 +83,34 @@ helm upgrade --install keptn klt/klt -n keptn-lifecycle-toolkit-system --create-
For more info about Keptn, please see our
[documentation](https://lifecycle.keptn.sh/docs/), specifically:

- [Introduction to Keptn Lifecycle Toolkit](https://lifecycle.keptn.sh/docs/intro-klt/)
gives an overview of the KLT facilities.
- [Introduction to Keptn](https://lifecycle.keptn.sh/docs/intro/)
gives an overview of the Keptn facilities.
- [Getting started](https://lifecycle.keptn.sh/docs/getting-started/)
includes some short exercises to introduce you to KLT.
includes some short exercises to introduce you to Keptn.
- [Installation and upgrade](https://lifecycle.keptn.sh/docs/install/)
provides information about preparing your Kubernetes cluster
then installing and enabling KLT.
- [Implementing KLT applications](https://lifecycle.keptn.sh/docs/implementing/)
documents how to integrate KLT to work with your existing deployment engine
then installing and enabling Keptn.
- [Implementing Keptn applications](https://lifecycle.keptn.sh/docs/implementing/)
documents how to integrate Keptn to work with your existing deployment engine
and implement its variouos features.
- [Architecture](https://lifecycle.keptn.sh/docs/concepts/architecture/) provides detailed technical information
about how KLT works.
about how Keptn works.
- [CRD Reference](https://lifecycle.keptn.sh/docs/yaml-crd-ref/) and
[API Reference](https://lifecycle.keptn.sh/docs/crd-ref/)
provide detailed reference material for the custom resources
used to configure KLT.
used to configure Keptn.
- [Contributing to Keptn](https://lifecycle.keptn.sh/contribute/)
provides information about how to contribute to the Keptn project.

You can also find a number of video presentations and demos
about the Keptn Lifecycle Toolkit on the
about Keptn on the
[YouTube Keptn channel](https://www.youtube.com/@keptn).
Videos that refer to the "Keptn Lifecycle Controller"
are relevant for the Keptn project.

## Architecture

The Keptn Lifecycle Toolkit is composed of the following components:
Keptn is composed of the following components:

- Keptn Lifecycle Operator
- Keptn Scheduler
Expand All @@ -132,11 +137,11 @@ After the Post-Deployment checks,
SLOs can be validated using an interface
for retrieving SLI data from a provider
e.g, [Prometheus](https://prometheus.io/).
Finally, the Keptn Lifecycle Toolkit exposes Metrics and Traces
Finally, Keptn exposes Metrics and Traces
of the entire Deployment cycle with
[OpenTelemetry](https://opentelemetry.io/).

![KLT Architecture](./assets/architecture.png)
![Keptn Architecture](./assets/architecture.png)

### Webhook

Expand Down
4 changes: 2 additions & 2 deletions assets/logo/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Keptn Lifecycle Controller Logos
# Keptn Logos

This directory contains the Keptn Lifecycle Controller logos in different formats and colors.
This directory contains the Keptn logos in different formats and colors.

## Logos

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/contribute/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Contributing to Keptn
description: How to contribute to the Keptn projects
description: How to contribute to the Keptn project
linktitle: Contributing
weight: 400
menu:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ that are relevant only to documentation

For usability considerations, we make the following exceptions:

* The main `README.md` file for the lifecycle-controller repository
* The main `README.md` file for the lifecycle-toolkit repository
includes this basic information as well as a link
to the full installation documentation which has more details.
* The Getting Started Guide also includes this information
Expand Down
28 changes: 14 additions & 14 deletions docs/content/en/contribute/docs/source-file-structure/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Structure source files with Metadata
weight: 400
---

The source files for the KLT documentation
The source files for the Keptn documentation
are stored in the same github repository as the source code.
This page explains how the documentation source files are organized.

Expand All @@ -23,26 +23,26 @@ the *docs/content/en/docs* directory in the repository.
The subdirectories correspond to the contents listed in the right frame.
In the order they appear in the rendered docs, the subdirectories are:

* **intro-klt** (Introduction to the Keptn Lifecycle Toolkit):
A brief overview of KLT, its features and use cases, and its history
* **intro** (Introduction to the Keptn Lifecycle Toolkit):
A brief overview of Keptn, its features and use cases, and its history
* **getting-started** (Getting started):
A hands-on exercise that demonstrates the capabilities of KLT
A hands-on exercise that demonstrates the capabilities of Keptn
* **tutorials** (Tutorials):
Additional hands-on exercises to introduce new users to KLT
Additional hands-on exercises to introduce new users to Keptn
* **install** (Installation and Upgrade):
Requirements and instructions for installing and enabling KLT
* **operate** (Operate KLT):
Guides about running and managing the KLT cluster
Requirements and instructions for installing and enabling Keptn
* **operate** (Operate Keptn):
Guides about running and managing the Keptn cluster
* **implementing** (Implementing Keptn applications):
This is currently a catch-all section
for guides and how-to material about implementing Keptn features.
It needs to be restructured and subdivided
* **troubleshooting.md** (Troubleshooting Guide):
How to diagnose and solve common problems with KLT
How to diagnose and solve common problems with Keptn
* **architecture** (Architecture):
Information about how KLT actually works
Information about how Keptn actually works
* **crd-ref** (API Reference):
Comprehensive information about all the APIs that define the KLT CRDs.
Comprehensive information about all the APIs that define the Keptn CRDs.
This section is auto-generated from source code
and should never be modified in the *docs* directory.
The source for the authored text can be modified
Expand All @@ -51,8 +51,8 @@ In the order they appear in the rendered docs, the subdirectories are:
Reference pages for the CRs that users must populate.
This is a subset of the CRDs documented in the *API Reference* section
* **migrate** (Migrating to the Keptn Lifecycle Toolkit):
Information to help users who are migrating to KLT
from Keptn V1
Information to help users who are migrating to Keptn
from Keptn v1

## Contributing guide

Expand Down Expand Up @@ -131,7 +131,7 @@ The system for assigning weights for the docs landing page
allows for maximum flexibility as we create new sections:

* General introductory material uses weight values under 100.
* Guide material about using specific KLT features
* Guide material about using specific Keptn features
use weight value of 2**.
* Reference material uses weight values of 5**.
* Other documents use weight values of 7**.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Contribution Guidelines
description: Guidelines for contributing to Keptn Lifecycle Toolkit
weight: 50
description: Guidelines for contributing towards Keptn
weight: 300
---

Before using the **Keptn Lifecycle Toolkit**
as a contributor to the Keptn Lifecycle Toolkit repository,
Before using Keptn
as a contributor to the Keptn `lifecycle-toolkit` repository,
it is expected that you comply with the guidelines while
making contributions towards the repository.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ to the repository are:

1. Switch back to the `main` branch in your repository,
and ensure that it is up to date
with the `main` branch of the Keptn Lifecycle Toolkit:
with the `main` Keptn branch:

```bash
git remote add upstream https://github.com/keptn/lifecycle-toolkit.git
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/contribute/general/technologies/_index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Technologies to get familiar
description: Technologies to get familiar before working with Keptn lifecycle toolkit
description: Technologies to get familiar before working with Keptn
weight: 100
---

### Related Technologies

You should understand some related technologies
to effectively use and contribute to the Keptn lifecycle-toolkit.
to effectively use and contribute to Keptn.
This section provides links to some materials that can help your learning.
The information has been gathered from the community and is subject to alteration.
If you have suggestions about additional content that should be included in this list,
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/concepts/architecture/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Architecture
linktitle: Architecture
description: Understand the details of how Keptn Lifecycle Toolkit works
description: Understand the details of how Keptn works
weight: 80
cascade:
---

### Keptn Lifecycle Toolkit Components
### Keptn Components
14 changes: 7 additions & 7 deletions docs/content/en/docs/concepts/architecture/cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can instead
[configure your own certificate manager](https://lifecycle.keptn.sh/docs/install/cert-manager/)
for this purpose.

The Lifecycle Toolkit includes a Mutating Webhook
Keptn includes a Mutating Webhook
that requires TLS certificates to be mounted as a volume in its pod.
In version 0.6.0 and later, the certificate creation
is handled automatically by
Expand All @@ -28,15 +28,15 @@ with a renewal threshold of 12 hours.
* If the certificate expires,
the [klt-cert-manager](https://github.com/keptn/lifecycle-toolkit/blob/main/klt-cert-manager/README.md)
renews it.
* The Lifecycle Toolkit operator waits for a valid certificate to be ready.
* The Keptn `lifecycle-operator` waits for a valid certificate to be ready.
* When the certificate is ready,
it is mounted on an empty dir volume in the operator.

`klt-cert-manager` is a customized certificate manager
that is installed with the Lifecycle Toolkit by default.
that is installed with Keptn by default.
It is included to simplify installation for new users
and because it is much smaller than most standard certificate managers.
However, KLT is compatible with most 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)
for instructions.
Expand All @@ -48,7 +48,7 @@ the webhook or the operator may generate errors
because of an invalid certificate.
To solve this, delete the certificate and restart the operator.

The KLT cert-manager certificate is stored as a secret in the `klt` namespace.
The Keptn cert-manager certificate is stored as a secret in the `klt` namespace.
To retrieve it:

```shell
Expand All @@ -62,8 +62,8 @@ NAME TYPE DATA AGE
klt-certs Opaque 5 4d23h
```

Specify the `NAME` of the KLT certificate (`klt-certs` in this case)
to delete the KLT certificate:
Specify the `NAME` of the Keptn certificate (`klt-certs` in this case)
to delete the Keptn certificate:

```shell
kubectl delete secret klt-certs -n keptn-lifecycle-toolkit-system
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Lifecycle Toolkit Components
title: Keptn Components
linktitle: Components
description: Basic understanding of Keptn Lifecycle Toolkit Components
description: Basic understanding of Keptn Components
weight: 20
cascade:
---

### Keptn Lifecycle Toolkit Components
### Keptn Components

The Keptn Lifecycle Toolkit consists of two main components:
Keptn consists of two main components:

* Keptn Lifecycle Operator, which splits into two separate operators
in Release 0.7.0 and later:
Expand All @@ -18,11 +18,11 @@ in Release 0.7.0 and later:

```mermaid
graph TD;
KLTComponents-->Operators;
KLTComponents-->Scheduler
KeptnComponents-->Operators;
KeptnComponents-->Scheduler
Operators-->Lifecycle-Operator
Operators-->Metrics-Operator
style KLTComponents fill:#006bb8,stroke:#fff,stroke-width:px,color:#fff
style KeptnComponents 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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Keptn Lifecycle Operator
linktitle: Lifecycle Operator
description: Basic understanding of Keptn's Lifecycle Operator
description: Basic understanding of the Keptn Lifecycle Operator
weight: 80
cascade:
---
Expand All @@ -10,7 +10,7 @@ cascade:
**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.
of the Keptn components in a Kubernetes cluster.
The Keptn Lifecycle Operator contains several controllers for **Keptn CRDs**
and a **Mutating Webhook**.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Keptn Lifecycle Scheduler
linktitle: Scheduler
description: Basic understanding of Keptn's Lifecycle Scheduler
description: Basic understanding of the Keptn Scheduler
weight: 80
cascade:
---

The **Keptn Scheduler** is an integral component of the Keptn Lifecycle Toolkit that orchestrates
The **Keptn Scheduler** is an integral component of Keptn that orchestrates
the deployment process.
The **Keptn Scheduler** works by registering itself as a Permit plugin within the Kubernetes
scheduling cycle that ensures that Pods are scheduled to a node until and unless the
Expand Down
Loading