https://github.com/pecigonzalo/fodinfo

F# microservice template for Kubernetes
https://github.com/pecigonzalo/fodinfo

dotnet dotnet-core fsharp helm kubernetes kustomize microservice

Last synced: 3 months ago
JSON representation

F# microservice template for Kubernetes

• Host: GitHub
• URL: https://github.com/pecigonzalo/fodinfo
• Owner: pecigonzalo
• License: apache-2.0
• Created: 2021-04-13T15:38:49.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-19T16:10:51.000Z (over 3 years ago)
• Last Synced: 2024-04-13T15:55:24.365Z (10 months ago)
• Topics: dotnet, dotnet-core, fsharp, helm, kubernetes, kustomize, microservice
• Language: F#
• Homepage:
• Size: 87.9 KB
• Stars: 14
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fodinfo

fodinfo is a tiny web application made with ~~Go~~ F# that showcases best practices of running microservices in Kubernetes. fodinfo is a F# port of the great work of [@stefanprodan](https://github.com/stefanprodan) in https://github.com/stefanprodan/podinfo to F#.

## Why?

Im using this as a project to learn F# and potentially create a usefull template for F# project.

## Stack

- [Falco](https://github.com/pimbrouwers/Falco)

## Specifications:

- [x] Health checks (readiness and liveness)

- [ ] Instrumented with Prometheus **(In Progress)**

- [ ] 12-factor app **(In Progress)**

- [ ] File watcher for secrets and configmaps

- [ ] Tracing with Istio and Jaeger

- [ ] Linkerd service profile

- [x] Structured logging

- [ ] Fault injection (random errors and latency)

- [ ] Swagger docs

- [ ] Helm and Kustomize installers

- [ ] End-to-End testing with Kubernetes Kind and Helm

- [ ] Kustomize testing with GitHub Actions and Open Policy Agent

- [ ] Multi-arch container image with Docker buildx and Github Actions

- [ ] CVE scanning with trivy

- [ ] Graceful shutdown on interrupt signals

## Web API:

- [ ] `GET /` prints runtime information

- [x] `GET /version` prints fodinfo version and git commit hash

- [x] `GET /metrics` return HTTP requests duration and Go runtime metrics

- [x] `GET /healthz` used by Kubernetes liveness probe

- [x] `GET /readyz` used by Kubernetes readiness probe

- [x] `POST /readyz/enable` signals the Kubernetes LB that this instance is ready to receive traffic

- [x] `POST /readyz/disable` signals the Kubernetes LB to stop sending requests to this instance

- [x] `GET /status/{code}` returns the status code

- [x] `GET /panic` crashes the process with exit code 255

- [x] `POST /echo` forwards the call to the backend service and echos the posted content

- [x] `GET /env` returns the environment variables as a JSON array

- [x] `GET /headers` returns a JSON with the request HTTP headers

- [x] `GET /delay/{seconds}` waits for the specified period

- [ ] `POST /token` issues a JWT token valid for one minute `JWT=$(curl -sd 'anon' fodinfo:5000/token | jq -r .token)`

- [ ] `GET /token/validate` validates the JWT token `curl -H "Authorization: Bearer $JWT" fodinfo:5000/token/validate`

- [ ] `GET /configs` returns a JSON with configmaps and/or secrets mounted in the `config` volume

- [ ] `POST/PUT /cache/{key}` saves the posted content to Redis

- [ ] `GET /cache/{key}` returns the content from Redis if the key exists

- [ ] `DELETE /cache/{key}` deletes the key from Redis if exists

- [x] `POST /store` writes the posted content to disk at /data/hash and returns the SHA1 hash of the content

- [x] `GET /store/{hash}` returns the content of the file /data/hash if exists

- [ ] `GET /ws/echo` echos content via websockets `podcli ws ws://localhost:5000/ws/echo`

- [ ] `GET /chunked/{seconds}` uses `transfer-encoding` type `chunked` to give a partial response and then waits for the specified period

- [ ] `GET /swagger.json` returns the API Swagger docs, used for Linkerd service profiling and Gloo routes discovery