Skip to content

Commit

Permalink
Document KafkaSource v1 API (#6201)
Browse files Browse the repository at this point in the history
Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com>
  • Loading branch information
pierDipi authored Jan 22, 2025
1 parent 4e1b454 commit fed9152
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion code-samples/eventing/kafka/binding/event-source.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# KAFKA_TLS_CA_CERT_SECRET_NAME: Name of secret containing server CA cert to use when connecting with TLS (optional)
# KAFKA_TLS_CA_CERT_SECRET_KEY: Key within secret containing server CA cert to use when connecting with TLS (optional)

apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand Down
2 changes: 1 addition & 1 deletion docs/eventing/event-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ After your event source is instantiated, EventTypes are added to the registry.
Given the following KafkaSource sample to populate the registry:

```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-sample
Expand Down
2 changes: 1 addition & 1 deletion docs/eventing/sinks/job-sink.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ For example, you can trigger a `Job` when a Kafka record is sent to a Kafka topi
a [`KafkaSource`](./../sources/kafka-source):

```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand Down
14 changes: 7 additions & 7 deletions docs/eventing/sources/kafka-source/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ If you are using Strimzi:
1. Modify `source/event-source.yaml` accordingly with bootstrap servers, topics, and so on:
```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand Down Expand Up @@ -187,7 +187,7 @@ Alternatively, if you are using a GitOps approach, you can add the `consumers` k
```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand Down Expand Up @@ -253,7 +253,7 @@ The `KafkaSource` implements the `Delivery` Specificiation, allowing you to conf

```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand Down Expand Up @@ -298,7 +298,7 @@ To specify the key deserializer, add the label `kafkasources.sources.knative.dev
`KafkaSource` definition, as shown in the following example:

```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand All @@ -323,7 +323,7 @@ By default the `KafkaSource` starts consuming from the latest offset in each par
to consume from the earliest offset, set the initialOffset field to `earliest`, for example:

```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand Down Expand Up @@ -368,7 +368,7 @@ KafkaSource expects these files to be in PEM format. If they are in another form
2. Apply the KafkaSource. Modify the `bootstrapServers` and `topics` fields accordingly.

```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source-with-tls
Expand Down Expand Up @@ -431,7 +431,7 @@ Simple Authentication and Security Layer (SASL) is used by Apache Kafka for auth
1. Create or modify a KafkaSource so that it contains the following spec options:
```yaml
apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: example-source
Expand Down
2 changes: 1 addition & 1 deletion docs/eventing/sources/kafka-source/event-source.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
# KAFKA_TLS_CA_CERT_SECRET_KEY: Key within secret containing server CA cert to use when connecting with TLS (optional)
# KAFKA_INITIAL_OFFSET initial offset for the consumer group, should be one of 'earliest' or 'latest' (optional)

apiVersion: sources.knative.dev/v1beta1
apiVersion: sources.knative.dev/v1
kind: KafkaSource
metadata:
name: kafka-source
Expand Down

0 comments on commit fed9152

Please sign in to comment.