Ottomata has submitted this change and it was merged.
Change subject: Add README.md with Usage info
......................................................................
Add README.md with Usage info
Change-Id: I6b97589e82ec6b1fcb0228a1d155412fe4ba8b25
---
A README.md
1 file changed, 30 insertions(+), 0 deletions(-)
Approvals:
Ottomata: Verified; Looks good to me, approved
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..212a74c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+## Usage
+
+```puppet
+
+ # Install kafkatee and point it at a Kafka Cluster.
+ class { 'kafkatee':
+ kafka_brokers => ['kafka1.example.org:9092',
'kafka2.example.org:9092'],
+ }
+
+ # Consume from the JSON formatted input topic 'mytopic'.
+ kafkatee::input { 'mytopic':
+ topic => 'mytopic',
+ partitions => '0-11',
+ options => { 'encoding' => 'json' },
+ offset => 'stored',
+ }
+
+ # Output sampling 1/100 to a file:
+ kafkatee::output { 'mytopic-sampled-100':
+ destination => '/path/to/mytopic-sampled-100.json',
+ type => 'file',
+ sample => 100,
+ }
+
+ # Output with no sampling to a piped filtering process:
+ kafkatee::output { 'mytopic-filtered':
+ destination => 'grep -v "whocares" >> /path/to/mytopic-filtered.json'
+ type => 'pipe',
+ }
+```
\ No newline at end of file
--
To view, visit https://gerrit.wikimedia.org/r/172763
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I6b97589e82ec6b1fcb0228a1d155412fe4ba8b25
Gerrit-PatchSet: 2
Gerrit-Project: operations/puppet/kafkatee
Gerrit-Branch: master
Gerrit-Owner: Ottomata <[email protected]>
Gerrit-Reviewer: Ottomata <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
