diff --git a/docs/tutorials/simple-nodejs-app-ci-workflow.md b/docs/tutorials/simple-nodejs-app-ci-workflow.md index f552e862..fdc48d04 100644 --- a/docs/tutorials/simple-nodejs-app-ci-workflow.md +++ b/docs/tutorials/simple-nodejs-app-ci-workflow.md @@ -3,11 +3,11 @@ weight: 14 title: Kev CI workflow example with a simple Node.js App --- -# CI workflow example with a simple Node.js app +# CI workflow example with a simple Node.js app This example walks through using Kev in a commit based CI pipeline. -You will setup CircleCI to render, build, push and deploy to a remote staging environment. +You will setup CircleCI to render, build, push and deploy to a remote staging environment. We assume that you, - Use [`git`](https://git-scm.com/) for source control and can push to a remote Git repo. @@ -67,13 +67,13 @@ These allow us to push our app's image to a secure docker registry. Should that ### config.yaml -Here is the [CircleCI config file](../../examples/node-app/.circleci/config.yml). It will create a CI pipeline that is triggered by a commit to your Git repo. +Here is the [CircleCI config file](../../examples/node-app/.circleci/config.yaml). It will create a CI pipeline that is triggered by a commit to your Git repo. It assumes the necessary **CircleCI Environment Variables have been setup**, and the target cluster has a `staging` namespace already setup. It also depends on the Kev staging environment that we will be creating shortly. Here's the relevant step that performs the actual deployment, -> CircleCI Deploy step: render staging, use Skaffold to build, push and deploy your app to Kubernetes. +> CircleCI Deploy step: render staging, use Skaffold to build, push and deploy your app to Kubernetes. ```yaml ... ... @@ -85,7 +85,7 @@ It also depends on the Kev staging environment that we will be creating shortly. ./bin/skaffold run --kubeconfig ${KUBE_CONFIG_STAGING_FILE} --kube-context ${KUBE_CONTEXT_STAGING} --profile staging-env --namespace staging ... ... -``` +``` ## Initialise project @@ -103,7 +103,7 @@ You will notice the staging environment configuration file has been created: > Added environment specific override files: ``` -... +... |- docker-compose.kev.staging.yaml # staging env ``` @@ -111,7 +111,7 @@ Adjust your Kubernetes `staging` application parameters for each of the componen Also, you'll find that Kev has bootstrapped a Skaffold config file (`skaffold.yaml`). If a `skaffold.yaml` file previously existed, then the additional profiles will be added there. -Our CI pipeline will be using this Skaffold config file to power builds, pushes and deployments. +Our CI pipeline will be using this Skaffold config file to power builds, pushes and deployments. ## Iterate on the application and commit @@ -135,4 +135,4 @@ app-69d87ffbc8-wgs6 1/1 Running 0 9s That's it! If you have an [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) configured then navigate to the correct Url. -Alternatively, you can choose to [port-forward](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) the service and test the app on your localhost. \ No newline at end of file +Alternatively, you can choose to [port-forward](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) the service and test the app on your localhost.