Parent Project
Project Documentation
Full name:
io.confluent:kafka-connect-maven-plugin:0.12.0:kafka-connect
Description:
Packages a project into an archive file for use on Confluent Hub. Allows user-specifiable metadata to be provided via configuration.
The archive will be a ZIP file generated in the target/components/packages directory.
For more details on the kinds of metadata that can be specified for a component, visit our documentation on the component archive format.
Any logo files submitted to Confluent Hub must contain a valid extension for their format, must be at least 400 pixels wide and 200 pixels tall, and be no larger than 45 MB in size.
String parameters with default values (such as source URL) can be manually nullified by specifying a value of "none".
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| componentTypes | Set | - | A list of types that apply to this component. The four allowed types are "sink", "source", "transform", and "converter". User property is: connect.component.componentTypes. |
| description | String | - | The description of the component. Should include a summary of the component's functionality, as well as any information that can't be specified in any other part of the manifest. We recommend the first short paragraph provide a good overview, and that subsequent paragraphs list features, capabilities, limitations, and external requirements in detailed, human-readable sentences. Default value is: ${project.description}. User property is: connect.component.description. |
| name | String | - | The name of the component. Default value is: ${project.artifactId}. User property is: connect.component.name. |
| ownerUsername | String | - | The username for the owner of the component. Must adhere to the regex [a-zA-Z0-9][a-zA-Z0-9_-]*. User property is: connect.component.owner.username. |
| version | String | - | The version of the component. Default value is: ${project.version}. User property is: connect.component.version. |
| Name | Type | Since | Description |
|---|---|---|---|
| confluentControlCenterIntegration | Boolean | - | Whether or not the component supports integration with Confluent Control Center. Default value is: false. User property is: connect.component.features.confluentControlCenterIntegration. |
| deliveryGuarantee | Set | - | What sort of delivery guarantees the component provides. Can be empty, or contain one or both of "atLeastOnce" and "exactlyOnce". User property is: connect.component.features.deliveryGuarantee. |
| dockerLabel | String | - | Deprecated. No longer used. Will be removed in a future release. User property is: connect.component.docker.label. |
| dockerName | String | - | The name for the component's Docker image. User property is: connect.component.docker.name. |
| dockerNamespace | String | - | The namespace that the component's Docker image occupies. User property is: connect.component.docker.namespace. |
| dockerRegistries | List | - | A list of Docker registries where the component's Docker image can be found. User property is: connect.component.docker.registries. |
| dockerTag | String | - | The tag for the component's Docker image. User property is: connect.component.docker.tag. |
| documentationUrl | String | - | A link to documentation for the component. Default value is: ${project.url}. User property is: connect.component.documentation.url. |
| kafkaConnectApi | Boolean | - | Whether or not the component is a Kafka Connect connector. Default value is: true. User property is: connect.component.features.kafkaConnectApi. |
| licenses | List | - | A list of licenses associated with the component. Each license is comprised of a name, a url, and a logo. If no licenses are specified here, the list of licenses found at the top level of the project's POM is used. If you would like to ensure that no licenses are included, configure this explicitly as an empty list. |
| logo | String | - | A logo to use for the component. Should consist of a project-local path to an image file; external URLs are not allowed. User property is: connect.component.logo. |
| ownerLogo | String | - | A logo to use for the owner of the component. Should consist of a project-local path to an image file; external URLs are not allowed. User property is: connect.component.owner.logo. |
| ownerName | String | - | The name of the owner of the component (akin to a friendlier, more-human-readable version of the ownerUsername field. User property is: connect.component.owner.name. |
| ownerType | String | - | The type of owner for the component. Either "organization" or "user". User property is: connect.component.owner.type. |
| ownerUrl | String | - | A link to a website for the owner of the component. User property is: connect.component.owner.url. |
| releaseDate | String | - | The release date for the component. Must be in the format "yyyy-MM-dd". User property is: connect.component.releaseDate. |
| requirements | Set | - | A list of requirements for the component. User property is: connect.component.requirements. |
| singleMessageTransforms | Boolean | - | Whether or not the component supports single message transforms. Default value is: true. User property is: connect.component.features.singleMessageTransforms. |
| sourceUrl | String | - | A link to source code for the component. Default value is: ${project.scm.url}. User property is: connect.component.source.url. |
| supportLogo | String | - | A logo to use for the component supporter. Should consist of a project-local path to an image file; external URLs are not allowed. User property is: connect.component.support.logo. |
| supportProviderName | String | - | The name of the support provider for the component. User property is: connect.component.support.providerName. |
| supportSummary | String | - | The kind of support provided for the component. User property is: connect.component.support.summary. |
| supportUrl | String | - | A link to a website for support for the component. User property is: connect.component.support.url. |
| supportedEncodings | Set | - | A list of encodings supported by the component (if the component is a Kafka Connect connector, it is assumed to be able to support any encoding, in which case this should be set to ["any"]). Defaults to "any"; if you would like to specify that no encodings are supported or if the packaged component is not a Kafka connector (e.g., it is instead a converter or transform), configure this explicitly as an empty list. |
| tags | Set | - | A list of search tags to associate with the component. User property is: connect.component.tags. |
| title | String | - | The title of the component (akin to a friendlier, more-human-readable version of the name field). Default value is: ${project.name}. User property is: connect.component.title. |
confluentControlCenterIntegration:
logo:
name:
tags: