From 073a6bfdc6b620bc42c68a2aaf9dd248da2f8439 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Wed, 16 Jun 2021 14:41:33 -0500 Subject: [PATCH] 3817: Clean up Kafka docs --- .../eventing}/kafka/README.md | 33 ++----------------- .../eventing}/kafka/binding/README.md | 0 .../kafka/binding/event-binding.yaml | 0 .../kafka/binding/event-display.yaml | 0 .../eventing}/kafka/binding/event-source.yaml | 0 .../eventing}/kafka/channel/000-ksvc.yaml | 0 .../kafka/channel/010-serviceaccount.yaml | 0 .../kafka/channel/020-k8s-events.yaml | 0 .../eventing}/kafka/channel/030-trigger.yaml | 0 .../eventing}/kafka/channel/README.md | 0 .../eventing/kafka}/kafka-broker/README.md | 0 .../eventing/kafka}/kafka-source/README.md | 0 .../kafka}/kafka-source/event-display.yaml | 0 .../kafka}/kafka-source/event-source.yaml | 0 .../kafka}/kafka-source/kafka-topic.yaml | 0 .../eventing}/kafka/kafka.yaml | 0 .../eventing}/kafka/kafka_setup.sh | 0 mkdocs.yml | 24 ++++++++++---- 18 files changed, 20 insertions(+), 37 deletions(-) rename docs/{eventing/samples => developer/eventing}/kafka/README.md (76%) rename docs/{eventing/samples => developer/eventing}/kafka/binding/README.md (100%) rename docs/{eventing/samples => developer/eventing}/kafka/binding/event-binding.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/binding/event-display.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/binding/event-source.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/channel/000-ksvc.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/channel/010-serviceaccount.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/channel/020-k8s-events.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/channel/030-trigger.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/channel/README.md (100%) rename docs/{eventing/broker => developer/eventing/kafka}/kafka-broker/README.md (100%) rename docs/{eventing/sources => developer/eventing/kafka}/kafka-source/README.md (100%) rename docs/{eventing/sources => developer/eventing/kafka}/kafka-source/event-display.yaml (100%) rename docs/{eventing/sources => developer/eventing/kafka}/kafka-source/event-source.yaml (100%) rename docs/{eventing/sources => developer/eventing/kafka}/kafka-source/kafka-topic.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/kafka.yaml (100%) rename docs/{eventing/samples => developer/eventing}/kafka/kafka_setup.sh (100%) diff --git a/docs/eventing/samples/kafka/README.md b/docs/developer/eventing/kafka/README.md similarity index 76% rename from docs/eventing/samples/kafka/README.md rename to docs/developer/eventing/kafka/README.md index 1857447ccb0..0723e64185b 100644 --- a/docs/eventing/samples/kafka/README.md +++ b/docs/developer/eventing/kafka/README.md @@ -1,23 +1,7 @@ ---- -title: "Apache Kafka examples" -linkTitle: "Apache Kafka" -weight: 10 -type: "docs" ---- +# Using Kafka with Knative -# Apache Kafka examples - -The following examples will help you understand how to use the different Apache -Kafka components for Knative. - -## Prerequisites - -All examples require: - -- A Kubernetes cluster with - - Knative Eventing v0.9+ - - Knative Serving v0.9+ -- An Apache Kafka cluster +1. Install Knative Eventing. +1. Install Strimzi or use an existing Kafka cluster. ### Setting up Apache Kafka @@ -82,8 +66,6 @@ my-cluster-zookeeper-2 2/2 Running 0 2m59s strimzi-cluster-operator-77555d4b69-sbrt4 1/1 Running 0 3m14s ``` -> NOTE: For production ready installs check [Strimzi](https://strimzi.io). - ### Installation script If you want to install the latest version of Strimzi, in just one step, we have @@ -93,12 +75,3 @@ steps that are listed above: ```bash $ ./kafka_setup.sh ``` - -## Examples of Apache Kafka and Knative - -A number of different examples, showing the `KafkaSource`, `KafkaChannel` and -`KafkaBinding` can be found here: - -- [`KafkaSource` to `Service`](../../sources/kafka-source) -- [`KafkaChannel` and Broker](./channel/) -- [`KafkaBinding`](./binding/) diff --git a/docs/eventing/samples/kafka/binding/README.md b/docs/developer/eventing/kafka/binding/README.md similarity index 100% rename from docs/eventing/samples/kafka/binding/README.md rename to docs/developer/eventing/kafka/binding/README.md diff --git a/docs/eventing/samples/kafka/binding/event-binding.yaml b/docs/developer/eventing/kafka/binding/event-binding.yaml similarity index 100% rename from docs/eventing/samples/kafka/binding/event-binding.yaml rename to docs/developer/eventing/kafka/binding/event-binding.yaml diff --git a/docs/eventing/samples/kafka/binding/event-display.yaml b/docs/developer/eventing/kafka/binding/event-display.yaml similarity index 100% rename from docs/eventing/samples/kafka/binding/event-display.yaml rename to docs/developer/eventing/kafka/binding/event-display.yaml diff --git a/docs/eventing/samples/kafka/binding/event-source.yaml b/docs/developer/eventing/kafka/binding/event-source.yaml similarity index 100% rename from docs/eventing/samples/kafka/binding/event-source.yaml rename to docs/developer/eventing/kafka/binding/event-source.yaml diff --git a/docs/eventing/samples/kafka/channel/000-ksvc.yaml b/docs/developer/eventing/kafka/channel/000-ksvc.yaml similarity index 100% rename from docs/eventing/samples/kafka/channel/000-ksvc.yaml rename to docs/developer/eventing/kafka/channel/000-ksvc.yaml diff --git a/docs/eventing/samples/kafka/channel/010-serviceaccount.yaml b/docs/developer/eventing/kafka/channel/010-serviceaccount.yaml similarity index 100% rename from docs/eventing/samples/kafka/channel/010-serviceaccount.yaml rename to docs/developer/eventing/kafka/channel/010-serviceaccount.yaml diff --git a/docs/eventing/samples/kafka/channel/020-k8s-events.yaml b/docs/developer/eventing/kafka/channel/020-k8s-events.yaml similarity index 100% rename from docs/eventing/samples/kafka/channel/020-k8s-events.yaml rename to docs/developer/eventing/kafka/channel/020-k8s-events.yaml diff --git a/docs/eventing/samples/kafka/channel/030-trigger.yaml b/docs/developer/eventing/kafka/channel/030-trigger.yaml similarity index 100% rename from docs/eventing/samples/kafka/channel/030-trigger.yaml rename to docs/developer/eventing/kafka/channel/030-trigger.yaml diff --git a/docs/eventing/samples/kafka/channel/README.md b/docs/developer/eventing/kafka/channel/README.md similarity index 100% rename from docs/eventing/samples/kafka/channel/README.md rename to docs/developer/eventing/kafka/channel/README.md diff --git a/docs/eventing/broker/kafka-broker/README.md b/docs/developer/eventing/kafka/kafka-broker/README.md similarity index 100% rename from docs/eventing/broker/kafka-broker/README.md rename to docs/developer/eventing/kafka/kafka-broker/README.md diff --git a/docs/eventing/sources/kafka-source/README.md b/docs/developer/eventing/kafka/kafka-source/README.md similarity index 100% rename from docs/eventing/sources/kafka-source/README.md rename to docs/developer/eventing/kafka/kafka-source/README.md diff --git a/docs/eventing/sources/kafka-source/event-display.yaml b/docs/developer/eventing/kafka/kafka-source/event-display.yaml similarity index 100% rename from docs/eventing/sources/kafka-source/event-display.yaml rename to docs/developer/eventing/kafka/kafka-source/event-display.yaml diff --git a/docs/eventing/sources/kafka-source/event-source.yaml b/docs/developer/eventing/kafka/kafka-source/event-source.yaml similarity index 100% rename from docs/eventing/sources/kafka-source/event-source.yaml rename to docs/developer/eventing/kafka/kafka-source/event-source.yaml diff --git a/docs/eventing/sources/kafka-source/kafka-topic.yaml b/docs/developer/eventing/kafka/kafka-source/kafka-topic.yaml similarity index 100% rename from docs/eventing/sources/kafka-source/kafka-topic.yaml rename to docs/developer/eventing/kafka/kafka-source/kafka-topic.yaml diff --git a/docs/eventing/samples/kafka/kafka.yaml b/docs/developer/eventing/kafka/kafka.yaml similarity index 100% rename from docs/eventing/samples/kafka/kafka.yaml rename to docs/developer/eventing/kafka/kafka.yaml diff --git a/docs/eventing/samples/kafka/kafka_setup.sh b/docs/developer/eventing/kafka/kafka_setup.sh similarity index 100% rename from docs/eventing/samples/kafka/kafka_setup.sh rename to docs/developer/eventing/kafka/kafka_setup.sh diff --git a/mkdocs.yml b/mkdocs.yml index 11d7e06daa6..9a2b1366c14 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -84,6 +84,14 @@ nav: - Event sinks: - About sinks: developer/eventing/sinks/README.md - KafkaSink: developer/eventing/sinks/kafka-sink.md + - Kafka integration: + - Using Kafka with Knative: developer/eventing/kafka/README.md + - Kafka components: + - KafkaSource: developer/eventing/kafka/kafka-source/README.md + - KafkaBroker: developer/eventing/broker/kafka-broker/README.md + #- Kafka sink: Move sink to here? + - KafkaBinding: eventing/samples/kafka/binding/README.md + - KafkaChannel: eventing/samples/kafka/channel/README.md # Serving - Knative Serving: - Overview: serving/README.md @@ -166,7 +174,6 @@ nav: - Creating a SinkBinding object: eventing/sources/sinkbinding/getting-started.md - SinkBinding reference: eventing/sources/sinkbinding/reference.md - Camel source: eventing/sources/apache-camel-source/README.md - - Kafka source: eventing/sources/kafka-source/README.md - Creating an event source: - Overview: eventing/sources/creating-event-sources/README.md - Writing an event source using Javascript: eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md @@ -201,8 +208,6 @@ nav: - Creating a broker: eventing/broker/create-mtbroker.md - Triggers: eventing/broker/triggers/README.md - Broker configuration example: eventing/broker/example-mtbroker.md - - Apache Kafka Broker: - - Overview: eventing/broker/kafka-broker/README.md - Debugging: eventing/debugging/README.md - Accessing CloudEvent traces: eventing/accessing-traces.md - Experimental Features: eventing/experimental-features.md @@ -213,10 +218,6 @@ nav: - Overview: eventing/samples/helloworld/README.md - GO: eventing/samples/helloworld/helloworld-go/README.md - Python: eventing/samples/helloworld/helloworld-python/README.md - - Apache Kafka: - - Overview: eventing/samples/kafka/README.md - - Binding Example: eventing/samples/kafka/binding/README.md - - Channel Example: eventing/samples/kafka/channel/README.md - Parallel: - Overview: eventing/samples/parallel/README.md - Multiple Cases: eventing/samples/parallel/multiple-branches/README.md @@ -297,6 +298,15 @@ plugins: # Redirects - redirects: redirect_maps: + # moved whole kafka sections, edit and cleanup to follow + # + 'eventing/samples/kafka/channel/README.md': 'developer/eventing/kafka/channel/README.md' + 'eventing/samples/kafka/binding/README.md': 'developer/eventing/kafka/binding/README.md' + 'eventing/samples/kafka/README.md': 'developer/eventing/kafka/README.md' + 'eventing/broker/kafka-broker/README.md': 'developer/eventing/broker/kafka-broker/README.md' + 'eventing/sources/kafka-source/README.md': 'developer/eventing/kafka/kafka-source/README.md' + # + # moved whole kafka folder including YAML files temporarily 'eventing/sink/kafka-sink.md': 'developer/eventing/sinks/kafka-sink.md' 'eventing/sink/README.md': 'developer/eventing/sinks/README.md' 'eventing/broker/broker-event-delivery.md': 'developer/eventing/event-delivery.md'