Example application that illustrates how to build an application that is Cloud Native and will correctly run within Kubernetes. Created by following this tutorial. All credit goes to Elena for making a great tutorial
The application itself is quite trivial in that it has a basic root endpoint that just shows some build information. The interesting parts of the application are that:
- it closely follows the 12-factor app methodology.
- has metrics instrumented with Prometheus.
- employs a health endpoint that Kubernetes can use to evaluate the health of a replica of the app.
- employs a readiness endpoint that Kubernetes can use to evaluate if a replica of the app is ready to accept traffic.
- embeds build and versioning information at build time through the Makefile.
It is expected that you have Golang installed and your $GOPATH configured correctly. Please follow the following guide to set this up.
As this is a Kubernetes example application, it is expected that you have kubectl installed to your path and its context is set to a live Kubernetes cluster.
There is a Makefile for the app located within the app/ directory the commands described below will help build, test and deploy this application.
- To run
make run - To build
make container - To deploy app to Kubernetes
make deploy
I've been testing the single node Kubernetes cluster that comes with Docker for Mac 17.12.0-ce so you can use the docker-compose.yml file to deploy the stack to Kubernetes using the docker stack deploy --compose-file=docker-compose.yml example-app
- Add Kubernetes files
- Expand background for Documentation
- Add examples to Documentation
MIT