Skip to main content

Home

HBase

Important

Before configuring HBase with Unravel, you may want to estimate Unravel storage requirements to monitor your cluster.

HBase configurations can be set either by auto-configuration or by manual configuration. Typically, during installation, the manager config auto command is run, which pulls in all the configurations from the corresponding cluster manager. However, you can also run the auto-configuration whenever there are any changes at the cluster level.

  • Option 1: HBase auto-configuration

    Run HBase auto-configuration as follows on the cluster where the HBase service is running:

    1. Stop Unravel

      <Unravel installation directory>/unravel/manager stop
      
    2. Run auto-configuration

      <unravel_installation_directory>/unravel/manager config auto
      

      The HBase properties are auto-configured.

    3. Apply the changes.

      <Unravel installation directory>/unravel/manager config apply
      
    4. Check if HBase is enabled successfully. Provide the CLUSTER KEY and HBASE KEY whenever prompted.

      <Unravel installation directory>/unravel/manager config hbase show
      

      Tip

      Run the manager config edge show command to get the <CLUSTER_KEY> <HBASE_KEY> details.

      • CLUSTER_KEY is the name of the cluster where you set the HBase configurations.

      • HBASE_KEY is the definition of the HBase service.

      unravel/manager config hbase show
      -- Running: config hbase show
      Cluster key:ClusterFromTemplate
      HBase key:hbase
      enabled: true
    5. Only for multi-cluster deployment: In a multi-cluster deployment of Unravel, in case you have configured HBase on an edge node, run the following command from the core node:

      <Unravel installation directory>/unravel/manager config feature enable hbase-monitoring
      

      This displays the HBase feature to the Unravel UI.

      HBase configurations can be set on the edge node or on the core node with auto-configuration or manual configuration. On the core node, the auto-configuration handles the automatic display of the HBase feature on Unravel UI. However, If you have configured HBase on the edge node, you must run the above command from the core node to display HBase feature to the Unravel UI.

    6. Start Unravel

      <Unravel installation directory>/unravel/manager start
  • Option 2: HBase manual configuration

    To manually configure HBase, run the following steps on an HBase node:

    1. Stop Unravel

      <Unravel installation directory>/unravel/manager stop
      
    2. Run the following command to view the HBase configuration.

      <unravel_installation_directory>/unravel/manager config hbase --help
      +-------------------------------------------------------------------------------
      | manager config hbase <subcommand>
      +-------------------------------------------------------------------------------
      | Available subcommands:
      |
      |   show              : Display configured hbase
      |   enable            : Enable hbase
      |   disable           : Disable hbase
      |   ssl               : Enable/Disable SSL
      |   set-table-pattern : Set table name filter
      |   set-jmx           : Set hbase JMX source
      |   set-cm            : Set hbase cluster managed source (ambari/cloudera manager)
      |   remove            : Remove hbase
      
    3. Enable HBase. This allows the specified HBase to be used when generating configuration.

      Tip

      Run the manager config edge show command to get the <EDGE_KEY> <CLUSTER_KEY> <HBASE_KEY> details.

      • EDGE_KEY is the label used to identify the edge node.

      • CLUSTER_KEY is the name of the cluster where you set the HBase configurations.

      • HBASE_KEY is the definition of the HBASE service.

      <unravel_installation_directory>/unravel/manager config hbase enable  <EDGE_KEY> <CLUSTER_KEY> <HBASE_KEY> 
      For example: /opt/unravel/manager config hbase enable my-edge cluster1 hbase
      
    4. Enable/disable SSL. This specifies if HTTPS should be used or not when making REST calls.

      manager config edge hbase ssl <enable|disable> <EDGE_KEY> <CLUSTER_KEY> <HBASE_KEY> 
    5. Set the table pattern filter. This sets a regular expression to filter tables.

      <unravel_installation_directory>/unravel/manager config hbase set-table-pattern <CLUSTER_KEY> <HBASE_KEY>
      
    6. Add/Update a JMX sourced HBase. This sets the details to get HBase information over JMX.

      <unravel_installation_directory>/unravel/manager config hbase set-jmx <EDGE_KEY> <CLUSTER_KEY> <HBASE_KEY> <MASTER_SERVER_HOSTNAME> <MASTER_SERVER_PORT> <REGION_SERVER_HOSTNAME> <REGION_SERVER_PORT> 
      • <MASTER_HOST> <MASTER_PORT>: Provide comma-separated HBase Web UI URLs of each Master server.

      • <REGION_HOST> <REGION_PORT>: Provide comma-separated HBase Web UI URLs of each Region server. 

    7. Add/update a cluster manager (ambari/cloudera manager) sourced HBase

      <unravel_installation_directory>/unravel/manager config hbase set-cm <EDGE_KEY> <CLUSTER_KEY> <HBASE_KEY> <MASTER_SERVER_HOSTNAME> <MASTER_SERVER_PORT> <REGION_SERVER_HOSTNAME> <REGION_SERVER_PORT> 
    8. Only for multi-cluster deployment: In a multi-cluster deployment of Unravel, in case you have configured HBase on an edge node, run the following command from the core node:

      <Unravel installation directory>/unravel/manager config feature enable hbase-monitoring
      

      This displays the HBase feature on the Unravel UI.

      HBase configurations can be set on the edge node or on the core node with auto-configuration or manual configuration. On the core node, the auto-configuration handles the automatic display of the HBase feature on Unravel UI. However, If you have configured HBase on the edge node, you must run the above command from the core node to display the HBase feature to the Unravel UI.

    9. Apply the changes.

      <Unravel installation directory>/unravel/manager config apply
      
    10. Start Unravel

      <Unravel installation directory>/unravel/manager start