gc-2021-ultimate-service

module

v0.0.0-...-75ff400 Latest Latest Go to latest Published: Dec 7, 2021 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This repository is created to capture my exercise for learning Ultimate Service (workshop in the GopherCon 2021)

This repository starts by setting up with:

A simple Go program (with console out) under app directory
Set up the Dockerfile under zarf so we can build out container of the main program
Set up the Kind and Kustomize file to run Kubernetes cluster locally
Utilize Makefile to group commands together

Clone the repository
Run make sales-api to re-build the Docker image
Run make kind-up to set up the Kubernetes cluster
Run make kind-load to load the image in Kubernetes
Run make kind-apply to create pod/deployment
Run make kind-status-sales to check the container status - should be RUNNING
Run make kind-logs-sales to check the container logs - should be able to see last few lines of logs

Path	Synopsis
app
service/sales-api
service/sales-api/handler Package handler manages the different versions of the API.	Package handler manages the different versions of the API.
tooling/logfmt This program takes the structured log output and makes it readable.	This program takes the structured log output and makes it readable.
business
web/v1 Package v1 represents types used by the web application for v1.	Package v1 represents types used by the web application for v1.
web/v1/mid Package mid contains a set of middleware functions	Package mid contains a set of middleware functions
foundation
logger Package logger provides a convenience function to constructing a logger for use.	Package logger provides a convenience function to constructing a logger for use.
web Package web contains a small web framework extension.	Package web contains a small web framework extension.