Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ghkdqhrbals/golang-backend-master

Backend bank server based on Gin framework with auto-configuring AWS and K8S.
https://github.com/ghkdqhrbals/golang-backend-master

aws-ec2 aws-ecr aws-eks aws-iam bcrypt docker gin git-workflow golang golang-migrate jwt kubernetes mock nginx sqlc viper

Last synced: 2 months ago
JSON representation

Backend bank server based on Gin framework with auto-configuring AWS and K8S.

Host: GitHub
URL: https://github.com/ghkdqhrbals/golang-backend-master
Owner: ghkdqhrbals
Created: 2022-05-21T04:36:21.000Z (over 2 years ago)
Default Branch: latest
Last Pushed: 2022-09-20T06:38:55.000Z (over 2 years ago)
Last Synced: 2024-09-30T07:21:33.613Z (3 months ago)
Topics: aws-ec2, aws-ecr, aws-eks, aws-iam, bcrypt, docker, gin, git-workflow, golang, golang-migrate, jwt, kubernetes, mock, nginx, sqlc, viper
Language: Go
Homepage:
Size: 11.8 MB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        [![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/golang-migrate/migrate/CI/master)](https://github.com/golang-migrate/migrate/actions/workflows/ci.yaml?query=branch%3Amaster)

[![GoDoc](https://pkg.go.dev/badge/github.com/golang-migrate/migrate)](https://pkg.go.dev/github.com/golang-migrate/migrate/v4)

[![Coverage Status](https://img.shields.io/coveralls/github/golang-migrate/migrate/master.svg)](https://coveralls.io/github/golang-migrate/migrate?branch=master)

[![packagecloud.io](https://img.shields.io/badge/deb-packagecloud.io-844fec.svg)](https://packagecloud.io/golang-migrate/migrate?filter=debs)

[![Docker Pulls](https://img.shields.io/docker/pulls/migrate/migrate.svg)](https://hub.docker.com/r/migrate/migrate/)

![Supported Go Versions](https://img.shields.io/badge/Go-1.16%2C%201.17-lightgrey.svg)

[![GitHub Release](https://img.shields.io/github/release/golang-migrate/migrate.svg)](https://github.com/golang-migrate/migrate/releases)

[![Go Report Card](https://goreportcard.com/badge/github.com/golang-migrate/migrate)](https://goreportcard.com/report/github.com/golang-migrate/migrate)

## Versions

Version | Skills | Done?

--------|------------|------

**[v1.1](https://github.com/ghkdqhrbals/simplebank/tree/1.1v)** | Postresq, migration, Testing_enviroments, Sqlc, Git-Workflow | :white_check_mark: |

**[v1.2](https://github.com/ghkdqhrbals/simplebank/tree/1.2v)** | __Gin__, __Viper__, __Gomock__, Postresq, migration, Testing_enviroments, Sqlc, Git-Workflow | :white_check_mark: |

**[v1.3](https://github.com/ghkdqhrbals/simplebank/tree/v1.3.1)** | __Bcrypt__, Gin, Viper, Gomock, Postresq, migration, Testing_enviroments, Sqlc, Git-Workflow | :white_check_mark: |

**[v1.4](https://github.com/ghkdqhrbals/simplebank/tree/v1.4.5)** | __Logger__, __NGINX__, __Kubernetes__, __AWS__, __JQ__, __Docker__, __JWT__, __PASETO__, Bcrypt, Gin, Viper, Gomock, Postresq, migration, Testing_enviroments, Sqlc, Git-Workflow | :white_check_mark: |

# Overview   

## How can we automatically deploy our service?

![Alt text](/image/deploy.jpg)

![example](image/ci-cd-deploy-example.jpg)

## We use AWS with following service

![Alt text](/image/aws-cloud.jpg)

## How can we safely store user password in RDS?

![Alt text](image/safe-password-storing.jpg)

## How can we handle multiple api request with asynchronous response?

![Alt text](image/api-multi-thread.jpg)

All Details and Studies in [wiki](https://github.com/ghkdqhrbals/simplebank/wiki)

## Update[v1.4.4]

* __Kubernetes Cluster 설정__

1. Set aws-ath.yaml to access AWS-EKS(with granted user)

2. Set deployment.yaml to get image from AWS-ECR and run with 2 replica(pod)

3. Set issuer.yaml to issue TLS certificate

    * get certificate from 'letsencrypt' with domain 'api.hwangbogyumin.com'(free)

4. Set ingress.yaml with Nginx ingress controller

    * request -> api.hwangbogyumin.com

    * api.hwangbogyumin.com -> aws-route-53 my arn

    * aws-route-53 my arn -> nginx-ingress address

    * nginx-ingress address -> ingress-service(TLS)

    * ingress-service ->> server pods(1,2)

* __AWS-Route-53에서 Domain 생성 및 Kubernetes Ingress-service pods 연결__

## Update[v1.4.3] 

* __Github action으로 자동 AWS docker image upload__

1. Set Configure AWS credentials

2. Add AWS_ACCESS_KEY_ID, KEY in Github Repositry secrets

    * __AWS-IAM__ secrets:AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY

3. Launch deploy action

    * Get secrets from Git and Access with token

    * Login

    * build images and Deploy to __AWS-ECR__ ap-northeast-2

* __AWS-ECR, AWS-Secrets Manager, AWS-IAM, AWS-RDS 추가__

1. Secrets Manager로 Paseto의 Payload를 encrypt/decrypt하는 symmetric_key 및 RDS port, RDS root, key 관리

2. Set IAM(Identity and Access Management) for safe AWS resource access

3. Set ECR(Elastic Container Registry) in ap-northeast-2

4. Set RDS(Relational Database Storage) in us-west-1, postgres12

* __JQ__

1. Get RDS informations and etc. from AWS secrets manager

2. Transform AWS secrets format into JSON format using JQ

3. Based on json data, set app.env with corresponding data

## Update[v1.4.2]

* __Dockerfile & Docker-compose 수정__

1. Set shell script(wait-for-it.sh) to wait until postgres is ready[Detail](https://github.com/peter-evans/docker-compose-healthcheck)

    * As we alpine image, 'apk add bash' needed

2. Set shell script(start.sh) to migrate db up

3. Edit Dockerfile to add needed files

    * migrate, app.env, main(object file), pre-setting shell script(wait-for-it.sh, start.sh)

4. Make docker-compose.yaml to specify services name and environment variables

## Update[v1.4.1]

* __Token Authentication Middleware 추가__

1. Set user.go/loginUser for create/verify TOKEN

2. Set Route(createAccounts, transferMoney, etc.) Group that need authorization.

3. Make authMiddleware for pre-check requests whether they have TOKEN for authorization

3. Edit api/server.go

    * Before get request, check and verify http header's authorized part.

    * If there is a TOKEN that server created, pass request to actual handler.

    * If no TOKEN exists, abort session and send response.

4. 위의 http통신은 TLS로 encrypt되었음을 가정한다. __[TLS Details](https://github.com/ghkdqhrbals/simplebank/wiki/ghkdqhrbals:SSL-TLS)__

    * TLS가 적용되지 않았으면 TOKEN가 탈취되었을 때, Server에 권한없이 RPC 통신하여 DB 탐색가능.

* __Testcase정의__

```

1. User -----      Login       --> Server    [LoginParams] = username, password

2. User <----      TOKEN       --- Server    [TOKEN] = chacha20poly1305(nonce, Server's Key, AEAD, Payload{username, duration})

3. User -----    CreateAccount --> Server    [Params] = currency, TOKEN

4. User <----  Account's Info  --- Server    [Account] = verifyToken(Server's Key, TOKEN)

```

## Update[v1.4.0]

* __JWT(JSON Web Token)의 HMAC-SHA256(HS256) algorithm를 통한 payload+header 'Encryption' and 'MAC' 생성__

1. Set secretKey as random 256 bits(As we use HS256, Key should be 256 bits) Temporary!

2. Make CreateToken function(interface)

    * ( [HEADER]:'alg:HS256,typ:jwt', [PAYLOAD]:'id:string, name:string, expiredAt:time', [SIGNATURE]:'HMAC([HEADER],[PAYLOAD]).TAG' )

3. Make VerifyToken function(interface)

    * Check HEADER, SIGNATURE, ...

4. Set test enviroments

    * case Invalid Header algorithm, MAC failed, Expiration, etc.

* __PASETO(Platform-Agnostic Security Tokens)의 chacha20Poly1305 algorithm를 통한 payload+header+nonce 'Encryption' and 'MAC' 생성__

1. Set secretKey as random 256 bits(As we use chacha20Poly1305, Key should be 256 bits) Temporary!

2. Make CreateToken function(interface)

3. Make VerifyToken function(interface)

4. Set test env.

## Update[v1.3.1]

* __User password의 Testcases 정의__

1. Set api/user_test.go TestCreateUserAPI test function

    * cases: "OK", "InternalError", "DuplicateUsername", "InvalidUsername", "InvalidEmail", "TooShortPassword"

2. Set Custom reply matcher(gomock)

## Update[v1.3.0]

* __Bcrypt로 사용자 PW 저장(Blowfish encryption algorithm)__([Detail](https://github.com/ghkdqhrbals/simplebank/wiki/ghkdqhrbals:bcrypt))

1. Set util/password.go using bcrypt which can randomly generate cost, salt to get hashed password with params

2. Set util/password_test.go for testing 

3. Make api/user.go to set createUser handler

4. Set routes("/user") for request from clients

## Update History

* __Gin으로 RPC 통신 추가 ([Details](https://github.com/ghkdqhrbals/simplebank/wiki/ghkdqhrbals:gin))__

1. Set router, routes

2. Set various handler

3. Get http request

4. Use custom validator to check if it is a valid request.

5. Binding JSON to STRUCT(request)

6. Access Local Database -> Execute transactions -> Get results(all process can handle with error)

7. Response

* __Viper으로 configuration 자동설정 ([Details](https://github.com/ghkdqhrbals/simplebank/wiki/ghkdqhrbals:viper))__

1. Set /app.env

2. Set /util/config.go

3. import configurations in /main.go

* __Gomock으로 서비스 레이어의 테스트에서 DB 의존성을 제거 ([Details](https://github.com/ghkdqhrbals/simplebank/wiki/ghkdqhrbals:mockdb))__

1. Use sqlc interface with all query functions to interface

2. Edit /.bash_profile for PATH to go/bin(to using mockgen)

3. Execute mockgen to generate mock functions

4. __Set APIs for testing(TestGetAccountAPI)__

## Notes

* go test -run "function name" -v(detaily describe) -cover(coverage)

__명령어는 Makefile에 정의__

__Work in VScode and Extensions below__

* [Go Coverage Viewer](https://marketplace.visualstudio.com/items?itemName=soren.go-coverage-viewer)

* [Go Extension Pack](https://marketplace.visualstudio.com/items?itemName=doggy8088.go-extension-pack)

* [Go Test Explorer](https://marketplace.visualstudio.com/items?itemName=premparihar.gotestexplorer)

* [Git Extension Pack](https://marketplace.visualstudio.com/items?itemName=donjayamanne.git-extension-pack)