From 458ef4eebc44ebc56f8be99552190db99b177bf6 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 11 May 2023 01:36:35 -0700 Subject: [PATCH 1/4] enhancements to install page Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/install.md | 60 ++++++++++++++++++++----- 1 file changed, 49 insertions(+), 11 deletions(-) diff --git a/docs/content/en/docs/install/install.md b/docs/content/en/docs/install/install.md index 66499f7d67..77c30d7aba 100644 --- a/docs/content/en/docs/install/install.md +++ b/docs/content/en/docs/install/install.md @@ -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). @@ -17,6 +15,12 @@ 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). + +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 @@ -33,15 +37,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 ` 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 ` 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) @@ -107,3 +124,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`. +This line tells KLT to handle the namespace From 9620d4d215958d642a4963dc94f8641edb978b55 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 11 May 2023 01:44:29 -0700 Subject: [PATCH 2/4] enable not always required Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/install.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/install.md b/docs/content/en/docs/install/install.md index 77c30d7aba..b473c1d0f8 100644 --- a/docs/content/en/docs/install/install.md +++ b/docs/content/en/docs/install/install.md @@ -16,7 +16,8 @@ Two methods are supported for installing the Keptn Lifecycle Toolkit (KLT): 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). +[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). From 757e1ab5ba613f420330d9aa3720602f4f04214a Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 11 May 2023 02:57:33 -0700 Subject: [PATCH 3/4] Update docs/content/en/docs/install/install.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: Giovanni Liva Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/install.md b/docs/content/en/docs/install/install.md index b473c1d0f8..90217ee536 100644 --- a/docs/content/en/docs/install/install.md +++ b/docs/content/en/docs/install/install.md @@ -144,5 +144,5 @@ metadata: keptn.sh/lifecycle-toolkit: "enabled" ``` -You see the annotation line that enables `lifecycle-toolkit`. +You see the annotation line that `keptn.sh/lifecycle-toolkit: "enabled"`. This line tells KLT to handle the namespace From 0671e1a6d84afdd02de6b4fbe5c824151d7fb763 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Thu, 11 May 2023 03:15:23 -0700 Subject: [PATCH 4/4] Update docs/content/en/docs/install/install.md Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Signed-off-by: Meg McRoberts --- docs/content/en/docs/install/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/install/install.md b/docs/content/en/docs/install/install.md index 90217ee536..5b762e75a3 100644 --- a/docs/content/en/docs/install/install.md +++ b/docs/content/en/docs/install/install.md @@ -144,5 +144,5 @@ metadata: keptn.sh/lifecycle-toolkit: "enabled" ``` -You see the annotation line that `keptn.sh/lifecycle-toolkit: "enabled"`. +You see the annotation line `keptn.sh/lifecycle-toolkit: "enabled"`. This line tells KLT to handle the namespace