kafka-batch-source/kamelet.json

420 lines
18 KiB
JSON
Raw Permalink Normal View History

{
"apiVersion": "camel.apache.org/v1",
"kind": "Kamelet",
"metadata": {
"name": "kafka-batch-source",
"annotations": {
"camel.apache.org/kamelet.support.level": "Stable",
"camel.apache.org/catalog.version": "4.22.1",
"camel.apache.org/kamelet.icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOS4wLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCA1MDAgNTAwIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MDAgNTAwOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+DQo8ZyBpZD0iWE1MSURfMV8iPg0KCTxwYXRoIGlkPSJYTUxJRF85XyIgZD0iTTMxNC44LDI2OS43Yy0xNC4yLDAtMjcsNi4zLTM1LjcsMTYuMkwyNTYuOCwyNzBjMi40LTYuNSwzLjctMTMuNiwzLjctMjAuOWMwLTcuMi0xLjMtMTQuMS0zLjYtMjAuNg0KCQlsMjIuMy0xNS43YzguNyw5LjksMjEuNCwxNi4xLDM1LjYsMTYuMWMyNi4yLDAsNDcuNi0yMS4zLDQ3LjYtNDcuNnMtMjEuMy00Ny42LTQ3LjYtNDcuNnMtNDcuNiwyMS4zLTQ3LjYsNDcuNg0KCQljMCw0LjcsMC43LDkuMiwyLDEzLjVsLTIyLjMsMTUuN2MtOS4zLTExLjYtMjIuOC0xOS42LTM4LjEtMjIuMXYtMjYuOWMyMS42LTQuNSwzNy44LTIzLjcsMzcuOC00Ni42YzAtMjYuMi0yMS4zLTQ3LjYtNDcuNi00Ny42DQoJCWMtMjYuMiwwLTQ3LjYsMjEuMy00Ny42LDQ3LjZjMCwyMi42LDE1LjgsNDEuNSwzNi45LDQ2LjN2MjcuM2MtMjguOCw1LjEtNTAuOCwzMC4yLTUwLjgsNjAuNWMwLDMwLjQsMjIuMiw1NS43LDUxLjIsNjAuNXYyOC44DQoJCWMtMjEuMyw0LjctMzcuNCwyMy43LTM3LjQsNDYuNGMwLDI2LjIsMjEuMyw0Ny42LDQ3LjYsNDcuNmMyNi4yLDAsNDcuNi0yMS4zLDQ3LjYtNDcuNmMwLTIyLjctMTYtNDEuOC0zNy40LTQ2LjR2LTI4LjgNCgkJYzE1LTIuNSwyOC4yLTEwLjQsMzcuNC0yMS44bDIyLjUsMTUuOWMtMS4yLDQuMy0xLjksOC43LTEuOSwxMy40YzAsMjYuMiwyMS4zLDQ3LjYsNDcuNiw0Ny42czQ3LjYtMjEuMyw0Ny42LTQ3LjYNCgkJQzM2Mi40LDI5MSwzNDEuMSwyNjkuNywzMTQuOCwyNjkuN3ogTTMxNC44LDE1OC40YzEyLjcsMCwyMy4xLDEwLjQsMjMuMSwyMy4xYzAsMTIuNy0xMC4zLDIzLjEtMjMuMSwyMy4xcy0yMy4xLTEwLjQtMjMuMS0yMy4xDQoJCUMyOTEuOCwxNjguOCwzMDIuMSwxNTguNCwzMTQuOCwxNTguNHogTTE3NiwxMTUuMWMwLTEyLjcsMTAuMy0yMy4xLDIzLjEtMjMuMWMxMi43LDAsMjMuMSwxMC40LDIzLjEsMjMuMQ0KCQljMCwxMi43LTEwLjMsMjMuMS0yMy4xLDIzLjFDMTg2LjMsMTM4LjIsMTc2LDEyNy44LDE3NiwxMTUuMXogTTIyMi4xLDM4NC45YzAsMTIuNy0xMC4zLDIzLjEtMjMuMSwyMy4xDQoJCWMtMTIuNywwLTIzLjEtMTAuNC0yMy4xLTIzLjFjMC0xMi43LDEwLjMtMjMuMSwyMy4xLTIzLjFDMjExLjgsMzYxLjgsMjIyLjEsMzcyLjIsMjIyLjEsMzg0Ljl6IE0xOTkuMSwyODEuMw0KCQljLTE3LjcsMC0zMi4yLTE0LjQtMzIuMi0zMi4yYzAtMTcuNywxNC40LTMyLjIsMzIuMi0zMi4yYzE3LjcsMCwzMi4yLDE0LjQsMzIuMiwzMi4yQzIzMS4yLDI2Ni45LDIxNi44LDI4MS4zLDE5OS4xLDI4MS4zeg0KCQkgTTMxNC44LDM0MC4zYy0xMi43LDAtMjMuMS0xMC40LTIzLjEtMjMuMWMwLTEyLjcsMTAuMy0yMy4xLDIzLjEtMjMuMXMyMy4xLDEwLjQsMjMuMSwyMy4xQzMzNy45LDMzMCwzMjcuNSwzNDAuMywzMTQuOCwzNDAuM3oiLz4NCjwvZz4NCjwvc3ZnPg0K",
"camel.apache.org/provider": "Apache Software Foundation",
"camel.apache.org/kamelet.group": "Kafka",
"camel.apache.org/kamelet.namespace": "Kafka"
},
"labels": {
"camel.apache.org/kamelet.type": "source"
}
},
"spec": {
"definition": {
"title": "Kafka Batch Source",
"description": "Receive data from Kafka topics in batch and commit them manually through KafkaManualCommit. This provides complete control over when messages are committed, allowing for custom processing logic before acknowledgment.",
"required": [
"topic",
"bootstrapServers"
],
"type": "object",
"properties": {
"topic": {
"title": "Topic Names",
"description": "Comma separated list of Kafka topic names",
"type": "string"
},
"bootstrapServers": {
"title": "Bootstrap Servers",
"description": "Comma separated list of Kafka Broker URLs",
"type": "string"
},
"saslAuthType": {
"title": "Authentication Type",
"description": "Authentication type to use. Use NONE for no authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS for Kerberos.",
"type": "string",
"default": "NONE",
"enum": [
"NONE",
"PLAIN",
"SCRAM_SHA_256",
"SCRAM_SHA_512",
"SSL",
"OAUTH",
"AWS_MSK_IAM",
"KERBEROS"
]
},
"saslUsername": {
"title": "Username",
"description": "Username for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.",
"type": "string",
"x-descriptors": [
"urn:camel:group:credentials"
]
},
"saslPassword": {
"title": "Password",
"description": "Password for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.",
"type": "string",
"format": "password",
"x-descriptors": [
"urn:camel:group:credentials"
]
},
"oauthClientId": {
"title": "OAuth Client ID",
"description": "OAuth client ID. Required when saslAuthType is OAUTH.",
"type": "string"
},
"oauthClientSecret": {
"title": "OAuth Client Secret",
"description": "OAuth client secret. Required when saslAuthType is OAUTH.",
"type": "string",
"format": "password",
"x-descriptors": [
"urn:camel:group:credentials"
]
},
"oauthTokenEndpointUri": {
"title": "OAuth Token Endpoint",
"description": "OAuth token endpoint URI. Required when saslAuthType is OAUTH.",
"type": "string"
},
"oauthScope": {
"title": "OAuth Scope",
"description": "OAuth scope. Optional when saslAuthType is OAUTH.",
"type": "string"
},
"sslTruststoreLocation": {
"title": "SSL Truststore Location",
"description": "The location of the trust store file.",
"type": "string"
},
"sslTruststorePassword": {
"title": "SSL Truststore Password",
"description": "The password for the trust store file.",
"type": "string",
"format": "password",
"x-descriptors": [
"urn:camel:group:credentials"
]
},
"sslKeystoreLocation": {
"title": "SSL Keystore Location",
"description": "The location of the key store file. Used for mTLS authentication.",
"type": "string"
},
"sslKeystorePassword": {
"title": "SSL Keystore Password",
"description": "The password for the key store file.",
"type": "string",
"format": "password",
"x-descriptors": [
"urn:camel:group:credentials"
]
},
"sslKeyPassword": {
"title": "SSL Key Password",
"description": "The password of the private key in the key store file.",
"type": "string",
"format": "password",
"x-descriptors": [
"urn:camel:group:credentials"
]
},
"autoCommitEnable": {
"title": "Auto Commit Enable",
"description": "If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer",
"type": "boolean",
"default": true
},
"allowManualCommit": {
"title": "Allow Manual Commit",
"description": "Whether to allow doing manual commits",
"type": "boolean",
"default": false
},
"pollOnError": {
"title": "Poll On Error Behavior",
"description": "What to do if kafka threw an exception while polling for new messages. There are 5 enums and the value can be one of DISCARD, ERROR_HANDLER, RECONNECT, RETRY, STOP",
"type": "string",
"default": "ERROR_HANDLER"
},
"autoOffsetReset": {
"title": "Auto Offset Reset",
"description": "What to do when there is no initial offset. There are 3 enums and the value can be one of latest, earliest, none",
"type": "string",
"default": "latest"
},
"consumerGroup": {
"title": "Consumer Group",
"description": "A string that uniquely identifies the group of consumers to which this source belongs",
"type": "string",
"example": "my-group-id"
},
"deserializeHeaders": {
"title": "Automatically Deserialize Headers",
"description": "When enabled the Kamelet source will deserialize all message headers to String representation.",
"type": "boolean",
"default": true
},
"batchSize": {
"title": "Batch Dimension",
"description": "The maximum number of records returned in a single call to poll()",
"type": "integer",
"default": 500
},
"pollTimeout": {
"title": "Poll Timeout Interval",
"description": "The timeout used when polling the KafkaConsumer",
"type": "integer",
"default": 5000
},
"maxPollIntervalMs": {
"title": "Max Poll Interval",
"description": "The maximum delay between invocations of poll() when using consumer group management",
"type": "integer"
},
"batchingIntervalMs": {
"title": "Batching Interval",
"description": "In consumer batching mode, then this option is specifying a time in millis, to trigger batch completion eager when the current batch size has not reached the maximum size defined by maxPollRecords. Notice the trigger is not exact at the given interval, as this can only happen between kafka polls (see pollTimeoutMs option).",
"type": "integer"
},
"topicIsPattern": {
"title": "Topic Is Pattern",
"description": "Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern.",
"type": "boolean",
"default": false
}
}
},
"dependencies": [
"camel:core",
"camel:kafka",
"camel:kamelet"
],
"template": {
"beans": [
{
"name": "kafkaHeaderDeserializer",
"type": "#class:org.apache.camel.component.kafka.KafkaHeaderDeserializer",
"properties": {
"enabled": "{{deserializeHeaders}}"
}
},
{
"name": "manualCommitFactory",
"type": "#class:org.apache.camel.component.kafka.consumer.DefaultKafkaManualCommitFactory"
}
],
"from": {
"uri": "kafka:{{topic}}",
"parameters": {
"brokers": "{{bootstrapServers}}",
"saslAuthType": "{{saslAuthType}}",
"saslUsername": "{{?saslUsername}}",
"saslPassword": "{{?saslPassword}}",
"oauthClientId": "{{?oauthClientId}}",
"oauthClientSecret": "{{?oauthClientSecret}}",
"oauthTokenEndpointUri": "{{?oauthTokenEndpointUri}}",
"oauthScope": "{{?oauthScope}}",
"sslTruststoreLocation": "{{?sslTruststoreLocation}}",
"sslTruststorePassword": "{{?sslTruststorePassword}}",
"sslKeystoreLocation": "{{?sslKeystoreLocation}}",
"sslKeystorePassword": "{{?sslKeystorePassword}}",
"sslKeyPassword": "{{?sslKeyPassword}}",
"autoCommitEnable": "{{autoCommitEnable}}",
"allowManualCommit": "{{allowManualCommit}}",
"pollOnError": "{{pollOnError}}",
"autoOffsetReset": "{{autoOffsetReset}}",
"groupId": "{{?consumerGroup}}",
"maxPollRecords": "{{batchSize}}",
"pollTimeoutMs": "{{pollTimeout}}",
"maxPollIntervalMs": "{{?maxPollIntervalMs}}",
"batchingIntervalMs": "{{?batchingIntervalMs}}",
"batching": true,
"kafkaManualCommitFactory": "#bean:{{manualCommitFactory}}",
"topicIsPattern": "{{topicIsPattern}}"
},
"steps": [
{
"process": {
"ref": "{{kafkaHeaderDeserializer}}"
}
},
{
"to": "kamelet:sink"
}
]
}
}
},
"propertiesSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Kafka Batch Source",
"description": "Receive data from Kafka topics in batch and commit them manually through KafkaManualCommit. This provides complete control over when messages are committed, allowing for custom processing logic before acknowledgment.",
"required": [
"topic",
"bootstrapServers"
],
"properties": {
"topic": {
"type": "string",
"title": "Topic Names",
"description": "Comma separated list of Kafka topic names"
},
"bootstrapServers": {
"type": "string",
"title": "Bootstrap Servers",
"description": "Comma separated list of Kafka Broker URLs"
},
"saslAuthType": {
"type": "string",
"title": "Authentication Type",
"description": "Authentication type to use. Use NONE for no authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS for Kerberos.",
"enum": [
"NONE",
"PLAIN",
"SCRAM_SHA_256",
"SCRAM_SHA_512",
"SSL",
"OAUTH",
"AWS_MSK_IAM",
"KERBEROS"
],
"default": "NONE"
},
"saslUsername": {
"type": "string",
"title": "Username",
"description": "Username for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512."
},
"saslPassword": {
"type": "string",
"title": "Password",
"description": "Password for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.",
"format": "password"
},
"oauthClientId": {
"type": "string",
"title": "OAuth Client ID",
"description": "OAuth client ID. Required when saslAuthType is OAUTH."
},
"oauthClientSecret": {
"type": "string",
"title": "OAuth Client Secret",
"description": "OAuth client secret. Required when saslAuthType is OAUTH.",
"format": "password"
},
"oauthTokenEndpointUri": {
"type": "string",
"title": "OAuth Token Endpoint",
"description": "OAuth token endpoint URI. Required when saslAuthType is OAUTH."
},
"oauthScope": {
"type": "string",
"title": "OAuth Scope",
"description": "OAuth scope. Optional when saslAuthType is OAUTH."
},
"sslTruststoreLocation": {
"type": "string",
"title": "SSL Truststore Location",
"description": "The location of the trust store file."
},
"sslTruststorePassword": {
"type": "string",
"title": "SSL Truststore Password",
"description": "The password for the trust store file.",
"format": "password"
},
"sslKeystoreLocation": {
"type": "string",
"title": "SSL Keystore Location",
"description": "The location of the key store file. Used for mTLS authentication."
},
"sslKeystorePassword": {
"type": "string",
"title": "SSL Keystore Password",
"description": "The password for the key store file.",
"format": "password"
},
"sslKeyPassword": {
"type": "string",
"title": "SSL Key Password",
"description": "The password of the private key in the key store file.",
"format": "password"
},
"autoCommitEnable": {
"type": "boolean",
"title": "Auto Commit Enable",
"description": "If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer",
"default": true
},
"allowManualCommit": {
"type": "boolean",
"title": "Allow Manual Commit",
"description": "Whether to allow doing manual commits",
"default": false
},
"pollOnError": {
"type": "string",
"title": "Poll On Error Behavior",
"description": "What to do if kafka threw an exception while polling for new messages. There are 5 enums and the value can be one of DISCARD, ERROR_HANDLER, RECONNECT, RETRY, STOP",
"default": "ERROR_HANDLER"
},
"autoOffsetReset": {
"type": "string",
"title": "Auto Offset Reset",
"description": "What to do when there is no initial offset. There are 3 enums and the value can be one of latest, earliest, none",
"default": "latest"
},
"consumerGroup": {
"type": "string",
"title": "Consumer Group",
"description": "A string that uniquely identifies the group of consumers to which this source belongs"
},
"deserializeHeaders": {
"type": "boolean",
"title": "Automatically Deserialize Headers",
"description": "When enabled the Kamelet source will deserialize all message headers to String representation.",
"default": true
},
"batchSize": {
"type": "integer",
"title": "Batch Dimension",
"description": "The maximum number of records returned in a single call to poll()",
"default": 500
},
"pollTimeout": {
"type": "integer",
"title": "Poll Timeout Interval",
"description": "The timeout used when polling the KafkaConsumer",
"default": 5000
},
"maxPollIntervalMs": {
"type": "integer",
"title": "Max Poll Interval",
"description": "The maximum delay between invocations of poll() when using consumer group management"
},
"batchingIntervalMs": {
"type": "integer",
"title": "Batching Interval",
"description": "In consumer batching mode, then this option is specifying a time in millis, to trigger batch completion eager when the current batch size has not reached the maximum size defined by maxPollRecords. Notice the trigger is not exact at the given interval, as this can only happen between kafka polls (see pollTimeoutMs option)."
},
"topicIsPattern": {
"type": "boolean",
"title": "Topic Is Pattern",
"description": "Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern.",
"default": false
}
}
}
}