Skip to content
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

Adding draft of new integrations topic for Quix <--> Upstash Kafka #151

Merged
merged 2 commits into from
Apr 24, 2024
Merged
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
Binary file added img/quix/helloquix-pipeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/quix/helloquix-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/quix/quix-upstash-broker-option.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/quix/quix-upstash-broker-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/quix/quix-upstash-topics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 81 additions & 0 deletions kafka/integrations/quix.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
id: "kafka-quix"
title: "Upstash Kafka with Quix"
description: "This tutorial shows how to integrate Upstash Kafka with Quix"
sidebarTitle: Quix
---

[Quix](https://quix.io?utm_source=upstash) is a complete platform for developing, deploying, and monitoring stream processing pipelines. You use the Quix Streams Python library to develop modular stream processing applications, and deploy them to containers managed in Quix with a single click. You can develop and manage applications on the command line or manage them in Quix Cloud and visualize them as a end-to-end pipeline.


## Upstash Kafka Setup

Create a Kafka cluster using
[Upstash Console](https://console.upstash.com/kafka) or
[Upstash CLI](https://github.com/upstash/cli) by following
[Getting Started](https://docs.upstash.com/kafka).

## Quix Setup

Like Upstash, Quix is a managed service—this means that you don't need to provision any servers or compute resources. You can [register for a free trial account](https://portal.platform.quix.io/self-sign-up/) and started in minutes.


# Configure the broker settings

When you [create your first project](https://quix.io/docs/create/create-project.html) in Quix, you'll be asked to configure a message broker. You have the option to configure an external broker (instead the default Quix managed broker).

<Frame>
<img src="/img/quix/quix-upstash-broker-option.png" />
</Frame>

To use Upstash as your message broker, select the Upstash option and configure the settings shown in the following screenshot:

<Frame>
<img src="/img/quix/quix-upstash-broker-settings.png" />
</Frame>


## Create your first pipeline

To help you get started, the Quix platform includes several pipeline templates that you can deploy in a few clicks.

To test the Upstash connection, you can use the ["Hello Quix" template](https://quix.io/templates/hello-quix) which is a simple three-step pipeline:

<Frame>
<img src="/img/quix/helloquix-template.png" />
</Frame>


* Click [**Clone this project** ](https://portal.platform.quix.io/signup?projectName=Hello%20Quix&httpsUrl=https://github.com/quixio/template-hello-quix&branchName=tutorial).
* On the **Import Project** screen, select **Quix advanced configuration** (this option ensures that you'll get the option to configure own broker settings).
* Follow the project creation wizard and configure your Upstash connection details when prompted.
* Click **Sync your pipeline**


## Test the Setup

In the Quix portal, wait for the services to deploy and show up as "Running".

<Frame>
<img src="/img/quix/helloquix-pipeline.png" />
</Frame>


Check that the required topics ("_csv-data_" and "_counted-names_") show up in both Quix and Upstash. In Upstash, topics that originate from Quix show up with the Quix workspace and project name as a prefix (e.g. "_quixdemo-helloquix-csv-data_").

<Frame>
<img src="/img/quix/helloquix-pipeline.png" />
</Frame>


## Links

[Quix documentation](https://quix.io/docs/get-started/welcome.html)

[Quix guide to creating projects](https://quix.io/blog/how-to-create-a-project-from-a-template#cloning-a-project-template-into-github)

[Quix portal](https://portal.platform.quix.io/workspaces)

[Upstash console](https://console.upstash.com/kafka)


1 change: 1 addition & 0 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,7 @@
"kafka/integrations/startree",
"kafka/integrations/timeplus",
"kafka/integrations/proton",
"kafka/integrations/quix",
"kafka/integrations/tinybird",
"kafka/integrations/risingwave",
"kafka/integrations/rockset"
Expand Down