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
    • Cluster capacity and redundancy 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
      • 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
      • Events list
    • Statistics
      • Manage statistics using the GUI
      • Manage statistics using the CLI
      • Statistics list
    • 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
  • Drivers distribution service
  • 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
      • Deploy the WEKA client on Amazon EKS
    • 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
  • Add an S3 cluster
  • Check the status of the S3 cluster readiness
  • List the S3 cluster containers
  • Update an S3 cluster configuration
  • Add containers to the S3 cluster
  • Remove containers from the S3 cluster
  • Remove an S3 cluster
  1. Additional Protocols
  2. Manage the S3 protocol
  3. S3 cluster management

Manage the S3 service using the CLI

This page describes how to set up, update, monitor, and delete an S3 cluster using the GUI.

PreviousManage the S3 service using the GUINextS3 buckets management

Last updated 2 months ago

Using the CLI, you can:

Add an S3 cluster

Command: weka s3 cluster add

Use the following command line to add an S3 cluster:

weka s3 cluster add <default-fs-name> <config-fs-name> [--port port] [--key key] [--secret secret] [--max-buckets-limit max-buckets-limit] [--anonymous-posix-uid anonymous-posix-uid] [--anonymous-posix-gid anonymous-posix-gid] [--domain domain] [--container container]... [--all-servers]

Parameters

Name
Value
Default

default-fs-name*

The filesystem name to be used for the S3 service.

config-fs-name*

port

The port where the S3 service is exposed. Do not set port 9001.

9000

key

The object store bucket access key ID.

secret

The object store bucket secret key.

max-buckets-limit

The maximum number of buckets that can be created. Maximum value: 10000.

anonymous-posix-uid

POSIX UID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).

65534

anonymous-posix-gid

POSIX GID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).

65534

domain

Virtual hosted-style comma-separated domains.

Maximum characters for a domain: 64.

Maximum characters for a list: 1024.

Example: --domain sub1.domain-name.com,sub2.domain-name.com. To remove the existing domain, set "". Example: --domain ""

container*

Container IDs with a frontend process to serve the S3 service. To ensure redundancy and fault tolerance, a minimum of two containers is required for the S3 cluster. However, it is possible to create a single-container S3 cluster, which means there will be no redundancy. If you add all-servers to the command, do not specify the list of containers in the container parameter.

all-servers*

Use all backend servers to serve S3 commands. If you add all-servers to the command, do not specify the list of containers in the container parameter.

None

Check the status of the S3 cluster readiness

Command: weka s3 cluster or weka s3 cluster status

The S3 cluster is comprised of a few S3 containers. Use this command to check the status of the S3 containers that are part of the S3 cluster. Once all the S3 containers are prepared and ready, it is possible to use the S3 service.

List the S3 cluster containers

Command: weka s3 cluster container list

Use this command to list the containers that serve the S3 cluster.

Update an S3 cluster configuration

Command: weka s3 cluster update

Use the following command line to update an S3 cluster configuration:

weka s3 cluster update [--key key] [--secret secret] [--port port] [--anonymous-posix-uid anonymous-posix-uid] [--anonymous-posix-gid anonymous-posix-gid] [--domain domain] [--container container]... [--all-servers]

Parameters

Name
Value
Default

key

The object store bucket access key ID.

secret

The object store bucket secret key.

port

The port where the S3 service is exposed. Do not set port 9001.

anonymous-posix-uid

POSIX UID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).

65534

anonymous-posix-gid

POSIX GID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).

65534

domain

Virtual-hosted-style comma-separated domains. Maximum number of characters: 1024.

Example: --domain sub1.domain-name.com,sub3.domain-name.com.

To remove the existing domain, set "". Example: --domain ""

Note: Modifying the domain parameter value automatically triggers a restart of all S3 containers, resulting in I/O disruption.

container*

Container IDs associated with a frontend process responsible for serving the S3 service.

For redundancy and fault tolerance, a minimum of two containers is necessary for the S3 cluster. Nevertheless, it is possible to create a single-container S3 cluster, which means there will be no redundancy.

If you include all-servers in the command, do not specify a list of containers in the container parameter.

all-servers*

Use all backend servers to serve S3 commands. If you add all-servers to the command, do not specify the list of containers in the container parameter.

None

Instead of using the weka s3 cluster update command for adding or removing containers, use the commands weka s3 cluster containers add or weka s3 cluster containers remove. It is more convenient when managing an S3 cluster with many containers.

Add containers to the S3 cluster

Command: weka s3 cluster container add

Use the following command line to add containers to the S3 cluster:

weka s3 cluster container add <container-ids>

The following command example adds two containers with the IDs 8 and 9:

weka s3 cluster container add 8 9

Parameters

Name
Value

container-ids*

Container IDs to add to the S3 cluster. Space-separated list of numbers.

Remove containers from the S3 cluster

Command: weka s3 cluster container remove

Use the following command line to remove containers from the S3 cluster:

weka s3 cluster container remove <container-ids>

Parameters

Name
Value

container-ids*

Container IDs to remove from the S3 cluster. Space-separated list of numbers

Remove an S3 cluster

Command: weka s3 cluster remove

Use this command to remove an S3 cluster managed by the WEKA system.

Removing an existing S3 cluster removes the S3 service and configuration, such as IAM policies, buckets, and ILM rules. S3 access is no longer available for clients. Data that resides within the buckets is not deleted. Internal users with S3 roles are deleted from the system.

The predefined filesystem name for maintaining the persisting cluster-wide protocols' configurations. Verify that the filesystem is already created. If not, create it. For details, see

As set when .

As set when .

As set when .

As set when .

Add an S3 cluster
Check the status of the S3 cluster readiness
List the S3 cluster containers
Update an S3 cluster configuration
Add containers to the S3 cluster
Remove containers from the S3 cluster
Remove an S3 cluster
adding an object store bucket
adding an object store bucket
adding an object store bucket
adding an object store bucket
#dedicated-filesystem-requirement-for-persistent-protocol-configurations