Manage the S3 service using the CLI

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

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> <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-id container-id]... [--all-servers]

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

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

Note: 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 containers add

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

weka s3 cluster containers add <container-ids>

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

weka s3 cluster containers add 8 9

Parameters

Remove containers from the S3 cluster

Command: weka s3 cluster containers remove

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

weka s3 cluster containers remove <container-ids>

Parameters

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 removes the S3 service and configuration, such as IAM policies, buckets, and ILM rules. S3 access is no longer available for clients. Data within the buckets is not deleted. Internal users with S3 roles are deleted from the system.

Last updated