View source for Zimbra Suite Plus/Zimbra HSM Plus/Secondary volumes on Amazon S3

<div class="col-md-12"><br></div>
<div class="col-md-12"><br></div>
<ol class="breadcrumb">
  <li>[[Main Page|Zimbra Wiki]]</li>
  <li>[[Zimbra_Suite_Plus]]</li>
  <li>[[Zimbra_HSM_Plus]]</li>
  <li class="active">Zimbra HSM Plus - Secondary Volumes on Amazon S3</li>
</ol>
__NOTOC__
<div class="col-md-12"><br /></div>
<div class="col-md-9">
    <h2 class="title-header" style="padding-bottom: 9px; border-bottom: 4px solid #0087c3;">Zimbra HSM Plus - Secondary Volumes on Amazon S3</h2>
    <div class="col-md-12">
        <div class="ibox-content">
            <div class="post animated fadeInLeft animation-delay-8" style="padding-top:5px">
                <div class="panel panel-default">
                    <div class="panel-body">
                        <h5 class="post-title">Zimbra HSM Plus - Secondary Volumes on Amazon S3</h5>
                        <div class="row">
Starting from Zimbra Suite Plus 2.4.0, secondary volumes created with Zimbra HSM Plus can now be hosted on Amazon S3 buckets, effectively moving the largest part of your data to a secure and durable cloud storage.  

=== Infrequent Access storage class ===
Zimbra HSM Plus is compatible with the "Amazon S3 Standard - Infrequent access" storage class, and will set any file larger than the "Infrequent Access Threshold" value to this storage class.

For more information about Infrequent Access please refer to the [https://aws.amazon.com/s3/storage-classes official Amazon S3 Documentation].

=== Other S3-compatible services ===
While any storage service compatible with the Amazon S3 API should work out of the box with Zimbra HSM Plus, only the Amazon S3 service is officially supported at the moment.

=== Local Cache ===
This feature requires a local directory to be used for item caching, which must be readable and writable by the "zimbra" user.

Such directory must be created manually and its path must be entrered in the "HSM" section of the Zimbra Suite Plus Administration Zimlet in the Zimbra Administration Console.

<div class="col-md-8"> 
    <div class="alert alert-warning fade in"> <p> <i class="fa  fa-warning"></i> <strong>warning</strong> </p>
    <p class="text-justify">Failing to correctly set the cache directory will cause items to be unretrievable, meaning that users will get a "No such BLOB" error when trying to access any item stored on an S3 volume.</p> 
    </div> 
</div>
<div class="clearfix"></div>

== Bucket setup ==
Zimbra HSM Plus doesn't need any dedicated setting or configuration on the S3 side, so setting up a bucket for your volumes is pretty easy - it's not even necessary to create a dedicated bucket.

All you need to start storing your secondary volumes on S3 is:

* An S3 bucket. You need to know the bucket's name and region in order to use it.
* A user's Access Key and Secret.
* A policy which grants the user full rights on your bucket.

=== Bucket paths and naming ===
Files are stored in a bucket according to a well-defined path, which can be customized at will in order to make your bucket's contents easier to understand even on multiserver environments with multiple secondary volumes:

/'''Bucket Name'''/'''Destination Path'''/['''Volume Prefix'''-]'''serverID'''/

The '''Bucket Name''' and '''Destination Path''' are not tied to the volume itself, and there can be as many volumes under the same destination path as you wish.

The '''Volume Prefix''', on the other hand, is specific to each volume and it's a quick way to differentiate and recognize different volumes within the bucket.

===  S3 Buckets ===
Instead of adding the bucket's data each time you add a new secondary volume, you can save it on the Zimbra Administration Console at '''Configure > Global Settings > S3 Buckets'''.

[[File:Zimbra-amazon-s3-010.png]]

== Creating a secondary volume on Amazon S3 ==
* Click on the "HSM" entry of the Zimbra Suite Plus Administration Zimlet in the Zimbra Administration Console.
* Under the "Secondary Volumes" list, click on "Add"
[[File:Zimbra-amazon-s3-001.png|900px]]
* Select "S3 bucket"
[[File:Zimbra-amazon-s3-016.png|900px]]

* Enter the volume's name and prefix, then either add a bucket's information or load those from the ones saved in the Global Settings. Define whether to use the Infrequent Access storage class and if so set its size threshold.
[[File:Zimbra-amazon-s3-008.png|900px]]

* Define whether the new volume is set as Current or not and click "Finish" to create  the new volume.
[[File:Zimbra-amazon-s3-009.png|900px]]
                        </div>
                    </div>
                    <div class="col-md-9">
                        <div class="panel-footer">
                            <p><i class="fa fa-clock-o"></i> Sep 29, 2016 - [https://www.zimbra.com/zimbra-suite-plus/ Know more »]</p>
                        </div>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<div class="col-md-3"><br /></div>
<div class="col-md-3">
    <div class="panel panel-zimbrared-light-border"> 
        <div class="panel-heading"> 
            <h3 class="panel-title"><i class="fa fa-gear pull-left"></i> Zimbra Suite Plus</h3> 
        </div>
        <div class="panel-body">
            {{ZSP}}
        </div>
    </div>
</div>
<div class="col-md-3">
    <div class="panel panel-primary-light-border"> 
        <div class="panel-heading"> 
            <h3 class="panel-title"><i class="fa fa-info-circle pull-left"></i> Zimbra Suite Plus Resources</h3> 
        </div>
        <div class="panel-body">
            {{ZSL}}
        </div>
    </div>
</div>
<div class="clearfix"></div>
<div class="col-md-12"><br></div>
{{FH}}