Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kafka Sink/source Kamelets: Changing some parameters name #432

Merged
merged 3 commits into from
Jul 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/modules/ROOT/pages/kafka-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ 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}* *| Brokers| 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| |
| *username {empty}* *| Username| Username to authenticate to Kafka| string| |
| *user {empty}* *| Username| Username to authenticate to Kafka| string| |
| saslMechanism| SASL Mechanism| The Simple Authentication and Security Layer (SASL) Mechanism used.| string| `"PLAIN"`|
| securityProtocol| Security Protocol| Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported| string| `"SASL_SSL"`|
|===
Expand Down Expand Up @@ -58,10 +58,10 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-sink
properties:
brokers: "The Brokers"
bootstrapServers: "The Brokers"
password: "The Password"
topic: "The Topic Names"
username: "The Username"
user: "The Username"

----

Expand All @@ -82,7 +82,7 @@ The procedure described above can be simplified into a single execution of the `

[source,shell]
----
kamel bind channel/mychannel kafka-sink -p "sink.brokers=The Brokers" -p "sink.password=The Password" -p "sink.topic=The Topic Names" -p "sink.username=The Username"
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"
----

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
Expand Down Expand Up @@ -110,10 +110,10 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-sink
properties:
brokers: "The Brokers"
bootstrapServers: "The Brokers"
password: "The Password"
topic: "The Topic Names"
username: "The Username"
user: "The Username"

----

Expand All @@ -135,7 +135,7 @@ The procedure described above can be simplified into a single execution of the `

[source,shell]
----
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic kafka-sink -p "sink.brokers=The Brokers" -p "sink.password=The Password" -p "sink.topic=The Topic Names" -p "sink.username=The Username"
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"
----

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
Expand Down
16 changes: 8 additions & 8 deletions docs/modules/ROOT/pages/kafka-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ 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}* *| Brokers| 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| |
| *username {empty}* *| Username| Username to authenticate to Kafka| string| |
| *user {empty}* *| Username| Username to authenticate to Kafka| 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`|
| autoOffsetReset| Auto Offset Reset| What to do when there is no initial offset. There are 3 enums and the value can be one of latest, earliest, none| string| `"latest"`|
Expand Down Expand Up @@ -49,10 +49,10 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-source
properties:
brokers: "The Brokers"
bootstrapServers: "The Brokers"
password: "The Password"
topic: "The Topic Names"
username: "The Username"
user: "The Username"
sink:
ref:
kind: InMemoryChannel
Expand All @@ -78,7 +78,7 @@ The procedure described above can be simplified into a single execution of the `

