add badges and minor editing (#5252)

This commit is contained in:
Lionel Villard 2022-10-04 13:59:29 -04:00 committed by GitHub
parent f545f21a0e
commit 136b53dc25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 5 deletions

View File

@ -1,5 +1,6 @@
# ApiServerSource
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)
![version](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)
The API server source is a Knative Eventing Kubernetes custom resource that listens for events emitted by the

View File

@ -1,10 +1,14 @@
# Apache Kafka Source
The `KafkaSource` reads all the messages, from all partitions, and sends those messages as CloudEvents through HTTP to its configured `sink`. The `KafkaSource` supports an ordered consumer delivery guaranty, which is a per-partition blocking consumer that waits for a successful response from the CloudEvent subscriber before it delivers the next message of the partition.
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)
![version](https://img.shields.io/badge/API_Version-v1beta1-yellow?style=flat-square)
## Installing Kafka source
1. Install the Kafka controller by entering the following command:
The `KafkaSource` reads messages stored in existing [Apache Kafka](https://kafka.apache.org) topics, and sends those messages as CloudEvents through HTTP to its configured `sink`. The `KafkaSource` preserves the order of the messages
stored in the topic partitions. It does this by waiting for a successful response from the `sink` before it delivers the next message in the same partition.
## Install the KafkaSource controller
1. Install the `KafkaSource` controller by entering the following command:
```bash
kubectl apply -f {{ artifact(org="knative-sandbox", repo="eventing-kafka-broker", file="eventing-kafka-controller.yaml") }}
@ -30,7 +34,7 @@ The `KafkaSource` reads all the messages, from all partitions, and sends those m
kafka-source-dispatcher 1/1 1 1 4s
```
## Create a Kafka topic
## Optional: Create a Kafka topic
!!! note
The create a Kafka topic section assumes you're using Strimzi to operate Apache Kafka, however equivalent operations can be replicated using the Apache Kafka CLI or any other tool.

View File

@ -1,6 +1,7 @@
# Creating a PingSource object
![API version v1](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)
![version](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)
This topic describes how to create a PingSource object.

View File

@ -1,5 +1,8 @@
# Creating a RabbitMQSource
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)
![version](https://img.shields.io/badge/API_Version-v1alpha1-red?style=flat-square)
This topic describes how to create a RabbitMQSource.
## Prerequisites