-
Notifications
You must be signed in to change notification settings - Fork 13
Restructure: Overview, Getting Started, Core Concepts > Protocol #292
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Restructure: Overview, Getting Started, Core Concepts > Protocol #292
Conversation
Release v2.1.14
Release v2.1.15
src/overview.md
Outdated
|
||
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 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
table not required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. Please check!
src/overview.md
Outdated
Jump to the [quickstart](./how-tos/quickstart/index.md) guide. | ||
::: | ||
|
||
## Who Zilla is for? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
move this after "Concepts", also if required rephrase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. Please check!
src/concepts/use-cases.md
Outdated
# 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can list these pre-curated examples: https://github.com/aklivity/zilla-examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. Please check!
src/concepts/use-cases.md
Outdated
### 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can simplify this, as for each protocol we have already listed these features.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. Please check!
src/getting-started/use-cases.md
Outdated
<div class="use_cases_cards"> | ||
<VPCard | ||
logo="/assets/icons/proxy.svg" | ||
title="HTTP Proxy Forwarding" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title="HTTP Proxy Forwarding" | |
title="HTTP Proxy" |
src/getting-started/use-cases.md
Outdated
/> | ||
<VPCard | ||
logo="/assets/icons/connecting kafka.svg" | ||
title="HTTP to Kafka CRUD" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title="HTTP to Kafka CRUD" | |
title="HTTP Kafka CRUD" |
src/getting-started/use-cases.md
Outdated
<div class="use_cases_cards"> | ||
<VPCard | ||
logo="/assets/icons/data governance.svg" | ||
title="MQTT Kafka Broker" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title="MQTT Kafka Broker" | |
title="MQTT Kafka Proxy" |
src/getting-started/use-cases.md
Outdated
/> | ||
<VPCard | ||
logo="/assets/icons/security.svg" | ||
title="MQTT Kafka Broker with JWT" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add mqtt.proxy.jwt
example reference, we have a zilla-examples
pr that will have this example.
/> | ||
</div> | ||
|
||
### For Kafka Services |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For Kafka Services add all the solutions mentioned here: https://docs.aklivity.io/zilla/latest/solutions/concepts/kafka-proxies/
src/getting-started/use-cases.md
Outdated
/> | ||
<VPCard | ||
logo="/assets/icons/connecting kafka.svg" | ||
title="gRPC Kafka Echo" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
src/getting-started/use-cases.md
Outdated
/> | ||
</div> | ||
|
||
## AsyncAPI Kafka Gateway |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add another for OpenAPI
with these examples:
https://github.com/aklivity/zilla-examples/tree/main/openapi.asyncapi.proxy
https://github.com/aklivity/zilla-examples/tree/main/openapi.proxy
src/getting-started/use-cases.md
Outdated
/> | ||
</div> | ||
|
||
## AsyncAPI Kafka Gateway |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## AsyncAPI Kafka Gateway | |
## AsyncAPI Proxy Gateway |
and mentioned these examples:
asyncapi.mqtt.proxy
asyncapi.sse.proxy
asyncapi.mqtt.kafka.proxy
asyncapi.http.kafka.proxy
src/concepts/protocol.md
Outdated
- Filesystem | ||
- gRPC | ||
- HTTP | ||
- Kafka | ||
- MQTT | ||
- SSE | ||
- TCP | ||
- TLS | ||
- WS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Filesystem | |
- gRPC | |
- HTTP | |
- Kafka | |
- MQTT | |
- SSE | |
- TCP | |
- TLS | |
- WS | |
- HTTP | |
- gRPC | |
- Kafka | |
- MQTT | |
- SSE |
Also, update the same in the sidebar as we discussed.
No description provided.