Migrate Apache HBase to a new version and storage account

  • Article

This article discusses how to update your Apache HBase cluster on Azure HDInsight to a newer version with a different Azure Storage account.

This article applies only if you need to use different Storage accounts for your source and destination clusters. To upgrade versions with the same Storage account for your source and destination clusters, see Migrate Apache HBase to a new version.

The downtime while upgrading should be only a few minutes. This downtime is caused by the steps to flush all in-memory data, and the time to configure and restart the services on the new cluster. Your results will vary, depending on the number of nodes, amount of data, and other variables.

Review Apache HBase compatibility

Before upgrading Apache HBase, ensure the HBase versions on the source and destination clusters are compatible. Review the HBase version compatibility matrix and release notes in the HBase Reference Guide to make sure your application is compatible with the new version.

Here is an example compatibility matrix. Y indicates compatibility and N indicates a potential incompatibility:

Compatibility type Major version Minor version Patch
Client-Server wire compatibility N Y Y
Server-Server compatibility N Y Y
File format compatibility N Y Y
Client API compatibility N Y Y
Client binary compatibility N N Y
Server-side limited API compatibility
Stable N Y Y
Evolving N N Y
Unstable N N N
Dependency compatibility N Y Y
Operational compatibility N N Y

The HBase version release notes should describe any breaking incompatibilities. Test your application in a cluster running the target version of HDInsight and HBase.

For more information about HDInsight versions and compatibility, see Azure HDInsight versions.

Apache HBase cluster migration overview

To upgrade and migrate your Apache HBase cluster on Azure HDInsight to a new storage account, you complete the following basic steps. For detailed instructions, see the detailed steps and commands.

Prepare the source cluster:

  1. Stop data ingestion.
  2. Flush memstore data.
  3. Stop HBase from Ambari.
  4. For clusters with accelerated writes, back up the Write Ahead Log (WAL) directory.

Prepare the destination cluster:

  1. Create the destination cluster.
  2. Stop HBase from Ambari.
  3. Clean Zookeeper data.
  4. Switch user to HBase.

Complete the migration:

  1. Clean the destination file system, migrate the data, and remove /hbase/hbase.id.
  2. Clean and migrate the WAL.
  3. Start all services from the Ambari destination cluster.
  4. Verify HBase.
  5. Delete the source cluster.

Detailed migration steps and commands

Use these detailed steps and commands to migrate your Apache HBase cluster with a new storage account.

Prepare the source cluster

  1. Stop ingestion to the source HBase cluster.

  2. Flush the source HBase cluster you're upgrading.

    HBase writes incoming data to an in-memory store called a memstore. After the memstore reaches a certain size, HBase flushes it to disk for long-term storage in the cluster's storage account. Deleting the source cluster after an upgrade also deletes any data in the memstores. To retain the data, manually flush each table's memstore to disk before upgrading.

    You can flush the memstore data by running the flush_all_tables.sh script from the hbase-utils GitHub repository.

    You can also flush the memstore data by running the following HBase shell command from inside the HDInsight cluster:

    hbase shell
flush "<table-name>"

  3. Sign in to Apache Ambari on the source cluster with https://<OLDCLUSTERNAME>.azurehdinsight.cn, and stop the HBase services.

  4. At the confirmation prompt, select the box to turn on maintenance mode for HBase.

    For more information on connecting to and using Ambari, see Manage HDInsight clusters by using the Ambari Web UI.

  5. If your source HBase cluster doesn't have the Accelerated Writes feature, skip this step. For source HBase clusters with Accelerated Writes, back up the WAL directory under HDFS by running the following commands from an SSH session on any source cluster Zookeeper node or worker node.

    hdfs dfs -mkdir /hbase-wal-backup
hdfs dfs -cp hdfs://mycluster/hbasewal /hbase-wal-backup

Prepare the destination cluster

  1. In the Azure portal, set up a new destination HDInsight cluster that uses a different storage account than your source cluster.

  2. Sign in to Apache Ambari on the new cluster at https://<NEWCLUSTERNAME>.azurehdinsight.cn, and stop the HBase services.

  3. Clean the Zookeeper data on the destination cluster by running the following commands in any Zookeeper node or worker node:

    hbase zkcli
rmr /hbase-unsecure
quit

  4. Switch the user to HBase by running sudo su hbase.

Clean and migrate the file system and WAL

Run the following commands, depending on your source HDI version and whether the source and destination clusters have Accelerated Writes. The destination cluster is always HDI version 4.0, since HDI 3.6 is in Basic support and isn't recommended for new clusters.

The <container-endpoint-url> for the storage account is https://<storageaccount>.blob.core.chinacloudapi.cn/<container-name>. Pass the SAS token for the storage account at the very end of the URL.

  • The <container-fullpath> for storage type WASB is wasbs://<container-name>@<storageaccount>.blob.core.chinacloudapi.cn
  • The <container-fullpath> for storage type Azure Data Lake Storage Gen2 is abfs://<container-name>@<storageaccount>.dfs.core.chinacloudapi.cn.

Copy commands

The HDFS copy command is hdfs dfs <copy properties starting with -D> -cp

Use hadoop distcp for better performance when copying files not in a page blob: hadoop distcp <copy properties starting with -D>

To pass the key of the storage account, use:

  • -Dfs.azure.account.key.<storageaccount>.blob.core.chinacloudapi.cn='<storage account key>'
  • -Dfs.azure.account.keyprovider.<storageaccount>.blob.core.chinacloudapi.cn=org.apache.hadoop.fs.azure.SimpleKeyProvider

