gitlab.com/dctx/devcon-contact-tracer.git/api-service

api-service

The API Service provides the entrypoint for accessing the different services.

Getting Started

To clone the repo:

git clone [e-mail]/dctx/contact-tracer/devcon-contact-tracer.git
cd api-service

A docker image is also avaible in Docker Hub:

docker pull dctx/api-service:latest

Prerequisire

Workspace

• Go
• Docker

Docker images

• Kafka (bitnami/kafka:2.4.1)

Deployment

• Docker Compose
• Kubernetes (minikube)
• Helm

Build

Run the following to build the binary:

make build

The binary will be located in: build/bin/api-service

Configuration

Configuration is handled by viper which allows configuration using a config file or by environment variables.

A sample configuration file can be found in config/.api-service.yaml. Copy this to the $HOME directory to override the defaults.

Setting environment variables can also override the default configuration:

Environment Variable	Description	Default
API_SERVICE_SERVER_HOST	Name of the host or interface to bind the server	0.0.0.0
API_SERVICE_SERVER_PORT	Port to bind the server	8080
API_SERVICE_KAFKA_BROKERS	Addresses of the Kafka Brokers	broker1:9092,broker2:9092
API_SERVICE_KAFKA_TOPIC	The topic to publish/subscribe to	dctx-commands
API_SERVICE_KAFKA_PARTITION	The topic partition	0
API_SERVICE_KAFKA_MINBYTES	Min Bytes when reading messages	10000
API_SERVICE_KAFKA_MAXBYTES	Max Bytes when reading messages	10000000

Starting the Service

make run

Packaging Image

To create the docker image:

make package

To publish the image to docker hub:

make publish

Note that publishing the image requires access to the dctx group in docker hub.

Development

This project follows gitlab flow. The general flow is:

• Pick / Create an issue
• Create a feature branch
• Open a Merge Request
• Maintainer merge's to master

Read more about gitlab flow here.

Project Structure

api-service
|- build/               # build artifacts are generated here
|- cmd/                 # command line commands live here. Checkout cobra library
|- config/              # configuration files are here
|- db/                  # for database migration files
|- helm/                # helm chart for kubernetes deployment
|- internal/            # for internal go packages 
| |- server
| |- ...
|- pkg/                 # for public go packages
|- .dockerignore        # ignore list for docker
|- .gitignore           # ignore list for git
|- go.mod               # dependencies for project
|- go.sum               # checksum for dependencies, do not manually change
|- main.go              # the main go file
|- Makefile             # build scripts
|- README.md            # this file

Adding Dependencies

To add dependencies, run the following:

go get -u {dependency}
make deps

TODO

Initial ToDo list:

• Improve this README
• Setup Gitlab CI/CD
• Create kafka connector
• Define features in Gitlab Issues or Trello