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

• 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

• Delete an S3 cluster

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

Parameters

Name	Value	Default
default-fs-name*	The filesystem name to be used for the S3 service.
config-fs-name*	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 #dedicated-filesystem-requirement-for-persistent-protocol-configurations
port	The port where the S3 service is exposed. Do not set port 9001.	9000
key	The object store bucket access key ID.	As set when adding an object store bucket.
secret	The object store bucket secret key.	As set when adding an object store bucket.
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 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

Name	Value	Default
key	The object store bucket access key ID.	As set when adding an object store bucket.
secret	The object store bucket secret key.	As set when adding an object store bucket.
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 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

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

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

weka s3 cluster containers remove <container-ids>

Parameters

Name	Value
container-ids*	Container IDs to remove from the S3 cluster. Space-separated list of numbers

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 that resides within the buckets is not deleted. Internal users with S3 roles are deleted from the system.