Skip to content

Commit

Permalink
Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jcustenborder committed Nov 4, 2017
1 parent 6354b9c commit ec26594
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 7 deletions.
30 changes: 23 additions & 7 deletions README.md
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",
}
}
```

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()};
}
}

0 comments on commit ec26594

Please sign in to comment.