-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into spike/lb-operator
- Loading branch information
Showing
93 changed files
with
4,575 additions
and
986 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,3 +13,4 @@ target/ | |
| Cargo.nix | ||
| crate-hashes.json | ||
| result | ||
| image.tar | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| {%- set title="Stackable Operator for Apache Kafka" -%} | ||
| {%- set operator_name="kafka" -%} | ||
| {%- set related_reading_links=[] -%} | ||
|
|
||
| {% include "partials/borrowed/header.md.j2" %} | ||
| {% include "partials/borrowed/links.md.j2" %} | ||
|
|
||
| {% include "partials/main.md.j2" %} | ||
|
|
||
| {% include "partials/borrowed/footer.md.j2" %} | ||
|
|
||
| {% include "partials/borrowed/related_reading.md.j2" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ## Documentation | ||
|
|
||
| The stable documentation for this operator can be found [here](https://docs.stackable.tech/{{operator_name}}/stable/index.html). | ||
| If you are interested in the most recent state of this repository, check out the [nightly docs](https://docs.stackable.tech/{{operator_name}}/nightly/index.html) instead. | ||
|
|
||
| The documentation for all Stackable products can be found at [docs.stackable.tech](https://docs.stackable.tech). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| ## About The Stackable Data Platform | ||
|
|
||
| This operator is written and maintained by [Stackable](https://www.stackable.tech) and it is part of a larger data platform. | ||
|
|
||
|  | ||
|
|
||
| Stackable makes it easy to operate data applications in any Kubernetes cluster. | ||
|
|
||
| The data platform offers many operators, new ones being added continuously. All our operators are designed and built to be easily interconnected and to be consistent to work with. | ||
|
|
||
| The [Stackable GmbH](https://stackable.tech/) is the company behind the Stackable Data Platform. Offering professional services, paid support plans and custom development. | ||
|
|
||
| We love open-source! | ||
|
|
||
| ## Supported Platforms | ||
|
|
||
| We develop and test our operators on the following cloud platforms: | ||
|
|
||
| * Kubernetes 1.21-1.24 | ||
| * EKS on Amazon Web Services (AWS) | ||
| * GKE on Google Cloud Platform (GCP) | ||
| * AKS on Microsoft Azure | ||
| * K3s | ||
|
|
||
| We are currently working to support: | ||
|
|
||
| * OpenShift | ||
|
|
||
| ## Other Operators | ||
|
|
||
| These are the operators that are currently part of the Stackable Data Platform: | ||
|
|
||
| - [Stackable Operator for Apache Airflow](https://github.com/stackabletech/airflow-operator) | ||
| - [Stackable Operator for Apache Druid](https://github.com/stackabletech/druid-operator) | ||
| - [Stackable Operator for Apache HBase](https://github.com/stackabletech/hbase-operator) | ||
| - [Stackable Operator for Apache Hadoop HDFS](https://github.com/stackabletech/hdfs-operator) | ||
| - [Stackable Operator for Apache Hive](https://github.com/stackabletech/hive-operator) | ||
| - [Stackable Operator for Apache Kafka](https://github.com/stackabletech/kafka-operator) | ||
| - [Stackable Operator for Apache NiFi](https://github.com/stackabletech/nifi-operator) | ||
| - [Stackable Operator for Apache Spark](https://github.com/stackabletech/spark-k8s-operator) | ||
| - [Stackable Operator for Apache Superset](https://github.com/stackabletech/superset-operator) | ||
| - [Stackable Operator for Trino](https://github.com/stackabletech/trino-operator) | ||
| - [Stackable Operator for Apache ZooKeeper](https://github.com/stackabletech/zookeeper-operator) | ||
|
|
||
| And our internal operators: | ||
|
|
||
| - [Commons Operator](https://github.com/stackabletech/commons-operator) | ||
| - [Listener Operator](https://github.com/stackabletech/listener-operator) | ||
| - [OpenPolicyAgent Operator](https://github.com/stackabletech/opa-operator) | ||
| - [Secret Operator](https://github.com/stackabletech/secret-operator) | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are welcome. Follow our [Contributors Guide](https://docs.stackable.tech/home/stable/contributor/index.html) to learn how you can contribute. | ||
|
|
||
| ## License | ||
|
|
||
| [Open Software License version 3.0](./LICENSE). | ||
|
|
||
| ## Support | ||
|
|
||
| You can use this project under different licenses. Get started with the community edition! If you want professional support, [we offer subscription plans](https://stackable.tech/en/plans/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <p align="center"> | ||
| <img width="150" src="./.readme/static/borrowed/Icon_Stackable.svg" alt="Stackable Logo"/> | ||
| </p> | ||
|
|
||
| <h1 align="center">{{title}}</h1> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| [](https://ci.stackable.tech/job/{{operator_name}}%2doperator%2dit%2dnightly) | ||
| [](https://GitHub.com/stackabletech/{{operator_name}}-operator/graphs/commit-activity) | ||
| [](https://docs.stackable.tech/home/stable/contributor/index.html) | ||
| [](./LICENSE) | ||
|
|
||
| [Documentation](https://docs.stackable.tech/{{operator_name}}-operator/stable/index.html) {% if quickstart_link %}| [Quickstart]({{quickstart_link}}) {% endif %}| [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| {%- if related_reading_links -%} | ||
| ## Related Reading | ||
| {% for (text, link) in related_reading_links %} | ||
| * [{{text}}]({{link}}) | ||
| {%- endfor %} | ||
| {%- endif -%} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| This is a Kubernetes operator to manage [Apache Kafka](https://kafka.apache.org/) clusters. | ||
|
|
||
| It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Kafka, Druid, Trino or Spark, [all](#other-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud]((#supported-platforms)). | ||
|
|
||
| ## Installation | ||
|
|
||
| You can install the operator using [stackablectl or helm](https://docs.stackable.tech/kafka/stable/getting_started/installation.html). | ||
|
|
||
| Read on to get started with it, or see it in action in one of our [demos](https://stackable.tech/en/demos/). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| You can follow this [tutorial](https://docs.stackable.tech/kafka/stable/getting_started/first_steps.html) to create a Kafka cluster with three replicas. | ||
|
|
||
| {% include "partials/borrowed/documentation.md.j2" %} | ||
|
|
||
| ## What Does This Do? | ||
|
|
||
| This operator is managing Kafka in Kubernetes. It is part of the Stackable Data Platform, a | ||
|
|
||
| Operators observe custom resources in a Kubernetes cluster, and manages the application it's responsible for according to the desired state specified in those custom resources. | ||
|
|
||
| Here's an example how a custom resource to bring up a 3-replica Kafka cluster can look like: | ||
|
|
||
| ``` | ||
| --- | ||
| apiVersion: kafka.stackable.tech/v1alpha1 | ||
| kind: KafkaCluster | ||
| metadata: | ||
| name: simple-kafka | ||
| spec: | ||
| version: 3.2.0-stackable0.1.0 | ||
| zookeeperConfigMapName: simple-kafka-znode | ||
| config: | ||
| tls: null | ||
| brokers: | ||
| roleGroups: | ||
| default: | ||
| replicas: 3 | ||
| ``` | ||
|
|
||
| If you want to find out more about it, take a look at this [getting started guide](https://docs.stackable.tech/kafka/stable/getting_started/first_steps.html). | ||
|
|
||
| ## Behind the Scenes | ||
|
|
||
| This operator is written by [Stackable](https://www.stackable.tech). It uses [kube.rs](https://kube.rs/) to interact with the Kubernetes control plane. | ||
|
|
||
| We test it [extensively](https://ci.stackable.tech/) using [Kuttl](https://kuttl.dev/)-powered integration tests on managed Kubernetes of multiple cloud platforms and our own bare-metal clusters. |
Oops, something went wrong.