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

name

String

Name of the object store being created

Must be a valid name

Yes

new-name

String

New name for the object store

Must be a valid name

site

String

local - for tiering+snapshots, remote - for snapshots only

local or remote

hostname

String

Object store host identifier, to be used as a default for added buckets

Must be a valid name/IP

port

String

Object store port, to be used as a default for added buckets

Must be a valid name

auth-method

String

Authentication method, to be used as a default for added buckets

None, AWSSignature2 or AWSSignature4

region

String

Region name, to be used as a default for added buckets

access-key-id

String

Object store access key ID, to be used as a default for added buckets

secret-key

String

Object store secret key, to be used as a default for added buckets

protocol

String

Protocol type, to be used as a default for added buckets

HTTP, HTTPS or HTTPS_UNVERIFIED

bandwidth

Number

Bandwidth limitation per core (Mbps)

download-bandwidth

Number

Object-store download bandwidth limitation per core (Mbps)

upload-bandwidth

Number

Object-store upload bandwidth limitation per core (Mbps)

max-concurrent-downloads

Number

Maximum number of downloads concurrently performed on this object store in a single IO node

1-64

max-concurrent-uploads

Number

Maximum number of uploads concurrently performed on this object store in a single IO node

1-64

max-concurrent-removals

Number

Maximum number of removals concurrently performed on this object store in a single IO node

1-64

enable-upload-tags

String

Whether to enable object-tagging or not, to be used as a default for added buckets

true or false

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

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)

local

obs-name

String

Name of the object-store to add this object-store bucket to

Must be an existing object-store

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

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

The protocol specified in obs-name if present, otherwiseHTTP

bandwidth

Number

Bucket bandwidth limitation per core (Mbps)

download-bandwidth

Number

Bucket download bandwidth limitation per core (Mbps)

upload-bandwidth

Number

Bucket upload bandwidth limitation per core (Mbps)

errors-timeout

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

300

prefetch-mib

Number

How many MiB of data to prefetch when reading a whole MiB on the object store

enable-upload-tags

String

Whether to enable object-tagging or not

true or false

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-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

name

String

Name of the object-store bucket being edited

Must be a valid name

Yes

new-name

String

New name for the object-store bucket

Must be a valid name

new-obs-name

String

New name of the object-store to add this object-store bucket to

Must be an existing object-store, with the same site value.

hostname

String

Object store host identifier

Must be a valid name/IP

port

String

Object store port

Must be a valid name

bucket

String

Object store bucket name

Must be a valid name

auth-method

String

Authentication method

None, AWSSignature2 or AWSSignature4

region

String

Region name

access-key-id

String

Object-store bucket access key ID

secret-key

String

Object-store bucket secret key

protocol

String

Protocol type to be used

HTTP, HTTPS or HTTPS_UNVERIFIED

bandwidth

Number

Bandwidth limitation per core (Mbps)

download-bandwidth

Number

Bucket download bandwidth limitation per core (Mbps)

upload-bandwidth

Number

Bucket upload bandwidth limitation per core (Mbps)

errors-timeout

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

prefetch-mib

Number

How many MiB of data to prefetch when reading a whole MiB on the object store

enable-upload-tags

String

Whether to enable object-tagging or not

true or false

List recent operations of an object store bucket

Command: weka fs tier ops

Use the following command line to list the recent operations running on an object store:

weka fs tier ops <name> [--format format] [--output output]...[--sort sort]...[--filter filter]...[--raw-units] [--UTC] [--no-header] [--verbose]

Parameters

Name

Type

Value

Limitations

Mandatory

Default

name

String

Name of the object store bucket to show its recent operations.

Must be a valid name

Yes

format

String

Specify the output format.

Available options: view, csv, markdown, json, or oldview

view

output

String

Specify the columns in the output.

Available columns: node, obsBucket, key, type, execution, phase, previous, start, size, results, errors, lastHTTP, concurrency, inode

All columns

sort

String

Specify the column(s) to consider when sorting the output. For the sorting order, ascending or descending, add - or + signs respectively before the column name.

filter

String

Specify the values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]]

raw-units

Boolean

Print values in raw units such as bytes, and seconds.

Human-readable format, for example, 1KiB 234MiB 2GiB.

no-header

Boolean

Don't show column headers in the output,

verbose

Boolean

Show all columns in the output.

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

name

String

Name of the object store bucket to delete.

Must be a valid name

Yes

PreviousManage object stores using the GUI

NextManage filesystem groups

Last updated 3 years ago