Some Random Repo

Requirements

Software

• docker
• docker compose

ENV Variables

1. REDIS_PASSWORD - Used to set password of redis instance and to provide connection info for webserver
2. REDIS_PORT - Used to set customize redis instance port and to provide connection info for webserver
3. REDIS_HOST - Used to provide connection info for webserver

Optional ENV variables:

1. WEB_SERVER_VERSION - This value will be returned when calling /version endpoint on the webserver

Development

Docker compose

To start dev environment run:

docker compose up

The webserver will be available on http://localhost:3000

K8S

Prerequisites

You need to have k8s cluster locally or a minikube installed.

You also need to install k8s ingress nginx.

If you have minikube, just run:

minikube addons enable ingress

Otherwise instructions to install ingress can be found here, just search for your environment.

And finally prepare the required redis password secret, by running:

./create-k8s-secret.sh

Start dev

To start dev environment run:

skaffold dev

When terminating skaffold will clean everything up except redis-secret you created manually

Helm deploy

Move into ./helm/main and run:

helm dependency build

Then to deploy the app run:

helm install [APP_NAME] .

Webserver

Webserver has 4 endpoints:

1. / - Prints and increments the timer whenever it is called (response type: HTML)
2. /version - Returns version set via WEB_SERVER_VERSION env variable
3. /healthz | /readyz | /livez - Returns HTTP status code 200 without content
4. /metrics - Returns metrics histogram data ready to be scraped by prometheus