APIs for Data-in-Motion

Getting Started

• 1

  Start Zilla

  Get started by either running pre-configured Zilla examples or docker pull and create your ownconfiguration using Zilla Studio.

  $ docker pull ghcr.io/aklivity/zilla
  
• 2

  Connect your Kafka

  Connect Zilla to your open source or vendor Kafka over PLAINTEXT or TLS/SSL (client certificates supported). Once your Kafka is added to the configuration, declare the Kafka services you want to Zilla to interface.

  zilla.json

  {
   "bindings":{
     ...
     "kafka_client0":{
       "type": "kafka",
       "kind": "client",
       "exit": "tcp_client0"
     },
     "tcp_client0":{
       "type": "tcp",
       "kind": "client",
       "options":{
         "host": "YOUR_KAFKA_HOSTNAME",
         "port": YOUR_KAFKA_PORT
        },
        "routes":[
          {
           "when":[{
             "cidr": "0.0.0.0/0"
            }]
           }
         ]
       }
     }    
  }

  
• 3

  Configure & Secure API endpoints

  Configure an idempotent REST API that supports HTTP request-response interactions with a Kafka service. Then set up a Server Sent Events (SSE) endpoint to reliably stream the service’s snapshots and events across the web. Wrap everything up by securing your REST and SSE endpoints with JWT access tokens. Continue exploring the docs ➔

  zilla.json

  HTTP

  SSE

  {
   "bindings":{
     ...
     "http_kafka_proxy0":{
       "type": "http-kafka",
       "kind": "proxy",
       "routes":[
         {
          "when":[{
             "method": "POST",
             "path": "/YOUR_API"
          }],
          "exit": "kafka_cache_client0",
          "with":{
             "capability": "produce",
             "topic": "COMMANDS_KAFKA_TOPIC",
             "key": "${params.id}",
  ‍           "reply-to": "REPLIES_KAFKA_TOPIC",
               "overrides":{
                 "zilla:domain-model": "CREATE"
               }
           }‍
         },{
          "when":[{
             "method": "DELETE",
             "path": "/YOUR_API"
          }],
          "exit": "kafka_cache_client0",
          "with":{
             "capability": "produce",
             "topic": "COMMANDS_KAFKA_TOPIC",
             "key": "${params.id}",
  ‍           "reply-to": "REPLIES_KAFKA_TOPIC",
               "overrides":{
                 "zilla:domain-model": "DELETE"
               }
           }‍
         },
         ...
        ]
      }
    }    
  }

  {
   "bindings":{
     ...
     "sse_kafka_proxy0":{
       "type": "sse-kafka",
       "kind": "proxy",
       "routes":[
         {
          "when":[{
             "path": "/YOUR_API"
          }],
          "exit": "kafka_cache_client0",
          "with":{
             "topic": "SNAPSHOTS_KAFKA_TOPIC",
             "event":{
  ‍             "id": "[\"${base64(key)}\",\"${etag}\"]"
              }
            }
         }
        ]
      },
      ...
    }    
  }