Arbutus object storage clients: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
No edit summary
(migrating content to Accessing object storage with WinSCP page)
Line 5: Line 5:
For information on obtaining Arbutus Object Storage, please see [[Arbutus object storage|this page]]. For information on how to use an object storage client to manage your Arbutus object store, choose a client and follow instructions from these pages:
For information on obtaining Arbutus Object Storage, please see [[Arbutus object storage|this page]]. For information on how to use an object storage client to manage your Arbutus object store, choose a client and follow instructions from these pages:
# [[ Accessing object storage with s3cmd ]]
# [[ Accessing object storage with s3cmd ]]
# WinSCP
# [[ Accessing object storage with WinSCP ]]
# awscli
# awscli


<!--T:2-->
<!--T:2-->
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 in the pages linked above.  
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 in the pages linked above.  
== WinSCP == <!--T:30-->
=== Installing WinSCP === <!--T:31-->
WinSCP can be installed from https://winscp.net/.
=== Configuring WinSCP === <!--T:32-->
Under "New Session", make the following configurations:
<ul>
<li>File protocol: Amazon S3</li>
<li>Host name: object-arbutus.cloud.computecanada.ca</li>
<li>Port number: 443</li>
<li>Access key ID: 20_DIGIT_ACCESS_KEY</li>
</ul>
and "Save" these settings as shown below
<!--T:33-->
[[File:WinSCP Configuration.png|600px|thumb|center|WinSCP configuration screen]]
<!--T:34-->
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:
<!--T:35-->
[[File:WinSCP Path Configuration.png|600px|thumb|center|WinSCP Path Configuration]]
<!--T:36-->
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]]
=== Using WinSCP === <!--T:37-->
Click on the "Login" button and use the WinSCP GUI to create buckets and to transfer files:
<!--T:38-->
[[File:WinSCP transfers.png|800px|thumb|center|WinSCP file transfer screen]]
=== Access Control Lists (ACLs) and Policies === <!--T:41-->
Right-clicking on a file will allow you to set a file's ACL, like this:
[[File:WinSCP ACL.png|400px|thumb|center|WinSCP ACL screen]]


== AWS CLI == <!--T:43-->
== AWS CLI == <!--T:43-->

Revision as of 17:46, 7 March 2023

Other languages:

For information on obtaining Arbutus Object Storage, please see this page. For information on how to use an object storage client to manage your Arbutus object store, choose a client and follow instructions from these pages:

  1. Accessing object storage with s3cmd
  2. Accessing object storage with WinSCP
  3. awscli

It is important to note that Arbutus' Object Storage solution does not use Amazon's 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 in the pages linked above.

AWS CLI

The awscli client also works with the Object Store service with better support for large (>5GB) files and the helpful sync command. However, not all features have not been tested.

Installing awscli

pip install awscli awscli-plugin-endpoint

Configuring awscli

Generate an access key ID & secret key 

openstack ec2 credentials create

Edit or create ~/.aws/credentials and add the credentials generated above 

[default]
aws_access_key_id = <access_key>
aws_secret_access_key = <secret_key>

Edit ~/.aws/config and add the following configuration 

[plugins]
endpoint = awscli_plugin_endpoint

[profile default]
s3 =
  endpoint_url = https://object-arbutus.cloud.computecanada.ca
  signature_version = s3v4
s3api =
  endpoint_url = https://object-arbutus.cloud.computecanada.ca

Using awscli

export AWS_PROFILE=default
aws s3 ls <container-name>
aws s3 sync local_directory s3://container-name/prefix

More examples can be found here: https://docs.ovh.com/us/en/storage/getting_started_with_the_swift_S3_API/

Retrieved from "https://docs.alliancecan.ca/mediawiki/index.php?title=Arbutus_object_storage_clients&oldid=130986"