Updated Branches: refs/heads/trunk 520de5153 -> f06a44bdc
FLUME-1879. Secure HBase documentation. (Hari Shreedharan via Mike Percy) Project: http://git-wip-us.apache.org/repos/asf/flume/repo Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/f06a44bd Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/f06a44bd Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/f06a44bd Branch: refs/heads/trunk Commit: f06a44bdc5533e233bf2672b68f23c2d8a44c8bb Parents: 520de51 Author: Mike Percy <[email protected]> Authored: Fri Jan 25 16:57:50 2013 -0800 Committer: Mike Percy <[email protected]> Committed: Fri Jan 25 16:57:50 2013 -0800 ---------------------------------------------------------------------- flume-ng-doc/sphinx/FlumeUserGuide.rst | 37 +++++++++++++++++--------- 1 files changed, 24 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flume/blob/f06a44bd/flume-ng-doc/sphinx/FlumeUserGuide.rst ---------------------------------------------------------------------- diff --git a/flume-ng-doc/sphinx/FlumeUserGuide.rst b/flume-ng-doc/sphinx/FlumeUserGuide.rst index 28895e9..8a7de6e 100644 --- a/flume-ng-doc/sphinx/FlumeUserGuide.rst +++ b/flume-ng-doc/sphinx/FlumeUserGuide.rst @@ -1517,28 +1517,39 @@ HBase puts and/or increments. These puts and increments are then written to HBase. This sink provides the same consistency guarantees as HBase, which is currently row-wise atomicity. In the event of Hbase failing to write certain events, the sink will replay all events in that transaction. -For convenience two serializers are provided with flume. The + +The HBaseSink supports writing data to secure HBase. To write to secure HBase, the user +the agent is running as must have write permissions to the table the sink is configured +to write to. The principal and keytab to use to authenticate against the KDC can be specified +in the configuration. The hbase-site.xml in the Flume agent's classpath +must have authentication set to ``kerberos`` (For details on how to do this, please refer to +HBase documentation). + +For convenience, two serializers are provided with Flume. The SimpleHbaseEventSerializer (org.apache.flume.sink.hbase.SimpleHbaseEventSerializer) writes the event body -as is to HBase, and optionally increments a column in Hbase. This is primarily +as-is to HBase, and optionally increments a column in Hbase. This is primarily an example implementation. The RegexHbaseEventSerializer (org.apache.flume.sink.hbase.RegexHbaseEventSerializer) breaks the event body based on the given regex and writes each part into different columns. The type is the FQCN: org.apache.flume.sink.hbase.HBaseSink. + Required properties are in **bold**. -================ ====================================================== ======================================================================== -Property Name Default Description -================ ====================================================== ======================================================================== -**channel** -- -**type** -- The component type name, needs to be ``org.apache.flume.sink.hbase.HBaseSink`` -**table** -- The name of the table in Hbase to write to. -**columnFamily** -- The column family in Hbase to write to. -batchSize 100 Number of events to be written per txn. -serializer org.apache.flume.sink.hbase.SimpleHbaseEventSerializer -serializer.* -- Properties to be passed to the serializer. -================ ====================================================== ======================================================================== +================== ====================================================== ============================================================================== +Property Name Default Description +================== ====================================================== ============================================================================== +**channel** -- +**type** -- The component type name, needs to be ``org.apache.flume.sink.hbase.HBaseSink`` +**table** -- The name of the table in Hbase to write to. +**columnFamily** -- The column family in Hbase to write to. +batchSize 100 Number of events to be written per txn. +serializer org.apache.flume.sink.hbase.SimpleHbaseEventSerializer +serializer.* -- Properties to be passed to the serializer. +kerberosPrincipal -- Kerberos user principal for accessing secure HBase +kerberosKeytab -- Kerberos keytab for accessing secure HBase +================== ====================================================== ============================================================================== Example for agent named a1:
