Gorush: A push notification server written in Go

* Why I create the Gorush Project?
* Detail implementation in Golang
* Testing and deploy Go project.
* Run Gorush in Kubernetes.

Transcript

1. A push notification server written in Go Gorush 1 Bo-Yi Wu Mopcon @ 2017.10.28
2. •Why I create the Gorush Project? •Detail implementation in Golang •Testing and deploy Go project. •Run Gorush in Kubernetes. 2 Outline
3. • Mediatek Engineer • DevOps • Golang, PHP, Node.js .. • Some open source • Gitea • Gin • Drone • appleboy @GitHub • appleboy @twitter • appleboy @slideshare • appleboy46 @facebook About Me 3
4. • drone/drone • go-gitea/gitea • gin-gonic/gin • appleboy/gorush Go Open Source in GitHub 4
5. • drone/drone • go-gitea/gitea • gin-gonic/gin • appleboy/gorush Go Open Source in GitHub 5
6. https://mcs.mediatek.com/ 6
7. Mediatek Cloud Sandbox Trigger Push Email hook MQTT TCP HTTP Mediatek Cloud Sandbox 7
8. Mediatek Cloud Sandbox Trigger Push Email hook MQTT TCP HTTP Mediatek Cloud Sandbox 8 Forcus on Push notification
9. https://github.com/appleboy/gorush Gorush 9
10. A general push notification server for smartphone application Gorush 10
11. •Written in Go •Push requests to APNs and FCM •Simple HTTP APIs (JSON) •RPC Protocol (gRPC) Gorush 11
12. Overview Client FCM APN s Gorush POST /push JSON Body HTTPS APNs Protocol 12
13. •System Requirement •Good Performance •High Concurrency •Simple net/http Package •Easy to Learn Why I Choose Go 13
14. https://github.com/golang/go/wiki/FromXToGo Why we switch 
 From XX to Go 14
15. https://github.com/golangtw/jobs Who use Go in Taiwan 15
16. 16 Push System Architecture
17. Before Seven years ago FCM APNs API Server API Server API Server PUSH 17
18. Before Two Years ago FCM APNs Worker Worker Worker PUSH Queue API API API de-queue Asynchronous Notification AWS en-queue 18
19. Nginx Traefik Now… FCM APNs Gorush Gorush Gorush PUSH API API API Http Post /push Gorush = Queue + Worker 19
20. How to implement simple notification service Gorush Architecture 20
21. How to send notification Client FCM APN s Gorush POST /push JSON Body HTTPS APNs Protocol 21
22. •Http Server •gRPC Server •Push API •Worker 22 Gorush Component
23. net/http + Gin Route+ Facebook Grace 23
24. Push API using Gin Framework 24
25. Initial Worker Queue 25
26. API Request and Response 26
27. Send notification to Queue 27
28. Start Worker 28
29. Gorush Major Feature 29
30. •GET /api/stat/go •GET /api/stat/app •GET /sys/stats •GET /metrics •POST /api/push •GET /healthz API List 30
31. GET /api/stat/go 31
32. GET /api/stat/app 32
33. GET /sys/stats 33
34. GET /metrics (Prometheus) 34
35. GET /metrics (Prometheus + Grafana) $ for i in {1..99999}; do bat -b.N=1000 -b.C=100 POST local:8088/api/push 35
36. GET /metrics (Prometheus + Grafana) 36
37. https://github.com/appleboy/gorush/#post-apipush POST /api/push 37
38. Push API Support Sync Mode Async vs. Sync Push 38
39. Notification Notification Notification Notification worker worker worker Client Notification worker WaitGroup 39
40. Notification Log Wait response Send to Work Queue 40
42. $ gorush Start Gorush Server 42
43. $ gorush –c config.yml Custom config file 43
44. $ GORUSH_CORE_PORT=8089 gorush Global Variable 44
45. • /etc/gorush/config.yml • $HOME/.gorush/config.yml • . (Current Folder) 45 Auto Load Config file
46. Server Confg Route Config 46
47. Server Config Route Config 47
48. 48 Go Support 
 Auto TLS Integrate Let's Encrypt
49. Autocert package in Go 49
50. Write one line code to support 
 renew Let’s Encrypt automatically https://goo.gl/pfeC5Q 50
51. Android Config iOS Config Log Config 51
52. Send Android Notification API Key From Request 52
53. iOS Support .p12, .pem or .p8 53 Supports new Apple Token Based Authentication (JWT)
54. Send iOS Notification 54
55. Success or fail records 55
56. memory, blotdb, buntdb, leveldb, redis Storage 56
57. Interface 57
58. Init Interface 58
59. package flg Send Notification 
 From CLI 59
60. Flag in Go 60
61. Flag doesn’t support 
 Global variable Docker Container 61
62. Configuration Management 62
63. $ gorush -android –m="message" -k="API Key" –t="token" Sned Android 63
64. $ gorush -ios -m="message" -i="certificate path" -t="token" -topic="topic" Send iOS 64
65. write once run anywhere Cross Platform 65
66. https://github.com/mitchellh/gox Simple Go Cross Compilation 66
68. https://github.com/facebookgo/grace Graceful restart & zero downtime 68
69. How to resolve this problem? Facebook Grace 
 doesn’t Support Windows 69
70. // +build windows https://golang.org/pkg/go/build/ Go build Flag 70
71. Build Binary into 
 Docker Container 71
72. Docker Multi-Stage Build 72
73. 
 Build small image using docker multi-stage $ docker build -t appleboy/gorush . https://goo.gl/zQbhmu 73
74. Auto testing and deploy in GO 74
75. Drone 75
76. Continuous Delivery system built on container technology What is Drone? 76
77. How to setup 
 deploy process? 77 Using .drone.yml file
78. Git Test Release Docker Notify How to build Go binary in Drone 78
79. • Testing Code • Analytic Code • Code Quality • Build Binary • Deploy Binary • Build Docker Image • Deploy Docker Container • Send Notification Pipeline Process in Go 79
80. Git Test Release Docker Notify How to build Go binary in Drone 80
81. First Step: Git Clone 81
82. Git Test Release Docker Notify How to build Go binary in Drone 82
83. Choose Image Testing Process 83
84. Code Quality in Go (golint) 84
85. Check comment typos (Misspell) 85
86. Check code format in Go (gofmt) 86
87. Check vendor folder (govendor) 87
88. Testing in Go $ coverage all https://github.com/appleboy/golang-testing 88
89. Git Test Release Docker Notify How to build Go binary in Drone 89
90. Choose Image Step Name Run on for Git tag event 90
91. Build binary for Cross Platform (gox) 91
92. Deploy to GitHub Release Page 92
93. Git Test Release Docker Notify How to build Go binary in Drone 93
94. Drone Envars Drone Secrets Plugin Image 94
95. Git Test Release Docker Notify How to build Go binary in Drone 95
96. Plugin Image Push Notification From FB Bot 96
97. Happy Coding 97
98. Run Gorush in Kubernets 98
99. 99 Container Health Check
100. 100 Global Configuration Map
102. $ kubectl create -f k8s $ kubectl get services $ minikube service frontend Three Steps 102
103. Interesting In Drone http://bit.ly/devops-drone 103
104. Thanks All coming. Any Problem? 104