moabu / favorite-tree Goto Github PK

General Spec

Add a new webservice that runs in k8 and returns the users favorite tree.

To-dos:

• Create Flask API that returns the users favorite tree with best practices in mind:
  - Use poetry
  - Use Gunicorn
  - Use tox
  - Write unit-tests PARTIALLY IMPLEMENTED
  - Containerize by writing a Dockerfile with an entrypoint
  - minimize image NOT IMPLEMENT
  - Run vulnerability and static scan checks NOT IMPLEMENT
  - Follow OpenAPI and generate swagger
  - Generate ERD diagram
  - Abstract config
  - Use models, extensions and add ability for extending the API and its versioning
  - Seed initial data
  - Create folder blueprint for visibility
  - Write Readme

• Create docker compose deployment

• Create helm chart

• Create helm docs

• Create helm values schema

• Create helm test cases NOT IMPLEMENTED

• Add automation simple deploy script with microk8s

• Add analyze and report script

• Create Github Action for running docker-compose

• Create GitHub action for running helm on microk8s

• Create GitHub action to run unit tests

• Create GitHub action (runs terraform) to publish private image and further activate the helm deployment upon PR merges NOT IMPLEMENTED

• Create Terraform module for controlling the infrastructure fully NOT IMPLEMENTED FULLY.
  - Get k8s config
  - Execute helm deploy for cert-manager issuer chart
  - Execute helm depoy for the favorite tree API
  - Create S3 bucket versioning enabled
  - Auto set Routr53 record from the ingress object
  - Helm deploy nginx ingress. Although we are assuming this is already installed.
  - Deploys ELK and integrates the API with it
  - Deploys live error debug

• Create cert manager helm chart for the favorite Tree API Issuer using the http01 challenge

• Create arch deployment diagram

• Implement Istio mesh - NOT IMPLEMENTED

• Write main Readme