sentenza/cats-http4s-crypto

:moneybag: A sample microservice written in Scala using Cats, HTTP4S, Doobie that implements an application to compute Crypto/Fiat currency conversion rates

cats-http4s-crypto's Issues

Define Kubernetes liveness and readiness HTTP probes

Readiness

Readiness probes are designed to let Kubernetes know when your app is ready to serve traffic. Kubernetes makes sure the readiness probe passes before allowing a service to send traffic to the pod. If a readiness probe starts to fail, Kubernetes stops sending traffic to the pod until it passes.

Liveness

Liveness probes let Kubernetes know if your app is alive or dead. If you app is alive, then Kubernetes leaves it alone. If your app is dead, Kubernetes removes the Pod and starts a new one to replace it.

GCP GKE Kubernetes Readiness/Liveness probes

k8s liveness probe

Routes and their definition

GET -> "/h/healthz" ==> 200 text/plain  // Liveness probe
GET -> "/h/ready"   ==> 200 text/plain  // Readiness probe

# pods/probe/http-liveness.yaml
apiVersion: v1
kind: Pod
metadata:
  labels:
    test: liveness
  name: liveness-http
spec:
  containers:
  - name: liveness
    image: k8s.gcr.io/liveness
    args:
    - /server
    livenessProbe:
      httpGet:
        path: /healthz
        port: 8080
        httpHeaders:
        - name: Custom-Header
          value: Awesome
      initialDelaySeconds: 3
      periodSeconds: 3

Add doobie and flyway support

Description

Add flyway to handle database migrations and doobie to interact with RDBMS.

Acceptance criteria

• Check that ...
• Check that ...

Tasks

• H2 in-memory relational database
• Flyway migrations
• doobie
• Testcontainers for test support

Dataset needed for testing

TODO: adding the schema of the first table that will describe Cryptocurrencies/USD rates

Technical & Architecture Design

Describe Cryptocurrencies

At the very least add:

• name
• symbol
• exchange rate

Also map the first 15 cryptocurrencies using Enumeratum

Example of a JSON representation of a single crypto asset

{

    "id": 1,
    "name": "Bitcoin",
    "symbol": "BTC",
    "slug": "bitcoin",
    "is_active": 1,
    "is_fiat": 0,
    "circulating_supply": 17199862,
    "total_supply": 17199862,
    "max_supply": 21000000,
    "date_added": "2013-04-28T00:00:00.000Z",
    "num_market_pairs": 331,
    "cmc_rank": 1,
    "last_updated": "2018-08-09T21:56:28.000Z",
    "tags": [
        "mineable"
    ],
    "platform": null,
    "quote": {
        "USD": {
            "price": 6602.60701122,
            "volume_24h": 4314444687.5194,
            "percent_change_1h": 0.988615,
            "percent_change_24h": 4.37185,
            "percent_change_7d": -12.1352,
            "percent_change_30d": -12.1352,
            "market_cap": 852164659250.2758,
            "market_cap_dominance": 51,
            "fully_diluted_market_cap": 952835089431.14,
            "last_updated": "2018-08-09T21:56:28.000Z"
        }

Example taken from CoinMarketCap Quotes/latest API

Describe main FIAT currencies in domain

Add major FIAT currencies in the domain (using squants):

• CHF
• CNY
• EUR
• USD

Basic structure

• Create the essential project structure
• Add the missing essential documentation

Add coveralls support

Add and configure sbt-coveralls