diff --git a/.config/vale/styles/Vocab/Base/accept.txt b/.config/vale/styles/Vocab/Base/accept.txt index e952903e..330287d7 100644 --- a/.config/vale/styles/Vocab/Base/accept.txt +++ b/.config/vale/styles/Vocab/Base/accept.txt @@ -29,6 +29,7 @@ (?i)middleware (?i)MSK (?i)namespace +(?i)nginx (?i)otlp (?i)overprovisioned (?i)param(s)? @@ -59,6 +60,7 @@ Aiven Aklivity alpn API(s)? +args async Avro Bidi @@ -133,5 +135,6 @@ WebSocket ws yaml Zilla +zlib zpm zpmw diff --git a/src/how-tos/quickstart/index.md b/src/how-tos/quickstart/index.md index 21d8ef3d..7e676fa5 100644 --- a/src/how-tos/quickstart/index.md +++ b/src/how-tos/quickstart/index.md @@ -18,8 +18,8 @@ Get started with Zilla by trying some of its Kafka proxying and API gateway feat This Quickstart is hosted at `quickstart.aklivity.io` meaning you can interact with it using any clients you prefer. The best way to experience the Zilla features in this Quickstart is by using the [Zilla Quickstart Postman Workspace](https://www.postman.com/aklivity-zilla/workspace/aklivity-zilla-quickstart/overview). -- A Postman [account](https://www.postman.com/postman-account/). -- The Postman [desktop client](https://www.postman.com/downloads/) to make MQTT and gRPC requests. +- The Postman [desktop client](https://www.postman.com/downloads/) to make MQTT and gRPC requests +- A Postman [account](https://www.postman.com/postman-account/) - Fork the Postman collections from the [Zilla Quickstart Workspace](https://www.postman.com/aklivity-zilla/workspace/aklivity-zilla-quickstart/overview) ## HTTP Kafka Proxy @@ -27,10 +27,10 @@ This Quickstart is hosted at `quickstart.aklivity.io` meaning you can interact w The Zilla HTTP Kafka Proxy lets you configure application-centric REST APIs and SSE streams that unlock Kafka event-driven architectures. 1. Fork the [HTTP Kafka proxy](https://www.postman.com/aklivity-zilla/workspace/aklivity-zilla-quickstart/overview) Postman collection. -1. Open the live [http-messages](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/http-messages/messages?limit=100&mode=TAILING) Kafka topic, which will have all the JSON messages you create. -1. Use the `Stream all messages` request to view messages fetched from a Kafka topic as a Server-sent Events (SSE) stream. SSE is a text stream over HTTP, meaning you can also open [the stream](http://quickstart.aklivity.io/api/stream) directly in a browser tab to see the raw output. +1. Open the live [http-messages](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/http-messages/messages?limit=100&mode=TAILING) Kafka topic, which will have all the JSON messages you create. +1. Open the live [API stream](https://quickstart.aklivity.io/api/stream) and scroll to the bottom to view messages fetched from a Kafka topic as a Server-sent Events (SSE) stream. SSE is a text stream over HTTP that directly shows the raw output in a browser tab. 1. Use the `Create a new message` request to update and submit the JSON in the `Body` tab. The new object will appear in the SSE stream and the Kafka topic. -1. Get your Kafka message key from the [http-messages](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/http-messages/messages) topic and use the `Get message by key` request to fetch only your message using your key in the `` path variable. +1. Get your Kafka message key from the [http-messages](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/http-messages/messages) topic and use the `Get message by key` request to fetch only your message using your key in the `` path variable. 1. To interact more with Zilla, use the `Additional features` in the Postman collection or copy the code samples. You can easily configure many common Restful actions with the added benefit of built-in streaming with an SSE endpoint. The `zilla.yaml` config has simple and clear syntax for defining each HTTP endpoint. @@ -140,12 +140,12 @@ Stream messages for a specific key published on a Kafka. The Zilla MQTT Kafka Proxy manages MQTT client connections and messages through Kafka topics. 1. Fork the [MQTT Kafka proxy](https://www.postman.com/aklivity-zilla/workspace/aklivity-zilla-quickstart/overview) Postman collection in the Postman Desktop client. -1. Open the live [mqtt-messages](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-messages/messages?limit=100&mode=TAILING) Kafka topic, which will have all of the MQTT messages sent to the broker. +1. Open the live [mqtt-messages](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-messages/messages?limit=100&mode=TAILING) Kafka topic, which will have all of the MQTT messages sent to the broker. 1. Connect to the broker with the `Pub/Sub` request. Send one of the saved messages, or you can send any message on any MQTT topic. Subscribe to topics in the **Topics** tab. 1. Observe the MQTT Broker messages on the Kafka topics with your message in the `body` and the MQTT topic as the `key`. 1. Connect to the broker with the `Simulator Topics` request to subscribe to the simulated messages being published to the broker. -A Zilla MQTT broker is defined using three specific Kafka topics. The [messages](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-messages/messages) Kafka topic will have all of the MQTT messages sent to the broker, where the MQTT topic is the Kafka message `key` and the MQTT payload is the Kafka message value. Marking messages with the `retain` flag set to true will produce a message on the [retained](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-retained/messages) Kafka topic. The [sessions](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-sessions/messages) Kafka topic is used to manage MQTT client connections. +A Zilla MQTT broker is defined using three specific Kafka topics. The [messages](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-messages/messages) Kafka topic will have all of the MQTT messages sent to the broker, where the MQTT topic is the Kafka message `key` and the MQTT payload is the Kafka message value. Marking messages with the `retain` flag set to true will produce a message on the [retained](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-retained/messages) Kafka topic. The [sessions](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/mqtt-sessions/messages) Kafka topic is used to manage MQTT client connections. ::: code-tabs#yaml @@ -174,7 +174,7 @@ A Zilla MQTT broker is defined using three specific Kafka topics. The [messages] The Zilla gRPC Kafka Proxy lets you implement gRPC service definitions from protobuf files to produce and consume messages via Kafka topics. 1. Fork the [gRPC Kafka proxy](https://www.postman.com/aklivity-zilla/workspace/aklivity-zilla-quickstart/overview) Postman collection in the Postman Desktop client. -1. Open the live [grpc-request](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/grpc-request/messages?limit=100&mode=TAILING&valueSerde=ProtobufDecodeRaw) and [grpc-response](http://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/grpc-response/messages?limit=100&mode=TAILING&valueSerde=ProtobufDecodeRaw) Kafka topics, which will have all of the service methods request and response messages respectively. +1. Open the live [grpc-request](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/grpc-request/messages?limit=100&mode=TAILING&valueSerde=ProtobufDecodeRaw) and [grpc-response](https://quickstart.aklivity.io/kafka/ui/clusters/zilla-quickstart-kafka/all-topics/grpc-response/messages?limit=100&mode=TAILING&valueSerde=ProtobufDecodeRaw) Kafka topics, which will have all of the service methods request and response messages respectively. 1. Invoke the `GetFeature` service method with the default message. 1. Observe the requested message payload on the Kafka topic followed by the response message with the `keys` having the same UUID. The gRPC method routing information is captured in the Kafka messages `header` values. 1. Try out the additional RPC method types in the Postman collection.