tic-tac-toverengineered

README

tic-tac-toverengineered

A simple Tic Tac Toe game build with an excessive number of microservices.

Goal

To provide an easy to understand project with a non-trivial number of microservices to try out monitoring, tracing and observability tooling.

Technologies

• Go
• gRPC
• Kubernetes
• Helm
• Tilt
• TailwindCSS
• OpenTelemetry
• Lightstep

Building and Running Locally

You can run all deployments locally using Tilt. Open a terminal in the root directory of the repo and run:

tilt up

This will build all containers and deploy a Helm chart to your current Kubernetes context, forwarding the web UI to port 8080 on localhost.

Tilt will also automatically run unit tests on any change to the source.

Deployment

A Helm chart has been provided for direct deployment. To deploy from the command line:

helm repo add tic-tac-toverengineered \
    https://theothertomelliott.github.io/tic-tac-toverengineered/

helm repo update

helm install \
    --create-namespace --namespace tictactoe \
    tic-tac-toverengineered/tic-tac-toe --generate-name

Secrets

Secrets are picked up by Tilt from secrets.yaml (which is gitignored). Currently, only a Lightstep access token is required.

Add the following content to secrets.yaml to enable tracing:

lightstep:
  access_token: <access token>