src/main/asciidoc/_chapters/snapshot_scanner.adoc

   1 ////
   2 /**
   3  *
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20 ////
  21
  22 [[snapshot_scanner]]
  23 == Scan over snapshot
  24 :doctype: book
  25 :numbered:
  26 :toc: left
  27 :icons: font
  28 :experimental:
  29 :toc: left
  30 :source-language: java
  31
  32 In HBase, a scan of a table costs server-side HBase resources reading, formating, and returning data back to the client.
  33 Luckily, HBase provides a TableSnapshotScanner and TableSnapshotInputFormat (introduced by link:https://issues.apache.org/jira/browse/HBASE-8369[HBASE-8369]),
  34 which can scan HBase-written HFiles directly in the HDFS filesystem completely by-passing hbase. This access mode
  35 performs better than going via HBase and can be used with an offline HBase with in-place or exported
  36 snapshot HFiles.
  37
  38 To read HFiles directly, the user must have sufficient permissions to access snapshots or in-place hbase HFiles.
  39
  40 === TableSnapshotScanner
  41
  42 TableSnapshotScanner provides a means for running a single client-side scan over snapshot files.
  43 When using TableSnapshotScanner, we must specify a temporary directory to copy the snapshot files into.
  44 The client user should have write permissions to this directory, and the dir should not be a subdirectory of
  45 the hbase.rootdir. The scanner deletes the contents of the directory once the scanner is closed.
  46
  47 .Use TableSnapshotScanner
  48 ====
  49 [source,java]
  50 ----
  51 Path restoreDir = new Path("XX"); // restore dir should not be a subdirectory of hbase.rootdir
  52 Scan scan = new Scan();
  53 try (TableSnapshotScanner scanner = new TableSnapshotScanner(conf, restoreDir, snapshotName, scan)) {
  54     Result result = scanner.next();
  55     while (result != null) {
  56         ...
  57         result = scanner.next();
  58     }
  59 }
  60 ----
  61 ====
  62
  63 === TableSnapshotInputFormat
  64 TableSnapshotInputFormat provides a way to scan over snapshot HFiles in a MapReduce job.
  65
  66 .Use TableSnapshotInputFormat
  67 ====
  68 [source,java]
  69 ----
  70 Job job = new Job(conf);
  71 Path restoreDir = new Path("XX"); // restore dir should not be a subdirectory of hbase.rootdir
  72 Scan scan = new Scan();
  73 TableMapReduceUtil.initTableSnapshotMapperJob(snapshotName, scan, MyTableMapper.class, MyMapKeyOutput.class, MyMapOutputValueWritable.class, job, true, restoreDir);
  74 ----
  75 ====
  76
  77 === Permission to access snapshot and data files
  78 Generally, only the HBase owner or the HDFS admin have the permission to access HFiles.
  79
  80 link:https://issues.apache.org/jira/browse/HBASE-18659[HBASE-18659] uses HDFS ACLs to make HBase granted user have permission to access snapshot files.
  81
  82 ==== link:https://hadoop.apache.org/docs/r2.7.1/hadoop-project-dist/hadoop-hdfs/HdfsPermissionsGuide.html#ACLs_Access_Control_Lists[HDFS ACLs]
  83
  84 HDFS ACLs supports an "access ACL", which defines the rules to enforce during permission checks, and a "default ACL",
  85 which defines the ACL entries that new child files or sub-directories receive automatically during creation.
  86 Via HDFS ACLs, HBase syncs granted users with read permission to HFiles.
  87
  88 ==== Basic idea
  89
  90 The HBase files are organized in the following ways:
  91
  92  * {hbase-rootdir}/.tmp/data/{namespace}/{table}
  93  * {hbase-rootdir}/data/{namespace}/{table}
  94  * {hbase-rootdir}/archive/data/{namespace}/{table}
  95  * {hbase-rootdir}/.hbase-snapshot/{snapshotName}
  96
  97 So the basic idea is to add or remove HDFS ACLs to files of the global/namespace/table directory
  98 when grant or revoke permission to global/namespace/table.
  99
 100 See the design doc in link:https://issues.apache.org/jira/browse/HBASE-18659[HBASE-18659] for more details.
 101
 102 ==== Configuration to use this feature
 103
 104  * Firstly, make sure that HDFS ACLs are enabled and umask is set to 027
 105 ----
 106 dfs.namenode.acls.enabled = true
 107 fs.permissions.umask-mode = 027
 108 ----
 109
 110  * Add master coprocessor, please make sure the SnapshotScannerHDFSAclController is configured after AccessController
 111 ----
 112 hbase.coprocessor.master.classes = "org.apache.hadoop.hbase.security.access.AccessController
 113 ,org.apache.hadoop.hbase.security.access.SnapshotScannerHDFSAclController"
 114 ----
 115
 116  * Enable this feature
 117 ----
 118 hbase.acl.sync.to.hdfs.enable=true
 119 ----
 120
 121  * Modify table scheme to enable this feature for a specified table, this config is
 122  false by default for every table, this means the HBase granted ACLs will not be synced to HDFS
 123 ----
 124 alter 't1', CONFIGURATION => {'hbase.acl.sync.to.hdfs.enable' => 'true'}
 125 ----
 126
 127 ==== Limitation
 128 There are some limitations for this feature:
 129
 130 =====
 131 If we enable this feature, some master operations such as grant, revoke, snapshot...
 132 (See the design doc for more details) will be slower as we need to sync HDFS ACLs to related hfiles.
 133 =====
 134
 135 =====
 136 HDFS has a config which limits the max ACL entries num for one directory or file:
 137 ----
 138 dfs.namenode.acls.max.entries = 32(default value)
 139 ----
 140 The 32 entries include four fixed users for each directory or file: owner, group, other, and mask.
 141 For a directory, the four users contain 8 ACL entries(access and default) and for a file, the four
 142 users contain 4 ACL entries(access). This means there are 24 ACL entries left for named users or groups.
 143
 144 Based on this limitation, we can only sync up to 12 HBase granted users' ACLs. This means, if a table
 145 enables this feature, then the total users with table, namespace of this table, global READ permission
 146 should not be greater than 12.
 147 =====
 148
 149 =====
 150 There are some cases that this coprocessor has not handled or could not handle, so the user HDFS ACLs
 151 are not synced normally. It will not make a reference link to another hfile of other tables.
 152 =====