Skip to content
dchev edited this page May 23, 2019 · 9 revisions

Welcome to the bucket-wipe wiki!

What is bucket-wipe?

bucket-wipe is a tool designed to enumerate a bucket and delete all of its contents in parallel threads. This tools can also be used to delete all directories and files hierarchically in an Atmos namespace.(1)*

Why use bucket-wipe?

S3 buckets cannot be deleted as long as they have objects in them. This tool allows a user to delete a non-empty bucket by programmatically deleting all objects in the specified bucket before deleting the bucket itself. If desired, the bucket can instead be kept, allowing the user to simply empty a bucket quickly and easily.
For Atmos this tool allows a user to delete a non-empty directory by programmatically deleting all files and sub-directories in the specified directory before deleting the directory itself. If desired, the directory can instead be kept, allowing the user to simply empty a directory quickly and easily.(1)*

What it Does?

This tool permanently deletes all data from the bucket and, by default, the bucket itself. However, a bucket can be kept after emptied with the --keep-bucket option. Please note: data cannot be recovered after deletion.
For Atmos users this tool deletes all data from the directory and all sub-directories and, by default, the directory itself. However, a directory can be kept after emptied with the --keep-bucket option. Please note: data cannot be recovered after deletion.(1)*

Examples of Use

  1. Delete all objects in a bucket, but keep the empty bucket. In this example there is an external load balancer in place, therefore the -no-smart-client option is used.
java -jar bucket-wipe-1.10.jar -e <end-point> -a <access-key> -s <secret-key> --no-smart-client --keep-bucket <bucket-name>
  1. Delete all objects in a bucket, then delete the bucket. In this example there is no external load balancer, so we keep do not deactivate the smart-client.
java -jar bucket-wipe-1.10.jar -e <end-point> -a <access-key> -s <secret-key> <bucket-name>
  1. Delete all files and directories in an Atmos namespace, then delete the directory. In this example there is no external load balancer, so we keep do not deactivate the smart-client.(1)*
java -jar bucket-wipe-1.10.jar --atmos -e <end-point> -a <atmos uid> -s <secret-key> -p <atmos-namespace-path>
  1. Delete all files and directories in an Atmos namespace, but keep the empty directory. In this example there is an external load balancer in place, therefore the -no-smart-client option is used.(1)*
java -jar bucket-wipe-1.10.jar --atmos -e <end-point> -a <atmos uid> -s <secret-key> --no-smart-client --keep-bucket -p <atmos-namespace-path>

(1)* Applicable only when bucket-wipe version with Atmos support is used.

Clone this wiki locally