Skip to content

Add recommendation for k8s deployment #734

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

Merged
merged 5 commits into from
Apr 30, 2025
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
2 changes: 1 addition & 1 deletion docs/gateway/get-started/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Conduktor Gateway is provided as a Docker image and [Helm chart](../kubernetes).

It should be deployed and managed in the best way for your organization and use case(s). This could be a single container, or more likely, multiple Gateway instances should be deployed and scaled to meet your needs. Optionally, the instances could be deployed behind a [load balancer](../reference/load-balancing.md).
It should be deployed and managed in the best way for your organization and use case(s). This could be a single container, or more likely, multiple Gateway instances should be deployed and scaled to meet your needs. Our recommendation is to [deploy with Kubernetes](/platform/get-started/installation/get-started/kubernetes).

Use this quick start guide to help you get started.

Expand Down
2 changes: 2 additions & 0 deletions docs/gateway/get-started/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: This guide is for deploying Conduktor Gateway on a local Minikube i
We welcome contributions and feedback. If you have issues, you can open an issue on our [GitHub repository](https://github.com/conduktor/conduktor-public-charts/issues) or contact [support](https://www.conduktor.io/contact/support/).
:::

Conduktor recommends deploying with Kubernetes. For a full reference of our recommended architecture for deploying the entire Conduktor platform refer to our example GitHub repository, [conduktor-reference-architecture](https://github.com/conduktor/conduktor-reference-architecture).

# Helm chart installation

Conduktor provides a [Helm repository](https://helm.conduktor.io) containing a chart that will deploy Conduktor Gateway on your Kubernetes cluster. This is a quick start guide to help you deploy a local instance of Gateway for non production purposes.
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/get-started/installation/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 2,
"link": {
"type": "generated-index",
"description": "Installation and setup docs. Start with your Deployment Option."
"description": "Installation and setup docs. Start with your Deployment Option. Our recommended deployment is with Kubernetes."
}
}
2 changes: 1 addition & 1 deletion docs/platform/get-started/installation/get-started/AWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Deploy an instance of Conduktor Console on AWS.

## Getting started

This guide will demonstrate how to deploy Console in your AWS environment with all mandatory dependencies. It will demonstrate how to deploy Conduktor as a Docker container on ECS with Fargate and configure it alongside a PostgreSQL database via RDS.
This guide will demonstrate how to deploy Console in your AWS environment with all mandatory dependencies. It will demonstrate how to deploy Conduktor as a Docker container on ECS with Fargate and configure it alongside a PostgreSQL database via RDS. Our recommendation is to [deploy with Kubernetes](/platform/get-started/installation/get-started/kubernetes).

Rather than follow this manual guide, you might prefer to see our [Marktetplace Listing](aws-marketplace-and-cloudformation.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 1,
"link": {
"type": "generated-index",
"description": "Get started with Conduktor. Installation and Configuration in minutes."
"description": "Get started with Conduktor. Installation and Configuration in minutes. Our recommended deployment is with Kubernetes."
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Get started with the latest Conduktor Console Docker image in just
Pre-requisite: [Docker Compose](https://docs.docker.com/compose/install)
:::

Get started in a few minutes with the latest Conduktor Console Docker image.
Get started in a few minutes with the latest Conduktor Console Docker image. Our recommendation is to [deploy with Kubernetes](/platform/get-started/installation/get-started/kubernetes).

- [**Simple Setup**](#simple-setup): Get started with the Conduktor Console through its user-friendly interface - Perfect to **quickly** see its value.
- [Option 1: Start with an embedded Kafka cluster](#option-1-start-with-an-embedded-kafka-cluster)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: The below guide details how to deploy Kubernetes resources to run C

Deploy a production-ready instance of Conduktor on Kubernetes.

For a full reference of our recommended architecture for deploying the entire Conduktor platform refer to our example GitHub repository, [conduktor-reference-architecture](https://github.com/conduktor/conduktor-reference-architecture).

:::info
We welcome contributions and feedback. If you have issues, you can either open an issue on our [GitHub repository](https://github.com/conduktor/conduktor-public-charts/issues) or [contact support](https://www.conduktor.io/contact/support/).
:::
Expand Down