Restructure: Overview, Getting Started, Core Concepts > Protocol #292
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ankitk-me
requested changes
Feb 27, 2025
src/concepts/protocol/kafka.md
Outdated
|
|
||
| ### Key Concepts | ||
|
|
||
| - **Broker**: A Kafka server that stores data and serves clients. |
There was a problem hiding this comment.
We need to talk about Kafka Wire Protocol, instead of general Kafka concepts (broker, producer & consumers).
src/concepts/protocol/filesystem.md
Outdated
|
|
||
| ## Supported Features | ||
|
|
||
| 1. Basic Filesystem operations (CREATE, UPDATE, DELETE). |
There was a problem hiding this comment.
these are all the supported operations:
CREATE_DIRECTORY,
CREATE_FILE,
DELETE_DIRECTORY,
DELETE_FILE,
READ_DIRECTORY,
READ_FILE,
READ_FILE_CHANGES,
READ_METADATA,
WRITE_FILE;
|
|
||
| ## Security | ||
|
|
||
| ### HTTPS |
There was a problem hiding this comment.
I think we should approach/rephrase this differently. As this is more about mapping of http-filesystem binding.
Any insights? @jfallows
src/concepts/protocol/filesystem.md
Outdated
|
|
||
| During authentication, the client sends the token in the Authorization header with each request. The server then validates the token’s integrity and claims before granting access. | ||
|
|
||
| ## Zilla: HTTP Filesystem Use Cases |
There was a problem hiding this comment.
Zilla: Filesystem Use Cases, so that it's consistent with other pages.
src/concepts/protocol/http.md
Outdated
| - **HTTP/2** – Faster, multiplexed streams, header compression. | ||
| - **HTTP/3** (On the Roadmap) | ||
|
|
||
| ### Differences Between HTTP/1.1 and HTTP/2 |
src/concepts/protocol/kafka.md
Outdated
| - **Data Governance**: Validate message schemas with [Schema Registry](../../reference/config/catalogs/apicurio-registry.md) support. | ||
| - **Data Conversion**: Support data format conversion from one format to another. | ||
| - **Protocol Mapping**: Enable effortless communication with HTTP, WebSocket, and MQTT through native protocol integration. | ||
| - **Continuous Authorization**: Enforce continuous authorization with real-time Challenge events. |
There was a problem hiding this comment.
this Continuous Authorization doesn't seems required here.
src/concepts/protocol/tcp.md
Outdated
| 4. **Congestion Control** - TCP dynamically adjusts the data transmission rate based on network conditions. | ||
| 5. **Error Detection and Recovery** - TCP uses checksums to detect errors in transmitted data so that if an error is found, it triggers retransmission of the affected segment. | ||
|
|
||
|  |
src/concepts/protocol/tls.md
Outdated
|
|
||
|  | ||
|
|
||
| 1. **Encryption through TLS handshake** - The TLS handshake establishes a secure communication channel by negotiating encryption keys and cipher suites between the client and server. |
There was a problem hiding this comment.
Can we simplify these steps? As we have already captured the flow in the image.
src/concepts/protocol/ws.md
Outdated
|
|
||
| ### WS Communication Workflow | ||
|
|
||
|  |
There was a problem hiding this comment.
smaller image size, lets make it consistent with other pages.
|
|
||
|  | ||
|
|
||
| The WebSocket frame structure consists of several components: |
There was a problem hiding this comment.
above image should be enough, explanation can be simpler.
ankitk-me
requested changes
Mar 3, 2025
|
|
||
| Zilla is under the Aklivity Community License. This open-source license gives the freedom to deploy, modify, and run Zilla as needed, as long as it is not turned into a standalone commercialized “Zilla-as-a-service” offering. A commercial version of Zilla (<ZillaPlus/> “Zilla Plus”) is available, which includes additional enterprise integrations and support. For more information, please visit the [<ZillaPlus/>](https://www.aklivity.io/products/zilla-plus) product page. | ||
|
|
||
| | Capability | <ZillaPlus/> for Enterprise | Zilla Open Source | |
| Jump to the [quickstart](./how-tos/quickstart/index.md) guide. | ||
| ::: | ||
|
|
||
| ## Who Zilla is for? |
There was a problem hiding this comment.
move this after "Concepts", also if required rephrase.
| # Real-World Use Cases | ||
|
|
||
| Zilla can be used as a service proxy (sidecar) or as an [AsyncAPI](https://www.asyncapi.com/) Kafka gateway. | ||
|
|
There was a problem hiding this comment.
We can list these pre-curated examples: https://github.com/aklivity/zilla-examples.
Comment on lines
+15
to
+41
| ### For HTTP Services | ||
|
|
||
| - **Metrics and Telemetry:** Gather metrics and telemetry data on inbound and outbound traffic. | ||
| - **Client Authentication:** Implement JWT-based authentication. | ||
| - **Schema Enforcement:** Enforce OpenAPI and AsyncAPI schema on requests. | ||
|
|
||
| ### For SSE Services | ||
|
|
||
| - **Metrics and Telemetry:** Gather metrics and telemetry data on inbound and outbound traffic. | ||
| - **Client Authentication:** Implement JWT-based authentication. | ||
| - **Continuous Authorization:** Zilla supports Continuous Authorization, which gracefully re-authorizes a client on an SSE server's behalf without abruptly terminating message streams. For more information, read [this article](https://www.aklivity.io/post/a-primer-on-server-sent-events-sse#:~:text=Securing%20SSE%20with%20aklivity%20Zilla). | ||
| - **Schema Enforcement:** Enforce AsyncAPI schema definition on outbound messages. | ||
|
|
||
| ### For MQTT Services | ||
|
|
||
| - **Metrics and Telemetry:** Gather metrics and telemetry data on inbound and outbound traffic. | ||
| - **Client Authentication:** Implement JWT-based authentication. | ||
| - **Schema Enforcement:** Enforce AsyncAPI schema definition on outbound messages. | ||
|
|
||
| ### For Kafka Services | ||
|
|
||
| - **Metrics and Telemetry:** Gather metrics and telemetry data on inbound and outbound traffic on Kafka service in <ZillaPlus/>. | ||
|
|
||
| ### For gRPC Services | ||
|
|
||
| - **Metrics and Telemetry:** Gather metrics and telemetry data on inbound and outbound traffic. | ||
| - **Schema Enforcement:** Enforce Protobuf schema definition on inbound messages. |
There was a problem hiding this comment.
We can simplify this, as for each protocol we have already listed these features.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.