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: tweaks to intro material for Keptn landing page #2221

Merged
merged 13 commits into from
Oct 17, 2023
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and orchestrate the deployment process.
If the Keptn helm chart value `schedulingGatesEnabled` is set to `true`, and Keptn is running on a Kubernetes version
greater than 1.26, Keptn does not install a scheduler plugin.
Instead, it uses
the [Pod Scheduling Readiness K8s API](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-scheduling-readiness)
the [Pod Scheduling Readiness K8s API](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-scheduling-readiness)
to gate Pods until the required deployment checks pass.

## Keptn Scheduling Gates for K8s 1.27 and above
Expand Down
9 changes: 6 additions & 3 deletions docs/content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
title: Getting started with Keptn
description: Get started with Keptn
title: Getting started with Keptn Observability
description: Get started with Keptn Observability
weight: 20
---

Keptn works whether or not you use a GitOps strategy.
Keptn provides sophisticated observability features
that enhance your existing cloud-native deployment environment.
These features are useful whether or not you use a GitOps strategy.

The following is an imperative walkthrough.

## Prerequisites
Expand Down
55 changes: 35 additions & 20 deletions docs/content/en/docs/intro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,26 @@ description: An introduction to Keptn and the usecases.
weight: 10
---

Keptn implements observability for deployments.
It seamlessly integrates with deployment tools
Keptn integrates seamlessly with cloud-native deployment tools
such as ArgoCD, Flux, and Gitlab
to bring application awareness to your Kubernetes cluster.
Keptn supplements the standard deployment tools
with features to help you ensure that your deployments are in
a healthy state.

These standard deployment tools
do an excellent job at deploying applications
but do not handle all issues
that are required to ensure that your deployment is usable.
Keptn "wraps" a standard Kubernetes deployment
with the capability to automatically handle issues
before and after the actual deployment.
For information about the history of the Keptn project,
see the
[Keptn Lifecycle Toolkit is now Keptn!](https://medium.com/keptn/keptn-lifecycle-toolkit-is-now-keptn-e0812217bf46)
blog.

Keptn includes multiple features
that can be implemented independently or together.
It targets three main use cases:
Custom metrics, Observability, and Release lifecycle management.
Metrics, Observability, and Release lifecycle management.

## Custom metrics
## Metrics

The Custom Keptn metrics feature extends the functionality of
The Keptn metrics feature extends the functionality of
[Kubernetes metrics](https://kubernetes.io/docs/concepts/cluster-administration/system-metrics/):

* Allows you to define metrics
Expand All @@ -39,10 +38,19 @@ The Custom Keptn metrics feature extends the functionality of
as well as data that comes directly from your cloud provider
such as AWS, Google, or Azure.

* Enhances the Kubernetes
[Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
facility.

The Keptn metrics server unifies and standardizes
access to data from various sources,
simplifying configuration and integration into a single set of metrics.

To learn more, see:

* [Custom Keptn metrics](usecase_metrics)
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
* [Keptn Metrics](../implementing/evaluatemetrics)
StackScribe marked this conversation as resolved.
Show resolved Hide resolved

## Observability

Keptn ensures observability for Kubernetes deployments
Expand Down Expand Up @@ -77,11 +85,21 @@ Keptn emits signals at every stage
OpenTelemetry metrics and traces)
to ensure that your deployments are observable.

To learn more, see:

* [Getting started with Keptn Observability](../getting-started)
* [Standardize observability](usecase-observability/)
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
* [DORA metrics](../implementing/dora) guide
* [OpenTelemetry observability](../implementing/otel) guide
StackScribe marked this conversation as resolved.
Show resolved Hide resolved

## Release lifecycle management

The Release lifecycle management tools run in conjunction
with the standard Kubernetes deployment tools
to make deployments more robust.
Keptn "wraps" a standard Kubernetes deployment
with the capability to automatically handle issues
before and after the actual deployment.

These tools run checks and tasks before or after deployment initiation.

Expand Down Expand Up @@ -116,12 +134,9 @@ or a
[KeptnApp](https://lifecycle.keptn.sh/docs/yaml-crd-ref/app/) resource,
which is a single, cohesive unit that groups multiple workloads.

To familiarize yourself with how Keptn works, refer to the
[Getting started with Keptn](../getting-started/)
and the
[Getting Started Exercises](https://lifecycle.keptn.sh/docs/getting-started/).
To learn more, see:

For information about the history of the Keptn project,
see the
[Keptn Lifecycle Toolkit is now Keptn!](https://medium.com/keptn/keptn-lifecycle-toolkit-is-now-keptn-e0812217bf46).
blog.
* [Getting started with release lifecycle management](../tutorials/tasks/)
* [Manage release lifecycle](usecase-orchestrate)
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
* [Deployment tasks](../implementing/tasks)
* [Evaluations](../implementing/evaluations)
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
14 changes: 11 additions & 3 deletions docs/content/en/docs/tutorials/tasks/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
---
title: Add Deployment Tasks
title: Getting started with Release Lifecycle Management
description: Add KeptnTasks to deployments
weight: 10
weight: 25
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

> This tutorial assumes you have already completed the [getting started guide](../../getting-started/).
The Release Lifecycle Management tools run
pre- and post-deployment tasks and checks
for your existing cloud-native deployments
to make them more robust.
This tutorial introduces these tools.

> This tutorial assumes you have already completed the
[Getting started with Keptn Observability](../../getting-started/)
exercise.
> Please ensure you've finished that before attempting this guide.

## Keptn Pre and Post Deployment Tasks
Expand Down
Loading