W E K A
4.4
4.4
  • WEKA v4.4 documentation
    • Documentation revision history
  • WEKA System Overview
    • Introduction
      • WEKA system functionality features
      • Converged WEKA system deployment
      • Optimize redundancy in WEKA deployments
    • SSD capacity management
    • Filesystems, object stores, and filesystem groups
    • WEKA networking
    • Data lifecycle management
    • WEKA client and mount modes
    • WEKA containers architecture overview
    • Glossary
  • Planning and Installation
    • Prerequisites and compatibility
    • WEKA cluster installation on bare metal servers
      • Plan the WEKA system hardware requirements
      • Obtain the WEKA installation packages
      • Install the WEKA cluster using the WMS with WSA
      • Install the WEKA cluster using the WSA
      • Manually install OS and WEKA on servers
      • Manually prepare the system for WEKA configuration
        • Broadcom adapter setup for WEKA system
        • Enable the SR-IOV
      • Configure the WEKA cluster using the WEKA Configurator
      • Manually configure the WEKA cluster using the resources generator
        • VLAN tagging in the WEKA system
      • Perform post-configuration procedures
      • Add clients to an on-premises WEKA cluster
    • WEKA Cloud Deployment Manager Web (CDM Web) User Guide
    • WEKA Cloud Deployment Manager Local (CDM Local) User Guide
    • WEKA installation on AWS
      • WEKA installation on AWS using Terraform
        • Terraform-AWS-WEKA module description
        • Deployment on AWS using Terraform
        • Required services and supported regions
        • Supported EC2 instance types using Terraform
        • WEKA cluster auto-scaling in AWS
        • Detailed deployment tutorial: WEKA on AWS using Terraform
      • WEKA installation on AWS using the Cloud Formation
        • Self-service portal
        • CloudFormation template generator
        • Deployment types
        • AWS Outposts deployment
        • Supported EC2 instance types using Cloud Formation
        • Add clients to a WEKA cluster on AWS
        • Auto scaling group
        • Troubleshooting
    • WEKA installation on Azure
      • Azure-WEKA deployment Terraform package description
      • Deployment on Azure using Terraform
      • Required services and supported regions
      • Supported virtual machine types
      • Auto-scale virtual machines in Azure
      • Add clients to a WEKA cluster on Azure
      • Troubleshooting
      • Detailed deployment tutorial: WEKA on Azure using Terraform
    • WEKA installation on GCP
      • WEKA project description
      • GCP-WEKA deployment Terraform package description
      • Deployment on GCP using Terraform
      • Required services and supported regions
      • Supported machine types and storage
      • Auto-scale instances in GCP
      • Add clients to a WEKA cluster on GCP
      • Troubleshooting
      • Detailed deployment tutorial: WEKA on GCP using Terraform
      • Google Kubernetes Engine and WEKA over POSIX deployment
    • WEKA installation on OCI
  • Getting Started with WEKA
    • Manage the system using the WEKA GUI
    • Manage the system using the WEKA CLI
      • WEKA CLI hierarchy
      • CLI reference guide
    • Run first IOs with WEKA filesystem
    • Getting started with WEKA REST API
    • WEKA REST API and equivalent CLI commands
  • Performance
    • WEKA performance tests
      • Test environment details
  • WEKA 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
      • Mount filesystems from Single Client to Multiple Clusters (SCMC)
      • Manage authentication across multiple clusters with connection profiles
    • 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
    • Snapshot policies
      • Manage snapshot policies using the GUI
      • Manage snapshot policies using the CLI
    • Quota management
      • Manage quotas using the GUI
      • Manage quotas using the CLI
  • Additional Protocols
    • Additional protocol containers
    • Manage the NFS protocol
      • Supported NFS client mount parameters
      • Manage NFS networking using the GUI
      • Manage NFS networking using the CLI
    • Manage the S3 protocol
      • 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 lifecycle rules management
        • Manage S3 lifecycle rules using the GUI
        • Manage S3 lifecycle 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
        • Example: How to use S3 audit events for tracking and security
      • S3 supported APIs and limitations
      • S3 examples using boto3
      • Configure and use AWS CLI with WEKA S3 storage
    • Manage the SMB protocol
      • Manage SMB using the GUI
      • Manage SMB using the CLI
  • Security
    • WEKA security overview
    • Obtain authentication tokens
    • Manage token expiration
    • Manage account lockout threshold policy
    • Manage KMS
      • Manage KMS using GUI
      • Manage KMS using CLI
    • Manage TLS certificates
      • Manage TLS certificates using GUI
      • Manage TLS certificates using CLI
    • Manage Cross-Origin Resource Sharing
    • Manage CIDR-based security policies
    • Manage login banner
  • Secure cluster membership with join secret authentication
  • Licensing
    • License overview
    • Classic license
  • 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
    • Insights
    • System congestion
    • 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
      • Add a backend server
      • Expand specific resources of a container
      • Shrink a cluster
    • Background tasks
      • Set up a Data Services container for background tasks
      • Manage background tasks using the GUI
      • Manage background tasks using the CLI
    • Upgrade WEKA versions
    • Manage WEKA drivers
  • Monitor the WEKA Cluster
    • Deploy monitoring tools using the WEKA Management Station (WMS)
    • WEKA Home - The WEKA support cloud
      • Local WEKA Home overview
      • Deploy Local WEKA Home v3.0 or higher
      • Deploy Local WEKA Home v2.x
      • Explore cluster insights
      • Explore performance statistics in Grafana
      • Manage alerts and integrations
      • Enforce security and compliance
      • Optimize support and data management
      • Export cluster metrics to Prometheus
    • Set up WEKAmon for external monitoring
    • Set up the SnapTool external snapshots manager
  • Kubernetes
    • Composable clusters for multi-tenancy in Kubernetes
    • WEKA Operator deployment
    • WEKA Operator day-2 operations
  • WEKApod
    • WEKApod Data Platform Appliance overview
    • WEKApod servers overview
    • Rack installation
    • WEKApod initial system setup and configuration
    • WEKApod support process
  • AWS Solutions
    • Amazon SageMaker HyperPod and WEKA Integrations
      • Deploy a new Amazon SageMaker HyperPod cluster with WEKA
      • Add WEKA to an existing Amazon SageMaker HyperPod cluster
    • AWS ParallelCluster and WEKA Integration
  • Azure Solutions
    • Azure CycleCloud for SLURM and WEKA Integration
  • Best Practice Guides
    • WEKA and Slurm integration
      • Avoid conflicting CPU allocations
    • Storage expansion best practice
  • Support
    • 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
      • Diagnostics data management
  • Appendices
    • WEKA CSI Plugin
      • Deployment
      • Storage class configurations
      • Tailor your storage class configuration with mount options
      • Dynamic and static provisioning
      • Launch an application using WEKA as the POD's storage
      • Add SELinux support
      • NFS transport failback
      • Upgrade legacy persistent volumes for capacity enforcement
      • Troubleshooting
    • Convert cluster to multi-container backend
    • Create a client image
    • Update WMS and WSA
    • BIOS tool
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
  • List recent operations of an object store bucket
  • Delete an object store bucket
  1. WEKA 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 1 month ago

