Arbutus object storage clients: Difference between revisions

<translate>

For information on obtaining Arbutus Object Storage, please see the [[Arbutus_Object_Storage_User_Guide|Object Storage User Guide]].  This page describes how to configure and use two common object storage clients:

# s3cmd

# WinSCP

It is important to note that Arbutus' Object Storage solution does not use Amazon's [https://documentation.help/s3-dg-20060301/VirtualHosting.html S3 Virtual Hosting] (i.e. DNS-based bucket) approach which these clients assume by default. They need to be configured not to use that approach as described below.

=== Installing s3cmd ===

Depending on your Linux distribution, the <code>s3cmd</code> command can be installed using the appropriate <code>yum</code> (RHEL, CentOS) or <code>apt</code> (Debian, Ubuntu) command:

<code>$ sudo yum install s3cmd</code><br/>

<code>$ sudo apt install s3cmd </code>

To configure the <code>s3cmd</code> tool use the command:</br>

<code>$ s3cmd --configure</code>

And make the following configurations with the keys provided by the Arbutus team:

<pre>

Refer to user manual for detailed description of all options.

Access key and Secret key are your identifiers for Amazon S3. Leave them empty for using the env variables.

Access Key []: 20_DIGIT_ACCESS_KEY

Default Region [US]:

Use "s3.amazonaws.com" for S3 Endpoint and not modify it to the target Amazon S3.

S3 Endpoint []: object-arbutus.cloud.computecanada.ca

Use "%(bucket)s.s3.amazonaws.com" to the target Amazon S3. "%(bucket)s" and "%(location)s" vars can be used

if the target S3 system supports dns based buckets.

DNS-style bucket+hostname:port template for accessing a bucket []: object-arbutus.cloud.computecanada.ca

Encryption password is used to protect your files from reading

by unauthorized persons while in transfer to S3

Path to GPG program []: /usr/bin/gpg

When using secure HTTPS protocol all communication with Amazon S3

servers is protected from 3rd party eavesdropping. This method is

Use HTTPS protocol []: Yes

On some networks all internet access must go through a HTTP proxy.

Try setting it here if you can't connect to S3 directly

</pre>

The next task is to make a bucket.  Buckets contain files. Bucket names must be globally unique across the Arbutus object storage solution.  Therefore, you will need to create a uniquely named bucket which will not conflict with other users.  For example, the buckets "s3://test/" and "s3://data/" are likely already taken.  Consider creating buckets reflective of your project, for example "s3://def-test-bucket1" or "s3://atlas_project_bucket".  Valid bucket names may only use the upper case characters, lower case characters, digits, periods, dashes, and underscores (i.e. A-Z, a-z, 0-9, ., -, and _ ).

To create a bucket, use the tool's <code>mb</code> (make bucket) command:

<code>$ s3cmd mb s3://BUCKET_NAME/</code>

To see the status of a bucket, use the <code>info</code> command:

<code>$ s3cmd info s3://BUCKET_NAME/</code>

The output will look something like this:

<pre>

s3://BUCKET_NAME/ (bucket):

</pre>

To upload a file to the bucket, use the <code>put</code> command similar to this:

<code>$ s3cmd put --guess-mime-type FILE_NAME.dat s3://BUCKET_NAME/FILE_NAME.dat</code>

Where the bucket name and the file name are specified.  Multipurpose Internet Mail Extensions (MIME) is a mechanism for handling files based on their type. The <code>--guess-mime-type</code> command parameter will guess the MIME type based on the file extension.  The default MIME type is <code>binary/octet-stream</code>.

To delete a file from the bucket, use the  <code>rm</code> command similar to this:<br/>

<code>$ s3cmd rm s3://BUCKET_NAME/FILE_NAME.dat</code>

Buckets can have Access Control Lists (ACLs) and policies which govern who can access what resources in the object store.  These features are quite sophisticated.  Here are two simple examples of using ACLs using the tool's <code>setacl</code> command.

<code>$ s3cmd setacl --acl-public -r s3://BUCKET_NAME/</code>

The result of this command is that the public can access the bucket and recursively (-r) every file in the bucket.  Files can be accessed via URLs such as<br/>

https://object-arbutus.cloud.computecanada.ca/BUCKET_NAME/FILE_NAME.dat.

The second ACL example limits access to the bucket to only the owner:

<code>$ s3cmd setacl --acl-private s3://BUCKET_NAME/</code>

Other more sophisticated examples can be found in the s3cmd man page.

WinSCP can be downloaded from https://winscp.net/ and installed by launching the downloaded WinSCP installer.

Under "New Session", make the following configurations:

<ul>

and "Save" these settings as shown below

[[File:WinSCP Configuration.png|600px|thumb|center|WinSCP configuration screen]]

Next, click on the "Edit" button and then click on "Advanced..." and navigate to "Environment" to "S3" to "Protocol options" to "URL style:" which <b>must</b> changed from "Virtual Host" to "Path" as shown below:

[[File:WinSCP Path Configuration.png|600px|thumb|center|WinSCP Path Configuration]]

This "Path" setting is important, otherwise WinSCP will not work and you will see hostname resolution errors, like this:

[[File:WinSCP resolve error.png|400px|thumb|center|WinSCP resolve error]]

Click on the "Login" button and use the WinSCP GUI to create buckets and to transfer files:

[[File:WinSCP transfers.png|800px|thumb|center|WinSCP file transfer screen]]

Unfortunately, as of version 5.19 WinSCP is not capable of managing object storage ACLs and Policies.

[[Category:CC-Cloud]]

</translate>