How we are maintaining ProtoBuf (Protocol Buffers) at Nuclei

How we are maintaining ProtoBuf (Protocol Buffers) at Nuclei!

We at Nuclei, welcome the latest technologies in our stack. We have our Micro Services in Java and Go Lang. I as a Full Stack Developer got an opportunity to completely build this system for us.

GitHub Actions + GitHub Package Registry + gRPC

Problems which our solution solved!

  1. Getting Go and Java artifacts at a swoosh
  2. Cost effective practice
  3. Robust Architecture
  4. Managing protocol buffer definitions at ease
  5. Generating the appropriate language files from the definitions
  6. Following Semantic Versioning along with Pre-Releases.

Challenges we faced.

Managing proto files is a cumbersome task for both the user and the creator of the proto. Distributing it in a cost effective yet efficient method was another big task. Using JFrog Artifactory with Jenkins needed separate server to host.

How We Manage Protocol Buffer Files.

We have a monorepo known as Protorepo where we keep our latest protocol buffer files.

How do we build the Java and Go Lang code?

We are using GitHub Actions + GitHub Package Registry. When one creates a new release. Let’s say version V1.0.0. It triggers our GitHub Action which generates GitHub Packages (Artifacts for Java) available for the other projects and it even pushes new releases with same versions for Go Lang according to the project name.

How do we pull dependencies?

For java β†’

json
1plugins {
2 id("maven-publish")
3 }
4
5 publishing {
6 repositories {
7 maven {
8 name = "GitHubPackages"
9 url = uri("https://maven.pkg.github.com/USERNAME/URL")
10 credentials {
11 username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
12 password = project.findProperty("gpr.key") ?: System.getenv("PASSWORD")
13 }
14 }
15 }
16 publications {
17 gpr(MavenPublication) {
18 from(components.java)
19 }
20 }
21 }

For Go β†’

markup
1go get <URL of the release>

How helpful it is?

  1. We are able to generate 30+ artifacts for Go as well as Java in less than 3 minutes.

  2. Building code and shipping it was never so quick and easy for us.

  3. All our Development Operations become even more easier.

  4. GitHub gives us storage and CI & CD minutes in our team plan, so why not use it.

  5. Data is safe and secured.

Future Scope

Implementing Chat-Ops with HuBot.

Tags:

grpc

protobuf

❀
Share article
Piyush Mehta Β© 2020