-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6354b9c
commit ec26594
Showing
2 changed files
with
33 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,35 @@ | ||
# Introduction | ||
|
||
Kafka Connect transform to assist with archiving to S3. | ||
# Transformations | ||
|
||
## Kafka 0.11.x and newer | ||
|
||
```properties | ||
## Archive | ||
|
||
The Archive transformation is used to help preserve all of the data for a message when archived to S3. | ||
|
||
``` | ||
### Configuration | ||
|
||
## Kafka 0.10.x and older | ||
| Name | Type | Importance | Default Value | Validator | Documentation| | ||
| ---- | ---- | ---------- | ------------- | --------- | -------------| | ||
|
||
```properties | ||
|
||
#### Standalone Example | ||
|
||
```properties | ||
transforms=Archive | ||
transforms.Archive.type=com.github.jcustenborder.kafka.connect.archive.Archive | ||
# The following values must be configured. | ||
``` | ||
|
||
#### Distributed Example | ||
|
||
```json | ||
{ | ||
"name": "connector1", | ||
"config": { | ||
"connector.class": "com.github.jcustenborder.kafka.connect.archive.Archive", | ||
"transforms": "Archive", | ||
"transforms.Archive.type": "com.github.jcustenborder.kafka.connect.archive.Archive", | ||
} | ||
} | ||
``` | ||
|
10 changes: 10 additions & 0 deletions
10
src/test/java/com/github/jcustenborder/kafka/connect/archive/DocumentationTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
package com.github.jcustenborder.kafka.connect.archive; | ||
|
||
import com.github.jcustenborder.kafka.connect.utils.BaseDocumentationTest; | ||
|
||
public class DocumentationTest extends BaseDocumentationTest { | ||
@Override | ||
protected String[] packages() { | ||
return new String[]{this.getClass().getPackage().getName()}; | ||
} | ||
} |