Using the CLI, you can perform the following actions:

View object stores

Command: weka fs tier obs

Use this command to view information on all the object stores configured to the WEKA system.

Using the GUI, only object store buckets are present. Adding an object store bucket only adds to the present local or remote object store. If more than one is present (such as during the time recovering from a remote snapshot), use the CLI.

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>] [--remove-bandwidth=<remove-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

Parameter
Description

name *

Name of the object store to create.

new-name

New name for the object store.

site

Site location of the object store. Possible values: local - for tiering+snapshots remote - for snapshots only

hostname

Object store host identifier (hostname or IP address) to use as a default for added buckets.

port

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

auth-method

Authentication method to use as a default for added buckets. Possible values: None,AWSSignature2,AWSSignature4

region

Region name to use as a default for added buckets.

access-key-id

Object store access key ID to use as a default for added buckets.

secret-key

Object store secret key to use as a default for added buckets.

protocol

Protocol type to use as a default for added buckets. Possible values: HTTP,HTTPS,HTTPS_UNVERIFIED

bandwidth

Bandwidth limitation per core (Mbps).

download-bandwidth

Object store download bandwidth limitation per core (Mbps).

upload-bandwidth

Object store upload bandwidth limitation per core (Mbps).

remove-bandwidth

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.

max-concurrent-downloads

Maximum number of downloads concurrently performed on this object store in a single IO node. Possible values: 1-64

max-concurrent-uploads

Maximum number of uploads concurrently performed on this object store in a single IO node. Possible values: 1-64

max-concurrent-removals

Maximum number of removals concurrently performed on this object store in a single IO node. Possible values: 1-64

enable-upload-tags

View object store buckets

Command: weka fs tier s3

Use this command 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 S3 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>] [--max-concurrent-downloads=<max-concurrent-downloads>] [--max-concurrent-uploads=<max-concurrent-uploads>] [--max-concurrent-removals=<max-concurrent-removals>] [--max-extents-in-data-blob=<max-extents-in-data-blob>] [--max-data-blob-size=<max-data-blob-size>] [--enable-upload-tags enable-upload-tags] [--data-storage-class data-storage-class] [--metadata-storage-class metadata-storage-class][--sts-operation-type=<sts-operation-type>] [--sts-role-arn=<sts-role-arn>] [--sts-role-session-name=<sts-role-session-name>] [--sts-session-duration=<sts-session-duration>]

