Commit Graph

69 Commits

Author SHA1 Message Date
Ken Huang b129ed4566
MINOR: Use immutable KIP link (#19153)
Reviewers: TengYao Chi <kitingiao@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2025-03-09 23:42:33 +08:00
TengYao Chi cbbeccad63
MINOR: Remove unnecessary < from Errant Record Reporter section (#18498)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2025-01-13 12:13:10 +01:00
Yash Mayya 4f1688742e
KAFKA-15387: Remove Connect's deprecated task configurations endpoint (#17412)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2024-11-21 19:43:54 +05:30
Chris Egerton d43806c7f3
MINOR: Clarify ACL requirements for Connect workers when exactly.once.source.support is set to preparing (#16636)
Reviewers: Mickael Maison <mickael.maison@gmail.com>,
2024-07-23 13:15:54 -04:00
Mickael Maison c4a3d2475f
MINOR: Refresh of the docs (#16375)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-06-18 17:15:47 +02:00
Ivan Yurchenko 5a9ccb6b77
KAFKA-16445: Add PATCH method for connector config (#6934)
Reviewers: Chris Egerton <chrise@aiven.io>
2024-05-09 21:59:09 +02:00
Hector Geraldino 7b9f31e35c
KAFKA-16358: Sort transformations by name in documentation; add missing transformations to documentation; add hyperlinks (#15499)
Reviewers: Yash Mayya <yash.mayya@gmail.com>
2024-03-15 16:26:36 +05:30
Josep Prat 829d5d45c4
MINOR: fix code listings connect.html (#10769)
* MINOR: fix code listings connect

Uses the right tool to show code listings, so it is consistent with the
rest of the examples

Signed-off-by: Josep Prat <josep.prat@aiven.io>

Reviewers: Mickael Maison <mickael.maison@gmail.com>
2024-02-05 15:39:19 +01:00
Mickael Maison 74be72a559
MINOR: Various fixes in the docs (#14914)
- Only use https links
- Fix broken HTML tags
- Replace usage of <tt> which is deprecated with <code>
- Replace hardcoded version numbers

Reviewers: Chris Egerton <fearthecellos@gmail.com>, Greg Harris <gharris1727@gmail.com>
2023-12-04 22:06:49 +01:00
Yash Mayya 1bc4de75a2
KAFKA-15470: Allow creating connectors in a stopped state (#14704)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-11-15 11:37:50 +05:30
Yash Mayya 1c8bb61a43
KAFKA-15387: Deprecate Connect's redundant task configurations endpoint (#14361)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Sagar Rao <sagarmeansocean@gmail.com>
2023-10-14 14:46:50 +05:30
Yash Mayya 1f473ebb5e
KAFKA-14876: Add stopped state to Kafka Connect Administration docs section (#14336)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-09-05 14:39:49 -04:00
Yash Mayya 79598b49d6
MINOR: Update the documentation's table of contents to add missing headings for Kafka Connect (#14337)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-09-05 13:58:44 -04:00
Greg Harris 821954e569
KAFKA-15233: Add documentation for plugin.discovery and connect-plugin-path (KIP-898) (#14068)
Reviewers: Qichao Chu (@ex172000), Chris Egerton <chrise@aiven.io>
2023-08-10 16:16:11 -07:00
Chris Egerton 1ed8fa2ee0
MINOR: Update anchor link for exactly-once source connectors (#13933)
Reviewers: Josep Prat <josep.prat@aiven.io>
2023-06-29 14:15:32 -04:00
Yash Mayya 30b087ead9
KAFKA-14930: Document the new PATCH and DELETE offsets REST APIs for Connect (#13915)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-06-29 11:23:23 -04:00
Jorge Esteban Quilcate Otoya 9cfc4b9373
KAFKA-15051: add missing GET plugin/config endpoint (#13803)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-06-07 11:06:22 -04:00
Yash Mayya 4a0b6ebf60
KAFKA-14876: Document the new 'PUT /connectors/{name}/stop' REST API for Connect (#13657)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-05-02 13:46:46 -04:00
Yash Mayya 4780dc773f
KAFKA-14933: Document Connect's log level REST APIs from KIP-495 (#13636)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Manyanda Chitimbo <manyanda.chitimbo@gmail.com>
2023-04-25 17:50:35 +02:00
Yash Mayya c324123629
KAFKA-14876: Document the new 'GET /connectors/{name}/offsets' REST API for Connect (#13587)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2023-04-24 10:36:20 +02:00
Chris Egerton 27548707dd
MINOR: Fix anchor link in Connect docs (#13358)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2023-03-08 10:37:01 -05:00
Chris Egerton a382acd31d
KAFKA-13709 (follow-up): Avoid mention of 'exactly-once delivery' or 'delivery guarantees' in Connect (#13106) 2023-01-13 09:19:29 -05:00
Chris Egerton dd76872264
KAFKA-13709: Add docs for exactly-once support in Connect (#12941)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2022-12-15 11:20:49 -05:00
Chris Egerton 548348c9e7
KAFKA-13731: Allow standalone workers to be started without providing any connector configurations (#11890)
Reviewers: Yash Mayya <yash.mayya@gmail.com>, Mickael Maison <mickael.maison@gmail.com>
2022-11-30 11:49:24 -05:00
Mickael Maison 335d70ede7
MINOR: Fix link to Connect OpenAPI spec (#12713)
Reviewers: José Armando García Sancio <jsancio@confluent.io>
2022-10-06 10:41:17 +02:00
Federico Valeri 6d463c1733
MINOR: Update offset.storage.topic description (#12656)
Reviewers: Chris Egerton <chrise@aiven.io>
2022-09-19 13:21:59 -04:00
Yash Mayya 18142bff4b
KAFKA-13809: Propagate full connector configuration to tasks in FileStream connectors (#12450)
Reviewers: Chris Egerton <fearthecellos@gmail.com>
2022-08-15 15:25:29 -04:00
Mickael Maison 4a06458633
KAFKA-13780: Generate OpenAPI file for Connect REST API (#12067)
New gradle task `connect:runtime:genConnectOpenAPIDocs` that generates `connect_rest.yaml` under `docs/generated`.
This task is executed when `siteDocsTar` runs.
2022-06-10 11:35:22 +02:00
Chris Egerton b9fc893546
MINOR: Correct Connect docs on connector/task states (#11914)
The `DESTROYED` state is represented internally as a tombstone record when running in distributed mode and by the removal of the connector/task from the in-memory status map when running in standalone mode. As a result, it will never appear to users of the REST API, and we should remove mention of it from our docs so that developers creating tooling against the REST API don't write unnecessary logic to account for that state.

Reviewers: Mickael Maison <mickael.maison@gmail.com>
2022-04-13 12:51:34 +02:00
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