ego

README

eGO - Enlightening Golang

eGO is a project skeleton that uses Golang and gRPC.

The intention of this project is to propose a simple approach to the implementation of a micro-service architecture based on Golang, gRPC, Docker and Kubernetes.

Furthermore eGO is set up to use Prometheus and Grafana for monitoring.

Users have to only define their proto definitions and implement the respective functions, all the rest (configuration, middlewares/interceptors, etc.) is provided by eGO.

Note: this project is still experimental and not ready for production.

Requirements

gRPC Docker

Setup

If you are not using the Makefile, then source the environment variables:

source .env

Create a Kubernetes cluster using Minikube:

./scripts/setup_kubernetes.sh

or

make kubernetes

Create a private local registry:

./tools/registry/create_registry.sh --docker-user mario -e mario.mario@bros.com

Generate the gRPC configuration for a service:

./tools/grpc-generator/generate.sh --service omega --project "github.com/luigi-riefolo/eGO"

or

make config omega

Build a service:

./scripts/build.sh -s alfa

or

make run alfa

Build and run all the servers:

make run_all

Test gateway:

curl $(minikube service alfa --url)/v1/alfa/get

Start the gateway locally:

go run src/alfa/cmd/main.go service -config $CONFIG_FILE

BETA_SERVER_PORT=9090 go run src/alfa/cmd/main.go service -config conf/global_conf.toml

go run src/alfa/cmd/main.go service -config $CONFIG_FILE -opts BETA_SERVER_PORT=9090

Credits

Thanks to all the Open Source projects that inspired eGO:

• gRPC
• grpc-gateway-generator
• go-micro-services
• Golang Project Makefile Template

More to be mentioned.