Parameters

Name
Description
Default

name*

Name of the object store to edit.

​

site

local - for tiering+snapshots, remote - for snapshots only. It must be the same as the object store site it is added to (obs-name).

local

obs-name

Name of the existing object store to add this object store bucket to.

If there is only one object store of type mentioned in site it is chosen automatically

hostname *

Object store host identifier or IP. Mandatory, if not specified at the object store level.

The hostname specified in obs-name if present

port

A valid object store port.

The port specified in obs-name if present, otherwise 80

bucket

A valid object store bucket name.

auth-method *

Authentication method. Possible values: None, AWSSignature2, AWSSignature4. Mandatory, if not specified in the object store level .

The auth-method specified in obs-name if present

region *

Region name. Mandatory, if not specified in the object store level .

The region specified in obs-name if present

access-key-id *

Object store bucket access key ID. Mandatory, if not specified in the object store level (can be left empty when using IAM role in AWS or GCP).

The access-key-id specified in obs-name if present

secret-key *

Object store bucket secret key. Mandatory, if not specified in the object store level (can be left empty when using IAM role in AWS or GCP).

The secret-key specified in obs-name if present

protocol

Protocol type to be used. Possible values: HTTP, HTTPS or HTTPS_UNVERIFIED.

The protocol specified in obs-name if present, otherwiseHTTP

bandwidth

Bucket bandwidth limitation per core (Mbps).

download-bandwidth

Bucket download bandwidth limitation per core (Mbps)

upload-bandwidth

Bucket upload bandwidth limitation per core (Mbps)

remove-bandwidth

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.

errors-timeout

If the object store link is down longer than this timeout period, all IOs that need data return an error. Possible values: 1m-15m, or 60s-900s. For example, 300s.

300s

prefetch-mib

The data size (MiB) to prefetch when reading a whole MiB on the object store.

128

enable-upload-tags

false

max-concurrent-downloads

Maximum number of downloads we concurrently perform on this object store in a single IO node.

Possible values: 1-64

max-concurrent-uploads

Maximum number of uploads we concurrently perform on this object store in a single IO node.

Possible values: 1-64

max-concurrent-removals

Maximum number of removals we concurrently perform on this object store in a single IO node.

Possible values: 1-64

max-extents-in-data-blob

Maximum number of extents' data to upload to an object store data blob.

max-data-blob-size

Maximum size to upload to an object store data blob.

Format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB.

enable-upload-tags

data-storage-class

AWS

Configurable Amazon S3 storage classes, allowing users to optimize storage based on cost and access needs. Supports STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, OUTPOSTS, GLACIER_IR, and EXPRESS_ONEZONE. For details, see the documentation for Amazon S3 Storage Classes. Azure Configurable Azure access storage tier, allowing users to optimize storage based on cost and access needs. Supports HOT, COOL, and COLD. For details, see the documentation for Azure Access tiers for blob data.

metadata-storage-class

AWS Configurable storage classes for the metadata on AWS. Azure Configurable Azure access storage tier for metadata. Supports HOT, COOL, and COLD.

sts-operation-type

AWS operation type to use.

Possible values: assume_role or none

none

sts-role-arn

The Amazon Resource Name (ARN) of the role to assume. Mandatory when setting sts-operation to assume_role.

sts-role-session

A unique identifier for the assumed role session. The length must be between 2 and 64 characters. Allowed characters include alphanumeric characters (upper and lower case), underscore (_), equal sign (=), comma (,), period (.), at symbol (@), and hyphen (-). Space is not allowed.

