https://github.com/sloppycoder/bank-demo
demo banking application written using gRPC microservices
https://github.com/sloppycoder/bank-demo
distributed-tracing gke golang grpc istio java kuber micronaut micronaut-grpc microservices-architecture opencensus python
Last synced: 2 days ago
JSON representation
demo banking application written using gRPC microservices
- Host: GitHub
- URL: https://github.com/sloppycoder/bank-demo
- Owner: sloppycoder
- Created: 2020-06-11T20:04:19.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-08T01:53:46.000Z (almost 3 years ago)
- Last Synced: 2023-02-27T23:02:09.530Z (over 2 years ago)
- Topics: distributed-tracing, gke, golang, grpc, istio, java, kuber, micronaut, micronaut-grpc, microservices-architecture, opencensus, python
- Language: Go
- Size: 3.99 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A modern microservice based application
This is a demo banking applicaiton built around modern technolgies. The key pillars of this application are:
* Self-contained [microservices](https://microservices.io/patterns/microservices.html) deployed into [Kubernetes](https://kubernetes.io)
* [Polyglot](https://en.wikipedia.org/wiki/Polyglot_(computing)) applicatoin with microservices written in different languages and communicate with each other over standard network protocols.
* Every microservice supports observability with metrics and distributed tracing. Use [opencensus](https://opencensus.io/) and [Prometheus](https://prometheus.io/) to be compatbile with both on-premise stack with [Jaeger](https://www.jaegertracing.io/), [Prometheus](https://prometheus.io/) and [Elastic](https://www.elastic.co/); or [Stackdriver](https://cloud.google.com/products/operations) in GCP.
* Use [Istio](https://istio.io) service mesh to perform traffic management within and inter kubernetes clusters
* High performance inter microservice communication with [gRPC](https://grpc.io). The gRPC services can be directly exposed to external client or use [Envoy gRPC-Web filter](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/grpc_web_filter) for clients that do not support HTTP/2 natively.
## Modules in this repo
| Directory | Language | Conent |
| ------------- |-------------|-------------|
| [protos](protos) | protobuf | protobuf API definition used in all across the application. |
| [dashboard](dashboard) | Go | dashboard microservice, calls casa-account services, either v1 or v2, controlled by [istio virtualservice](https://istio.io/latest/docs/reference/config/networking/virtual-service/) configuration |
| [customer-v1](customer-v1) | Java | customer microservice built using spring boot. It reads customer data stored in MySQL |
| [casa-account-v1](casa-account-v1) | Java | casa account microservice built using [micronaut](https://micronaut.io/) framework. It reads account data stored in Cassandra |
| [casa-account-v2](casa-account-v2) | nodejs | casa account microservice, only returns dummy data. |
| [ext-cust-svc](ext-cust-svc) | python | a simple http server written using [aiohttp](https://docs.aiohttp.org/en/stable/#) to mock an external REST server that provides customer info |
| [load-generator](load-generator) | python | uses [Locust](https://locust.io/) to generate API calls |
| [testdata](testdata) | python | generates test data and write them to Cassandra |
| [istio](istio) | yaml | istio manifest files to traffice management |
| [gcp](gcp) | shell | script and manifests to provision GKE cluster. |
### Requirement
The code in this repo has been tested with minikube and GKE. Details below
Local Minikue
* Ubuntu Linux 20.04
* [minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/) v1.11.0
* Kubernetes 1.16.8
* Istio 1.4.8
* [Apache Cassandra](https://cassandra.apache.org/) version 4.0.0
Google Kubernetes Engine
* Kubernetes provisioned using [regular channel provided by GKE](https://cloud.google.com/kubernetes-engine/docs/release-notes-regular), v1.16.8-gke.15 as of now
* Istio is provisioned as a feature of GKE cluster, 1.4.6-gke.0 as of now
* [Datastax Astra](https://www.datastax.com/products/datastax-astra) running in GCP
Development Tools:
* [kustomize](https://github.com/kubernetes-sigs/kustomize) 3.5.4
* [skaffold](https://skaffold.dev) v1.10.1
### Run with minikube
Below are steps tesed on Ubutnu Bionic and Focal, should work on other linux flavors too.
Get prerequites first
1. [Install minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
2. Download Istio from 1.4.8 from [Istio release pages from Github](https://github.com/istio/istio/releases/)
3. [Install Skaffold](https://skaffold.dev/docs/install/)
4. Get Evans gRPC utility from [Github release pages](https://github.com/ktr0731/evans/releases)
first, then
```
#
# the k8s and istio versions below matches to versions in GKE's regular channel
#
# start minikube. for
minikube start \
--driver=kvm2 \
--disk-size='30000mb' \
--cpus='2' \
--memory='12000mb' \
--kubernetes-version='1.16.8'
# install istio with auto mTLS enabled
cd istio-1.4.8
bin/istioctl manifest apply --set profile=demo \
--set values.global.mtls.auto=true \
--set values.global.mtls.enabled=true
# istio takes sometime to get installed, wait till all the
# pods are in Running status
# expose port 31400 for use grpc services
# this port is enabled on GCP and later versions of Istio
kubectl patch svc istio-ingressgateway -n istio-system \
--type='json' \
-p='[{"op":"add","path":"/spec/ports/0", value: {"name": "tcp", "port":31400,"targetPort":31400, "protocol":"TCP"}}]'
#
# come back to this directory and run all the services
# the script should build and start microservices
./deploy
# if all goes well, you should see output similiar to the one below
{
"customer": {
"customerId": "10001000",
"loginName": "10001000"
}
}
```
### Roadmap
1. better integration of logging and tracing. ability to navigate from trace to log with high accuracy. (implemeneted logic for adding data to trace span, and use custom data, e.g. login_name to search trace span. same custom data is added to log entries)
2. use an external OpenID Connect provide for authentication.
3. enable mTLS for inter microservice communication. (done)
4. use Istio for oauth token validation