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: added a list of links to the tutorials included in 'Get Started' #3871

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
40 changes: 40 additions & 0 deletions docs/docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,43 @@ comments: true
This section provides tutorials to familiarize you
with some basic Keptn features
and point you to other documentation that has more comprehensive information.

This section provides tutorials to familiarize you
with some basic Keptn features
and point you to other documentation that has more comprehensive information.
Comment on lines +10 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This section provides tutorials to familiarize you
with some basic Keptn features
and point you to other documentation that has more comprehensive information.

These lines duplicate text that is already there.


Before attempting these tutorials, we recommend that you read the
[Core Concepts]((../core-concepts/index.md)) section.

## Keptn Metrics

The Keptn Metrics component simplifies observability in Kubernetes
by unifying and standardizing metrics from multiple data sources,
such as Prometheus, Dynatrace, Datadog, and cloud providers like AWS, Google,
and Azure.
It integrates seamlessly with deployment and scaling tools like Argo,
Flux, KEDA, and HPA, enabling automated decisions with minimal configuration.
Unlike the Kubernetes Metrics Server, Keptn Metrics eliminates the complexity
of maintaining multiple point-to-point integrations, offering a streamlined,
centralized approach for managing metrics across diverse tools and observability platforms.

## Keptn Observability

Keptn enhances your cloud-native deployment environment with powerful observability
features, whether or not you follow a GitOps strategy.
This guide walks you through installing Keptn on a Kubernetes cluster, enabling
Keptn for a namespace and deployment, and setting up Grafana and observability tools to
visualize DORA metrics and OpenTelemetry traces.
By the end, you’ll have a fully integrated observability system built step-by-step.

## Release Lifecycle Management

Keptn's Release Lifecycle Management tools enhance your cloud-native deployments by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Keptn's Release Lifecycle Management tools enhance your cloud-native deployments by
Keptn's Release Lifecycle Management tools can enhance your cloud-native deployments by

running pre- and post-deployment tasks, conducting SLO evaluations, and managing
workload promotions.
This tutorial introduces these tools and demonstrates how to configure Keptn to trigger
webhooks around deployments.
It builds on the **Getting Started with Keptn Observability** exercise, so completing
that first is recommended.
Comment on lines +46 to +47
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It builds on the **Getting Started with Keptn Observability** exercise, so completing
that first is recommended.
It builds on the **Getting Started with Keptn Observability** exercise,
so you should complete that exercise before attempting this one.

You'll learn to annotate workloads, group them into KeptnApp resources, and set
up webhook triggers for robust deployment workflows.