Skip to content

Commit

Permalink
fix: clean up wording
Browse files Browse the repository at this point in the history
  • Loading branch information
vordimous committed Aug 9, 2024
1 parent bb37876 commit 44f8a96
Show file tree
Hide file tree
Showing 13 changed files with 71 additions and 37 deletions.
5 changes: 2 additions & 3 deletions src/.vuepress/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@ export const enSidebar = sidebar({
{
text: "CloudFormation Deploy",
collapsible: false,
link: "production.md",
children: [
{
text: "with SASL/SCRAM",
Expand Down Expand Up @@ -240,7 +239,7 @@ export const enSidebar = sidebar({
{
text: "-hidden-",
ariaLabel: "-hidden-",
link: "/hidden",
link: "/",
children: [],
},
{
Expand Down Expand Up @@ -353,7 +352,7 @@ export const enSidebar = sidebar({
{
text: "-hidden-",
ariaLabel: "-hidden-",
link: "/hidden",
link: "/",
children: [],
},
{
Expand Down
4 changes: 2 additions & 2 deletions src/how-tos/connecting-to-kafka/amazon-msk.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ MSK's “Public Access” feature directly exposes your brokers to the internet,
Once your MSK cluster is reachable over the internet, it will rely on `mTLS` to authenticate external clients. Setting up `mTLS` between MSK and Zilla is done in three steps:

1. Create a trusted Client Certificate in Amazon Certificate Manager.
2. Export the Client Certificate as well as the Certificate Authority (CA) Certificate.
3. Create a PKCS12 KeyStore containing the exported certificates that will be referenced by Zilla to complete the `mTLS` handshake with your MSK cluster.
1. Export the Client Certificate as well as the Certificate Authority (CA) Certificate.
1. Create a PKCS12 KeyStore containing the exported certificates that will be referenced by Zilla to complete the `mTLS` handshake with your MSK cluster.

::: info NOTE
If you deployed the Zilla Plus for Amazon MSK, then you should already have a Client Certificate that Zilla can use and you can go straight to the second step.
Expand Down
4 changes: 2 additions & 2 deletions src/solutions/concepts/kafka-proxies/iot-ingest-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ You will need to choose a wildcard DNS pattern to use for public internet access

## Confluent Cloud

The [Zilla Plus for Confluent Cloud](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) IoT Ingest and Control Broker lets authorized Kafka clients connect, publish messages and subscribe to topics in your Confluent Cloud cluster via the internet.
The [Zilla Plus for Confluent Cloud](https://aws.amazon.com/marketplace/pp/prodview-eblxkinsqbaks) IoT Ingest and Control Broker lets authorized Kafka clients connect, publish messages and subscribe to topics in your Confluent Cloud cluster via the internet.

> [Follow the guide to get started](../../how-tos/confluent-cloud/iot-ingest-control.md)
## Redpanda

The [Zilla Plus for Redpanda](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) IoT Ingest and Control Broker lets authorized Kafka clients connect, publish messages and subscribe to topics in your Redpanda cluster via the internet.
The [Zilla Plus for Redpanda](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu) IoT Ingest and Control Broker lets authorized Kafka clients connect, publish messages and subscribe to topics in your Redpanda cluster via the internet.

> [Follow the guide to get started](../../how-tos/redpanda/iot-ingest-control.md)
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ The [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-j
## Confluent Cloud

The [Zilla Plus for Confluent Cloud](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) Secure Public Access proxy lets authorized Kafka clients connect, publish messages and subscribe to topics in your Confluent Cloud cluster via the internet.
The [Zilla Plus for Confluent Cloud](https://aws.amazon.com/marketplace/pp/prodview-eblxkinsqbaks) Secure Public Access proxy lets authorized Kafka clients connect, publish messages and subscribe to topics in your Confluent Cloud cluster via the internet.

> [Follow the guide to get started](../../how-tos/confluent-cloud/secure-public-access.md)
5 changes: 3 additions & 2 deletions src/solutions/how-tos/amazon-msk/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
icon: aky-zilla-plus
description: Zilla Plus for Amazon MSK, you can create publicly reachable Kafka endpoints into an Amazon MSK cluster. You can also expose topics inside your Amazon MSK cluster via declaratively defined REST, SSE, gRPC, and MQTT APIs.
---

# Zilla Plus for Amazon MSK

The [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) Secure Public Access Proxy lets authorized Kafka clients connect, publish messages and subscribe to topics in your Amazon MSK cluster via the internet.
With [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44), you can create publicly reachable Kafka endpoints into an Amazon MSK cluster. You can also expose topics inside your Amazon MSK cluster via declaratively defined REST, SSE, gRPC, and MQTT APIs.

## IoT Ingest and Control

The IoT Ingest and Control MQTT Broker that lets clients publish messages and subscribe to topics proxied to Kafka topics in your Amazon MSK cluster.

> [Amazon MSK IoT Ingest and Control Guide](./iot-ingest-control.md.md)
> [Amazon MSK IoT Ingest and Control Guide](./iot-ingest-control.md)
## Secure Public Access

Expand Down
6 changes: 3 additions & 3 deletions src/solutions/how-tos/amazon-msk/iot-ingest-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ Go to the newly created secret and under `Resource permissions` > select `Edit P

## Subscribe via AWS Marketplace

The [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu) is available through the AWS Marketplace. You can skip this step if you have already subscribed to Zilla Plus for Amazon MSK via the AWS Marketplace.
The [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44)) is available through the AWS Marketplace. You can skip this step if you have already subscribed to Zilla Plus for Amazon MSK via the AWS Marketplace.

To get started, visit the Proxy's Marketplace [Product Page](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu) and `Subscribe` to the offering. You should now see `Zilla Plus for Amazon MSK` listed in your [AWS Marketplace](https://console.aws.amazon.com/marketplace) subscriptions.
To get started, visit the Proxy's Marketplace [Product Page](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) and `Subscribe` to the offering. You should now see `Zilla Plus for Amazon MSK` listed in your [AWS Marketplace](https://console.aws.amazon.com/marketplace) subscriptions.

## Deploy the IoT Ingest and Control MQTT Broker

Expand Down Expand Up @@ -147,4 +147,4 @@ Parameters:

## Conclusion

You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu) IoT Ingest and Control MQTT Broker. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../aws-services/manage-cloudformation-stack.md) section.
You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) IoT Ingest and Control MQTT Broker. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../aws-services/manage-cloudformation-stack.md) section.
Original file line number Diff line number Diff line change
Expand Up @@ -486,16 +486,16 @@ b-1.aklivity.example.com:9094,b-2.aklivity.example.com:9094,b-3.aklivity.example
::: tip A quick summary of what just happened

1. The Kafka client with access to the public internet issued a request to create a new topic
2. This request was directed to the internet-facing Network Load Balancer
3. The Network Load Balancer forwarded the request to the <ZillaPlus/> proxy
4. The <ZillaPlus/> proxy routed the request to the appropriate MSK broker
5. The topic was created in the MSK broker
6. Public access was verified
1. This request was directed to the internet-facing Network Load Balancer
1. The Network Load Balancer forwarded the request to the <ZillaPlus/> proxy
1. The <ZillaPlus/> proxy routed the request to the appropriate MSK broker
1. The topic was created in the MSK broker
1. Public access was verified

:::

<!-- @include: @partials/secure-public-access/send-message.md -->

## Conclusion

You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu) Secure Public Access. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../../aws-services/manage-cloudformation-stack.md) section.
You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) Secure Public Access. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../../aws-services/manage-cloudformation-stack.md) section.
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ The <ZillaPlus/> proxy can securely expose any MSK cluster with these access opt

Follow the [Secure Public Access with Terraform](https://github.com/aklivity/zilla-plus-aws-templates/tree/main/amazon-msk/cdktf/secure-public-access) guide to generated or deploy a custom Terraform template using [CDKTF](https://developer.hashicorp.com/terraform/cdktf). This Terraform script can be configured to deploy `SASL/SCRAM authentication`, `Mutual TLS (mTLS) authentication` or `Unauthorized access` to setup connectivity to your MSK cluster with a wildcard DNS pattern.

## SASL/SCRAM authentication deployment with CloudFormation
## SASL/SCRAM authentication with CloudFormation

Follow the [Secure Public Access via SASL/SCRAM authentication](./production.md) guide to setup connectivity to your MSK cluster using a globally trusted TLS server certificate with a wildcard DNS pattern `*.example.aklivity.io` to illustrate the steps.

## Mutual TLS (mTLS) authentication deployment with CloudFormation
## Mutual TLS (mTLS) authentication with CloudFormation

Follow the [Secure Public Access via mTLS](./production-mutual-tls.md) guide to setup connectivity to your MSK cluster using a globally trusted TLS server certificate with a wildcard DNS pattern `*.example.aklivity.io` to illustrate the steps.

## Unauthorized access deployment with CloudFormation
## Unauthorized access with CloudFormation

Follow the [Secure Public Access via Unauthorized access](./development.md) guide to setup connectivity to your MSK cluster using a locally trusted TLS server certificate with the example wildcard DNS pattern `*.aklivity.example.com`.
Original file line number Diff line number Diff line change
Expand Up @@ -476,18 +476,18 @@ Replace these TLS bootstrap server names accordingly for your own custom wildcar
::: tip A quick summary of what just happened

1. The Kafka client with access to the public internet issued a request to create a new topic
2. This request was directed to the internet-facing Network Load Balancer
3. The Network Load Balancer forwarded the request to the <ZillaPlus/> proxy
4. The <ZillaPlus/> proxy verified the client identity of the Kafka client
5. The <ZillaPlus/> proxy selected a matching client certificate to propagate client identity
6. The <ZillaPlus/> proxy routed the request to the appropriate MSK broker
7. The topic was created in the MSK broker
8. Public access was verified, authorized by trusted client certificate
1. This request was directed to the internet-facing Network Load Balancer
1. The Network Load Balancer forwarded the request to the <ZillaPlus/> proxy
1. The <ZillaPlus/> proxy verified the client identity of the Kafka client
1. The <ZillaPlus/> proxy selected a matching client certificate to propagate client identity
1. The <ZillaPlus/> proxy routed the request to the appropriate MSK broker
1. The topic was created in the MSK broker
1. Public access was verified, authorized by trusted client certificate

:::

<!-- @include: @partials/secure-public-access/send-message.md -->

## Conclusion

You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu) Secure Public Access. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../../aws-services/manage-cloudformation-stack.md) section.
You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) Secure Public Access. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../../aws-services/manage-cloudformation-stack.md) section.
Original file line number Diff line number Diff line change
Expand Up @@ -435,16 +435,16 @@ Replace these TLS bootstrap server names accordingly for your own custom wildcar
::: tip A quick summary of what just happened

1. The Kafka client with access to the public internet issued a request to create a new topic
2. This request was directed to the internet-facing Network Load Balancer
3. The Network Load Balancer forwarded the request to the <ZillaPlus/> proxy
4. The <ZillaPlus/> proxy routed the request to the appropriate MSK broker
5. The topic was created in the MSK broker
6. Public access was verified
1. This request was directed to the internet-facing Network Load Balancer
1. The Network Load Balancer forwarded the request to the <ZillaPlus/> proxy
1. The <ZillaPlus/> proxy routed the request to the appropriate MSK broker
1. The topic was created in the MSK broker
1. Public access was verified

:::

<!-- @include: @partials/secure-public-access/send-message.md -->

## Conclusion

You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu) Secure Public Access. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../../aws-services/manage-cloudformation-stack.md) section.
You have successfully deployed the [Zilla Plus for Amazon MSK](https://aws.amazon.com/marketplace/pp/prodview-jshnzslazfm44) Secure Public Access. Instructions on how to Monitor and Upgrade your <ZillaPlus/> proxy can be found in the [managing a cloudformation stack](../../aws-services/manage-cloudformation-stack.md) section.
2 changes: 1 addition & 1 deletion src/solutions/how-tos/aws-services/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: Common errors and how to handle them
---

# AWS Troubleshooting
# Troubleshooting

::: note Table of contents

Expand Down
20 changes: 20 additions & 0 deletions src/solutions/how-tos/confluent-cloud/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
icon: aky-zilla-plus
description: Zilla Plus for Confluent Cloud, you can create publicly reachable Kafka endpoints into an Confluent Cloud cluster. You can also expose topics inside your Confluent Cloud cluster via declaratively defined REST, SSE, gRPC, and MQTT APIs.
---

# Zilla Plus for Confluent Cloud

With [Zilla Plus for Confluent Cloud](https://aws.amazon.com/marketplace/pp/prodview-eblxkinsqbaks), you can create publicly reachable Kafka endpoints into an Confluent Cloud cluster. You can also expose topics inside your Confluent Cloud cluster via declaratively defined REST, SSE, gRPC, and MQTT APIs.

## IoT Ingest and Control

The IoT Ingest and Control MQTT Broker that lets clients publish messages and subscribe to topics proxied to Kafka topics in your Confluent Cloud cluster.

> [Confluent Cloud IoT Ingest and Control Guide](./iot-ingest-control.md)
## Secure Public Access

The Secure Public Access Proxy lets authorized Kafka clients connect, publish messages and subscribe to topics in your Confluent Cloud cluster via the internet.

> [Confluent Cloud Secure Public Access Proxy Guide](./secure-public-access/overview.md)
14 changes: 14 additions & 0 deletions src/solutions/how-tos/redpanda/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
icon: aky-zilla-plus
description: Zilla Plus for Redpanda, you can expose topics inside your Redpanda cluster via declaratively defined REST, SSE, gRPC, and MQTT APIs.
---

# Zilla Plus for Redpanda

With [Zilla Plus for Redpanda](https://aws.amazon.com/marketplace/pp/prodview-sj4kquyndubiu), you can expose topics inside your Redpanda cluster via declaratively defined REST, SSE, gRPC, and MQTT APIs.

## IoT Ingest and Control

The IoT Ingest and Control MQTT Broker that lets clients publish messages and subscribe to topics proxied to Kafka topics in your Redpanda cluster.

> [Redpanda IoT Ingest and Control Guide](./iot-ingest-control.md)

0 comments on commit 44f8a96

Please sign in to comment.