cng-hello-backend

README

cng-hello-backend

Showcase of a cloud native application in Go.

1. How to run:

Local

go run .\cmd\cng-hello-backend

Local with database

docker compose -f deployment/docker/cng-hello-backend-ressources/docker-compose.yml up --detach

go run .\cmd\cng-hello-backend

docker-compose

docker build -f ./build/package/docker/Dockerfile -t cng-hello-backend --build-arg version=$$(cat VERSION) .

docker compose -f deployment/docker/cng-hello-backend-standalone/docker-compose.yml up --detach

2. Thougths on the project

Initial thoughts

• Is Go ready to be used in the cloud enterprise environment ?
• Can Go detach big ship backends like java ?

20.02.2022

• Some general packages for tracing, logging, and auth with a clean api needs to be implemented in order to not always do everything from scratch

07.06.2023

• Using otel for logs/traces/metrics with existing contrib instrumentation makes life a lot easier.

3. Done

General

• Base go file structure (https://github.com/golang-standards/project-layout)
• Architecture (example: https://medium.com/@matiasvarela/hexagonal-architecture-in-go-cfd4e436faa3)
• Rest-Api (https://github.com/gin-gonic/gin)
• Logger for json logging (https://github.com/uber-go/zap)
• Support for UUID

Database

• Added usage of gorm for postgresql (https://github.com/go-gorm/gorm)
• Added migration with gorm
• Added optimistic locking

Build/Deployment

• Dockerfile
• Helm chart
• Configuration (https://github.com/spf13/viper)

Auth

• JWT validation (https://github.com/golang-jwt/jwt)
• Cert parsing from oidc cert endpoint
• Apply groups from jwt in the context

Metrics

• Telemtry done via otel
• Grafana
• Tracing for jeager (https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/jaeger)
• Tracing of gin (https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/github.com/gin-gonic/gin/otelgin)
• Trace and spanId in logs
• Implement readiness and live checks
• Added possibility to pass handler for readiness and liveness
• Added Ping on db for readiness and liveness check and include result in response object

Error handling

• Added general error handling and middleware for gin.

4. Honorable mentions

• Alternative web framework https://github.com/gofiber/fiber