diff --git a/docs/eventing/channels/channels-crds.md b/docs/eventing/channels/channels-crds.md index e358a9824..07834b937 100644 --- a/docs/eventing/channels/channels-crds.md +++ b/docs/eventing/channels/channels-crds.md @@ -16,9 +16,11 @@ This is a non-exhaustive list of the available Channels for Knative Eventing. !!! note Inclusion in this list is not an endorsement, nor does it imply any level of support. -Name | Status | Support | Description ---- | --- | --- | --- +Name | Status | Support | Description +--- |------------------| --- | --- [GCP PubSub](https://github.com/google/knative-gcp) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). [InMemoryChannel](https://github.com/knative/eventing/tree/{{ branch }}/config/channels/in-memory-channel/README.md) | Proof of Concept | None | In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. -[KafkaChannel](https://github.com/knative-sandbox/eventing-kafka-broker/tree/{{ branch }}/docs/channel/README.md) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. +[KafkaChannel](https://github.com/knative-sandbox/eventing-kafka-broker/tree/{{ branch }}/README.md) | Beta | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. [NatssChannel](https://github.com/knative-sandbox/eventing-natss/tree/{{ branch }}/config/README.md) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). +[KafkaChannel - Consolidated](https://github.com/knative-sandbox/eventing-kafka/tree/{{ branch }}/pkg/channel/consolidated/README.md) | Deprecated | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. The original Knative KafkaChannel implementation which utilizes a single combined Kafka Producer / Consumer deployment. +[KafkaChannel - Distributed](https://github.com/knative-sandbox/eventing-kafka/tree/{{ branch }}/pkg/channel/distributed/README.md) | Deprecated | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. An alternate KafkaChannel implementation, contributed by SAP's [Kyma](https://kyma-project.io/) project, which provides a more granular deployment of Producers / Consumers. diff --git a/docs/eventing/channels/channels.yaml b/docs/eventing/channels/channels.yaml index 8e3707fe2..67a11f0a4 100644 --- a/docs/eventing/channels/channels.yaml +++ b/docs/eventing/channels/channels.yaml @@ -7,8 +7,8 @@ channels: description: > In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. - name: KafkaChannel - url: https://github.com/knative-sandbox/eventing-kafka/tree/{{< branch >}}/pkg/channel/consolidated/README.md - status: Proof of Concept + url: https://github.com/knative-sandbox/eventing-kafka-broker/tree/{{< branch >}}/README.md + status: Beta support: None description: > Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. @@ -24,9 +24,3 @@ channels: support: None description: > Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). - - name: Knative sandbox channel that uses Confluent Go Client, and the librdkafka C library - url: https://github.com/knative-sandbox/eventing-kafka - status: Proof of Concept - support: None - description: > - Kafka Channel implementation, contributed by SAP's Kyma project, is a Knative Eventing implementation of a Kafka backed channel which provides advanced functionality and production grade qualities. diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index 49b7e46f6..63cb1ce42 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -176,7 +176,7 @@ Uninstall any Eventing extensions you have installed by following the relevant p Uninstall the Apache Kafka source by running: ```bash - kubectl delete -f {{ artifact(org="knative-sandbox", repo="eventing-kafka", file="source.yaml") }} + kubectl delete -f {{ artifact(org="knative-sandbox", repo="eventing-kafka-broker", file="eventing-kafka-source.yaml") }} ``` @@ -263,9 +263,7 @@ Uninstall each channel layer you have installed: Uninstall the Apache Kafka Channel by running: ```bash - curl -L "{{ artifact(org="knative-sandbox", repo="eventing-kafka", file="channel-consolidated.yaml") }}" \ - | sed 's/REPLACE_WITH_CLUSTER_URL/my-cluster-kafka-bootstrap.kafka:9092/' \ - | kubectl delete -f - + kubectl delete -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-channel.yaml")}} ``` diff --git a/docs/install/yaml-install/eventing/install-eventing-with-yaml.md b/docs/install/yaml-install/eventing/install-eventing-with-yaml.md index 6c5cdb636..551105d5c 100644 --- a/docs/install/yaml-install/eventing/install-eventing-with-yaml.md +++ b/docs/install/yaml-install/eventing/install-eventing-with-yaml.md @@ -50,8 +50,28 @@ Follow the procedure for the Channel of your choice: === "Apache Kafka Channel" - 1. Install [Strimzi](https://strimzi.io/quickstarts/). - 1. Install the Apache Kafka Channel for Knative from the [`knative-sandbox` repository](https://github.com/knative-sandbox/eventing-kafka). + + The following commands install the KafkaChannel and run event routing in a system + namespace. The `knative-eventing` namespace is used by default. + + 1. Install the Kafka controller by running the following command: + + ```bash + kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-controller.yaml")}} + ``` + + 1. Install the KafkaChannel data plane by running the following command: + + ```bash + kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-channel.yaml")}} + ``` + + 1. If you're upgrading from the previous version, run the following command: + + ```bash + kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-post-install.yaml")}} + ``` + === "Google Cloud Pub/Sub Channel" @@ -115,6 +135,13 @@ Follow the procedure for the Broker of your choice: kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-broker.yaml")}} ``` + 1. If you're upgrading from the previous version, run the following command: + + ```bash + kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-post-install.yaml")}} + ``` + + For more information, see the [Kafka Broker](../../../eventing/broker/kafka-broker/README.md) documentation. === "MT-Channel-based" @@ -265,10 +292,16 @@ The following tabs expand to show instructions for installing each Eventing exte === "Apache Kafka Source" - * Install the Apache Kafka Source by running the command: + 1. Install the Apache Kafka Source by running the command: ```bash - kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka",file="source.yaml")}} + kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-source.yaml")}} + ``` + + 1. If you're upgrading from the previous version, run the following command: + + ```bash + kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-post-install.yaml")}} ``` To learn more, try the [Apache Kafka source sample](../../../eventing/sources/kafka-source/README.md).