batazor/shortlink-metadata repository overview

⁠shortlink

Shortlink service

⁠High Level Architecture

⁠Architecture (miro.com)

• Low-level schema⁠

⁠Requirements

• docker
• docker-compose
• protoc 3.7.1+
• ansible
• ansible-galaxy

⁠Services

⁠Run

make run

⁠Kubernetes

make minikube-up
make helm-shortlink-up

⁠DNS/HTTP

services:

• ui-nuxt.local
• shortlink.local

Add 127.0.0.1 [name services].local to your /etc/hosts

⁠HTTP API

• Import Postman link⁠ for test HTTP API
• Swagger docs⁠

⁠Support HTTP REST API:

• HTTP (chi)
• gRPC-gateway
• GraphQL
• Optional
  • go-kit
  • CloudEvents⁠

⁠MQ

• Kafka⁠
• NATS
• RabbitMQ

⁠Store provider

• RAM
• MongoDB
• Postgres
• Optional
  • Redis
  • MySQL
  • LevelDB
  • Badger
  • SQLite
  • Scylla
  • Сassandra (via: Scylla driver)
  • RethinkDB
  • DGraph

⁠Cloud-Native

• Logger
  • Loki⁠
  • DataDog
• Prometheus
  • prometheus-operator
    • notify: slack, email, telegram
• HealthCheck
• Support K8S
  • Helm Chart
    • pingcap/chaos-meshh⁠
  • Minikube
  • Backup/Restore (Velero⁠
  • Custom CSI driver (fork csi-driver-host-pat⁠)
• Istio
• MetalLB
• kyverno⁠ - Kubernetes Native Policy Management

⁠Gateway

• Traefik
• Nginx

⁠UI service

• Landing: demo UI⁠
• Nuxt: demo UI⁠
• Next: ddemo UI⁠

⁠ENV for UI

Use .env file in pkg/ui/[nuxt/next/etc] directories for setting your UI

⁠UI Screenshot

Describe	Screenshot
Link Table

⁠Mobile

• Hello World on flutter ;-)

⁠Configuration

⁠CoreDNS IP table

⁠troubleshooting

Sometimes a container without a specified ip may occupy a binding address of another service, which will result in Address already in use.

⁠Ansible

cd ops/vagrant
vagrant up

cd ops/ansible
ansible-playbook playbooks/playbook.yml

⁠Kubernetes

⁠GITLAB CI

⁠GitLab Variable

• SURGE_LOGIN
• SURGE_TOKEN
• DANGER_GITLAB_API_TOKEN - API TOKEN for danger

⁠Support environment

• Minikube
• Yandex Cloud⁠
• AWS EKS⁠

⁠GitHub CI

• Travis action (backend/frontend)
• Docker action
• Helm chart

⁠Error code⁠

⁠-- THE END --