Using Generic Simple Storage Service (S3) as a primary storage for Enterprise Vault
- Overview
- Configuring Generic Simple Storage Service (S3) primary partition
- Known Issues
- Troubleshooting
Adding a new Generic S3 primary partition
Before configuring the Generic S3 for primary partition, complete the following steps:
Keep your AWS Access Key ID and Secret Access Key ready.
Ensure that the S3 bucket that needs to be configured with the primary partition has been created on the S3 storage, and that you know the name of your bucket.
To add a new Generic S3 partition
- In the left pane of the Administration Console, expand the Vault Store Groups container to view the existing vault store groups.
- Expand the vault store group that contains the vault store for which you want to create the partition.
- Expand the vault store in which you want to create the partition.
- Right-click the Partitions container, and then click New > Partition. The New Partition wizard starts.
- Click Next.
- Enter all the details for new Vault Store Partition and then click Next.
- In the Storage type list, select Generic Simple Storage Service (S3).
- In Enterprise Vault 14.2 or later, the New Partition Wizard enables you to configure the non-WORM or WORM options. If you want to store data in the WORM mode, select the Store data in the WORM mode using S3 Object Lock. By default, this option is not selected and data is stored in the non-WORM mode.
Note:
Ensure that the retention mode of the S3 Object Lock for the Generic Simple Storage Service (S3) bucket is configured in the Compliance mode. The test functionality for the partition created for Generic Simple Storage Service (S3) in the WORM mode fails if the clock on the Enterprise Vault server is behind the universal clock in the same time zone. The test functionality might fail to upload the objects due to Retain Until Date must be in future error from the S3 service. You must synchronize the clock on your Enterprise Vault server with the universal clock.
- Provide the Generic S3 connection settings:
Setting
Description
Access key ID
Specify the secure access key ID for the S3-compliant storage device.
Secret access key
Specify the secret access key for the S3-compliant storage device.
Service host name
Specify the service host name URL of the same region where the S3 bucket resides.
Note:
If you select a path-style URL in Bucket access type, then the Service host name should be in the following format (varies depending on the S3-compliant storage device that is being used):
For Amazon S3: s3-<Bucket region>.amazonaws.com
For example: s3-us-east-2.amazonaws.com
Bucket name
Specify the name of the bucket.
Note:
The bucket name cannot be modified once the partition is created.
You must not delete the bucket after creating the partition. In case you need to delete the bucket for some reason, you must create a new partition.
Bucket access type
Specifies whether the URL is virtual-hosted-style URL or path-style URL.
In a virtual-hosted-style URL, the bucket name is part of the domain name in the URL. For example: https://bucket.s3.amazonaws.com.
In a path-style URL, the bucket name is not part of the domain. For example: https://s3-us-east-2.amazonaws.com/bucket.
Bucket region
Specify the geographical region where the bucket is created.
Storage class
By default, Enterprise Vault supports the S3 Standard storage class for storing archived files into the S3 bucket.
Log level
Specify the logging level for SDK logs.
No logging - Enterprise Vault does not log any SDK logs.
Fatal - Logs only fatal errors.
Error - Logs all errors.
Warn - Logs warning and errors.
Info - Logs every information, including warnings and errors.
Debug - Logs debug messages, including info, warnings, and errors.
Everything - Logs everything.
Note:
DTrace logs will include the SDK log statements, which can be easily found prefixed with AwsSdk:.
Write chunk size (MB)
Specify the write chunk size, in the range of 5 MB to 200 MB, to upload data in chunks.
Read chunk size (MB)
Specify the read chunk size, in the range of 1 MB to 1024 MB, to download data in chunks.
- Click Next.
- On the Replication page, select the appropriate option as When archived files exist on the storage or When archived files are replicated on the storage.
Please see the Administration Console Help pages for more information.
- Choose the scan interval for checking if files exist on the cloud. The supported scan interval is from 0 minute to 1440 minutes. By default, every 60 minutes, Enterprise Vault checks whether archived data is replicated or exists on cloud based on the above options. If required, you can change the scan interval. If you set the scan interval to 0 minutes, partitions are checked only when the backup mode is cleared from the vault store, and when the storage service starts.
- Click Next.
- The summary page provides the information for the newly created Generic S3 partition.