S3Clients

From UMIACS
Revision as of 20:39, 10 October 2024 by Ekr597 (talk | contribs)
Jump to navigation Jump to search

Many popular S3 desktop clients can be used to access the UMIACS Object Store. These tools complement the UMobj command line utilities and the built-in web interface by providing integration with the native file explorer on your desktop machine.

Note: Many of these clients have features that are not supported by our Object Store in UMIACS. One prominent example of this is permissions. We suggest you instead manage permissions from the built-in web application for the Object Store.

Graphical Clients

Cyberduck

https://cyberduck.io/

This is a free Windows and Mac S3 browser (it is however nagware that asks for a donation). It supports our S3 Object Store using the "S3 (Amazon Simple Storage Service)" drop down menu choice in the add bookmark dialog.

Cyberduck.png

The following fields are required:

  • Server - This is your object store (obj.umiacs.umd.edu)
  • Access Key ID - This is your access key as provided to you in the object store
  • Password - This is your secret key as provided to you in the object store

You will be prompted for your secret key when you connect and may choose to save the password.

WinSCP

This is a free Windows file transfer application. It supports our S3 Object Store using the "Amazon S3" drop down menu choice under File protocol when logging in.

WinSCPS3.png

The following fields are required:

  • Host name - This is your object store (obj.umiacs.umd.edu)
  • Access key ID - This is your access key as provided to you in the object store
  • Secret access key - This is your secret key as provided to you in the object store

Transmit

This is a paid file transfer application for Mac. It supports our S3 Object Store using the "S3" menu choice after clicking the plus sign to add a favorite.

Transmit.png

The following fields are required:

  • Server - This is your object store (obj.umiacs.umd.edu)
  • Access Key ID - This is your access key as provided to you in the object store
  • Secret - This is your secret key as provided to you in the object store

These settings can be saved as a favorite for easy access. Transmit also allows you to mount your Obj buckets as local disks, which will support easy drag-and-drop of files.

Command Line Clients

s3cmd

Command line client for accessing S3-like services.

You need to configure a file like ~/.s3cfg that looks like the following with your ACCESS_KEY and SECRET_KEY substituted.

[default]
access_key = <ACCESS_KEY>
host_base = obj.umiacs.umd.edu
host_bucket = %(bucket)s.obj.umiacs.umd.edu
secret_key = <SECRET_KEY>
use_https = True

mc

The MinIO Client is a comprehensive single binary (Go) command line client for cloud based storage services.

You can run this client on supported UMIACS systems through adding it via our software module.

module add mc

You will need to setup a cloud provider for Obj by running the following command (substituting in your actual ACCESS_KEY and SECRET_KEY for your personal account or LabGroup in the Object Store).

mc config host add obj http://obj.umiacs.umd.edu <ACCESS_KEY> <SECRET_KEY>

You can see what host(s) you have configured with the command mc config host ls.

$ mc config host ls
...
obj
  URL       : http://obj.umiacs.umd.edu
  AccessKey : (redacted)
  SecretKey : (redacted)
  API       : s3v4
  Path      : auto
...

You can then use the normal mc commands like the following to list the contents of a bucket.

$ mc ls obj/iso
[2017-02-10 16:45:04 EST] 3.5GiB rhel-server-7.3-x86_64-dvd.iso
[2017-02-13 12:21:33 EST] 4.0GiB rhel-workstation-7.3-x86_64-dvd.iso

There is also the ability to search for file globs of specific files using the find sub-command for mc.

$ mc find derek/derek_support --name "*.log"
derek/derek_support/mds_20170918/ceph-mds.objmds01.log
derek/derek_support/satellite.log
derek/derek_support/umiacs-49168.log

The full MinIO Client documentation can be found here: https://min.io/docs/minio/linux/reference/minio-mc.html.