Manage object stores using the CLI
This page describes how to view and manage object stores using the CLI.
Using the CLI, you can perform the following actions:
View object stores
Command: weka fs tier obs
This command is used to view information on all the object stores configured to the Weka system.
Note: Using the GUI only object-store buckets are present. Adding an object-store bucket will add it to the only local or remote object-store present. If more than one is present (such as during the time recovering from a remote snapshot), the CLI should be used.
Edit an object store
Command: weka fs tier obs update
Use the following command line to edit an object store:
weka fs tier obs update <name> [--new-name new-name] [--site site] [--hostname=<hostname>] [--port=<port>] [--auth-method=<auth-method>] [--region=<region>] [--access-key-id=<access-key-id>] [--secret-key=<secret-key>] [--protocol=<protocol>] [--bandwidth=<bandwidth>] [--download-bandwidth=<download-bandwidth>] [--upload-bandwidth=<upload-bandwidth>] [--max-concurrent-downloads=<max-concurrent-downloads>] [--max-concurrent-uploads=<max-concurrent-uploads>] [--max-concurrent-removals=<max-concurrent-removals>] [--enable-upload-tags=<enable-upload-tags>]
Parameters
Name | Type | Value | Limitations | Mandatory | Default |
| String | Name of the object store being created | Must be a valid name | Yes | |
| String | New name for the object store | Must be a valid name | No | |
| String |
|
| No | |
| String | Object store host identifier, to be used as a default for added buckets | Must be a valid name/IP | No | |
| String | Object store port, to be used as a default for added buckets | Must be a valid name | No | |
| String | Authentication method, to be used as a default for added buckets |
| No | |
| String | Region name, to be used as a default for added buckets | No | ||
| String | Object store access key ID, to be used as a default for added buckets | No | ||
| String | Object store secret key, to be used as a default for added buckets | No | ||
| String | Protocol type, to be used as a default for added buckets |
| No | |
| Number | Bandwidth limitation per core (Mbps) | No | ||
| Number | Object-store download bandwidth limitation per core (Mbps) | No | ||
| Number | Object-store upload bandwidth limitation per core (Mbps) | No | ||
| Number | Maximum number of downloads concurrently performed on this object store in a single IO node | 1-64 | No | |
| Number | Maximum number of uploads concurrently performed on this object store in a single IO node | 1-64 | No | |
| Number | Maximum number of removals concurrently performed on this object store in a single IO node | 1-64 | No | |
| String | Whether to enable object-tagging or not, to be used as a default for added buckets |
| No |
View object store buckets
Command: weka fs tier s3
This command is used to view information on all the object-store buckets configured to the Weka system.
Add an object store bucket
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>] [--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 |
| String | Name of the object-store bucket being created | Must be a valid name | Yes | |
| String |
| Must be the same as the object store site it is added to | No |
|
| 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 |
| String | Object store host identifier | Must be a valid name/IP | Yes, if not specified in the object-store level | The |
| String | Object store port | Must be a valid name | No | The |
| String | Object store bucket name | Must be a valid name | Yes | |
| String | Authentication method |
| Yes, if not specified in the object-store level | The |
| String | Region name | Yes, if not specified in the object-store level | The | |
| 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 | |
| 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 | |
| String | Protocol type to be used |
| No | The |
| Number | Bucket bandwidth limitation per core (Mbps) | No | ||
| Number | Bucket download bandwidth limitation per core (Mbps) | No | ||
| Number | Bucket upload bandwidth limitation per core (Mbps) | No | ||
| Number | If the object-store link is down for longer than this timeout period, all IOs that need data return with an error | 1-15 minutes, e.g: 5m or 300s | No | 300 |
| Number | How many MiB of data to prefetch when reading a whole MiB on the object store | No | 0 | |
| String | Whether to enable object-tagging or not |
| No |
|
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-verificationoption.
Note: The max-concurrent settings are applied per Weka compute process and the minimum setting of all object-stores is applied.
Make the relevant changes and click Update to update the object store bucket.
Edit an object store bucket
Command: weka fs tier s3 update
Use the following command line to edit an object-store bucket:
weka fs tier s3 update <name> [--new-name=<new-name>] [--new-obs-name new-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>] [--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 |
| String | Name of the object-store bucket being edited | Must be a valid name | Yes | |
| String | New name for the object-store bucket | Must be a valid name | No | |
| String | New name of the object-store to add this object-store bucket to | Must be an existing object-store, with the same | No | |
| String | Object store host identifier | Must be a valid name/IP | No | |
| String | Object store port | Must be a valid name | No | |
| String | Object store bucket name | Must be a valid name | No | |
| String | Authentication method |
| No | |
| String | Region name | No | ||
| String | Object-store bucket access key ID | No | ||
| String | Object-store bucket secret key | No | ||
| String | Protocol type to be used |
| No | |
| Number | Bandwidth limitation per core (Mbps) | No | ||
| Number | Bucket download bandwidth limitation per core (Mbps) | No | ||
| Number | Bucket upload bandwidth limitation per core (Mbps) | No | ||
| Number | If the object-store link is down for longer than this timeout period, all IOs that need data return with an error | 1-15 minutes, e.g: 5m or 300s | No | |
| Number | How many MiB of data to prefetch when reading a whole MiB on the object store | No | ||
| String | Whether to enable object-tagging or not |
| No |
Delete an object store bucket
Command: weka fs tier s3 delete
Use the following command line to delete an object-store bucket:
weka fs tier s3 delete <name>
Parameters
Name | Type | Value | Limitations | Mandatory | Default |
| String | Name of the object-store bucket being deleted | Must be a valid name | Yes | |
Last updated