From f2263b50e5172f3d052b42f4a8f1eba997b8e21e Mon Sep 17 00:00:00 2001 From: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com> Date: Mon, 6 Feb 2023 12:33:52 +0530 Subject: [PATCH] docs: modify getting-started.md (#768) --- docs/content/en/docs/getting-started.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/content/en/docs/getting-started.md b/docs/content/en/docs/getting-started.md index 4cf10f86a2..b924bbd5bd 100644 --- a/docs/content/en/docs/getting-started.md +++ b/docs/content/en/docs/getting-started.md @@ -8,10 +8,10 @@ cascade: path_base_for_github_subdir: "/content/en/docs-dev" --- -The Keptn Lifecycle Toolkit makes your deployments observable, brings application-awareness to your Kubernetes cluster and helps you reliably delivering your application with: +The Keptn Lifecycle Toolkit makes your deployments observable, brings application-awareness to your Kubernetes cluster and helps you reliably deliver your application with: * Pre-Deployment Tasks: e.g. checking for dependant services, checking if the cluster is ready for the deployment, etc. -* Pre-Deployment Evaluations: e.g. evaluate metrics before your application gets deployed (e.g. layout of the cluster +* Pre-Deployment Evaluations: e.g. evaluate metrics before your application gets deployed (e.g. layout of the cluster) * Post-Deployment Tasks: e.g. trigger a test, trigger a deployment to another cluster, etc. * Post-Deployment Evaluations: e.g. evaluate the deployment, evaluate the test results, etc. @@ -31,7 +31,7 @@ All of these things can be executed on a workload or on an application level, wh ## Check Kubernetes Version -Run the following and ensure both client and server version are greater than or equal to v1.24. +Run the following and ensure both client and server versions are greater than or equal to v1.24. ``` kubectl version --short @@ -45,7 +45,7 @@ The output should look like this. In this example, both client and server are at {{% readfile file="./snippets/tasks/install.md" markdown="true" %}} ## Check out the Getting Started Repository -For the further progress of this guide, we need a sample application as well as some helpers which makes it easier for your to set up your environment. These things can be found in our Getting Started repository which can be checked out as follows: +For the further progress of this guide, we need a sample application as well as some helpers which make it easier for your to set up your environment. These things can be found in our Getting Started repository which can be checked out as follows: ```console git clone https://github.com/keptn-sandbox/lifecycle-toolkit-examples.git @@ -53,7 +53,7 @@ cd lifecycle-toolkit-examples ``` ## Install the required observability features -The Keptn Lifecycle Toolkit emits OpenTelemetry data as standard but the toolkit does not come pre-bundled with Observability backend tooling. This is deliberate as it provides flexibility for you to bring your own Observability backend which consume this emitted data. +The Keptn Lifecycle Toolkit emits OpenTelemetry data as standard but the toolkit does not come pre-bundled with Observability backend tooling. This is deliberate as it provides flexibility for you to bring your own Observability backend which consumes this emitted data. In order to use the observability features of the lifecycle toolkit, we need a monitoring and tracing backend. @@ -70,7 +70,7 @@ For this demonstration, we use a slightly modified version of [the PodTatoHead]( ![img.png](assets/podtatohead.png) -Over time, we will evolve this application from a simple manifest to a Keptn-managed application. We will install it first with kubectl and add pre- as well as post-deployment tasks. For this, we will check if the entry service is available before the other ones get scheduled. Afterwards, we will add evaluations to ensure that our infrastructure is in a good shape before we deploy the application. Finally, we will evolve to a GitOps driven deployment and will notify an external webhook service when the deployment has finished. +Over time, we will evolve this application from a simple manifest to a Keptn-managed application. We will install it first with kubectl and add pre- as well as post-deployment tasks. For this, we will check if the entry service is available before the other ones get scheduled. Afterward, we will add evaluations to ensure that our infrastructure is in a good shape before we deploy the application. Finally, we will evolve to a GitOps driven deployment and will notify an external webhook service when the deployment has finished. ## Install the Demo Application (Version 1) In the first version of the Demo application, the Keptn Lifecycle Toolkit evaluates metrics provided by prometheus and checks if a specified amount of CPUs is available before deploying the application