W E K A
4.0
4.0
  • WEKA v4.0 documentation
  • WEKA System Overview
    • About the WEKA system
    • SSD capacity management
    • Filesystems, object stores, and filesystem groups
    • Weka networking
    • Data lifecycle management
    • Weka client and mount modes
    • Weka containers architecture overview
    • Glossary
  • Getting Started with Weka
    • Quick installation guide
    • Manage the system using the Weka CLI
    • Manage the system using the Weka GUI
    • Run first IOs with WekaFS
    • Getting started with Weka REST API
  • Planning & Installation
    • Prerequisites for installation
    • Weka installation on bare metal
      • Planning a Weka System Installation
      • Prepare the system for Weka installation
        • SR-IOV enablement
      • Obtain the Weka software installation package
      • Weka cluster installation
      • WEKA legacy system installation process
      • Add clients
    • Weka installation on AWS
      • Self-service portal
      • CloudFormation template generator
      • Deployment types
      • AWS outposts deployment
      • Supported EC2 instance types
      • Add clients
      • Auto scaling group
      • Troubleshooting
  • Performance
    • Weka performance tests
      • Test environment details
  • WekaFS Filesystems & Object Stores
    • Manage object stores
      • Manage object stores using the GUI
      • Manage object stores using the CLI
    • Manage filesystem groups
      • Manage filesystem groups using the GUI
      • Manage filesystem groups using the CLI
    • Manage filesystems
      • Manage filesystems using the GUI
      • Manage filesystems using the CLI
    • Attach or detach object store buckets
      • Attach or detach object store bucket using the GUI
      • Attach or detach object store buckets using the CLI
    • Advanced data lifecycle management
      • Advanced time-based policies for data storage location
      • Data management in tiered filesystems
      • Transition between tiered and SSD-only filesystems
      • Manual fetch and release of data
    • Mount filesystems
    • Snapshots
      • Manage snapshots using the GUI
      • Manage snapshots using the CLI
    • Snap-To-Object
      • Manage Snap-To-Object using the GUI
      • Manage Snap-To-Object using the CLI
    • Quota management
  • Additional Protocols
    • NFS
      • Manage NFS networking using the GUI
      • Manage NFS networking using the CLI
    • SMB
      • Manage SMB using the GUI
      • Manage SMB using the CLI
    • S3
      • S3 cluster management
        • Manage the S3 service using the GUI
        • Manage the S3 service using the CLI
      • S3 buckets management
        • Manage S3 buckets using the GUI
        • Manage S3 buckets using the CLI
      • S3 users and authentication
        • Manage S3 users and authentication using the CLI
        • Manage S3 service accounts using the CLI
      • S3 rules information lifecycle management (ILM)
        • Manage S3 rules using the CLI
      • Audit S3 APIs
        • Configure audit webhook using the GUI
        • Configure audit webhook using the CLI
        • Example: How to use Splunk to audit S3
      • S3 supported APIs and limitations
      • S3 examples using boto3
  • Operation Guide
    • Alerts
      • Manage alerts using the GUI
      • Manage alerts using the CLI
      • List of alerts and corrective actions
    • Events
      • Manage events using the GUI
      • Manage events using the CLI
      • List of events
    • Statistics
      • Manage statistics using the GUI
      • Manage statistics using the CLI
      • List of statistics
    • System congestion
    • Security management
      • Obtain authentication tokens
      • KMS management
        • Manage KMS using the GUI
        • Manage KMS using the CLI
      • TLS certificate management
        • Manage the TLS certificate using the GUI
        • Manage the TLS certificate using the CLI
      • CA certificate management
        • Manage the CA certificate using the GUI
        • Manage the CA certificate using the CLI
      • Account lockout threshold policy management
        • Manage the account lockout threshold policy using GUI
        • Manage the account lockout threshold policy using CLI
      • Manage the login banner
        • Manage the login banner using the GUI
        • Manage the login banner using the CLI
    • User management
      • Manage users using the GUI
      • Manage users using the CLI
    • Organizations management
      • Manage organizations using the GUI
      • Manage organizations using the CLI
      • Mount authentication for organization filesystems
    • Expand and shrink cluster resources
      • Expand and shrink overview
      • Workflow: Add a backend host
      • Expansion of specific resources
      • Shrink a Cluster
    • Background tasks
    • Upgrade Weka versions
  • Billing & Licensing
    • License overview
    • Classic license
    • Pay-As-You-Go license
  • Support
    • Prerequisites and compatibility
    • Get support for your Weka system
    • Diagnostics management
      • Traces management
        • Manage traces using the GUI
        • Manage traces using the CLI
      • Protocols debug level management
        • Manage protocols debug level using the GUI
        • Manage protocols debug level using the CLI
      • Collect and upload diagnostics data
    • Weka Home - The Weka support cloud
      • Local Weka Home overview
      • Local Weka Home deployment
      • Set the Local Weka Home to send alerts or events
      • Download the Usage Report or Analytics
  • Appendix
    • Weka CSI Plugin
    • Set up the Weka-mon external monitoring
    • Set up the SnapTool external snapshots manager
  • REST API Reference Guide
Powered by GitBook
On this page
  • View object stores
  • Edit an object store
  • View object store buckets
  • Add an object store bucket
  • Edit an object store bucket
  • Delete an object store bucket
  1. WekaFS Filesystems & Object Stores
  2. Manage object stores

Manage object stores using the CLI

This page describes how to view and manage object stores using the CLI.

PreviousManage object stores using the GUINextManage filesystem groups

Last updated 2 years ago

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

No

site

String

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

local or remote

No

hostname

String

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

Must be a valid name/IP

No

port

String

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

Must be a valid name

No

auth-method

String

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

None, AWSSignature2 or AWSSignature4

No

region

String

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

No

access-key-id

String

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

No

secret-key

String

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

No

protocol

String

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

HTTP, HTTPS or HTTPS_UNVERIFIED

No

bandwidth

Number

Bandwidth limitation per core (Mbps)

No

download-bandwidth

Number

Object-store download bandwidth limitation per core (Mbps)

No

upload-bandwidth

Number

Object-store upload bandwidth limitation per core (Mbps)

No

max-concurrent-downloads

Number

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

1-64

No

max-concurrent-uploads

Number

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

1-64

No

max-concurrent-removals

Number

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

1-64

No

enable-upload-tags

String

true or false

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

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

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

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

No

300

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

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

No

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.

No

hostname

String

Object store host identifier

Must be a valid name/IP

No

port

String

Object store port

Must be a valid name

No

bucket

String

Object store bucket name

Must be a valid name

No

auth-method

String

Authentication method

None, AWSSignature2 or AWSSignature4

No

region

String

Region name

No

access-key-id

String

Object-store bucket access key ID

No

secret-key

String

Object-store bucket secret key

No

protocol

String

Protocol type to be used

HTTP, HTTPS or HTTPS_UNVERIFIED

No

bandwidth

Number

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

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

No

prefetch-mib

Number

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

No

enable-upload-tags

String

true or false

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

name

String

Name of the object-store bucket being deleted

Must be a valid name

Yes

​

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

Whether to enable or not

Whether to enable or not

View object stores
Add an object store
View object store buckets
Add an object store bucket
Edit an object store bucket
Delete an object store bucket
object-tagging
object-tagging
object-tagging