Adding an object store bucket using the CLI

Content Software for File CLI Reference

Version
4.2.x
Audience
anonymous
Part Number
MK-HCSF001-03

Command

weka fs tier s3 add

Use the following command line to add an object store:

weka fs tier s3 add <name> [--site site] [--obs-name obs-name] [--hostname=<hostname>] [--port=<port> [--bucket=<bucket>] [--auth-method=<auth-method>] [--region=<region>] [--access-key-id=<access-key-id>] [--secret-key=<secret-key>] [--protocol=<protocol>] [--bandwidth=<bandwidth>] [--download-bandwidth=<download-bandwidth>] [--remove-bandwidth=<remove-bandwidth>] [--upload-bandwidth=<upload-bandwidth>] [--errors-timeout=<errors-timeout>] [--prefetch-mib=<prefetch-mib>] [--enable-upload-tags=<enable-upload-tags>]

Parameters

Name Type Value Limitations Mandatory Default
name String Name of the object-store bucket being created Must be a valid name Yes
Site String local - for tiering+snapshots, remote - for snapshots only Must be the same as the object store site it is added to (obs-name) No Local
obs-name String Name of the object-store to add this object-store bucket to Must be an existing object-store No If there is only one object-store of type mentioned in site it is chosen automatically
hostname String Object store host identifier Must be a valid name/IP Yes, if not specified in the object-store level The hostname specified in obs-name if present
port String Object store port Must be a valid name No The port specified in obs-name if present, otherwise 80
bucket String Object store bucket name Must be a valid name Yes
auth-method String Authentication method None, AWSSignature2 or AWSSignature4 Yes, if not specified in the object-store level The auth-method specified in obs-name if present
region String Region name Yes, if not specified in the object-store level The region specified in obs-name if present
access-key-id String Object store bucket access key ID Yes, if not specified in the object-store level (can be left empty when using IAM role in AWS) The access-key-id specified in obs-name if present
secret-key String Object store bucket secret key Yes, if not specified in the object-store level (can be left empty when using IAM role in AWS) The secret-key specified in obs-name if present
protocol String Protocol type to be used HTTP, HTTPS or HTTPS_UNVERIFIED No The protocol specified in obs-name if present, otherwise HTTP
bandwidth Number Bucket bandwidth limitation per core (Mbps)   No  
download-bandwidth Number Bucket download bandwidth limitation per core (Mbps)   No
upload-bandwidth Number Bucket upload bandwidth limitation per core (Mbps) No
remove-bandwidth Number

A bandwidth (Mbps) to limit the throughput of delete requests sent to the object store. Setting a bandwidth equal to or lower than the object store deletion throughput prevents an increase in the object store deletions queue.

     
prefetch-mib Number How many MiB of data to prefetch when reading a whole MiB on the object store   No 0
enable-upload-tags String Whether to enable object-tagging or not true or false No false
Note: When using the CLI, by default a misconfigured object store will not be created. To create an object store even when it is misconfigured, use the --skip-verification option.
Note: The max-concurrent settings are applied per Content Software for File compute process and the minimum setting of all object-stores is applied.
Note: When you create the object store bucket in AWS, to use the storage classes: S3 Intelligent-Tiering, S3 Standard-IA, S3 One Zone-IA, and S3 Glacier Instant Retrieval, do the following:
  1. Create the bucket in S3 Standard.
  2. Create an AWS lifecycle policy to transition objects to these storage classes.
  3. Make the relevant changes and click Update to update the object store bucket.