[source,shell]
----
kamel bind kafka-source -p "source.brokers=The Brokers" -p "source.password=The Password" -p "source.topic=The Topic Names" -p "source.username=The Username" channel/mychannel
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
----

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
Expand All @@ -101,10 +101,10 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kafka-source
properties:
brokers: "The Brokers"
bootstrapServers: "The Brokers"
password: "The Password"
topic: "The Topic Names"
username: "The Username"
user: "The Username"
sink:
ref:
kind: KafkaTopic
Expand All @@ -131,7 +131,7 @@ The procedure described above can be simplified into a single execution of the `

[source,shell]
----
kamel bind kafka-source -p "source.brokers=The Brokers" -p "source.password=The Password" -p "source.topic=The Topic Names" -p "source.username=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
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
----

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
Expand Down
12 changes: 6 additions & 6 deletions kafka-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ spec:
Both the headers are optional.
required:
- topic
- brokers
- username
- bootstrapServers
- user
- password
type: object
properties:
topic:
title: Topic Names
description: Comma separated list of Kafka topic names
type: string
brokers:
bootstrapServers:
title: Brokers
description: Comma separated list of Kafka Broker URLs
type: string
Expand All @@ -48,7 +48,7 @@ spec:
description: The Simple Authentication and Security Layer (SASL) Mechanism used.
type: string
default: PLAIN
username:
user:
title: Username
description: Username to authenticate to Kafka
type: string
Expand Down Expand Up @@ -93,7 +93,7 @@ spec:
- to:
uri: "kafka:{{topic}}"
parameters:
brokers: "{{brokers}}"
brokers: "{{bootstrapServers}}"
securityProtocol: "{{securityProtocol}}"
saslMechanism: "{{saslMechanism}}"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{username}}' password='{{password}}';"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{user}}' password='{{password}}';"
12 changes: 6 additions & 6 deletions kafka-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ spec:
Receive data from Kafka topics.
required:
- topic
- brokers
- username
- bootstrapServers
- user
- password
type: object
properties:
topic:
title: Topic Names
description: Comma separated list of Kafka topic names
type: string
brokers:
bootstrapServers:
title: Brokers
description: Comma separated list of Kafka Broker URLs
type: string
Expand All @@ -40,7 +40,7 @@ spec:
description: The Simple Authentication and Security Layer (SASL) Mechanism used.
type: string
default: PLAIN
username:
user:
title: Username
description: Username to authenticate to Kafka
type: string
Expand Down Expand Up @@ -82,10 +82,10 @@ spec:
from:
uri: "kafka:{{topic}}"
parameters:
brokers: "{{brokers}}"
brokers: "{{?bootstrapServers}}"
securityProtocol: "{{securityProtocol}}"
saslMechanism: "{{saslMechanism}}"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{username}}' password='{{password}}';"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{user}}' password='{{password}}';"
autoCommitEnable: "{{autoCommitEnable}}"
allowManualCommit: "{{allowManualCommit}}"
pollOnError: "{{pollOnError}}"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ spec:
Both the headers are optional.
required:
- topic
- brokers
- username
- bootstrapServers
- user
- password
type: object
properties:
topic:
title: Topic Names
description: Comma separated list of Kafka topic names
type: string
brokers:
bootstrapServers:
title: Brokers
description: Comma separated list of Kafka Broker URLs
type: string
Expand All @@ -48,7 +48,7 @@ spec:
description: The Simple Authentication and Security Layer (SASL) Mechanism used.
type: string
default: PLAIN
username:
user:
title: Username
description: Username to authenticate to Kafka
type: string
Expand Down Expand Up @@ -93,7 +93,7 @@ spec:
- to:
uri: "kafka:{{topic}}"
parameters:
brokers: "{{brokers}}"
brokers: "{{bootstrapServers}}"
securityProtocol: "{{securityProtocol}}"
saslMechanism: "{{saslMechanism}}"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{username}}' password='{{password}}';"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{user}}' password='{{password}}';"
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ spec:
Receive data from Kafka topics.
required:
- topic
- brokers
- username
- bootstrapServers
- user
- password
type: object
properties:
topic:
title: Topic Names
description: Comma separated list of Kafka topic names
type: string
brokers:
bootstrapServers:
title: Brokers
description: Comma separated list of Kafka Broker URLs
type: string
Expand All @@ -40,7 +40,7 @@ spec:
description: The Simple Authentication and Security Layer (SASL) Mechanism used.
type: string
default: PLAIN
username:
user:
title: Username
description: Username to authenticate to Kafka
type: string
Expand Down Expand Up @@ -82,10 +82,10 @@ spec:
from:
uri: "kafka:{{topic}}"
parameters:
brokers: "{{brokers}}"
brokers: "{{?bootstrapServers}}"
securityProtocol: "{{securityProtocol}}"
saslMechanism: "{{saslMechanism}}"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{username}}' password='{{password}}';"
saslJaasConfig: "org.apache.kafka.common.security.plain.PlainLoginModule required username='{{user}}' password='{{password}}';"
autoCommitEnable: "{{autoCommitEnable}}"
allowManualCommit: "{{allowManualCommit}}"
pollOnError: "{{pollOnError}}"
Expand Down