This repository contains a simple Flask App that displays 'Hello, World!' and can be deployed in Minikube.
You will need the following to launch the App:
- Python 3 (and
pip) - Minikube
The following is a list of tools that are not required, but helpful to have:
- Helm - Used to deploy in to Minikube using the included Helm Chart
- Taskfile - Run tasks in the included
Taskfile.yaml
There are two ways to deploy the hello-world app in to Minikube, you can deploy manually or you can using Taskfile.
Both ways follow the same steps, however using Taskfileautomates the process.
-
Ensure Minikube cluster is up and running with ingress addon enabled:
$ minikube start $ minikube addons enable ingress -
Build container image and ensure that it's loaded in to Minikube cluster:
minikube image build -t 127.0.0.1/hello-world-demo:local . -
Deploy in to Minikube:
$ minikube kubectl -- apply -f ./static-deploy.yaml $ minikube service -n ingress-nginx ingress-nginx-controller --url | head -1You will see URL displayed, browsing to that link should display the App.
Note: HTTP
Hostmust bestatic-hello.localdomainwhen making the request, or add an entry to/etc/hosts
-
Ensure Minikube cluster is up and running:
$ minikube start
-
To be safe, set
KUBECONFIGpath:$ export KUBECONFIG=${PWD}/.kubeconfig $ minikube update-context
-
Build container image and ensure that it's loaded in to Minikube cluster:
minikube image build -t 127.0.0.1/hello-world-demo:local . -
Deploy using Helm:
$ helm upgrade --install \ -n hello-world \ --create-namespace \ -f helm/hello-world/deploy-values.yaml \ hello-world \ helm/hello-world/ $ minikube service -n ingress-nginx ingress-nginx-controller --url | head -1You will see URL displayed, browsing to that link should display the App.
Note: HTTP
Hostmust behello.localdomainwhen making the request, or add an entry to/etc/hosts
Simply run the either of the following:
task helm-install # To deploy using HelmOr
task minikube-helloworld-deploy # To deploy without using HelmThe default task will run helm-install, so if you have helm installed, you can also just run task
A list of tasks can be shown by running task -l:
$ task -l
task: Available tasks for this project:
* build-image: Build Container image
* helm-install: Deploy Hello World app using Helm
* minikube-helloworld-deploy: Deploy Hello World App using minikube
* minikube-launch: Launch Minikube cluster with Docker driver
* python-test: Lint and test Python codeThe app is very simple "Hello, World!" example app, but does provide a API endpoint that allows the user to customise the greeting.
Note: Output can be formatted in json by appending ?output=json to the request
-
/# Regular Output $ curl -H 'Host: static-hello.localdomain' http://127.0.0.1:30269/ Hello, World! # Output in JSON $ curl -H 'Host: static-hello.localdomain' http://127.0.0.1:30269/?output=json {"name":"World","output":"Hello, World!"}
-
/hello/<name># Regular Output $ curl -H 'Host: static-hello.localdomain' http://127.0.0.1:30269/hello/yasser Hello, Yasser! # Output in JSON $ curl -H 'Host: static-hello.localdomain' http://127.0.0.1:30269/hello/yasser?output=json {"name":"Yasser","output":"Hello, Yasser!"}
Work should be undertaken in a virtual env to prevent causing any conflicts with your system installation.
Once you are running in a virtual env, install the needed pip modules:
$ pip install -r dev-requirements.txtThe code conforms to PEP8 style guide and you can use pycodestyle to check:
$ pycodestyle src/Tests are also provided in src/tests, to run tests:
$ pytest --no-header src/
====================================================================================== test session starts ======================================================================================
collected 4 items
src/tests/test_endpoint.py .... [100%]
======================================================================================= 4 passed in 0.07s =======================================================================================