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
  • Create an S3 cluster
  • Check the status of the S3 cluster and hosts readiness
  • List the S3 cluster hosts
  • Update an S3 cluster configuration
  • Add hosts to the S3 cluster
  • Remove hosts from the S3 cluster
  • Delete an S3 cluster
  1. Additional Protocols
  2. S3
  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 years ago

Using the CLI, you can:

Create an S3 cluster

Command: weka s3 cluster create

Use the following command line to create an S3 cluster:

weka s3 cluster create <default-fs-name> [--all-hosts] [--host hosts] [--port port] [--anonymous-posix-uid uid] [--anonymous-posix-gid gid] [--config-fs-name config-fs-name]

Note: As a best practice, it is recommended to have only one of the following protocol containers, NFS, SMB, or S3, installed on the same server. Starting from version 4.2, setting more than one additional protocol to the existing POSIX is not allowed.

Parameters

Name

Type

Value

Limitations

Mandatory

Default

filesystem

String

The filesystem name to be used for the S3 service.

None

Yes

all-hosts

Boolean

Use all backend hosts to serve S3 commands.

None

Either host list or all-hosts must be provided

Off

host

Comma-separated list of Numbers

Host IDs to serve the S3 service.

Minimum of 3 hosts must be supplied.

Either host list or all-hosts must be provided

port

Number

The port where the S3 service is exposed.

Do not set port 9001.

No

9000

anonymous-posix-uid

Number

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

None

No

65534

anonymous-posix-gid

Number

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

None

No

65534

config-fs-name

String

S3 config filesystem name.

S3 supports config filesystem for persisting S3 cluster-wide configuration

No

If not supplied it defaults to the value provided in filesystem

Check the status of the S3 cluster and hosts readiness

Command: weka s3 cluster or weka s3 cluster status

Use these commands to check the status and configuration of the S3 cluster. Once all hosts are prepared and ready, it is possible to use the S3 service.

List the S3 cluster hosts

Command: weka s3 cluster hosts list

Use this command to list the hosts 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 [--all-hosts] [--host hosts] [--port port] [--anonymous-posix-uid uid] [--anonymous-posix-gid gid] [--config-fs-name config-fs-name]

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

Parameters

Name

Type

Value

Limitations

Mandatory

Default

all-hosts

Boolean

Use all backend hosts to serve S3 commands.

None

No

host

Comma-separated list of numbers

Host IDs to serve the S3 service.

Minimum of 3 hosts

No

port

Number

The port where the S3 service is exposed.

None

No

anonymous-posix-uid

Number

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

None

No

anonymous-posix-gid

Number

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

None

No

config-fs-name

String

S3 config filesystem name.

S3 supports config filesystem for persisting S3 cluster-wide configuration

Add hosts to the S3 cluster

Command: weka s3 cluster hosts add

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

weka s3 cluster hosts add <hosts>

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

weka s3 cluster hosts add 8 9

Parameters

Name

Type

Value

Limitations

Mandatory

Default

hosts

Space-separated list of numbers

Host IDs to add to the S3 cluster.

Yes

Remove hosts from the S3 cluster

Command: weka s3 cluster hosts remove

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

weka s3 cluster hosts remove <hosts>

Parameters

Name

Type

Value

Limitations

Mandatory

Default

hosts

Space-separated list of numbers

Host IDs to remove from the S3 cluster.

Yes

Delete an S3 cluster

Command: weka s3 cluster destroy

Use this command to destroy an S3 cluster managed by the Weka system.

Deleting an existing S3 cluster managed by the Weka system does not delete the backend Weka filesystem but removes the S3 bucket exposures of these filesystems.

Create an S3 cluster
Check the status of the S3 cluster and hosts readiness
List the S3 cluster hosts
Update an S3 cluster configuration
Add hosts to the S3 cluster
Remove hosts from the S3 cluster
Delete an S3 cluster