jaotaohu / guestbook

Guestbook is a simple cloud-native web application which allows visitors to leave a public comment without creating a user account

📘 Guestbook

Guestbook is a simple cloud-native web application which allows visitors to leave a public comment without creating a user account.

Application uses MVC architecture, which is widely used software architectural pattern in GUI-based applications.

This application among other things, contains these endpoints:

• API (for interaction without UI) - python-restx/flask-restx,
• Prometheus metrics (for observability) - rycus86/prometheus_flask_exporter,
• Health (health of a application) - ateliedocodigo/py-healthcheck.

Live demo of Guestbook application is deployed in Fly.io 🚀, public comments Welcome!🤗:

https://guestbook.jakuboskera.dev

📖 TOC

• 📖 TOC
• 🏁 Get started
• 🛠 Used technologies
• 🎉 Run in docker using docker-compose
  • ⚠️ Prerequisites
  • 🚀 Install
  • 🧹 Cleanup
• 🎉 Run in Kubernetes
  • Using Helm
    • ⚠️ Prerequisites
    • 🚀 Install
    • 🧹 Cleanup
  • Using skaffold and Helm
    • ⚠️ Prerequisites
    • 🚀 Install
    • 🧹 Cleanup

🏁 Get started

1. Clone this repo

   git clone [email protected]:jakuboskera/guestbook.git

2. Navigate to a folder guestbook

   cd guestbook

3. Issue make command to see available targets, which you can use

   make

🛠 Used technologies

🎉 Run in docker using docker-compose

⚠️ Prerequisites

• docker-compose

🚀 Install

make docker-run

🧹 Cleanup

make docker-cleanup

🎉 Run in Kubernetes

Using Helm chart guestbook from Helm repository https://jakuboskera.github.io/charts.

Using Helm

⚠️ Prerequisites

• Kubernetes 1.12+
• Helm 3.1.0+

🚀 Install

make helm-install

🧹 Cleanup

make helm-cleanup

Using skaffold and Helm

Ideal for local Kubernetes development.

⚠️ Prerequisites

• Kubernetes 1.12+
• Helm 3.1.0+
• skaffold

🚀 Install

Build, tag and deploy artifacts via Helm chart using skaffold.yaml

make skaffold-run

Build, tag and deploy artifacts via Helm chart using skaffold.yaml, make port-forward to containers and write logs of containers to stdout

make skaffold-dev

🧹 Cleanup

make skaffold-cleanup