Difference between revisions of "UMobj"

From UMIACS
Jump to navigation Jump to search
(Created page with "=UMobj= This is a set of console utilities that are available on all UMIACS supported machines. They are provided to support our Ceph Object Stores so our users may interac...")
 
 
(51 intermediate revisions by 5 users not shown)
Line 1: Line 1:
=UMobj=
+
The UMobj suite of utilities provide command-line access to the [https://obj.umiacs.umd.edu/obj UMIACS Object Store].  UMobj is preinstalled on all UMIACS-supported Linux machines.
  
This is a set of console utilities that are available on all UMIACS supported machines.  They are provided to support our Ceph Object Stores so our users may interact with them on the command line.  In addition each Ceph Object Store in UMIACS has fully functional web application that allows access to your storage from any web browser.
+
==When to use UMobj==
 +
Use umobj if:
 +
* you have a large number of files to upload (hundreds or thousands of files)
 +
* you are uploading large files (files greater than 4GB in size)
  
For UMIACS support machines these utilities are installed at <code>/opt/UMobj/bin</code> however they should already be available in your path.
+
==Setup==
 +
We highly recommend setting a few environmental variables containing your credentials for
 +
convenience.  When logged into the Object Store web interface (see list above), you can
 +
find these credentials on the user page.  E.g. https://obj.umiacs.umd.edu/obj/user/
  
==Prerequisites==
+
For example, if you use the <tt>bash</tt> shell, you can add something like the following to your
 +
<tt>.bashrc</tt> or <tt>.bash_profile</tt>.
  
To use any of these utilities you either have to pass in on the command line your access and secret keys or you need to set some appropriate environmental variables.  You can obtain your access and secret keys (which are different from your username and password) by visiting the appropriate Ceph Object Store.  The default store is https://obj.umiacs.umd.edu/UMobjstore/.
+
<pre>
 +
export OBJ_ACCESS_KEY_ID="31sdfadDFAHFDN+344qOEIS"
 +
export OBJ_SECRET_ACCESS_KEY="NDSMK3233adfahadflkkPDSH092DSJKDKDJKFDLSFLNK"
 +
export OBJ_SERVER="obj.umiacs.umd.edu"
 +
</pre>
  
 +
Or in tcsh you can do the following or add it into your <tt>.tcshrc</tt>.
  
==lsobj==
+
<pre>
 +
setenv OBJ_ACCESS_KEY_ID "31sdfadDFAHFDN+344qOEIS"
 +
setenv OBJ_SECRET_ACCESS_KEY "NDSMK3233adfahadflkkPDSH092DSJKDKDJKFDLSFLNK"
 +
setenv OBJ_SERVER "obj.umiacs.umd.edu"
 +
</pre>
  
To list the object store you can use the <b>lsobj</b> command.
+
==Detailed Usage==
 +
For an example of how to use UMobj, please see [[UMobj/Example]].
 +
 
 +
For complete usage information, please see the [[GitLab]] page for [https://gitlab.umiacs.umd.edu/staff/umobj/blob/master/README.md#umobj umobj].

Latest revision as of 16:28, 4 January 2021

The UMobj suite of utilities provide command-line access to the UMIACS Object Store. UMobj is preinstalled on all UMIACS-supported Linux machines.

When to use UMobj

Use umobj if:

  • you have a large number of files to upload (hundreds or thousands of files)
  • you are uploading large files (files greater than 4GB in size)

Setup

We highly recommend setting a few environmental variables containing your credentials for convenience. When logged into the Object Store web interface (see list above), you can find these credentials on the user page. E.g. https://obj.umiacs.umd.edu/obj/user/

For example, if you use the bash shell, you can add something like the following to your .bashrc or .bash_profile.

export OBJ_ACCESS_KEY_ID="31sdfadDFAHFDN+344qOEIS"
export OBJ_SECRET_ACCESS_KEY="NDSMK3233adfahadflkkPDSH092DSJKDKDJKFDLSFLNK"
export OBJ_SERVER="obj.umiacs.umd.edu"

Or in tcsh you can do the following or add it into your .tcshrc.

setenv OBJ_ACCESS_KEY_ID "31sdfadDFAHFDN+344qOEIS"
setenv OBJ_SECRET_ACCESS_KEY "NDSMK3233adfahadflkkPDSH092DSJKDKDJKFDLSFLNK"
setenv OBJ_SERVER "obj.umiacs.umd.edu"

Detailed Usage

For an example of how to use UMobj, please see UMobj/Example.

For complete usage information, please see the GitLab page for umobj.