[HBASE-9426] Make custom distributed barrier procedure pluggable

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.95.2, 0.94.11
• Fix Version/s: 0.99.0
• Hadoop Flags: Incompatible change, Reviewed
• Release Note: This patch adds two new API calls to the protobuf rpc interface.
• Assignee: Richard Ding
• Reporter: Richard Ding
• Created: 04/Sep/13 00:01
• Updated: 21/Feb/15 23:33
• Resolved: 22/Jan/14 01:43

Description

Currently if one wants to implement a custom distributed barrier procedure (e.g., distributed log roll or distributed table flush), the HBase core code needs to be modified in order for the procedure to work.

Looking into the snapshot code (especially on region server side), most of the code to enable the procedure are generic life-cycle management (i.e., init, start, stop). We can make this part pluggable.

Here is the proposal. Following the coprocessor example, we define two properties:

hbase.procedure.regionserver.classes
hbase.procedure.master.classes

The values for both are comma delimited list of classes. On region server side, the classes implements the following interface:

public interface RegionServerProcedureManager {
  public void initialize(RegionServerServices rss) throws KeeperException;
  public void start();
  public void stop(boolean force) throws IOException;
  public String getProcedureName();
}

While on Master side, the classes implement the interface:

public interface MasterProcedureManager {
  public void initialize(MasterServices master) throws KeeperException, IOException, UnsupportedOperationException;
  public void stop(String why);
  public String getProcedureName();
  public void execProcedure(ProcedureDescription desc) throws IOException;
  IOException;
}

Where the ProcedureDescription is defined as

message ProcedureDescription {
  required string name = 1;
  required string instance = 2;
  optional int64 creationTime = 3 [default = 0];
  message Property {
    required string tag = 1;
    optional string value = 2;
  }
  repeated Property props = 4;
}

A generic API can be defined on HMaster to trigger a procedure:

public boolean execProcedure(ProcedureDescription desc) throws IOException;

SnapshotManager and RegionServerSnapshotManager are special examples of MasterProcedureManager and RegionServerProcedureManager. They will be automatically included (users don't need to specify them in the conf file).

Issue Links

• is related to: HBASE-10926 Use global procedure to flush table memstore cache
• is related to: HBASE-9864 Notifications bus for use by cluster members keeping up-to-date on changes
• relates to: HBASE-11304 Enable HBaseAdmin.execProcedure to return data from procedure execution