CLI, SDK, Doc... What if we generate them?
0 likes147 views
This document discusses generating developer tools from a single source of truth (SSOT) specification. It proposes using Protocol Buffers (Protobuf) and an interface description language as the SSOT, and generating documentation, SDKs, CLIs and other tools using code generators from the SSOT. Specific generators and tools that could be generated are listed. The benefits of this approach are standardized, consistent tools that are easy to maintain and release.
CLI, SDK, Doc... What if we generate them?
- 2. Quentin Brosse DEVOPS ENGINEER, API Gateway - Dev tools CLI, SDK, Doc… What if we generate them? Olivier Cano DEVOPS ENGINEER, API Gateway - Dev tools
- 3. Our mission
- 4. API Gateway & Dev tools High Availability Routing cross-region Monitoring Tracing Dev tools API Gateway
- 6. Works well at small scale
- 8. 54 services
- 9. 11 methods
- 10. 7 fields
- 11. 54 services 580 methods 4 293 fields
- 13. How to scale better?
- 15. Define a Single Source Of Truth (SSOT)
- 17. • Sync releases • Short time-to-market • Ease to patch • Cross-team standardization BENEFITS
- 18. Step 1: choose a SSOT
- 19. Interface Description Language Specification language used to describe a software component's application programming interface (API).
- 20. INTERFACE DESCRIPTION LANGUAGE Apache Thrift
- 21. • Easy to read • Typed language • Growing ecosystem for code generation • Used by major companies (Google, Twitter, …) • High performance API with GRPC PROTOBUF
- 22. Serialization Framework :method: POST :path: /greeter.Api/SayHello content-type: application/grpc 0x78 0x67 0x68 0x5A 0x9A . . .
- 23. Serialization Framework :method: POST :path: /greeter.Api/SayHello content-type: application/grpc 0x78 0x67 0x68 0x5A 0x9A . . .
- 24. package greeter; service Api { rpc SayHello (HelloRequest) returns (HelloReply) {} } message HelloRequest { string name = 1; } message HelloReply { string message = 1; } PROTOBUF
- 27. Doc SDK CLI GENERATED DEVELOPER TOOLS GRPC Gateway
- 28. GENERATED DEVELOPER TOOLS GRPC Gateway Doc SDK CLI
- 29. REST vs gRPC
- 32. GENERATED DEVELOPER TOOLS GRPC Gateway Doc SDK CLI
- 34. • Description • Required / Optional field • Versions • Public / Private • Errors • … MISSING DATA
- 35. package: greeter services: Api: title: Greeter API version: v1 short: The Scaleway Greeter API long: Say hello to Scaleway people! 👋 methods: Greeter: short: say hello ! messages: HelloRequest: fields: name: short: the name required: true SERVICE CONFIG
- 36. GENERATED DEVELOPER TOOLS GRPC Gateway Doc SDK CLI
- 39. GENERATED DEVELOPER TOOLS Doc CLISDKGRPC Gateway
- 43. $ scw k8s create cluster
- 44. SSOT GENERATORS PROJECTS Protobuf Repository protoc protoc-gen-go protoc-gen-python protoc-gen-grpc-gateway protoc-gen-openapi protoc-gen-sdk-go protoc-gen-cli CLI Developers Website SDK Go GRPC Client GRPC Client GRPC Gateway Internal
- 45. Let’s generate (more) stuff! 🙌
- 46. 245, 328 generated lines 20, 847 handwritten lines
- 47. MERCI Suivez notre actualité, tutoriels inédits et infos cloud sur Twitter et LinkedIn @Scaleway Et suivez-nous sur Twitter @QuentinBrosse & @kindermoumoute