Skip to content

Commit

Permalink
Update doc and regen
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaferraro authored and oscerd committed Dec 9, 2021
1 parent e6d903e commit e8d8bfe
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 38 deletions.
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/kafka-not-secured-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following table summarizes the configuration options available for the `kafk
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *brokers {empty}* *| Brokers| Comma separated list of Kafka Broker URLs| string| |
| *bootstrapServers {empty}* *| Bootstrap Servers| Comma separated list of Kafka Broker URLs| string| |
| *topic {empty}* *| Topic Names| Comma separated list of Kafka topic names| string| |
|===

Expand Down Expand Up @@ -63,7 +63,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-not-secured-sink
properties:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"
----
Expand All @@ -89,7 +89,7 @@ Configure and run the sink by using the following command:

[source,shell]
----
kamel bind channel:mychannel kafka-not-secured-sink -p "sink.brokers=The Brokers" -p "sink.topic=The Topic Names"
kamel bind channel:mychannel kafka-not-secured-sink -p "sink.bootstrapServers=The Bootstrap Servers" -p "sink.topic=The Topic Names"
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand Down Expand Up @@ -117,7 +117,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-not-secured-sink
properties:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"
----
Expand Down Expand Up @@ -145,7 +145,7 @@ Configure and run the sink by using the following command:

[source,shell]
----
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic kafka-not-secured-sink -p "sink.brokers=The Brokers" -p "sink.topic=The Topic Names"
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic kafka-not-secured-sink -p "sink.bootstrapServers=The Bootstrap Servers" -p "sink.topic=The Topic Names"
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/kafka-not-secured-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The following table summarizes the configuration options available for the `kafk
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *brokers {empty}* *| Brokers| Comma separated list of Kafka Broker URLs| string| |
| *bootstrapServers {empty}* *| Bootstrap Servers| Comma separated list of Kafka Broker URLs| string| |
| *topic {empty}* *| Topic Names| Comma separated list of Kafka topic names| string| |
| allowManualCommit| Allow Manual Commit| Whether to allow doing manual commits| boolean| `false`|
| autoCommitEnable| Auto Commit Enable| If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer| boolean| `true`|
Expand Down Expand Up @@ -55,7 +55,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-not-secured-source
properties:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"
sink:
ref:
Expand Down Expand Up @@ -86,7 +86,7 @@ Configure and run the source by using the following command:

[source,shell]
----
kamel bind kafka-not-secured-source -p "source.brokers=The Brokers" -p "source.topic=The Topic Names" channel:mychannel
kamel bind kafka-not-secured-source -p "source.bootstrapServers=The Bootstrap Servers" -p "source.topic=The Topic Names" channel:mychannel
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand All @@ -109,7 +109,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-not-secured-source
properties:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"
sink:
ref:
Expand Down Expand Up @@ -142,7 +142,7 @@ Configure and run the source by using the following command:

[source,shell]
----
kamel bind kafka-not-secured-source -p "source.brokers=The Brokers" -p "source.topic=The Topic Names" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
kamel bind kafka-not-secured-source -p "source.bootstrapServers=The Bootstrap Servers" -p "source.topic=The Topic Names" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/kafka-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following table summarizes the configuration options available for the `kafk
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *bootstrapServers {empty}* *| Brokers| Comma separated list of Kafka Broker URLs| string| |
| *bootstrapServers {empty}* *| Bootstrap Servers| Comma separated list of Kafka Broker URLs| string| |
| *password {empty}* *| Password| Password to authenticate to kafka| string| |
| *topic {empty}* *| Topic Names| Comma separated list of Kafka topic names| string| |
| *user {empty}* *| Username| Username to authenticate to Kafka| string| |
Expand Down Expand Up @@ -67,7 +67,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-sink
properties:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down Expand Up @@ -95,7 +95,7 @@ Configure and run the sink by using the following command:

[source,shell]
----
kamel bind channel:mychannel kafka-sink -p "sink.bootstrapServers=The Brokers" -p "sink.password=The Password" -p "sink.topic=The Topic Names" -p "sink.user=The Username"
kamel bind channel:mychannel kafka-sink -p "sink.bootstrapServers=The Bootstrap Servers" -p "sink.password=The Password" -p "sink.topic=The Topic Names" -p "sink.user=The Username"
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand Down Expand Up @@ -123,7 +123,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-sink
properties:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down Expand Up @@ -153,7 +153,7 @@ Configure and run the sink by using the following command:

[source,shell]
----
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic kafka-sink -p "sink.bootstrapServers=The Brokers" -p "sink.password=The Password" -p "sink.topic=The Topic Names" -p "sink.user=The Username"
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic kafka-sink -p "sink.bootstrapServers=The Bootstrap Servers" -p "sink.password=The Password" -p "sink.topic=The Topic Names" -p "sink.user=The Username"
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/kafka-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The following table summarizes the configuration options available for the `kafk
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *bootstrapServers {empty}* *| Brokers| Comma separated list of Kafka Broker URLs| string| |
| *bootstrapServers {empty}* *| Bootstrap Servers| Comma separated list of Kafka Broker URLs| string| |
| *password {empty}* *| Password| Password to authenticate to kafka| string| |
| *topic {empty}* *| Topic Names| Comma separated list of Kafka topic names| string| |
| *user {empty}* *| Username| Username to authenticate to Kafka| string| |
Expand Down Expand Up @@ -59,7 +59,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-source
properties:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down Expand Up @@ -92,7 +92,7 @@ Configure and run the source by using the following command:

