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: add cluster requirements #1364

Merged
merged 25 commits into from
May 10, 2023
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
feacc1a
chore(metrics-operator): add configuration parameters for container s…
odubajDT May 2, 2023
3baf203
docs: describe automatic application discovery (#1304)
bacherfl May 2, 2023
f060766
feat(operator): add information about evaluation target in status (#1…
bacherfl May 2, 2023
808cf34
docs: fix missing code fence (#1343)
thisthat May 3, 2023
62fe9c2
feat(operator): introduce fallback search to KLT default namespace wh…
odubajDT May 3, 2023
4d41c53
docs: improve docs for KeptnEvaluationDefinition (#1335)
thisthat May 3, 2023
f5a5a9c
docs: improve headline of Getting Started subsection (#1350)
thisthat May 3, 2023
b8cd329
docs: update KeptnTaskDefinition to include fallback search to defaul…
odubajDT May 3, 2023
0935f62
docs: update KeptnConfig docs to include KeptnAppCreationRequestTimeo…
odubajDT May 3, 2023
aec5db0
chore: release 0.7.1 (#1089)
keptn-bot May 3, 2023
d2e3de9
chore: bump up helm chart version (#1351)
RealAnna May 3, 2023
d3d6f9e
feat(operator): introduce fallback search to KLT default namespace wh…
odubajDT May 3, 2023
7727c73
cleanup
StackScribe May 4, 2023
6af2836
content for cluster reqs, how to check k8s version
StackScribe May 4, 2023
8cd483d
markdownlint-fix
StackScribe May 4, 2023
afef5d4
missing tics
StackScribe May 4, 2023
499a1ee
docs: misspelled file name, misordered pages (#1363)
StackScribe May 4, 2023
73615a4
Update docs/content/en/docs/install/k8s.md
StackScribe May 4, 2023
901a8fe
Update docs/content/en/docs/install/k8s.md
StackScribe May 4, 2023
2c5acf8
Update docs/content/en/docs/install/k8s.md
StackScribe May 4, 2023
2cc0487
Merge branch 'main' into 0503-cluster-reqs
StackScribe May 4, 2023
27805da
Merge branch 'main' into 0503-cluster-reqs
StackScribe May 4, 2023
5594696
Merge branch 'main' into 0503-cluster-reqs
StackScribe May 10, 2023
06f8245
Update docs/content/en/docs/install/k8s.md
StackScribe May 10, 2023
5537df9
Update docs/content/en/docs/install/k8s.md
StackScribe May 10, 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
55 changes: 50 additions & 5 deletions docs/content/en/docs/install/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,19 @@ that runs your deployment software.
See [Requirements](reqs.md) for information about supported releases
and advice about resources required.

You can also create a local cluster using packages
such as KinD, Minikube, K3s, and K3d
that can be used for testing, study, and demonstration purposes.

## Create local Kubernetes cluster

You can use tools such as
You can also create a local cluster using packages such as
[KinD](https://kind.sigs.k8s.io/),
[k3d](https://k3d.io/),
[k3s](https://k3s.io/),
and [Minikube](https://minikube.sigs.k8s.io/docs/)
to set up a local, lightweight Kubernetes cluster
where you can install the Keptn Lifecycle Toolkit
for personal study, demonstrations, and testing.
For more information, see the Kubernetes
[Install Tools](https://kubernetes.io/docs/tasks/tools/)
documentation.

The [Keptn Lifecycle Toolkit: Installation and KeptnTask Creation in Minutes](https://www.youtube.com/watch?v=Hh01bBwZ_qM)
video demonstrates how to create a KinD cluster.
Expand All @@ -41,6 +40,10 @@ The basic steps are:
kind create cluster
```

See the
[KinD Quick Start Guide](https://kind.sigs.k8s.io/docs/user/quick-start/)
for more information

1. When the cluster has been created,
run the following to verify that the cluster is working
and that it is running a supported version of Kubernetes
Expand All @@ -49,3 +52,45 @@ The basic steps are:
```shell
kubectl version --short
```

## Prepare your cluster for KLT

The Keptn Lifecycle Toolkit installs into an existing Kubernetes cluster.
When setting up a local Kubernetes cluster
to study or demonstrate the Lifecycle Toolkit,
you need to provide these components.

Your cluster should include the following:

* A supported version of Kubernetes.
See [Supported Kubernetes versions](reqs.md/#supported-kubernetes-versions)
for details.

* [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)

* Data source such as
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
[Prometheus](https://prometheus.io/),
[Dynatrace](https://www.dynatrace.com/),
or [Datadog](https://www.datadoghq.com/).
This is used for the metrics used for the observability features.

* Deployment tools of your choice,
such as
[Argo CD](https://argo-cd.readthedocs.io/en/stable/) or
[Flux](https://fluxcd.io/).
KLT also works with just `kubctl apply` for deployment.
StackScribe marked this conversation as resolved.
Show resolved Hide resolved

* For traces, install [Jaeger](https://jaegertracing.io)
or a similar tool.

* If you want a dashboard for reviewing metrics and traces,
Install [Grafana](https://grafana.com/)
or the dashboard of your choice.

Also note that the Keptn Lifecycle Toolkit includes
a light-weight cert-manager that, by default, is installed
as part of the KLT software.
If you are using another cert-manager in the cluster,
you can configure KLT to instead use your cert-manager.
See [Use your own cert-manager](cert-manager.md)
for detailed instructions.
17 changes: 15 additions & 2 deletions docs/content/en/docs/install/reqs.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Requirements
description: Supported software versions and information about resources required
icon: concepts
layout: quickstart
weight: 15
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---
Expand All @@ -11,6 +9,21 @@ hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.htm

The Keptn Lifecycle Controller requires Kubernetes v1.24.0 or later.

Run the following to ensure that both client and server versions
are running Kubernetes versions greater than or equal to v1.24.
In this example, both client and server are at v1.24.0
so the Keptn Lifecycle Toolkit will work.

```shell
kubectl version --short
```

```shell
Client Version: v1.24.0
Kustomize Version: v4.5.4
Server Version: v1.24.0
```

StackScribe marked this conversation as resolved.
Show resolved Hide resolved
## Resource requirements

## cert-manager
Expand Down