[HBASE-17097] [offheap] Documentation for max off heap configuration

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Incomplete
• Affects Version/s: 2.0.0
• Component/s: documentation, Offheaping
• Assignee: Unassigned
• Reporter: Anoop Sam John
• Created: 15/Nov/16 05:44
• Updated: 11/Jun/22 23:50
• Resolved: 11/Jun/22 23:50

Description

# Uncomment below if you intend to use off heap cache. For example, to allocate 8G of
# offheap, set the value to "8G".
# export HBASE_OFFHEAPSIZE=1G

This is what we have in hbase-env.sh now. We need more notes around this and some suggestion. May be more details in book also. This depends on whether we want L2 off heap BC as the default data cache in 2.0. (I would like to and will open a jira soon) Also if users use off heap MSLAB pool, then that also to be added up..
As of now we will use a ByteBufferPool which pool direct BBs and this is ON by default. The max size, this pool can keep is 2 MB * 2 * #handlers.
Will add more details as we turn ON other features.

Issue Links

• is related to: HBASE-20059 Make sure documentation is updated for the offheap Bucket cache usage