[source,shell]
----
kamel bind kafka-source -p "source.bootstrapServers=The Brokers" -p "source.password=The Password" -p "source.topic=The Topic Names" -p "source.user=The Username" channel:mychannel
kamel bind kafka-source -p "source.bootstrapServers=The Bootstrap Servers" -p "source.password=The Password" -p "source.topic=The Topic Names" -p "source.user=The Username" channel:mychannel
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand All @@ -115,7 +115,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-source
properties:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down Expand Up @@ -150,7 +150,7 @@ Configure and run the source by using the following command:

[source,shell]
----
kamel bind kafka-source -p "source.bootstrapServers=The Brokers" -p "source.password=The Password" -p "source.topic=The Topic Names" -p "source.user=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
kamel bind kafka-source -p "source.bootstrapServers=The Bootstrap Servers" -p "source.password=The Password" -p "source.topic=The Topic Names" -p "source.user=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
----

This command creates the KameletBinding in the current namespace on the cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ spec:
Both the headers are optional.
required:
- topic
- brokers
- bootstrapServers
type: object
properties:
topic:
title: Topic Names
description: Comma separated list of Kafka topic names
type: string
brokers:
title: Brokers
bootstrapServers:
title: Bootstrap Servers
description: Comma separated list of Kafka Broker URLs
type: string
dependencies:
Expand Down Expand Up @@ -86,4 +86,4 @@ spec:
- to:
uri: "kafka:{{topic}}"
parameters:
brokers: "{{brokers}}"
brokers: "{{bootstrapServers}}"
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ spec:
Receive data from Kafka topics on an insecure broker.
required:
- topic
- brokers
- bootstrapServers
type: object
properties:
topic:
title: Topic Names
description: Comma separated list of Kafka topic names
type: string
brokers:
title: Brokers
bootstrapServers:
title: Bootstrap Servers
description: Comma separated list of Kafka Broker URLs
type: string
autoCommitEnable:
Expand Down Expand Up @@ -80,7 +80,7 @@ spec:
from:
uri: "kafka:{{topic}}"
parameters:
brokers: "{{brokers}}"
brokers: "{{bootstrapServers}}"
autoCommitEnable: "{{autoCommitEnable}}"
allowManualCommit: "{{allowManualCommit}}"
pollOnError: "{{pollOnError}}"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ spec:
description: Comma separated list of Kafka topic names
type: string
bootstrapServers:
title: Brokers
title: Bootstrap Servers
description: Comma separated list of Kafka Broker URLs
type: string
securityProtocol:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ spec:
description: Comma separated list of Kafka topic names
type: string
bootstrapServers:
title: Brokers
title: Bootstrap Servers
description: Comma separated list of Kafka Broker URLs
type: string
securityProtocol:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-not-secured-sink
properties:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-not-secured-source
properties:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"
sink:
ref:
Expand Down
2 changes: 1 addition & 1 deletion templates/bindings/camel-k/kafka-sink-binding.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-sink
properties:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down
2 changes: 1 addition & 1 deletion templates/bindings/camel-k/kafka-source-binding.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-source
properties:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
- to:
uri: "kamelet:kafka-not-secured-sink"
parameters:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from:
uri: "kamelet:kafka-not-secured-source"
parameters:
brokers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
topic: "The Topic Names"
steps:
- to:
Expand Down
2 changes: 1 addition & 1 deletion templates/bindings/core/kafka-sink-binding.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- to:
uri: "kamelet:kafka-sink"
parameters:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down
2 changes: 1 addition & 1 deletion templates/bindings/core/kafka-source-binding.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from:
uri: "kamelet:kafka-source"
parameters:
bootstrapServers: "The Brokers"
bootstrapServers: "The Bootstrap Servers"
password: "The Password"
topic: "The Topic Names"
user: "The Username"
Expand Down

0 comments on commit e8d8bfe

Please sign in to comment.