You can also use AzCopy for better performance when copying HBase data files.

  1. Run the AzCopy command:

    azcopy cp "<source-container-endpoint-url>/hbase" "<target-container-endpoint-url>" --recursive

  2. If the destination storage account is Azure Blob storage, do this step after the copy. If the destination storage account is Data Lake Storage Gen2, skip this step.

    The Hadoop WASB driver uses special 0-sized blobs corresponding to every directory. AzCopy skips these files when doing the copy. Some WASB operations use these blobs, so you must create them in the destination cluster. To create the blobs, run the following Hadoop command from any node in the destination cluster:

    sudo -u hbase hadoop fs -chmod -R 0755 /hbase

You can download AzCopy from Get started with AzCopy. For more information about using AzCopy, see azcopy copy.

The source cluster is HDI 3.6 or HDI 4.0 with Accelerated Writes, and the destination cluster has Accelerated Writes

  1. To clean the file system and migrate data, run the following commands:

    hdfs dfs -rm -r /hbase 
hadoop distcp <source-container-fullpath>/hbase /

  2. Remove hbase.id by running hdfs dfs -rm /hbase/hbase.id

  3. To clean and migrate the WAL, run the following commands:

    hdfs dfs -rm -r hdfs://<destination-cluster>/hbasewal
hdfs dfs -cp <source-container-fullpath>/hbase-wal-backup/hbasewal hdfs://<destination-cluster>/hbasewal

The source cluster is HDI 3.6 without Accelerated Writes, and the destination cluster has Accelerated Writes

  1. To clean the file system and migrate data, run the following commands:

    hdfs dfs -rm -r /hbase 
hdfs dfs -Dfs.azure.page.blob.dir="/hbase/WALs,/hbase/MasterProcWALs,/hbase/oldWALs,/hbase-wals" -cp <source-container-fullpath>/hbase /
hdfs dfs -rm -r /hbase/*WALs

  2. Remove hbase.id by running hdfs dfs -rm /hbase/hbase.id

  3. To clean and migrate the WAL, run the following commands:

    hdfs dfs -rm -r hdfs://<destination-cluster>/hbasewal/*
hdfs dfs -Dfs.azure.page.blob.dir="/hbase/WALs,/hbase/MasterProcWALs,/hbase/oldWALs,/hbase-wals" -cp <source-container-fullpath>/hbase/*WALs hdfs://<destination-cluster>/hbasewal

The source cluster is HDI 3.6 without Accelerated Writes, and the destination cluster doesn't have Accelerated Writes

  1. To clean the file system and migrate data, run the following commands:

    hdfs dfs -rm -r /hbase 
hdfs dfs -Dfs.azure.page.blob.dir="/hbase/WALs,/hbase/MasterProcWALs,/hbase/oldWALs,/hbase-wals" -cp <source-container-fullpath>/hbase /
hdfs dfs -rm -r /hbase/*WALs

  2. Remove hbase.id by running hdfs dfs -rm /hbase/hbase.id

  3. To clean and migrate the WAL, run the following commands:

    hdfs dfs -rm -r /hbase-wals/*
hdfs dfs -Dfs.azure.page.blob.dir="/hbase/WALs,/hbase/MasterProcWALs,/hbase/oldWALs,/hbase-wals" -cp <source-container-fullpath>/hbase/*WALs /hbase-wals

The source cluster is HDI 4.0 without Accelerated Writes, and the destination cluster has Accelerated Writes

  1. To clean the file system and migrate data, run the following commands:

    hdfs dfs -rm -r /hbase 
hadoop distcp <source-container-fullpath>/hbase /

  2. Remove hbase.id by running hdfs dfs -rm /hbase/hbase.id

  3. To clean and migrate the WAL, run the following commands:

    hdfs dfs -rm -r hdfs://<destination-cluster>/hbasewal
hdfs dfs -Dfs.azure.page.blob.dir="/hbase-wals" -cp <source-container-fullpath>/hbase-wals hdfs://<destination-cluster>/hbasewal

The source cluster is HDI 4.0 without Accelerated Writes, and the destination cluster doesn't have Accelerated Writes

  1. To clean the file system and migrate data, run the following commands:

    hdfs dfs -rm -r /hbase 
hadoop distcp <source-container-fullpath>/hbase /

  2. Remove hbase.id by running hdfs dfs -rm /hbase/hbase.id

  3. To clean and migrate the WAL, run the following commands:

    hdfs dfs -rm -r /hbase-wals/*
hdfs dfs -Dfs.azure.page.blob.dir="/hbase-wals" -cp <source-container-fullpath>/hbase-wals /

Complete the migration

  1. On the destination cluster, save your changes and restart all required services as indicated by Ambari.

  2. Point your application to the destination cluster.

    Note

    The static DNS name for your application changes when you upgrade. Rather than hard-coding this DNS name, you can configure a CNAME in your domain name's DNS settings that points to the cluster's name. Another option is to use a configuration file for your application that you can update without redeploying.

  3. Start the ingestion.

  4. Verify HBase consistency and simple Data Definition Language (DDL) and Data Manipulation Language (DML) operations.

  5. If the destination cluster is satisfactory, delete the source cluster.

Next steps

To learn more about Apache HBase and upgrading HDInsight clusters, see the following articles: