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> [--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 |
| String | The filesystem name to be used for the S3 service. | None | Yes | |
| Boolean | Use all backend hosts to serve S3 commands. | None | Either | Off |
| Comma-separated list of Numbers | Host IDs to serve the S3 service. | Minimum of 3 hosts must be supplied. | Either | |
| Number | The port where the S3 service is exposed. | Do not set port 9001. | No | 9000 |
| Number | POSIX UID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that). | None | No | 65534 |
| Number | POSIX GID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that). | None | No | 65534 |
| 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 |
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 |
| Boolean | Use all backend hosts to serve S3 commands. | None | No | |
| Comma-separated list of numbers | Host IDs to serve the S3 service. | Minimum of 3 hosts | No | |
| Number | The port where the S3 service is exposed. | None | No | |
| Number | POSIX UID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that). | None | No | |
| Number | POSIX GID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that). | None | No | |
| 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 |
| 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 |
| 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.
Last updated