---

Source Code

Github: https://github.com/lisy09/k8s-project-template (opens new window)

This is a project to provide a k8s project template with built-in engineering excellence.

Features

This project provides these features:

• document templates with VuePress (opens new window)/dev-docs-template (opens new window)
• k8s cluster in docker for local or CI/CD machine with kind (opens new window)
• ci/cd, gitops with Argo (opens new window)
• chatops with Jenkins X (lighthouse) (opens new window)
• source code scan with sonarqube (opens new window)
• code coverage:
  • python: coverage.py (opens new window)
  • golang: go tool cover (opens new window)
  • java/scala: jacoco (opens new window)/sbt-jacoco (opens new window)
• examples for various test x various language
  • unit test
  • e2e test
  • integration test/deployment test
  • load test
    • locust (opens new window)
• k8s observability
  • monitoring/metrics
    • Prometheus (opens new window)
  • alert to email/slack
    • Prometheus (opens new window)
  • logging
    • PGL stack: Promtail + Loki + Grafana
      • Promtail (opens new window): log collecting sidecar
      • Loki (opens new window): log storage & query
      • Grafana (opens new window): UI
  • [TODO] tracing

Easy to Start

# build all needed docker images
make all

# start a local k8s cluster
make local-cluster

# deploy k8s workload
make deploy

# check the monitoring dash board in http://monitoring.observe.local