View source for Workspace mechanism

This mechanism allows you to keep data outside your home not only during a run, but also after a run. The idea is to allocate disk space for a number of days, and giving it a name, which allows you identify a workspace, and to distinguish several workspaces. It is also possible to allocate workspaces on different filesystems, which are prepared for workspaces on the local host.
The toolset is an Open Source Project (see [https://github.com/holgerBerger/hpc-workspace hpc-workspace@github]). Further documentation can be found at github as well, e.g. the [https://github.com/holgerBerger/hpc-workspace/blob/master/user-guide.md Workspace user guide@github].

== Allocating new workspace:== 

  MYSCR=`ws_allocate SimulatesomeThing 10` 
<UL>
MYSCR will contain the name of a directory which exists for 10 days, is on a temporary filesystem, and is owned by the caller. The directory is not deleted after the job, but after 10 days of realworld time. In a second job, you can just use the same line to get the same directory. Please note that the directory of the example will be deleted 10 days after first usage, no matter how often it is used and what duration was specified in the subsequent calls. The name may not contain any special characters, only digits and letters are allowed (the only exceptions are dash, dot, and underscore which are also possible, but not as first character of the name).<BR>
 
'''Options:'''<BR> 
</UL>
    ws_allocate [-F filesystem] name duration 
<UL> 
The option -F filesystem specifies the filesystem on which your workspace will be located. If this option is omitted, then your workspace will be located on a default filesystem.<BR>
 
</UL>

== Find your existing workspace path:== 
  MYSCR=`ws_find SimulatesomeThing` 
<UL>
MYSCR will contain the name of the directory where your prior allocated workspace is located
</UL>

== Listing your workspaces and available workspace filesystems: ==

  ws_list
<UL> 
Lists all workspaces of the default workspace filesystem, their names and locations as well as remaining live time. 
</UL> 
  ws_list -a
<UL> 
Lists your workspaces in all workspace filesystems. 
</UL> 
  ws_list -s
<UL> 
short output: list names of workspaces only (this is useful for scripting, e.g. the output can be used for ws_find to finally obtain the directories)
</UL>
  ws_list -F <fstype>
<UL> 
If several filesystems are used, you can limit the listing to workspaces of a specific filesystem type only. On Laki the filesystem NEC_lustre is available, on Hazelhen the filesystem univ_1. default is also a possible value.
</UL> 
  ws_list -l
<UL> 
list all available workspace filesystems 
</UL>

== Release a workspace:== 

  ws_release [-F filesystem] name 
<UL> 
Release the workspace 'name' on the specified filesystem. If the optione '-F filesystem' is omitted, then the workspace 'name' will be released on the default workspace filesystem. The user are responsible for releasing the correct workspace. After a workspace is released or the workspace is expired, then the directory of this workspace will be deleted. 
</UL>
==Register your workspaces:== 

  ws_register -F filesystem dir
<UL> 
This command will create/update in directory 'dir/filesystem' symbolic links of your workspaces in the specified 'filesystem'. If filesystem = ALL, then all of your workspaces in all available filesystems will be registered in the specified 'dir'. The symbolic links could be useful for getting some more information about your workspaces e.g. find ..., du ..., ls ..., .... 
</UL>

== Extend your workspace duration:== 

Starting with Version 3.0 of the workspace tools there is a possibility to extend an existing workspace:
 ws_extend [-f <fsname>] <wsname> [<duration>]
or, alternatively, using <tt>ws_allocate</tt> with the flag <tt>-x</tt>
 ws_allocate -x [-f <fsname>] <wsname> <duration>
with <tt>wsname</tt> being the name of an existing workspace. When using <tt>ws_extend</tt> the duration may be ommitted.
Extension is allowed for a small number of times, which is displayed with <tt>ws_list <wsname></tt>.


== Remind your workspace expiration date ==

  ws_send_ical.sh  <WS_name> <your_Email-address>

This little script may help you to take care of your work space.
For this task it checks the remaining time of a given work space
(first parameter) and send a calendar invitation to the
Email address (second parameter). If you are using a mail
programm with an integrated calendar funktion, you can accept
this event and your calendar / PDA will remind you ...


== Quota limits ==

usually quotas are enforced for all filesystems holding workspaces on user and group basis. To check the current usage, use following commands:
         lfs quota –u <login>        <file_system>      ##  display user quota 
         lfs quota –g <group_name>   <file_system>      ## display group quota


Please note, for a lustre based filesystem one has to use the ''lfs'' command to get the quota information.



== Workspace was expired, what can I do? ==
After a workspace was expired, a system cleaner moves that workspace for some days to an trash directory which is not accessible by users.
Some days later the trash directory will be really cleaned.
Users can list their own expired workspace which are still in the trash directory by using:
         ws_restore -l

To restore expired workspaces is also possible by users.
First you need a valid workspace. If you don't have a valid workspace, so please create one (see above).
Then you can restore a expired workspace which are listed with "ws_restore -l" using:
         ws_restore [options] workspace_name target_name

         workspace_name ''is one of the names listed by "ws_restore -l".''
         target_name ''is one of your valid workspace id's listed with "ws_list".''