Swestore-irods

From SNIC Documentation
Revision as of 17:25, 13 December 2013 by Andreas Lindqvist (NSC) (talk | contribs) (Yubikey instructions)
Jump to: navigation, search


Getting access

Apply for storage
Please follow the instructions on the Apply for storage on SweStore page.
iRODS user authentication
SweStore's iRODS system uses Yubikey one-time passwords (OTP). With a simple touch of a button, a 44 character one-time password is generated and sent to the system. The user will be provided with a SweStore yubikey.
Yubikey has a status as pilot now. It can be changed in the future.
iRODS usage - How to acquire a SweStore yubikey
Please send an email to support@swestore.se and provide the shipping address to where the yubikey should be sent.
Yubikey has a status as pilot now. It can be changed in the future.

Support

If you have any issues using SweStore please do not hesitate to contact support@swestore.se.

Usage monitoring

Supported clients

iDrop web - Point your Web browser to iweb.swestore.se
E-iRODS iCommands 3.0 - Command line client Download E-iRODS icommands

SweStore iRODS uses PAM authentication and SweStore yubikeys. With a simple touch of a button, a 44 character one-time password is generated and sent to the system.

Community iRODS version 3.3

The community iRODS client version 3.3 also should work, with PAM authentication.
Please install the OpenSSL include files and libraries:

$ sudo apt-get install libssl-dev (debian based system)
# yum install openssl-devel (redhat-based systems)

Download irods 3.3 from https://www.irods.org/index.php/Downloads and unpack the tar.gz archive.

Please enable the following defines in the Makefile iRODS/config/config.mk.in

PAM_AUTH = 1
PAM_AUTH_NO_EXTEND = 1
USE_SSL = 1 

Please run irodssetup to compile the irods community client with PAM authentication.

SweStore iRODS usage documentation

To use the system you need to have the E-iRODS command line client installed or using iDROP web.

Command line client

For Linux systems the iRODS command line client is available as an installable package for various Linux platforms from the e-iRODS website downloads section.

The command line client is natural to use for Unix users. There are versions of the usual ls, rm, mv, mkdir, pwd, rsync commands prefixed with an i for iRODS, i.e. irm, imv, imkdir etc.

As expected iput and iget move files to and from the irods system. All these commands print short help when using the -h option.

iCommands environment file

There is an environment file .irodsEnv in the .irods subdirectory of the home directory ($HOME/.irods/.irodsEnv) which contains information where and how to access the iRODS metadata (iCAT) server.

It looks like (placeholders are in <>):

irodsHost 'irods.swestore.se'
irodsPort 1247
irodsDefResource 'snicdefResc'
irodsHome '/snicZone/proj/<PROJECT_NAME>'
irodsCwd '/snicZone/proj/<PROJECT_NAME>'
irodsUserName '<USERNAME>'
irodsZone 'snicZone'
irodsAuthScheme 'PAM'

The iCAT server is irods.swestore.se. The default irods zone name is snicZone. The default resource is snicdefResc.

Yubikey instructions

Prerequisite: A correct iCommands environment file, see above for instructions.

  1. Insert the yubikey in an available USB-slot in your computer.
  2. Type iinit
  3. Touch the conductive surface on the yubikey to send an one-time password to the system.

$ iinit
Enter your current PAM (system) password:
$ ils
/snicZone/home/<USERNAME>:
$

After that we can use the usual iCommands for 8 hours.

More details on the iCommands are available at https://www.irods.org/index.php/icommands

Using iCommands on SNIC HPC clusters

On SNIC-clusters the icommands command line tools are either available in the PATH or by adding the irods module, e.g.

module load irods
If the irods commands are not available at the SNIC HPC cluster, please contact support@swestore.se

We also need to setup the iCommands environment file $HOME/.irods/.irodsEnv

Storage Project directory structure

Your storage project is available at /snicZone/proj/<PROJECT NAME>

/snicZone/home/<USERNAME> is just a small home directory.

iDROP web client

The web client is accessible via the URL https://iweb.swestore.se/. The login screen consists of two prompts:

Username:
Password:
  1. Please type in your SweStore username.
  2. Insert the yubikey in an available USB-slot in your computer.
  3. Touch the conductive golden surface on the yubikey (for at least a second) to send an one-time password to the system.

Upstream documentation

Detailed documentation, papers and resources are available from the E-iRODS web site

Community iRODS

User forum