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

Update managed broker options #209

Merged
merged 3 commits into from
Oct 26, 2023
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
28 changes: 16 additions & 12 deletions docs/platform/how-to/create-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@ You can enter any suitable name for your environment. Examples could be: product

An environment is always associated with a branch. You can select a branch that already exists (such as when you have connected your project to an existing Git repository), but you are also free to create any new branches you need - simply click `+ New branch` from the branch dropdown, in the `Environment settings` dialog.

## Kafka hosting option
## Broker settings

There are three hosting options:
You now choose the Kafka broker you use with Quix.

There are three broker options:

1. Quix broker
2. Self-hosted
3. Confluent Cloud
2. Managed Kafka
3. Self-hosted

Each of these is described briefly in the following sections.

Expand All @@ -38,21 +40,23 @@ There is a small charge for storage for messages persisted in a topic:

![Topic storage](../images/how-to/create-environment/topic-storage.png){width=80%}

### Self-hosted Kafka
### Managed Kafka

If you want to install and manage your own Kafka installation, you can do this too. You'll need to do more configuration, and be very familiar with details of Kafka hosting and configuration. Selecting this option presents you with a setup guide:
Quix has integrations with common Kafka hosting providers. There are three options here:

![Self-hosted Kafka](../images/how-to/create-environment/self-hosted-kafka.png){width=90%}
1. [Confluent Cloud](https://www.confluent.io/confluent-cloud/){target=_blank}
2. [Redpanda](https://redpanda.com/){target=_blank}
3. [Aiven](https://aiven.io/kafka){target=_blank}

You also have the option to test your connection with the Kafka server before continuing.
Select your managed broker option, and then follow the detailed setup guide provided to connect Quix to the broker.

!!! tip
### Self-hosted Kafka

You could use any Kafka solution here, for example [Redpanda](https://redpanda.com/){target=_blank}.
If you want to install and manage your own Kafka installation, you can do this too, as long as the Kafka Cluster is available on the Internet. You'll need to do more configuration, and be very familiar with details of Kafka hosting and configuration. Selecting this option presents you with a setup guide:

### Confluent Cloud
![Self-hosted Kafka](../images/how-to/create-environment/self-hosted-kafka.png){width=90%}

You can also use the Confluent Cloud hosting option. You can read documentation on [connecting to Confluent Cloud](../integrations/kafka/confluent-cloud.md). It is assumed you're familiar with [Confluent Cloud](https://www.confluent.io/){target=_blank}.
You also have the option to test your connection with the Kafka server before continuing.

## Data and streaming services

Expand Down
35 changes: 0 additions & 35 deletions docs/platform/integrations/kafka/confluent-cloud.md

This file was deleted.

8 changes: 5 additions & 3 deletions docs/platform/what-is-quix.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,22 +84,24 @@ To achieve these goals, Quix Portal includes the following features:

Quix has the ability to create projects where all code and configuration is contained in a Git repository. This Git repository can be hosted by Quix (using Gitea), or on any third-party Git provider, such as GitHub, or Bitbucket, where you can configure the Quix SSH public key provided to you for Git provider authentication. This helps integrate Quix with your existing workflows.

### Kafka integration
### Kafka integrations

Quix requires Kafka to provide streaming infrastructure for your solutions.

When you create a new Quix environment, there are three hosting options:

1. Quix Broker - Quix hosts Kafka for you. This is the simplest option as Quix provides hosting and configuration.
2. Self-Hosted Kafka - This is where you already have existing Kafka infrastructure that you use, and you want to enable Quix to provide the event stream processing platform on top of it. You can configure Quix to work with your existing Kafka infrastructure using this option.
3. Confluent Cloud - if you use Confluent Cloud for your Kafka infrastructure, then you can configure Quix to connect to your existing Confluent Cloud account.
2. Managed Kafka - use Quix integrations with common Kafka hosting providers such as Confluent Cloud, Redpanda, and Aiven.
3. Self-Hosted Kafka - use your own Kafka installation, as long as the cluster is available on the Internet.

This enables you to select a Kafka hosting option according to requirements. For example, your production environment may be hosted on your own Kafka infrastructure, while your develop environment is hosted by Quix.

!!! tip

To get your event streaming application to the testing stage as quickly as possible, the Quix-hosted Kafka option is recommended, as it requires zero configuration to get Kafka running. You can focus on your application code, without needing to do the up front work of creating a powerful scalable Kafka cluster, as that work has already been done for you by Quix.

Read more about [selecting your broker option](./how-to/create-environment.md#broker-settings).

### Docker integration

When you create an application from a template in Quix, a Dockerfile is provided for you in the `build` directory of the application. This uses a base image, and additions only need to be made in the case of special requirements, such as to include a library that is not part of the base image. The Dockerfile, combined with your code and configuration, is used to drive the Quix build service, which ensures the generated Docker image is registered with the Quix Docker registry. This image is then submitted to the Quix serverless engine, as part of the deployment process. All this is largely transparent to the developer - you simply click `Deploy` to build and deploy your application, and then monitor the deployment using the tools provided, such as the Data Explorer, logs, CPU monitor, and memory monitor.
Expand Down
4 changes: 1 addition & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,6 @@ nav:
- 'No code sentiment analysis': 'platform/tutorials/nocode-sentiment/nocode-sentiment-analysis.md'
- 'MATLAB and Simulink': 'platform/tutorials/matlab/matlab-and-simulink.md'
- 'Code Samples': 'platform/samples/samples.md'
- 'Integrations':
- 'Kafka':
- 'Confluent': 'platform/integrations/kafka/confluent-cloud.md'
- 'Connectors':
- platform/connectors/index.md
#ConnectorsGetInsertedHere
Expand Down Expand Up @@ -182,6 +179,7 @@ plugins:
'apis/portal-api.md': 'apis/portal-api/index.md'
'apis/index.md': 'apis/intro.md'
'platform/definitions.md': 'platform/glossary.md'
'platform/integrations/kafaka/confluent-cloud.md': 'platform/how-to/create-environment.md'

theme:
name: 'material'
Expand Down
Loading