Reorganize all runnable samples into Categories

[vordimous]

As a developer, I want an easy way to run different samples and use the code to configure my own usecases.

Acceptance criteria

• Single entry point to run all samples startup.sh
• Each sample shouldn't have extra complexity that distracts from the demonstrated use
• Each sample has a setup.sh and teardown.sh script that handles everything for the dev
• A sample should be testable via a test.sh script
• Sample variations are self contained and adjusted by changing profiles

Catagories

• Quickstart
  • Low barrier of entry, fast success, 5min proof of function
  • Used to confirm Zilla does work
  • hosted
• Cookbook
  • Teaching focused
  • Organized by use case
  • Exhaustive explanation
  • Used to guide
  • Variable backend vendors
  • Supports simple BYOK with feature flags and profiles
• Examples
  • Feature focused
  • Organized by function
  • Short copy & paste oriented
  • Used to add or troubleshoot features
  • Static backend vendors
  • BYOK requires manual editing of the example
• Demo
  • Show and Tell focused
  • End to End, Real world scenarios
  • Quick setup and walkthrough
  • Used to showcase multiple functions & use cases
  • hosted when possible

Quickstart

All resources in zilla-docs repo

• gRPC Kafka proxy
• HTTP Kafka proxy
• MQTT Broker Kafka proxy
• HTTP Kafka Async
• MQTT over WS

Cookbooks

All resources in zilla-docs repo

• Web Streaming
• gRPC service mesh
• Typed REST API
  • JSON-Avro
  • JSON-Proto
  • JSONSchema
• MQTT broker with WS
• JWT Authn with Keycloak
  • SSE JWT
  • HTTP JWT
  • MQTT JWT
  • WS
• K8s HA resources and autoscaling zilla-docs#259
• Kafka auth methods
  • Sasl/scram
  • Sasl/SSL
  • RP, CC clouds
  • Kafka APIs, (Warpstream, VoltDB, etc.)

Examples

All resources in zilla-examples repo

• Kafka mapping
  • REST Sync (crud)
  • REST Async
  • SSE
  • MQTT
  • gRPC
• Kafka Fanin/Fanout
  • Http oneway
  • SSE Fanout
  • gRPC oneway
  • gRPC Fanout
• Asycapi Kafka
  • REST Sync
  • REST Async
  • SSE
  • MQTT
• Kafka Schemas
  • Avro
  • JsonSchema
  • Transforms
• API gateway proxy
  • Schemas
    • Asycapi proxy
      • SSE
      • MQTT
    • OpenAPi proxy
  • HTTP proxy
  • gRPC proxy
• Filesystem
  • Web host
  • Config server
• Install on
  • Linux server
  • Helm with ingress
  • k8s autoscaling
  • ArgoCD
  • Portainer

Demos

All resources in zilla-demos repo

• MQTT
• gRPC
• Open/AsyncAPI
• Web

Extra

Evaluate for best fit

• .echo & .reflect examples
• http crud vs sync
• adding tls
• routing when not necessary

Tasks

• Convert all samples to use only docker compose or helm #149
• Move some examples to cookbooks and mange in the docs repo
  • MQTT broker
  • Quickstart
  • Kafka and RP sasl examples
• update the startup.sh script to pull from any repo that has sample artifacts