<li><ahref="#Protecting_the_Azure_Credentials_for_WASB_with_Credential_Providers">Protecting the Azure Credentials for WASB with Credential Providers</a></li>
<li><ahref="#Protecting_the_Azure_Credentials_for_WASB_within_an_Encrypted_File">Protecting the Azure Credentials for WASB within an Encrypted File</a></li></ul></li>
<li><ahref="#Block_Blob_with_Compaction_Support_and_Configuration">Block Blob with Compaction Support and Configuration</a></li>
<li><ahref="#Page_Blob_Support_and_Configuration">Page Blob Support and Configuration</a></li>
<p>The <code>hadoop-azure</code> module provides support for integration with <aclass="externalLink"href="http://azure.microsoft.com/en-us/documentation/services/storage/">Azure Blob Storage</a>. The built jar file, named <code>hadoop-azure.jar</code>, also declares transitive dependencies on the additional artifacts it requires, notably the <aclass="externalLink"href="https://github.com/Azure/azure-storage-java">Azure Storage SDK for Java</a>.</p>
<p>To make it part of Apache Hadoop’s default classpath, simply make sure that <code>HADOOP_OPTIONAL_TOOLS</code>in <code>hadoop-env.sh</code> has <code>'hadoop-azure</code> in the list. Example:</p>
<li>Read and write data stored in an Azure Blob Storage account.</li>
<li>Present a hierarchical file system view by implementing the standard Hadoop <ahref="../api/org/apache/hadoop/fs/FileSystem.html"><code>FileSystem</code></a> interface.</li>
<li>Supports configuration of multiple Azure Blob Storage accounts.</li>
<li>Supports both block blobs (suitable for most use cases, such as MapReduce) and page blobs (suitable for continuous write use cases, such as an HBase write-ahead log).</li>
<li>Reference file system paths using URLs using the <code>wasb</code> scheme.</li>
<li>Also reference file system paths using URLs with the <code>wasbs</code> scheme for SSL encrypted access.</li>
<li>Can act as a source of data in a MapReduce job, or a sink.</li>
<li>Tested on both Linux and Windows.</li>
<li>Tested at scale.</li>
</ul></section><section>
<h2><aname="Limitations"></a>Limitations</h2>
<ul>
<li>File owner and group are persisted, but the permissions model is not enforced. Authorization occurs at the level of the entire Azure Blob Storage account.</li>
<li>File last access time is not tracked.</li>
</ul></section><section>
<h2><aname="Usage"></a>Usage</h2><section>
<h3><aname="Concepts"></a>Concepts</h3>
<p>The Azure Blob Storage data model presents 3 core concepts:</p>
<ul>
<li><b>Storage Account</b>: All access is done through a storage account.</li>
<li><b>Container</b>: A container is a grouping of multiple blobs. A storage account may have multiple containers. In Hadoop, an entire file system hierarchy is stored in a single container. It is also possible to configure multiple containers, effectively presenting multiple file systems that can be referenced using distinct URLs.</li>
<li><b>Blob</b>: A file of any type and size. In Hadoop, files are stored in blobs. The internal implementation also uses blobs to persist the file system hierarchy and other metadata.</li>
<p>Usage of Azure Blob Storage requires configuration of credentials. Typically this is set in core-site.xml. The configuration property name is of the form <code>fs.azure.account.key.<account name>.blob.core.windows.net</code> and the value is the access key. <b>The access key is a secret that protects access to your storage account. Do not share the access key (or the core-site.xml file) with an untrusted party.</b></p>
<p>In many Hadoop clusters, the core-site.xml file is world-readable. It is possible to protect the access key within a credential provider as well. This provides an encrypted file format along with protection with file permissions.</p><section>
<h4><aname="Protecting_the_Azure_Credentials_for_WASB_with_Credential_Providers"></a>Protecting the Azure Credentials for WASB with Credential Providers</h4>
<p>To protect these credentials from prying eyes, it is recommended that you use the credential provider framework to securely store them and access them through configuration. The following describes its use for Azure credentials in WASB FileSystem.</p>
<p>For additional reading on the credential provider API see: <ahref="../hadoop-project-dist/hadoop-common/CredentialProviderAPI.html">Credential Provider API</a>.</p><section>
<h5><aname="End_to_End_Steps_for_Distcp_and_WASB_with_Credential_Providers"></a>End to End Steps for Distcp and WASB with Credential Providers</h5><section>
<p>NOTE: You may optionally add the provider path property to the distcp command line instead of added job specific configuration to a generic core-site.xml. The square brackets above illustrate this capability.</p></section></section></section><section>
<h4><aname="Protecting_the_Azure_Credentials_for_WASB_within_an_Encrypted_File"></a>Protecting the Azure Credentials for WASB within an Encrypted File</h4>
<p>In addition to using the credential provider framework to protect your credentials, it’s also possible to configure it in encrypted form. An additional configuration property specifies an external program to be invoked by Hadoop processes to decrypt the key. The encrypted key value is passed to this external program as a command line argument:</p>
<value>PATH TO DECRYPTION PROGRAM</value>
</property>
</pre></div></div>
</section></section><section>
<h3><aname="Block_Blob_with_Compaction_Support_and_Configuration"></a>Block Blob with Compaction Support and Configuration</h3>
<p>Block blobs are the default kind of blob and are good for most big-data use cases. However, block blobs have strict limit of 50,000 blocks per blob. To prevent reaching the limit WASB, by default, does not upload new block to the service after every <code>hflush()</code> or <code>hsync()</code>.</p>
<p>For most of the cases, combining data from multiple <code>write()</code> calls in blocks of 4Mb is a good optimization. But, in others cases, like HBase log files, every call to <code>hflush()</code> or <code>hsync()</code> must upload the data to the service.</p>
<p>Block blobs with compaction upload the data to the cloud service after every <code>hflush()</code>/<code>hsync()</code>. To mitigate the limit of 50000 blocks, <code>hflush()</code>/<code>hsync()</code> runs once compaction process, if number of blocks in the blob is above 32,000.</p>
<p>Block compaction search and replaces a sequence of small blocks with one big block. That means there is associated cost with block compaction: reading small blocks back to the client and writing it again as one big block.</p>
<p>In order to have the files you create be block blobs with block compaction enabled, the client must set the configuration variable <code>fs.azure.block.blob.with.compaction.dir</code> to a comma-separated list of folder names.</p>
<h3><aname="Page_Blob_Support_and_Configuration"></a>Page Blob Support and Configuration</h3>
<p>The Azure Blob Storage interface for Hadoop supports two kinds of blobs, <aclass="externalLink"href="http://msdn.microsoft.com/en-us/library/azure/ee691964.aspx">block blobs and page blobs</a>. Block blobs are the default kind of blob and are good for most big-data use cases, like input data for Hive, Pig, analytical map-reduce jobs etc. Page blob handling in hadoop-azure was introduced to support HBase log files. Page blobs can be written any number of times, whereas block blobs can only be appended to 50,000 times before you run out of blocks and your writes will fail. That won’t work for HBase logs, so page blob support was introduced to overcome this limitation.</p>
<p>Page blobs can be up to 1TB in size, larger than the maximum 200GB size for block blobs. You should stick to block blobs for most usage, and page blobs are only tested in context of HBase write-ahead logs.</p>
<p>In order to have the files you create be page blobs, you must set the configuration variable <code>fs.azure.page.blob.dir</code> to a comma-separated list of folder names.</p>
<p>You can set this to simply / to make all files page blobs.</p>
<p>The configuration option <code>fs.azure.page.blob.size</code> is the default initial size for a page blob. It must be 128MB or greater, and no more than 1TB, specified as an integer number of bytes.</p>
<p>The configuration option <code>fs.azure.page.blob.extension.size</code> is the page blob extension size. This defines the amount to extend a page blob if it starts to get full. It must be 128MB or greater, specified as an integer number of bytes.</p></section><section>
<p>WASB passes User-Agent header to the Azure back-end. The default value contains WASB version, Java Runtime version, Azure Client library version, and the value of the configuration option <code>fs.azure.user.agent.prefix</code>. Customized User-Agent header enables better troubleshooting and analysis by Azure service.</p>
<p>Azure storage stores files as a flat key/value store without formal support for folders. The hadoop-azure file system layer simulates folders on top of Azure storage. By default, folder rename in the hadoop-azure file system layer is not atomic. That means that a failure during a folder rename could, for example, leave some folders in the original directory and some in the new one.</p>
<p>HBase depends on atomic folder rename. Hence, a configuration setting was introduced called <code>fs.azure.atomic.rename.dir</code> that allows you to specify a comma-separated list of directories to receive special treatment so that folder rename is made atomic. The default value of this setting is just <code>/hbase</code>. Redo will be applied to finish a folder rename that fails. A file <code><folderName>-renamePending.json</code> may appear temporarily and is the record of the intention of the rename operation, to allow redo in event of a failure.</p>
<p>After credentials are configured in core-site.xml, any Hadoop component may reference files in that Azure Blob Storage account by using URLs of the following format:</p>
<p>The schemes <code>wasb</code> and <code>wasbs</code> identify a URL on a file system backed by Azure Blob Storage. <code>wasb</code> utilizes unencrypted HTTP access for all interaction with the Azure Blob Storage API. <code>wasbs</code> utilizes SSL encrypted HTTPS access.</p>
<p>For example, the following <ahref="../hadoop-project-dist/hadoop-common/FileSystemShell.html">FileSystem Shell</a> commands demonstrate access to a storage account named <code>youraccount</code> and a container named <code>yourcontainer</code>.</p>
<p>It’s also possible to configure <code>fs.defaultFS</code> to use a <code>wasb</code> or <code>wasbs</code> URL. This causes all bare paths, such as <code>/testDir/testFile</code> to resolve automatically to that file system.</p></section><section>
<h3><aname="Append_API_Support_and_Configuration"></a>Append API Support and Configuration</h3>
<p>The Azure Blob Storage interface for Hadoop has optional support for Append API for single writer by setting the configuration <code>fs.azure.enable.append.support</code> to true.</p>
<p>It must be noted Append support in Azure Blob Storage interface DIFFERS FROM HDFS SEMANTICS. Append support does not enforce single writer internally but requires applications to guarantee this semantic. It becomes a responsibility of the application either to ensure single-threaded handling for a particular file path, or rely on some external locking mechanism of its own. Failure to do so will result in unexpected behavior.</p></section><section>
<p>Rename and Delete blob operations on directories with large number of files and sub directories currently is very slow as these operations are done one blob at a time serially. These files and sub folders can be deleted or renamed parallel. Following configurations can be used to enable threads to do parallel processing</p>
<p>To enable 10 threads for Delete operation. Set configuration value to 0 or 1 to disable threads. The default behavior is threads disabled.</p>
<divclass="source">
<divclass="source">
<pre><property>
<name>fs.azure.delete.threads</name>
<value>10</value>
</property>
</pre></div></div>
<p>To enable 20 threads for Rename operation. Set configuration value to 0 or 1 to disable threads. The default behavior is threads disabled.</p>
<divclass="source">
<divclass="source">
<pre><property>
<name>fs.azure.rename.threads</name>
<value>20</value>
</property>
</pre></div></div>
</section><section>
<h3><aname="WASB_Secure_mode_and_configuration"></a>WASB Secure mode and configuration</h3>
<p>WASB can operate in secure mode where the Storage access keys required to communicate with Azure storage does not have to be in the same address space as the process using WASB. In this mode all interactions with Azure storage is performed using SAS uris. There are two sub modes within the Secure mode, one is remote SAS key mode where the SAS keys are generated from a remote process and local mode where SAS keys are generated within WASB. By default the SAS Key mode is expected to run in Romote mode, however for testing purposes the local mode can be enabled to generate SAS keys in the same process as WASB.</p>
<p>To enable Secure mode following property needs to be set to true.</p>
<divclass="source">
<divclass="source">
<pre><property>
<name>fs.azure.secure.mode</name>
<value>true</value>
</property>
</pre></div></div>
<p>To enable SAS key generation locally following property needs to be set to true.</p>
<p>To use the remote SAS key generation mode, comma separated external REST services are expected to provided required SAS keys. Following property can used to provide the end point to use for remote SAS Key generation:</p>
<p>The remote service is expected to provide support for two REST calls <code>{URL}/GET_CONTAINER_SAS</code> and <code>{URL}/GET_RELATIVE_BLOB_SAS</code>, for generating container and relative blob sas keys. An example requests</p>
<p>The service is expected to return a response in JSON format:</p>
<divclass="source">
<divclass="source">
<pre>{
"responseCode" : 0 or non-zero <int>,
"responseMessage" : relavant message on failure <String>,
"sasKey" : Requested SAS Key <String>
}
</pre></div></div>
</section><section>
<h3><aname="Authorization_Support_in_WASB"></a>Authorization Support in WASB</h3>
<p>Authorization support can be enabled in WASB using the following configuration:</p>
<divclass="source">
<divclass="source">
<pre><property>
<name>fs.azure.authorization</name>
<value>true</value>
</property>
</pre></div></div>
<p>The current implementation of authorization relies on the presence of an external service that can enforce the authorization. The service is expected to be running on comma separated URLs provided by the following config.</p>
<p>The remote service is expected to provide support for the following REST call: <code>{URL}/CHECK_AUTHORIZATION</code> An example request: <code>{URL}/CHECK_AUTHORIZATION?wasb_absolute_path=<absolute_path>&operation_type=<operation type>&delegation_token=<delegation token></code></p>
<p>The service is expected to return a response in JSON format:</p>
<divclass="source">
<divclass="source">
<pre>{
"responseCode" : 0 or non-zero <int>,
"responseMessage" : relevant message on failure <String>,
<p>The current implementation of delegation token implementation relies on the presence of an external service instances that can generate and manage delegation tokens. The service is expected to be running on comma separated URLs provided by the following config.</p>
<p>The remote service is expected to provide support for the following REST call: <code>{URL}?op=GETDELEGATIONTOKEN</code>, <code>{URL}?op=RENEWDELEGATIONTOKEN</code> and <code>{URL}?op=CANCELDELEGATIONTOKEN</code> An example request: <code>{URL}?op=GETDELEGATIONTOKEN&renewer=<renewer></code><code>{URL}?op=RENEWDELEGATIONTOKEN&token=<delegation token></code><code>{URL}?op=CANCELDELEGATIONTOKEN&token=<delegation token></code></p>
<p>The service is expected to return a response in JSON format for GETDELEGATIONTOKEN request:</p>
<divclass="source">
<divclass="source">
<pre>{
"Token" : {
"urlString": URL string of delegation token.
}
}
</pre></div></div>
</section><section>
<h3><aname="chown_behaviour_when_authorization_is_enabled_in_WASB"></a>chown behaviour when authorization is enabled in WASB</h3>
<p>When authorization is enabled, only the users listed in the following configuration are allowed to change the owning user of files/folders in WASB. The configuration value takes a comma separated list of user names who are allowed to perform chown.</p>
<h3><aname="chmod_behaviour_when_authorization_is_enabled_in_WASB"></a>chmod behaviour when authorization is enabled in WASB</h3>
<p>When authorization is enabled, only the owner and the users listed in the following configurations are allowed to change the permissions of files/folders in WASB. The configuration value takes a comma separated list of user names who are allowed to perform chmod.</p>
<p>Caching of both SAS keys and Authorization responses can be enabled using the following setting: The cache settings are applicable only when fs.azure.authorization is enabled. The cache is maintained at a filesystem object level.</p>
<p>The validity of an authorization cache-entry can be controlled using the following setting: Setting the value to zero disables authorization-caching. If the key is not specified, a default expiry duration of 5m takes effect.</p>
<p>The validity of a SASKey cache-entry can be controlled using the following setting. Setting the value to zero disables SASKey-caching. If the key is not specified, the default expiry duration specified in the sas-key request takes effect.</p>
<p>Use container saskey for access to all blobs within the container. Blob-specific saskeys are not used when this setting is enabled. This setting provides better performance compared to blob-specific saskeys.</p>
<p><code>fs.azure.block.blob.buffered.pread.disable</code>: By default the positional read API will do a seek and read on input stream. This read will fill the buffer cache in BlockBlobInputStream. If this configuration is true it will skip usage of buffer and do a lock free call for reading from blob. This optimization is very much helpful for HBase kind of short random read over a shared InputStream instance. Note: This is not a config which can be set at cluster level. It can be used as an option on FutureDataInputStreamBuilder. See FileSystem#openFile(Path path)</p></section></section><section>
