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.

Sign up for GitHub

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: enhance install page #1399

Merged
merged 4 commits into from
May 11, 2023
Merged

docs: enhance install page #1399

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
458ef4e
enhancements to install page
StackScribe May 11, 2023
9620d4d
enable not always required
StackScribe May 11, 2023
757e1ab
Update docs/content/en/docs/install/install.md
StackScribe May 11, 2023
0671e1a
Update docs/content/en/docs/install/install.md
StackScribe May 11, 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
61 changes: 50 additions & 11 deletions docs/content/en/docs/install/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
title: Install KLT
title: Install and enable KLT
description: Install the Keptn Lifecycle Toolkit
icon: concepts
layout: quickstart
weight: 35
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

Two methods are supported for installing the Keptn Lifecycle Toolkit:
Two methods are supported for installing the Keptn Lifecycle Toolkit (KLT):

* Releases v0.7.0 and later can be installed using
the [Helm Chart](#use-helm-chart).
Expand All @@ -17,6 +15,13 @@ Two methods are supported for installing the Keptn Lifecycle Toolkit:
the [manifests](#use-manifests).
This is the less-preferred way because it does not support customization.

After KLT is installed, you must
[Enable KLT for your cluster](#enable-klt-for-your-cluster)
in order to run some KLT functionality.

You are then ready to
[Integrate KLT with your applications](../implementing/integrate).

## Use Helm Chart

Version v0.7.0 and later of the Lifecycle Toolkit
Expand All @@ -33,15 +38,28 @@ helm upgrade --install keptn klt/klt \
Note that the `helm repo update` command is used for fresh installs
as well as for upgrades.

Use the `--version <version>` flag on the
`helm upgrade --install` command line to specify a different KLT version.
Some helpful hints:

Use the following command sequence to see a list of available versions:
* Use the `--version <version>` flag on the
`helm upgrade --install` command line to specify a different KLT version.

```shell
helm repo update
helm search repo klt
```
* Use the following command sequence to see a list of available versions:

```shell
helm repo update
helm search repo klt
```

* To verify that the KLT components are installed in your cluster,
run the following command:

```shell
kubectl get pods -n keptn-lifecycle-toolkit-system
```

The output shows all components that are running on your system.

### Modify Helm configuration options

To modify configuration options, download a copy of the
[helm/chart/values.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/helm/chart/values.yaml)
Expand Down Expand Up @@ -107,3 +125,24 @@ kubectl wait --for=condition=Available deployment/lifecycle-operator \
```

The Lifecycle Toolkit and its dependencies are now installed and ready to use.

## Enable KLT for your cluster

To enable KLT for your cluster, annotate the Kubernetes
[Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
resource.
In this example, this is defined in the
[simplenode-dev-ns.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/simplenode-dev-ns.yaml)
file, which looks like this:

```yaml
apiVersion: v1
kind: Namespace
metadata:
name: simplenode-dev
annotations:
keptn.sh/lifecycle-toolkit: "enabled"
```

You see the annotation line that enables `lifecycle-toolkit`.
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
This line tells KLT to handle the namespace