Skip to content

update example names #273

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

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/.vuepress/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -435,15 +435,15 @@ export const enSidebar = sidebar({
},
{
text: "Add JWT auth to MQTT",
link: "https://github.com/aklivity/zilla-examples/tree/main/mqtt.kafka.broker.jwt",
link: "https://github.com/aklivity/zilla-examples/tree/example-startup-compose/mqtt.jwt",
},
{
text: "Add JWT auth to REST",
link: "https://github.com/aklivity/zilla-examples/tree/main/http.echo.jwt",
link: "https://github.com/aklivity/zilla-examples/tree/example-startup-compose/http.jwt",
},
{
text: "Add JWT auth to SSE",
link: "https://github.com/aklivity/zilla-examples/tree/main/sse.proxy.jwt",
link: "https://github.com/aklivity/zilla-examples/tree/example-startup-compose/sse.jwt",
},
],
},
Expand Down
4 changes: 2 additions & 2 deletions src/concepts/catalogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ catalogs:

The simplest catalogs allow Zilla to access resources directly. The [filesystem](../reference/config/catalogs/filesystem.md) catalog will look for resources on the host filesystem. To embed a resource directly into the Zilla config yaml an [inline](../reference/config/catalogs/inline.md) catalog can be used to define any text based resource.

> [Local Catalogs Guide](../how-tos/catalogs/index.md#local-catalogs) | [http.proxy.schema.inline example](https://github.com/aklivity/zilla-examples/tree/main/http.proxy.schema.inline)
> [Local Catalogs Guide](../how-tos/catalogs/index.md#local-catalogs) | [http.json.schema example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/http.json.schema)

## Remote Catalogs

Zilla can reference remote configs stored in third-party services like Schema Registry. The [schema-registry](../reference/config/catalogs/schema-registry.md) and [apicurio-registry](../reference/config/catalogs/apicurio-registry.md) catalogs allow zilla to interact with those services through their admin APIs.

> [Remote Catalogs Guide](../how-tos/catalogs/index.md#remote-catalogs) | [Apicurio in the Petstore REST Demo](https://github.com/aklivity/zilla-demos/tree/main/petstore) | [http.kafka.karapace example](https://github.com/aklivity/zilla-examples/tree/main/http.kafka.karapace)
> [Remote Catalogs Guide](../how-tos/catalogs/index.md#remote-catalogs) | [Apicurio in the Petstore REST Demo](https://github.com/aklivity/zilla-demos/tree/main/petstore) | [http.kafka.avro.json example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/http.kafka.avro.json)
4 changes: 2 additions & 2 deletions src/concepts/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ model: string
encoding: utf_8
```

> [Validating message keys](../how-tos/models/index.md#validating-message-keys) | [http.proxy.schema.inline example](https://github.com/aklivity/zilla-examples/tree/main/http.proxy.schema.inline)
> [Validating message keys](../how-tos/models/index.md#validating-message-keys) | [http.json.schema example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/http.json.schema)

## Schema Models

Expand Down Expand Up @@ -44,4 +44,4 @@ Schema-based models will reference a [catalog](./catalogs.md) to supply the bind
- id: 42
```

> [Validating a new message](../how-tos/models/index.md#validating-a-new-message) | [Expose a different model format](../how-tos/models/index.md#expose-a-different-model-format) | [http.kafka.karapace example](https://github.com/aklivity/zilla-examples/tree/main/http.kafka.karapace)
> [Validating a new message](../how-tos/models/index.md#validating-a-new-message) | [Expose a different model format](../how-tos/models/index.md#expose-a-different-model-format) | [http.kafka.avro.json example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/http.kafka.avro.json)
6 changes: 3 additions & 3 deletions src/concepts/spec-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ You can see a working [Petstore Demo](https://github.com/aklivity/zilla-demos/tr

Zilla implements the RESTful APIs defined in the [openapi](../reference/config/bindings/openapi/) binding. A REST Kafka proxy is defined using the [openapi-asyncapi](../reference/config/bindings/openapi-asyncapi/) binding. The Kafka configuration is defined with an [asyncapi](../reference/config/bindings/asyncapi/README.md) `client` binding.

> [Petstore REST demo](https://github.com/aklivity/zilla-demos/tree/main/petstore) | [Taxi Hailing demo](https://github.com/aklivity/zilla-demos/tree/main/taxi) | [openapi.proxy example](https://github.com/aklivity/zilla-examples/tree/main/openapi.proxy)
> [Petstore REST demo](https://github.com/aklivity/zilla-demos/tree/main/petstore) | [Taxi Hailing demo](https://github.com/aklivity/zilla-demos/tree/main/taxi) | [openapi.proxy example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/openapi.proxy)

### AsyncAPI

Zilla implements Event-Driven APIs defined in the [asyncapi](../reference/config/bindings/asyncapi/) binding. A Kafka proxy is defined using the [asyncapi](../reference/config/bindings/asyncapi/) `proxy` binding. The Kafka configuration is defined with an [asyncapi](../reference/config/bindings/asyncapi/README.md) `client` binding.

> [Taxi Hailing demo](https://github.com/aklivity/zilla-demos/tree/main/taxi) | [asyncapi.http.kafka.proxy example](https://github.com/aklivity/zilla-examples/tree/main/asyncapi.http.kafka.proxy) | [asyncapi.mqtt.kafka.proxy example](https://github.com/aklivity/zilla-examples/tree/main/asyncapi.mqtt.kafka.proxy) | [asyncapi.sse.kafka.proxy example](https://github.com/aklivity/zilla-examples/tree/main/asyncapi.sse.kafka.proxy)
> [Taxi Hailing demo](https://github.com/aklivity/zilla-demos/tree/main/taxi) | [asyncapi.http.kafka.proxy example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/asyncapi.http.kafka.proxy) | [asyncapi.mqtt.kafka.proxy example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/asyncapi.mqtt.kafka.proxy) | [asyncapi.sse.kafka.proxy example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/asyncapi.sse.kafka.proxy)

## Protobuf

The Zilla gRPC Kafka Proxy lets you implement gRPC service definitions from protobuf files to produce and consume messages via Kafka topics.

Zilla can be the gRPC server, routing a service method's request and response messages to and from Kafka topics, or Zilla can fanout messages from a Kafka topic to multiple gRPC clients using the [grpc-kafka](../reference/config/bindings/grpc-kafka/) and [kafka-grpc](../reference/config/bindings/kafka-grpc/) bindings in a [zilla.yaml](../reference/config/overview.md) config. Additionally, Zilla can sit on the critical path between a gRPC client and a server. They can communicate as if they are talking directly to each other, while Zilla actually proxies the messages through Kafka.

> [grpc.kafka.fanout example](https://github.com/aklivity/zilla-examples/tree/main/grpc.kafka.fanout) | [grpc.proxy example](https://github.com/aklivity/zilla-examples/tree/main/grpc.proxy)
> [grpc.kafka.fanout example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/grpc.kafka.fanout) | [grpc.proxy example](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/grpc.proxy)
2 changes: 1 addition & 1 deletion src/tutorials/mqtt/mqtt-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ Go deeper into this concept with the [Running an MQTT Kafka broker](../../how-to
Try out more MQTT examples:

- [Running an MQTT Kafka broker](../../how-tos/mqtt/mqtt.kafka.broker.md)
- [mqtt.kafka.broker.jwt](https://github.com/aklivity/zilla-examples/tree/main/mqtt.kafka.broker.jwt)
- [mqtt.jwt](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/mqtt.jwt)
6 changes: 3 additions & 3 deletions src/tutorials/sse/sse-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ docker-compose down
```

::: tip See more of what Zilla can do
Go deeper into this concept with the [sse.kafka.fanout](https://github.com/aklivity/zilla-examples/tree/main/sse.kafka.fanout) example.
Go deeper into this concept with the [sse.kafka.fanout](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/sse.kafka.fanout) example.
:::

## Going Deeper

Try out the other SSE examples:

- [sse.kafka.fanout](https://github.com/aklivity/zilla-examples/tree/main/sse.kafka.fanout)
- [sse.proxy.jwt](https://github.com/aklivity/zilla-examples/tree/main/sse.proxy.jwt)
- [sse.kafka.fanout](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/sse.kafka.fanout)
- [sse.jwt](https://github.com/aklivity/zilla-examples/tree/example-startup-compose/sse.jwt)
Loading