sts-session-duration

The duration of the temporary security credentials in seconds.

Possible values: 900 - 43200.

3600

When using the CLI, by default a misconfigured object store are not created. To create an object store even when it is misconfigured, use the --skip-verification option.

The max-concurrent settings are applied per WEKA compute process and the minimum setting of all object stores is applied.

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.

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>] [--remove-bandwidth=<remove-bandwidth>] [--errors-timeout=<errors-timeout>] [--prefetch-mib=<prefetch-mib>] [--enable-upload-tags=<enable-upload-tags>] [--max-concurrent-downloads=<max-concurrent-downloads>] [--max-concurrent-uploads=<max-concurrent-uploads>] [--max-concurrent-removals=<max-concurrent-removals>] [--max-extents-in-data-blob=<max-extents-in-data-blob>] [--max-data-blob-size=<max-data-blob-size>] [--sts-operation-type=<sts-operation-type>] [--sts-role-arn=<sts-role-arn>] [--sts-role-session-name=<sts-role-session-name>] [--sts-session-duration=<sts-session-duration>]

Parameters

Name
Value

name*

A valid name of the object store bucket to edit.

new-name

New name for the object store bucket

new-obs-name

A new object store name to add this object store bucket to. It must be an existing object store with the same site value.

hostname

Object store host identifier or IP.

port

A valid object store port

bucket

A valid object store bucket name

auth-method

Authentication method. Possible values: None, AWSSignature2 or AWSSignature4

region

Region name

access-key-id

Object store bucket access key ID

secret-key

Object store bucket secret key

protocol

Protocol type to be used. Possible values: HTTP, HTTPS or HTTPS_UNVERIFIED

bandwidth

Bandwidth limitation per core (Mbps)

download-bandwidth

Bucket download bandwidth limitation per core (Mbps)

upload-bandwidth

Bucket upload bandwidth limitation per core (Mbps)

remove-bandwidth

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.

errors-timeout

If the object store link is down longer than this timeout period, all IOs that need data return an error. Possible values: 1m-15m, or 60s-900s. For example, 300s.

prefetch-mib

The data size in MiB to prefetch when reading a whole MiB on the object store

enable-upload-tags

max-concurrent-downloads

Maximum number of downloads we concurrently perform on this object store in a single IO node.

Possible values: 1-64

max-concurrent-uploads

Maximum number of uploads we concurrently perform on this object store in a single IO node.

Possible values: 1-64

max-concurrent-removals

Maximum number of removals we concurrently perform on this object store in a single IO node.

Possible values: 1-64

max-extents-in-data-blob

Maximum number of extents' data to upload to an object store data blob.

max-data-blob-size

Maximum size to upload to an object store data blob.

Format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB.

sts-operation-type

AWS operation type to use.

Possible values: assume_role or none

sts-role-arn

The Amazon Resource Name (ARN) of the role to assume. Mandatory when setting sts-operation to assume_role.

sts-role-session

A unique identifier for the assumed role session. The length must be between 2 and 64 characters. Allowed characters include alphanumeric characters (upper and lower case), underscore (_), equal sign (=), comma (,), period (.), at symbol (@), and hyphen (-). Space is not allowed.

sts-session-duration

The duration of the temporary security credentials in seconds.

Possible values: 900 - 43200.

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

name*

A valid object store bucket name to show its recent operations.

​

format

Specify the output format. Possible values: view, csv, markdown, json, or oldview

view

output

Specify the columns in the output. Possible values: node, obsBucket, key, type, execution, phase, previous, start, size, results, errors, lastHTTP, concurrency, inode

All columns

sort

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

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

raw-units

Print values in a readable format of raw units such as bytes and seconds. Possible value examples: 1KiB 234MiB 2GiB.

no-header

Don't show column headers in the output,

verbose

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
Value

name*

A valid name of the object store bucket to delete.

Determines whether to enable or not. To use as a default for added buckets. Possible values: true,false

Whether to enable or not. Possible values: true or false

Enable tagging of uploaded objects. For details, see .

Whether to enable or not. Possible values: true, false

View object stores
Edit an object store
Add an object store
View object store buckets
Add an object store bucket
Edit an object store bucket
List recent operations of an object store bucket
Delete an object store bucket
object-tagging
object-tagging
object-tagging
object-tagging