Skip to content

Commit 0110bf3

Browse files
authored
HBASE-27722 Update documentation about how to enable encryption on WAL (#5120)
Signed-off-by: Xiaolin Ha <[email protected]>
1 parent 201846b commit 0110bf3

File tree

4 files changed

+6
-29
lines changed

4 files changed

+6
-29
lines changed

hbase-common/src/main/resources/hbase-default.xml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -278,16 +278,6 @@ possible configurations would overwhelm and obscure the important.
278278
log rolling. Even a small value (2 or 3) will allow a region server
279279
to ride over transient HDFS errors.</description>
280280
</property>
281-
<property>
282-
<name>hbase.regionserver.hlog.reader.impl</name>
283-
<value>org.apache.hadoop.hbase.regionserver.wal.ProtobufLogReader</value>
284-
<description>The WAL file reader implementation.</description>
285-
</property>
286-
<property>
287-
<name>hbase.regionserver.hlog.writer.impl</name>
288-
<value>org.apache.hadoop.hbase.regionserver.wal.ProtobufLogWriter</value>
289-
<description>The WAL file writer implementation.</description>
290-
</property>
291281
<property>
292282
<name>hbase.regionserver.global.memstore.size</name>
293283
<value></value>

src/main/asciidoc/_chapters/hbase-default.adoc

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -357,25 +357,6 @@ The number of consecutive WAL close errors we will allow
357357
`2`
358358

359359

360-
[[hbase.regionserver.hlog.reader.impl]]
361-
*`hbase.regionserver.hlog.reader.impl`*::
362-
+
363-
.Description
364-
The WAL file reader implementation.
365-
+
366-
.Default
367-
`org.apache.hadoop.hbase.regionserver.wal.ProtobufLogReader`
368-
369-
370-
[[hbase.regionserver.hlog.writer.impl]]
371-
*`hbase.regionserver.hlog.writer.impl`*::
372-
+
373-
.Description
374-
The WAL file writer implementation.
375-
+
376-
.Default
377-
`org.apache.hadoop.hbase.regionserver.wal.ProtobufLogWriter`
378-
379360
[[hbase.regionserver.global.memstore.size]]
380361
*`hbase.regionserver.global.memstore.size`*::
381362
+

src/main/asciidoc/_chapters/security.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2027,6 +2027,8 @@ You can include these in the HMaster's _hbase-site.xml_ as well, but the HMaster
20272027
</property>
20282028
----
20292029

2030+
NOTE: Starting from 2.6.0, the hbase.regionserver.hlog.reader.impl and hbase.regionserver.hlog.writer.impl configurations are removed, you do not need to specify them any more. Just set hbase.regionserver.wal.encryption to true is enough to enable WAL encryption.
2031+
20302032
. (Optional) Configure encryption key hash algorithm.
20312033
+
20322034
Since link:https://issues.apache.org/jira/browse/HBASE-25181[HBASE-25181] it is possible to use
@@ -2258,6 +2260,8 @@ All options have been discussed separately in the sections above.
22582260
----
22592261
====
22602262

2263+
NOTE: Starting from 2.6.0, the hbase.regionserver.hlog.reader.impl and hbase.regionserver.hlog.writer.impl configurations are removed, you do not need to specify them any more. Just set hbase.regionserver.wal.encryption to true is enough to enable WAL encryption.
2264+
22612265
.Example Group Mapper in Hadoop _core-site.xml_
22622266
====
22632267
Adjust these settings to suit your environment.

src/main/asciidoc/_chapters/upgrading.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -625,6 +625,8 @@ HBase has simplified our internal HFile handling. As a result, we can no longer
625625

626626
HBase can no longer read the deprecated WAL files written in the Apache Hadoop Sequence File format. The hbase.regionserver.hlog.reader.impl and hbase.regionserver.hlog.writer.impl configuration entries should be set to use the Protobuf based WAL reader / writer classes. This implementation has been the default since HBase 0.96, so legacy WAL files should not be a concern for most downstream users.
627627

628+
Starting from 2.6.0, the hbase.regionserver.hlog.reader.impl and hbase.regionserver.hlog.writer.impl configuration entries are removed since the only valid values are protobuf based reader/writer. Setting them in _hbase-site.xml_ will have no real effect.
629+
628630
A clean cluster shutdown should ensure there are no WAL files. If you are unsure of a given WAL file's format you can use the `hbase wal` command to parse files while the HBase cluster is offline. In HBase 2.0+, this command will not be able to read a Sequence File based WAL. For more information on the tool see the section <<hlog_tool.prettyprint>>.
629631

630632
[[upgrade2.0.filters]]

0 commit comments

Comments
 (0)