In a previous blog we introduced Zimbra’s new Storage Management, in this article we introduce you to zms3config a command line application that allows you to manage Zimbra’s S3 configuration.
The zms3config is the CLI utility to manage the Global S3 buckets which can be shared across mailstore nodes. Bucket configurations can be created from any node and it is available across the nodes.
- The bucket name should be unique within the provider.
- The same bucket can be used for multiple volumes, just follow different paths (check volume prefix option in
zmvolumecommand) for each volume. - Following providers are supported: Amazon AWS, Ceph, Custom S3, EMC, NetApp-StorageGrid, OpenIO and Scality
Syntax:
zms3config {-a | -d | -l | -h} <options>Options
| Operations | Long Name | Short Name | Description |
|---|---|---|---|
|
Display Help |
–help |
-h |
Display Help |
|
Add new S3 config |
–add |
-a |
Create a new S3 bucket with further options. |
|
–storeProvider |
-t |
Store Provider to add s3BucketConfig, Valid Values are: AWS_S3, CEPH_S3, CUSTOM_S3, EMC_S3, STORAGE_GRID_S3, SCALITY_S3. |
|
|
–bucketName |
-bn |
Name of the bucket |
|
|
–accessKey |
-ak |
Access key |
|
|
–secretKey |
-sk |
Secret key |
|
|
–destPath |
-dp |
Destination path, root path in S3 bucket for storing volume data. |
|
|
–region |
-r |
S3 bucket region |
|
|
–url |
-url |
Endpoint URL for S3 bucket |
|
|
Delete S3 bucket |
–delete |
-d |
Delete S3 bucket |
|
–bucketID |
-bid |
Id of a bucket, which is used to delete the S3 bucket. |
|
|
List Bucket |
–list |
-l |
List all buckets |
Add S3 Configuration
- To create an AWS bucket configuration with long option names, use the command:
zms3config --add --storeProvider AWS_S3 --bucketName <bucket_name> --accessKey <secret_key> --destPath <destination_path> --region <valid_aws_region> --url <aws_valid_endpoint_url>
- To create a Ceph bucket configuration with short option names, use the command:
zms3config -a -t CEPH_S3 -bn <bucket_name> -ak <secret_key> -dp <destination_path> --url <valid_endpoint_url>
- To create a Custom S3 bucket configuration with short option names, use the command:
zms3config -a -t CUSTOM_S3 -bn <bucket_name> -ak <secret_key> -dp <destination_path> --url <valid_endpoint_url>
- To create a EMC bucket configuration with short option names, use the command:
zms3config -a -t EMC_S3 -bn <bucket_name> -ak <secret_key> -dp <destination_path> --url <valid_endpoint_url>
- To create a StorageGrid bucket configuration with short option names, use the command:
zms3config -a -t STORAGE_GRID_S3 -bn <bucket_name> -ak <secret_key> -dp <destination_path> --url <valid_endpoint_url>
- To create a Scality bucket configuration with short option names, use the command:
zms3config -a -t SCALITY_S3 -bn <bucket_name> -ak <secret_key> -dp <destination_path> --url <valid_endpoint_url>
List S3 bucket configuration
List all the S3 buckets which are configured on the setup.
zms3config -l
Delete S3 Configuration
zms3config -d -bid <bucket_unique_id>
No comments yet.