Commit Graph

40 Commits

Author SHA1 Message Date
Konstantine Karantasis dd62ef2eda
KAFKA-13748: Do not include file stream connectors in Connect's CLASSPATH and plugin.path by default (#11908)
With this change we stop including the non-production grade connectors that are meant to be used for demos and quick starts by default in the CLASSPATH and plugin.path of Connect deployments. The package of these connector will still be shipped with the Apache Kafka distribution and will be available for explicit inclusion. 

The changes have been tested through the system tests and the existing unit and integration tests. 

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Randall Hauch <rhauch@gmail.com>
2022-03-30 13:15:42 -07:00
Mickael Maison 576496a1ca
MINOR: Improve Connect docs (#11642)
- Fix indendation of code blocks
- Add links to all SMTs and Predicates

Reviewers: Luke Chen <showuon@gmail.com>, Tom Bentley <tbentley@redhat.com>
2022-02-22 20:49:53 +08:00
kpatelatwork 2e89f40575
KAFKA-13035 updated documentation for connector restart REST API to … (#10975)
Updated documentation for connector restart REST API to include the tasks restart behavior, including calling out that by default the same behavior of previous versions is preserved.

Author: Kalpesh Patel <kpatel@confluent.io>
Reviewer: Randall Hauch <rhauch@gmail.com>
2021-07-06 13:31:40 -05:00
Tom Bentley f8f1769256
KIP-145: Add SMTs, HeaderFrom, DropHeaders and InsertHeader (#9549)
These SMTs were originally specified in KIP-145 but never implemented
at the time.

HeaderTo is not included since its original specification doesn't deal with
the fact that there can be >1 header with the same name, but a field can only
have a single value (which could be an array, but not if the headers for
the given name had different schemas).

Reviewers: Chris Egerton <chrise@confluent.io>, Mickael Maison <mickael.maison@gmail.com>
2021-04-16 15:11:25 +01:00
Alexander Iskuskov 51c8c69e3a
MINOR: Fix documentation for KIP-585 (#9524)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2020-10-29 10:08:00 +08:00
Aakash Shah 16eb9c0bfe
KAFKA-10153: Error Reporting in Connect Documentation (#8858)
Added a section about error reporting in Connect documentation, and another about how to safely use the new errant record reporter in SinkTask implementations.

Author: Aakash Shah <ashah@confluent.io>
Reviewer: Randall Hauch <rhauch@gmail.com>
2020-07-01 10:18:16 -05:00
Tom Bentley a1f429d4f6
MINOR: Documentation for KIP-585 (#8839)
* Add documentation for using transformation predicates.
* Add `PredicateDoc` for generating predicate config docs, following the style of `TransformationDoc`.
* Fix the header depth mismatch.
* Avoid generating HTML ids based purely on the config name since there
are very likely to conflict (e.g. #name). Instead allow passing a function
which can be used to generate an id from a config key.

The docs have been generated and tested locally. 

Reviewer: Konstantine Karantasis <konstantine@confluent.io>
2020-06-15 22:07:01 -07:00
Valeria 9aeb78b990
KAFKA-6755: Allow literal value for MaskField SMT (#6284)
Implemented KIP-437 by adding a new optional configuration property for the `MaskField` transformation that allows users to define a replacement literal for specific fields in matching records.

Author: Valeria Vasylieva <valeria.vasylieva@gmail.com>
Reviewer: Randall Hauch <rhauch@gmail.com>
2020-05-24 09:22:40 -05:00
showuon 3ec5e8e652
MINOR: Small fixes in the documentation (#8623)
These minor documentation fixes included: 

1. fix broken links
2. remove redundant sentences
3. fix content format issue

Reviewers: Konstantine Karantasis <konstantine@confluent.io>
2020-05-19 07:31:06 -07:00
Konstantine Karantasis 8595267260
KAFKA-9810: Document Connect Root REST API on / (#8408)
Document the supported endpoint at the top-level (root) REST API resource and the information that it returns when a request is made to a Connect worker.

Fixes an omission in documentation after KAFKA-2369 and KAFKA-6311 (KIP-238)

Reviewers: Toby Drake <tobydrake7@gmail.com>, Soenke Liebau <soenke.liebau@opencore.com>
2020-04-03 13:27:27 -07:00
Scott 43f4372531
MINOR: Fix code example reference to SchemaBuilder call in Connect's documentation (#3029)
Simple doc fix in a code snippet in connect.html

Co-authored-by: Scott Ferguson <smferguson@gmail.com>

Reviewers: Ewen Cheslack-Postava <me@ewencp.org>, Konstantine Karantasis <konstantine@confluent.io>
2020-03-28 18:34:07 -07:00
Hossein Torabi afe26e2992
KAFKA-9563: Fix Kafka Connect documentation around consumer and producer overrides (#8124)
Kafka Connect main doc required a fix to distinguish between worker level producer and consumer overrides and per-connector level producer and consumer overrides, after the latter were introduced with KIP-458.  

* [KAFKA-9563] Fix Kafka connect consumer and producer override documentation

Co-authored-by: Konstantine Karantasis <konstantine@confluent.io>

Reviewers: Konstantine Karantasis <konstantine@confluent.io>
2020-03-22 20:07:21 -07:00
Konstantine Karantasis bbfecaef72 MINOR: Document endpoints for connector topic tracking (KIP-558)
Update the site documentation to include the endpoints introduced with KIP-558 and a short paragraph on how this feature is used in Connect.

Author: Konstantine Karantasis <konstantine@confluent.io>

Reviewers: Toby Drake <tobydrake7@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #8148 from kkonstantine/kip-558-docs
2020-02-21 12:25:35 -08:00
Konstantine Karantasis c6ddd31887 MINOR: Update docs for KIP-415 (#6958)
Update docs with KIP-415 details for incremental cooperative rebalancing

Author: Konstantine Karantasis <konstantine@confluent.io>
Reviewer: Randall Hauch <rhauch@gmail.com>
2019-06-17 21:53:20 -07:00
Chia-Ping Tsai d2bbcbed44 MINOR: Correct "exeption" to "exception" in connect docs (#4709) 2018-03-14 08:46:07 -07:00
Randall Hauch 4c48942f9d KAFKA-5142: Add Connect support for message headers (KIP-145)
**[KIP-145](https://cwiki.apache.org/confluence/display/KAFKA/KIP-145+-+Expose+Record+Headers+in+Kafka+Connect) has been accepted, and this PR implements KIP-145 except without the SMTs.**

Changed the Connect API and runtime to support message headers as described in [KIP-145](https://cwiki.apache.org/confluence/display/KAFKA/KIP-145+-+Expose+Record+Headers+in+Kafka+Connect).

The new `Header` interface defines an immutable representation of a Kafka header (key-value pair) with support for the Connect value types and schemas. This interface provides methods for easily converting between many of the built-in primitive, structured, and logical data types.

The new `Headers` interface defines an ordered collection of headers and is used to track all headers associated with a `ConnectRecord` (and thus `SourceRecord` and `SinkRecord`). This does allow multiple headers with the same key. The `Headers` contains methods for adding, removing, finding, and modifying headers. Convenience methods allow connectors and transforms to easily use and modify the headers for a record.

A new `HeaderConverter` interface is also defined to enable the Connect runtime framework to be able to serialize and deserialize headers between the in-memory representation and Kafka’s byte[] representation. A new `SimpleHeaderConverter` implementation has been added, and this serializes to strings and deserializes by inferring the schemas (`Struct` header values are serialized without the schemas, so they can only be deserialized as `Map` instances without a schema.) The `StringConverter`, `JsonConverter`, and `ByteArrayConverter` have all been extended to also be `HeaderConverter` implementations. Each connector can be configured with a different header converter, although by default the `SimpleHeaderConverter` is used to serialize header values as strings without schemas.

Unit and integration tests are added for `ConnectHeader` and `ConnectHeaders`, the two implementation classes for headers. Additional test methods are added for the methods added to the `Converter` implementations. Finally, the `ConnectRecord` object is already used heavily, so only limited tests need to be added while quite a few of the existing tests already cover the changes.

Author: Randall Hauch <rhauch@gmail.com>

Reviewers: Arjun Satish <arjun@confluent.io>, Ted Yu <yuzhihong@gmail.com>, Magesh Nandakumar <magesh.n.kumar@gmail.com>, Konstantine Karantasis <konstantine@confluent.io>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #4319 from rhauch/kafka-5142-b
2018-01-31 10:40:24 -08:00
Jakub Scholz 3431be2aeb KAFKA-4029: SSL support for Connect REST API (KIP-208)
This PR implements the JIRA issue [KAFKA-4029: SSL support for Connect REST API](https://issues.apache.org/jira/browse/KAFKA-4029) / [KIP-208](https://cwiki.apache.org/confluence/display/KAFKA/KIP-208%3A+Add+SSL+support+to+Kafka+Connect+REST+interface).

Summary of the main changes:
- Jetty `HttpClient` is used as HTTP client instead of the one shipped with Java. That allows to keep the SSL configuration for Server and Client be in single place (both use the Jetty `SslContextFactory`). It also has much richer configuration than the JDK client (it is easier to configure things such as supported cipher suites etc.).
- The `RestServer` class has been broker into 3 parts. `RestServer` contains the server it self. `RestClient` contains the HTTP client used for forwarding requests etc. and `SSLUtils` contain some helper classes for configuring SSL. One of the reasons for this was Findbugs complaining about the class complexity.
- A new method `valuesWithPrefixAllOrNothing` has been added to `AbstractConfig` to make it easier to handle the situation that we want to use either only the prefixed SSL options or only the non-prefixed. But not mixed them.

Author: Jakub Scholz <www@scholzj.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #4429 from scholzj/kip-208
2018-01-30 15:09:40 -08:00
Jeff Klukas 049342e440 KAFKA-3073: Add topic regex support for Connect sinks
There are more methods that had to be touched than I anticipated when writing [the KIP](https://cwiki.apache.org/confluence/display/KAFKA/KIP-215%3A+Add+topic+regex+support+for+Connect+sinks).

The implementation here is now complete and includes a test that verifies that there's a call to `consumer.subscribe(Pattern, RebalanceHandler)` when `topics.regex` is provided.

Author: Jeff Klukas <jeff@klukas.net>

Reviewers: Randall Hauch <rhauch@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #4151 from jklukas/connect-topics.regex
2017-11-21 16:01:16 -08:00
Adem Efe Gencer 86062e9a78 KAFKA-6157; Fix repeated words words in JavaDoc and comments.
Author: Adem Efe Gencer <agencer@linkedin.com>

Reviewers: Jiangjie Qin <becket.qin@gmail.com>

Closes #4170 from efeg/bug/typoFix
2017-11-05 18:00:43 -08:00
Tom Bentley 9e35a2aa78 MINOR: Add <p>/</p> to connect docs, because HTML render doesn't respect blank lines
This just adds `<p>`/`</p>` to paragraphs in Kafak Connect docs.

ewencp are you a good person to review this?

Author: Tom Bentley <tbentley@redhat.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #4008 from tombentley/MINOR-connect-docs-paragraph
2017-10-03 10:25:09 -07:00
Robin Moffatt f4d1305bfe MINOR: Fix typo in SMT doc: s/RegexpRouter/RegexRouter
Author: Robin Moffatt <robin@rmoff.net>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #3576 from rmoff/patch-1
2017-07-26 09:17:44 -07:00
ppatierno 8a81566214 KAFKA-5410; Fix taskClass() method name in Connector and flush() signature in SinkTask
Author: ppatierno <ppatierno@live.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #3269 from ppatierno/connect-doc
2017-07-20 19:51:09 -07:00
Guozhang Wang 57b0d0fe57 MINOR: syntax brush for java / bash / json / text
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Derrick Or <derrickor@gmail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #3214 from guozhangwang/KMinor-doc-java-brush
2017-06-07 15:17:25 +01:00
Gwen Shapira 95ef40dd31 MINOR: Adding example to SMT documentation
Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2721 from gwenshap/improve_smt_docs
2017-03-22 23:06:26 -07:00
Sönke Liebau b1272500bd KAFKA-4567 - Connect Producer and Consumer ignore ssl parameters…
KAFKA-4567 - Connect Producer and Consumer ignore ssl parameters configured for worker

Added brief explanation to the docs about parameter inheritance of Kafka consumers and producers from the worker config.

Author: Sönke Liebau <soenke.liebau@opencore.com>

Reviewers: Gwen Shapira

Closes #2511 from soenkeliebau/KAFKA-4567
2017-03-05 10:28:36 -08:00
Shikhar Bhushan a8aa756166 KAFKA-3209: KIP-66: more single message transforms
Renames `HoistToStruct` SMT to `HoistField`.

Adds the following SMTs:
`ExtractField`
`MaskField`
`RegexRouter`
`ReplaceField`
`SetSchemaMetadata`
`ValueToKey`

Adds HTML doc generation and updates to `connect.html`.

Author: Shikhar Bhushan <shikhar@confluent.io>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2374 from shikhar/more-smt
2017-01-20 16:15:15 -08:00
Derrick Or 53428694a6 Separate Streams documentation and setup docs with easy to set variables
- Seperate Streams documentation out to a standalone page.
- Setup templates to use handlebars.js
- Create template variables to swap in frequently updated values like version number from a single file templateData.js

Author: Derrick Or <derrickor@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2245 from derrickdoo/docTemplates
2016-12-13 17:59:49 -08:00
Vahid Hashemian e972d2afd3 MINOR: Fix typos in documentation
And improve readability by adding proper punctuations.

Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2002 from vahidhashemian/doc/fix_typos
2016-10-10 15:58:37 -07:00
Mathieu Fenniak ca3f3a492c MINOR: Document that Connect topics should use compaction
Update documentation for Kafka Connect distributed’s config.storage.topic, offset.storage.topic, and status.storage.topic configuration values to indicate that all three should refer to compacted topics.

Author: Mathieu Fenniak <mathieu.fenniak@replicon.com>

Reviewers: Jason Gustafson

Closes #1832 from mfenniak/kafka-connect-topic-docs
2016-09-07 17:34:24 -07:00
Ewen Cheslack-Postava 05ed54bf2b KAFKA-3845: KIP-75: Add per-connector converters
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Shikhar Bhushan, Gwen Shapira

Closes #1721 from ewencp/kafka-3845-per-connector-converters
2016-08-18 20:56:31 -07:00
uchan-nos 250981fb98 MINOR: Fix connect development guide.
Fix some trivial misses.
ewencp

Author: uchan-nos <uchan0@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1496 from uchan-nos/docfix-connect
2016-06-11 17:20:23 -07:00
Liquan Pei 527b98d82f KAFKA-3421: Connect developer guide update and several fixes
This is a follow up of KAKFA-3421 to update the connect developer guide to include the configuration validation. Also includes a couple of minor fixes.

Author: Liquan Pei <liquanpei@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1366 from Ishiihara/connect-dev-doc
2016-05-12 18:15:04 -07:00
Jason Gustafson 4807dd1df9 KAFKA-3583: Add documentation for Connect status control APIs
Author: Jason Gustafson <jason@confluent.io>

Reviewers: Roger Hoover <roger.hoover@gmail.com>, Ismael Juma <ismael@juma.me.uk>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1358 from hachikuji/KAFKA-3583
2016-05-11 17:19:11 -07:00
Ewen Cheslack-Postava 36ed00d9bf KAFKA-3421; Follow up to fix name of SourceTask method and add documentation of connector status REST API
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #1355 from ewencp/kafka-3421-follow-up
2016-05-09 23:42:09 +01:00
Kaufman Ng b86378840a KAFKA-3681; Connect doc formatting
Author: Kaufman Ng <kaufman@confluent.io>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #1351 from coughman/KAFKA-3681-connect-doc-formatting
2016-05-09 17:01:16 +01:00
Liquan Pei 501fa37222 KAFKA-3421: Update docs with new connector features
ewencp gwenshap Docs. I also tried to clean up some typos. However, it seems that the we don't have two words without space in between in the source yet they showed up as no space in between in the generated doc.

Author: Liquan Pei <liquanpei@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1227 from Ishiihara/config-doc
2016-04-19 11:06:31 -07:00
Dongjoon Hyun e79d9af3cf KAFKA-3461: Fix typos in Kafka web documentations.
This PR fixes 8 typos in HTML files of `docs` module. I wrote explicitly here since Github sometimes does not highlight the corrections on long lines correctly.
- docs/api.html: compatability => compatibility
- docs/connect.html: simultaneoulsy => simultaneously
- docs/implementation.html: LATIEST_TIME => LATEST_TIME, nPartions => nPartitions
- docs/migration.html: Decomission => Decommission
- docs/ops.html: stoping => stopping, ConumserGroupCommand => ConsumerGroupCommand, youre => you're

Author: Dongjoon Hyun <dongjoon@apache.org>

Reviewers: Ismael Juma

Closes #1138 from dongjoon-hyun/KAFKA-3461
2016-04-12 13:48:18 -07:00
Sasaki Toru 291f430d9c MINOR: Fix typos in docs
Author: Sasaki Toru <sasakitoa@nttdata.co.jp>

Reviewers: Gwen Shapira

Closes #1003 from sasakitoa/Fix_typo_in_docs
2016-03-03 11:46:16 -08:00
Grant Henke 6cbd97597c KAFKA-2809; Improve documentation linking
Often it is useful to link to a specific header within the documentation. Especially when referencing docs in the mailing lists.

This adds anchors and links for all headers in the docs.

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #498 from granthenke/doc-links
2015-11-16 14:14:17 -08:00
Ewen Cheslack-Postava 83eaf3284f KAFKA-2379: Add basic documentation for Kafka Connect.
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Gwen Shapira

Closes #475 from ewencp/kafka-2379-connect-docs
2015-11-09 16:29:30 -08:00