Skip to content

Commit 9d8de9c

Browse files
Update templated files to rev 8742a41 (#652)
* Generated commit to update templated files based on rev 8742a41 in stackabletech/operator-templating repo. Triggered by: Manual run triggered by: lfrancke with message [README updates] * Fix links & update README * Remove the introduction and example They are nice but are not kept up to date currently so we decided to remove them for now --------- Co-authored-by: Lars Francke <git@lars-francke.de>
1 parent f0bc720 commit 9d8de9c

File tree

5 files changed

+19
-81
lines changed

5 files changed

+19
-81
lines changed
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Documentation
22

3-
The stable documentation for this operator can be found [here](https://docs.stackable.tech/{{operator_docs_slug}}/stable/index.html).
4-
If you are interested in the most recent state of this repository, check out the [nightly docs](https://docs.stackable.tech/{{operator_docs_slug}}/nightly/index.html) instead.
3+
The stable documentation for this operator can be found [here](https://docs.stackable.tech/home/stable/{{operator_docs_slug}}).
4+
If you are interested in the most recent state of this repository, check out the [nightly docs](https://docs.stackable.tech/home/nightly/{{operator_docs_slug}}) instead.
55

66
The documentation for all Stackable products can be found at [docs.stackable.tech](https://docs.stackable.tech).
77

8-
If you have a question about the Stackable Data Platform contact us via our [homepage](https://stackable.tech/) or ask a public questions in our [Discussions forum](https://github.com/orgs/stackabletech/discussions).
8+
If you have a question about the Stackable Data Platform contact us via our [homepage](https://stackable.tech/) or ask a public questions in our [Discussions forum](https://github.com/orgs/stackabletech/discussions).

.readme/partials/borrowed/links.md.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://docs.stackable.tech/home/stable/contributor/index.html)
55
[![License OSL3.0](https://img.shields.io/badge/license-OSL3.0-green)](./LICENSE)
66

7-
[Documentation](https://docs.stackable.tech/{{operator_docs_slug}}/stable/index.html) {% if quickstart_link %}| [Quickstart]({{quickstart_link}}) {% endif %}| [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/) | [Discussions](https://github.com/orgs/stackabletech/discussions) | [Discord](https://discord.gg/7kZ3BNnCAF)
7+
[Documentation](https://docs.stackable.tech/home/stable/{{operator_docs_slug}}) {% if quickstart_link %}| [Quickstart]({{quickstart_link}}) {% endif %}| [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/) | [Discussions](https://github.com/orgs/stackabletech/discussions) | [Discord](https://discord.gg/7kZ3BNnCAF)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Apache Kafka, Apache Druid, Trino or Apache Spark, [all](#our-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud](#supported-platforms).
1+
It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Apache Kafka, Apache Druid, Trino or Apache Spark, [all](#other-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud](#supported-platforms).

.readme/partials/main.md.j2

Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,19 @@
11
This is a Kubernetes operator to manage [Apache Kafka](https://kafka.apache.org/) clusters.
22

3-
{% include "partials/borrowed/overview_blurb.md.j2" %}
3+
{% filter trim %}
4+
{%- include "partials/borrowed/overview_blurb.md.j2" -%}
5+
{% endfilter %}
46

57
## Installation
68

7-
You can install the operator using [stackablectl or helm](https://docs.stackable.tech/kafka/stable/getting_started/installation.html).
9+
You can install the operator using [stackablectl or helm](https://docs.stackable.tech/home/stable/{{operator_name}}/getting_started/installation).
810

911
Read on to get started with it, or see it in action in one of our [demos](https://stackable.tech/en/demos/).
1012

1113
## Getting Started
1214

13-
You can follow this [tutorial](https://docs.stackable.tech/kafka/stable/getting_started/first_steps.html) to create a Kafka cluster with three replicas.
15+
You can follow this [tutorial](https://docs.stackable.tech/home/stable/{{operator_name}}/getting_started/first_steps) to create a Kafka cluster with three replicas.
1416

15-
{% include "partials/borrowed/documentation.md.j2" %}
16-
17-
## What Does This Do?
18-
19-
This operator is managing Kafka in Kubernetes. An operator observes custom resources in a Kubernetes cluster, and manages the application it's responsible for according to the desired state specified in those custom resources.
20-
21-
Here's an example how a custom resource to bring up a 3-replica Kafka cluster can look like:
22-
23-
```
24-
---
25-
apiVersion: kafka.stackable.tech/v1alpha1
26-
kind: KafkaCluster
27-
metadata:
28-
name: simple-kafka
29-
spec:
30-
image:
31-
productVersion: 3.4.0
32-
clusterConfig:
33-
zookeeperConfigMapName: simple-kafka-znode
34-
tls:
35-
serverSecretClass: null
36-
brokers:
37-
roleGroups:
38-
default:
39-
replicas: 3
40-
```
41-
42-
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).
43-
44-
## Behind the Scenes
45-
46-
This operator is written by [Stackable](https://www.stackable.tech). It uses [kube.rs](https://kube.rs/) to interact with the Kubernetes control plane.
47-
48-
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.
17+
{% filter trim %}
18+
{%- include "partials/borrowed/documentation.md.j2" -%}
19+
{% endfilter %}

README.md

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -9,64 +9,31 @@
99
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://docs.stackable.tech/home/stable/contributor/index.html)
1010
[![License OSL3.0](https://img.shields.io/badge/license-OSL3.0-green)](./LICENSE)
1111

12-
[Documentation](https://docs.stackable.tech/kafka/stable/index.html) | [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/) | [Discussions](https://github.com/orgs/stackabletech/discussions) | [Discord](https://discord.gg/7kZ3BNnCAF)
12+
[Documentation](https://docs.stackable.tech/home/stable/kafka) | [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/) | [Discussions](https://github.com/orgs/stackabletech/discussions) | [Discord](https://discord.gg/7kZ3BNnCAF)
1313

1414
This is a Kubernetes operator to manage [Apache Kafka](https://kafka.apache.org/) clusters.
1515

16-
It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Apache Kafka, Apache Druid, Trino or Apache Spark, [all](#our-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud](#supported-platforms).
16+
It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Apache Kafka, Apache Druid, Trino or Apache Spark, [all](#other-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud](#supported-platforms).
1717

1818
## Installation
1919

20-
You can install the operator using [stackablectl or helm](https://docs.stackable.tech/kafka/stable/getting_started/installation.html).
20+
You can install the operator using [stackablectl or helm](https://docs.stackable.tech/home/stable/kafka/getting_started/installation).
2121

2222
Read on to get started with it, or see it in action in one of our [demos](https://stackable.tech/en/demos/).
2323

2424
## Getting Started
2525

26-
You can follow this [tutorial](https://docs.stackable.tech/kafka/stable/getting_started/first_steps.html) to create a Kafka cluster with three replicas.
26+
You can follow this [tutorial](https://docs.stackable.tech/home/stable/kafka/getting_started/first_steps) to create a Kafka cluster with three replicas.
2727

2828
## Documentation
2929

30-
The stable documentation for this operator can be found [here](https://docs.stackable.tech/kafka/stable/index.html).
31-
If you are interested in the most recent state of this repository, check out the [nightly docs](https://docs.stackable.tech/kafka/nightly/index.html) instead.
30+
The stable documentation for this operator can be found [here](https://docs.stackable.tech/home/stable/kafka).
31+
If you are interested in the most recent state of this repository, check out the [nightly docs](https://docs.stackable.tech/home/nightly/kafka) instead.
3232

3333
The documentation for all Stackable products can be found at [docs.stackable.tech](https://docs.stackable.tech).
3434

3535
If you have a question about the Stackable Data Platform contact us via our [homepage](https://stackable.tech/) or ask a public questions in our [Discussions forum](https://github.com/orgs/stackabletech/discussions).
3636

37-
## What Does This Do?
38-
39-
This operator is managing Kafka in Kubernetes. An operator observes custom resources in a Kubernetes cluster, and manages the application it's responsible for according to the desired state specified in those custom resources.
40-
41-
Here's an example how a custom resource to bring up a 3-replica Kafka cluster can look like:
42-
43-
```
44-
---
45-
apiVersion: kafka.stackable.tech/v1alpha1
46-
kind: KafkaCluster
47-
metadata:
48-
name: simple-kafka
49-
spec:
50-
image:
51-
productVersion: 3.4.0
52-
clusterConfig:
53-
zookeeperConfigMapName: simple-kafka-znode
54-
tls:
55-
serverSecretClass: null
56-
brokers:
57-
roleGroups:
58-
default:
59-
replicas: 3
60-
```
61-
62-
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).
63-
64-
## Behind the Scenes
65-
66-
This operator is written by [Stackable](https://www.stackable.tech). It uses [kube.rs](https://kube.rs/) to interact with the Kubernetes control plane.
67-
68-
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.
69-
7037
## About The Stackable Data Platform
7138

7239
This operator is written and maintained by [Stackable](https://stackable.tech) and it is part of a larger data platform.

0 commit comments

Comments
 (0)