SNIC Documentation - User contributions [en]

Swestore-dCache

2020-03-03T10:47:49Z

Robert Pilstål (NSC): /* From the command line */

[[Category:Storage]]
[[Category:Swestore]]
[[Category:Swestore]]
[[Category:Swestore user guide]]

Swestore-dCache is distributed across the SNIC centres [http://www.c3se.chalmers.se/ C3SE], [http://www.hpc2n.umu.se/ HPC2N], [http://www.lunarc.lu.se/ Lunarc] and [http://www.nsc.liu.se/ NSC]. Data is stored in two copies with each copy at a different SNIC centre. This enables the system to cope with a multitude of issues ranging from a simple crash of a storage element to losing an entire site while still providing access to the stored data.

One of the major advantages to the distributed nature of Swestore is the excellent aggregated transfer rates possible. This is achieved by bypassing a central node and having transfers going directly to/from the storage elements if the selected transfer protocol allows it. Swestore can achieve aggregated transfer rates in excess of 100 Gigabit per second, but in practice this is limited by connectivity to the end user, each university or a limited number of files (typically max 1 Gbit/s per file/connection).

To protect against silent data corruption the dCache storage system checksums all stored data and periodically verifies the data using this checksum.

The dCache system does NOT yet provide protection against user errors like inadvertent file deletions.

== Acquire and manage certificate (for users accessing with certificate authentication) ==

Certificate authentication is needed in some special cases, and more convenient for use in automation (ie. Robot certificates).

Some communities require certificate authentication and such users might already have a certificate, that certificate is likely good to use with Swestore.

If you need to use Certificate authentication, follow the instruction on the page [[Certificate Setup for Swestore]].

= Using Swestore =
== Download and upload data ==
=== From the command line ===

There are several command line tools capable of using the protocols provided by Swestore. For usage on SNIC clusters we recommend using the ARC tools which should be installed on all SNIC resources.

As an integration point for building scripts and automated systems we suggest using the curl program and library.

:; Interactive tools
:: Best suited for interactive use with various support for directory listings, wildcards etc.
::;Currently no suitable tools to recommend
:; Command-line tools
:: These tools are also suitable for scripting or automation.
::; rclone
::: Supports multiple protocols.
::: Please see the instructions for [[Accessing Swestore with rclone]].
::; cURL
::: Please see the instructions for [[Accessing Swestore with cURL]]. We suggest using this as integration point for building scripts and automated systems.
::; davix
::: Swestore-specific documentation not written yet. See upstream documentation at https://davix.web.cern.ch/davix/docs/master/
::: Use access URL: davs://webdav.swestore.se:1443/
::; ARC
::: Certificate authentication only. Supports multiple protocols.
::: Please see the instructions for [[Accessing Swestore with the ARC client]].
::; gfal2
::: Certificate authentication only. Supports multiple protocols.
::: Swestore-specific documentation not written yet. See upstream documentation at https://dmc.web.cern.ch/projects/gfal-2/documentation
::: Use access URL: gsiftp://gsiftp.swestore.se/
::; https://duck.sh/
::: Command-line client for Windows/macOS/Linux (not documented yet)

=== Using a GUI client ===

Graphical User Interface (GUI) clients are known to work on some operating systems.

:; Cyberduck
:: Please see the instructions for [[Accessing Swestore using Cyberduck]] '''Recommended method on macOS'''
:; WinSCP
:: Please see the instructions for [[Accessing Swestore using WinSCP]] '''Recommended method on Windows'''

=== From a web browser ===

Swestore is accessible in your web browser as a simple directory index interface at https://webdav.swestore.se/.

Web browser access supports both username/password and certificate authentication.

Projects are organized under the <code>/snic</code> directory as <code><nowiki>https://webdav.swestore.se/snic/DIRECTORY_NAME/</nowiki></code>.

==== JavaScript WebDAV client ====

Swestore dCache can also be accessed in your browser, through a JavaScript client, over WebDAV at https://webdav.swestore.se/browser/ .

=== Legacy documentation ===

There are other clients/methods available, but not recommended for new deployments. See [[:Category:Swestore user guide]] for a complete list of documentation.

== Enabled access protocols ==
A design criteria for Swestore is to provide the storage over a number of standardized and public protocols. There is no vendor specific client needed for access.

:; GridFTP
:: Also called gsiftp. Well supported within Swestore.
:: Features: Transfer checksums. Direct transfer from/to storage pools for high speed transfers.
:: Access URL: gsiftp://gsiftp.swestore.se/
:; HTTP/WebDAV
:: Contender for being the recommended protocol for Swestore.
:: Features: Support in web browsers. Supports direct transfer of files from/to storage pools improving performance (varying support in clients).
::; Authenticated access
::: This is the normal read-write access.
::: Access URL: https://webdav.swestore.se/ (non-redirected)
::: Access URL: https://webdav.swestore.se:1443/ (redirected)
::: Access URL: https://webdav.swestore.se:2443/ (redirected reads)
::; Unauthenticated read-only access
::: For special cases only.
::: Access URL: http://webdav.swestore.se/ (unauthenticated, read-only, non-redirected)
::: Access URL: http://webdav.swestore.se:1080/ (unauthenticated, read-only, redirected)
::: Access URL: http://webdav.swestore.se:2080/ (unauthenticated, read-only, redirected reads)
:; NFSv4.1
:: Used by some communities, not recommended for general use
:; SRM - Storage Resource Manager
:: Used by some communities, not recommended for general use.
:: Access URL: srm://srm.swegrid.se/
:; Xrootd
:: Used by some communities, not recommended for general use
:; DCAP
:: Used by some communities, not recommended for general use

== Usage monitoring ==
* On the project page in SUPR: https://supr.snic.se
* On the monitoring server for Swestore: http://status.swestore.se/munin/monitor/monitor/ (only accessible from .se-domains.

= Support =

If you have any issues using Swestore, please do not hesitate to contact [mailto:support@swestore.se support@swestore.se].

Accessing Swestore with rclone

2020-03-03T10:47:42Z

Robert Pilstål (NSC):

[[Category:Grid computing]]
[[Category:SweGrid user guide]]
[[Category:Swestore]]
[[Category:Swestore user guide]]

[[Swestore|< Swestore]]

This guide describes how to use the [https://rclone.org/webdav/ Rclone] ''WebDAV'' client for storing and retrieving files from Swestore. Rclone is versatile and supports many protocols through a simple command line interface (CLI).

= Requirements =
To access Swestore using the rclone you need to be a member of a Swestore storage project, see [[Swestore#Getting access to Swestore]].

To install rclone on your own computer, please follow your systems instructions at the official rclone documentation pages [https://rclone.org/install/ here].

= Quickstart =

== Swestore access URL ==

The WebDAV access URL for Swestore should be specified for <code>rclone</code> as;

:: https://webdav.swestore.se

== Basic commands ==
: <code>rclone config</code> - configure rclone. See [https://rclone.org/docs/#configure Rclone configuration] for details.
: <code>rclone ls</code> - for listing files. Works similarly to <code>ls</code>. See [https://rclone.org/commands/rclone_ls/ Rclone ls].
: <code>rclone copyto</code> - for copying directories or separate files. Works similarly to <code>cp</code> with wildcards. See [https://rclone.org/commands/rclone_copyto/ Rclone copyto].
: <code>rclone copy</code> - for copying contents of directories. Works similarly to <code>cp -R path/*</code>. See [https://rclone.org/commands/rclone_copy/ Rclone copy].
: <code>rclone mkdir</code> - for creating directories. Works similarly to <code>mkdir -p</code>. See [https://rclone.org/commands/rclone_mkdir/ Rclone mkdir].
: <code>rclone deletefile</code> - for removing specific files. Works similarly to <code>rm</code>. See [https://rclone.org/commands/rclone_deletefile/ Rclone deletefile].
:: More powerful removal functions are available, but '''be careful''' with these;
::: <code>rclone delete</code> - for removing all files under path - i.e. '''you loose your data'''. Works similarly to <code>find path -type f | xargs rm</code>. See [https://rclone.org/commands/rclone_delete/ Rclone delete].
::: <code>rclone rmdir</code> - removing path if empty. Works similarly to <code>rm -d</code>. See [https://rclone.org/commands/rclone_rmdir/ Rclone rmdir].
::: <code>rclone rmdirs</code> - removing all empty directories under path. Works similarly to <code>find path -type d | awk '{ print length, $0 }' | sort -nsr | cut -d" " -f2- | xargs rm -d</code> (example modified from [https://stackoverflow.com/a/5917762 stackoverflow]). See [https://rclone.org/commands/rclone_rmdirs/ Rclone rmdirs].
::: <code>rclone purge</code> - removing all data under path, including path - i.e. '''you loose your data'''. Works similarly to <code>rm -rf</code>. See [https://rclone.org/commands/rclone_purge/ Rclone purge].

Use <code>man</code> and <code>--help</code> to get more info on rclone and its commands. Examples: <code>man rclone</code>, <code>rclone --help</code> or <code>rclone copy --help</code> .

== Paths ==
The rclone commands supports multiple storage protocols. Given that you have configured <code><nowiki>https://webdav.swestore.se</nowiki></code> as the <code>swestore</code> remote, we recommend using WebDAV with paths on the form <code><nowiki>swestore:/snic/YOUR_PROJECT_DIR/...</nowiki></code> .

= Configuration =

You have to configure rclone with your access protocol, URL and user login credentials for it to work. Simply issue the following configuration command to interactively configure rclone;

$ rclone config

For configuring WebDAV, this amounts to answering something along the lines;

: <code>n</code> for '''New remote'''
: <code>swestore</code> for '''name'''
: <code>33</code> for '''Storage''' (WebDAV)
: <code><nowiki>https://webdav.swestore.se</nowiki></code> for '''url'''
: <code>4</code> for '''vendor''' (Other)
: <code>yourusername</code> for '''user''', should be on the format <code>s_user</code>
: <code>y</code> for '''Yes type in my own password'''
:: then enter your swestore password twice
: Just press <code><nowiki><Enter></nowiki></code> for '''bearer_token'''
: <code>n</code> for '''Edit advanced config?'''
: <code>y</code> if you think the resulting config is correct, otherwise <code>e</code> to edit again.
: <code>q</code> to '''Quit config'''

To see your configuartion afterwards, run

$ cat ~/.config/rclone/rclone.conf

You can also list your configured remotes by issuing

$ rclone listremotes

In the following sections, we are assuming your swestore remote is named <code>swestore</code>

= Copying files =

Copying files to and from resources is accomplished using the rclone '''copy''' and '''copyto''' command.

== Copying single files ==

Copying single files is accomplished in the same way as using the
normal '''cp''' command as shown in the following example:

$ rclone copyto archive.tar.gz swestore:/snic/YOUR_PROJECT_DIR/archive.tar.gz

You can also use '''copyto''' in order to rename the file in the process of copying it to the destination, by specifying a different filename on the remote.

== Recursive copying ==

Recursive copying of a directory is accomplished using the '''copy''' command. The command will only copy files that have changed on the source compared to the destination, which is determined by checksums and timestamps. Observe that the source directory is not copied over, only its contents. Also, empty directories are omitted.

Example:

$ rclone copy /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY

The option '''--no-traverse''' can be used to not list files on the destination (good for huge directories). '''--max-age''' can be used to select the most recently modified files for transfer, and '''-P''' gives you status on progress.

Example, copying the last days modifications, with progress:

$ rclone copy --max-age 24h --no-traverse -P /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY

'''NOTE:''' The above example will copy all files in the directory <code>src</code> into
the destination directory <code>DESTINATION_DIRECTORY</code>. If you want the directory <code>src</code>
to be part of the destination path you have to explicitly supply it as shown in the example below:

$ rclone copy /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY/src

= Listing =

Rclone supports listing all files under a path; you can list recursively with the '''-R''' flag.

Listing files and directories on a resources is done using the '''ls'''
or one of the '''ls*''' commands (see below). The simple '''ls''' command
only lists objects and their sizes;

$ rclone ls swestore:/snic/YOUR_PROJECT_DIR

Further functionality can be be achieved from using any of the the following '''ls*''' commands;

: <code>lsl</code> long listing with additional info
: <code>lsd</code> list only directories
: <code>lsf</code> list objects and directories, in a fashion good for scripting
: <code>lsjson</code> gives advanced output in JSON format

Example:

$ rclone lsl swestore:/snic/YOUR_PROJECT_DIR

= Creating directories =

Directories are generally created on demand. If you copy a file with the destination /snic/YOUR_PROJECT_DIR/newdir/dummyfile the newdir directory will be created if missing. But you can explicitly create directories using the '''mkdir''' command.

$ rclone mkdir swestore:/snic/YOUR_PROJECT_DIR/newdir

= Removing files or directories =

'''Beware''' that the command '''delete''' will recursively delete all file objects under specified path!

To remove the file <code>dummyfile</code> under <code>/snic/YOUR_PROJECT_DIR/newdir</code>,

$ rclone deletefile swestore:/snic/YOUR_PROJECT_DIR/newdir/dummyfile

To remove a directory, they have to be empty, and you use the command

$ rclone rmdir swestore:/snic/YOUR_PROJECT_DIR/newdir/

To remove '''all''' empty directories under a path, use

$ rclone rmdirs swestore:/snic/YOUR_PROJECT_DIR/newdir/

To recursively remove '''all''' files under <code>/snic/YOUR_PROJECT_DIR/newdir</code>, leaving the empty directory structure in place, '''be careful''';

$ rclone delete swestore:/snic/YOUR_PROJECT_DIR/newdir/

'''Do not use''' the command purge, as that will '''delete everything''' under the path specified.

= FAQ =

'''Q''': I used <code>rclone purge</code> or <code>rclone delete</code> and have now deleted all my files; can I get them back somehow?
: '''A''': '''No'''. Swestore does not currently support recovery of data for which the user has explicably requested to be deleted from the system, be it intentionally or by mistake. Therefore '''caution''' is advised while using powerful tools such as <code>rclone</code>.

Accessing Swestore with rclone

2020-03-03T10:40:22Z

Robert Pilstål (NSC): /* FAQ */

[[Category:Grid computing]]
[[Category:SweGrid user guide]]
[[Category:Swestore]]
[[Category:Swestore user guide]]

[[Swestore|< Swestore]]

This guide describes how to use the [https://rclone.org/webdav/ Rclone] ''WebDAV'' client for storing and retrieving files from Swestore. Rclone is versatile and supports many protocols through a simple command line interface (CLI).

= Requirements =
To access Swestore using the rclone you need to be a member of a Swestore storage project, see [[Swestore#Getting access to Swestore]].

To install rclone on your own computer, please follow your systems instructions at the official rclone documentation pages [https://rclone.org/install/ here].

= Quickstart =

== Basic commands ==
: <code>rclone config</code> - configure rclone. See [https://rclone.org/docs/#configure Rclone configuration] for details.
: <code>rclone ls</code> - for listing files. Works similarly to <code>ls</code>. See [https://rclone.org/commands/rclone_ls/ Rclone ls].
: <code>rclone copyto</code> - for copying directories or separate files. Works similarly to <code>cp</code> with wildcards. See [https://rclone.org/commands/rclone_copyto/ Rclone copyto].
: <code>rclone copy</code> - for copying contents of directories. Works similarly to <code>cp -R path/*</code>. See [https://rclone.org/commands/rclone_copy/ Rclone copy].
: <code>rclone mkdir</code> - for creating directories. Works similarly to <code>mkdir -p</code>. See [https://rclone.org/commands/rclone_mkdir/ Rclone mkdir].
: <code>rclone deletefile</code> - for removing specific files. Works similarly to <code>rm</code>. See [https://rclone.org/commands/rclone_deletefile/ Rclone deletefile].
:: More powerful removal functions are available, but '''be careful''' with these;
::: <code>rclone delete</code> - for removing all files under path - i.e. '''you loose your data'''. Works similarly to <code>find path -type f | xargs rm</code>. See [https://rclone.org/commands/rclone_delete/ Rclone delete].
::: <code>rclone rmdir</code> - removing path if empty. Works similarly to <code>rm -d</code>. See [https://rclone.org/commands/rclone_rmdir/ Rclone rmdir].
::: <code>rclone rmdirs</code> - removing all empty directories under path. Works similarly to <code>find path -type d | awk '{ print length, $0 }' | sort -nsr | cut -d" " -f2- | xargs rm -d</code> (example modified from [https://stackoverflow.com/a/5917762 stackoverflow]). See [https://rclone.org/commands/rclone_rmdirs/ Rclone rmdirs].
::: <code>rclone purge</code> - removing all data under path, including path - i.e. '''you loose your data'''. Works similarly to <code>rm -rf</code>. See [https://rclone.org/commands/rclone_purge/ Rclone purge].

Use <code>man</code> and <code>--help</code> to get more info on rclone and its commands. Examples: <code>man rclone</code>, <code>rclone --help</code> or <code>rclone copy --help</code> .

== Paths ==
The rclone commands supports multiple storage protocols. Given that you have configured <code><nowiki>https://webdav.swestore.se</nowiki></code> as the <code>swestore</code> remote, we recommend using WebDAV with paths on the form <code><nowiki>swestore:/snic/YOUR_PROJECT_DIR/...</nowiki></code> .

= Configuration =

You have to configure rclone with your access protocol, URL and user login credentials for it to work. Simply issue the following configuration command to interactively configure rclone;

$ rclone config

For configuring WebDAV, this amounts to answering something along the lines;

: <code>n</code> for '''New remote'''
: <code>swestore</code> for '''name'''
: <code>33</code> for '''Storage''' (WebDAV)
: <code><nowiki>https://webdav.swestore.se</nowiki></code> for '''url'''
: <code>4</code> for '''vendor''' (Other)
: <code>yourusername</code> for '''user''', should be on the format <code>s_user</code>
: <code>y</code> for '''Yes type in my own password'''
:: then enter your swestore password twice
: Just press <code><nowiki><Enter></nowiki></code> for '''bearer_token'''
: <code>n</code> for '''Edit advanced config?'''
: <code>y</code> if you think the resulting config is correct, otherwise <code>e</code> to edit again.
: <code>q</code> to '''Quit config'''

To see your configuartion afterwards, run

$ cat ~/.config/rclone/rclone.conf

You can also list your configured remotes by issuing

$ rclone listremotes

In the following sections, we are assuming your swestore remote is named <code>swestore</code>

= Copying files =

Copying files to and from resources is accomplished using the rclone '''copy''' and '''copyto''' command.

== Copying single files ==

Copying single files is accomplished in the same way as using the
normal '''cp''' command as shown in the following example:

$ rclone copyto archive.tar.gz swestore:/snic/YOUR_PROJECT_DIR/archive.tar.gz

You can also use '''copyto''' in order to rename the file in the process of copying it to the destination, by specifying a different filename on the remote.

== Recursive copying ==

Recursive copying of a directory is accomplished using the '''copy''' command. The command will only copy files that have changed on the source compared to the destination, which is determined by checksums and timestamps. Observe that the source directory is not copied over, only its contents. Also, empty directories are omitted.

Example:

$ rclone copy /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY

The option '''--no-traverse''' can be used to not list files on the destination (good for huge directories). '''--max-age''' can be used to select the most recently modified files for transfer, and '''-P''' gives you status on progress.

Example, copying the last days modifications, with progress:

$ rclone copy --max-age 24h --no-traverse -P /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY

'''NOTE:''' The above example will copy all files in the directory <code>src</code> into
the destination directory <code>DESTINATION_DIRECTORY</code>. If you want the directory <code>src</code>
to be part of the destination path you have to explicitly supply it as shown in the example below:

$ rclone copy /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY/src

= Listing =

Rclone supports listing all files under a path; you can list recursively with the '''-R''' flag.

Listing files and directories on a resources is done using the '''ls'''
or one of the '''ls*''' commands (see below). The simple '''ls''' command
only lists objects and their sizes;

$ rclone ls swestore:/snic/YOUR_PROJECT_DIR

Further functionality can be be achieved from using any of the the following '''ls*''' commands;

: <code>lsl</code> long listing with additional info
: <code>lsd</code> list only directories
: <code>lsf</code> list objects and directories, in a fashion good for scripting
: <code>lsjson</code> gives advanced output in JSON format

Example:

$ rclone lsl swestore:/snic/YOUR_PROJECT_DIR

= Creating directories =

Directories are generally created on demand. If you copy a file with the destination /snic/YOUR_PROJECT_DIR/newdir/dummyfile the newdir directory will be created if missing. But you can explicitly create directories using the '''mkdir''' command.

$ rclone mkdir swestore:/snic/YOUR_PROJECT_DIR/newdir

= Removing files or directories =

'''Beware''' that the command '''delete''' will recursively delete all file objects under specified path!

To remove the file <code>dummyfile</code> under <code>/snic/YOUR_PROJECT_DIR/newdir</code>,

$ rclone deletefile swestore:/snic/YOUR_PROJECT_DIR/newdir/dummyfile

To remove a directory, they have to be empty, and you use the command

$ rclone rmdir swestore:/snic/YOUR_PROJECT_DIR/newdir/

To remove '''all''' empty directories under a path, use

$ rclone rmdirs swestore:/snic/YOUR_PROJECT_DIR/newdir/

To recursively remove '''all''' files under <code>/snic/YOUR_PROJECT_DIR/newdir</code>, leaving the empty directory structure in place, '''be careful''';

$ rclone delete swestore:/snic/YOUR_PROJECT_DIR/newdir/

'''Do not use''' the command purge, as that will '''delete everything''' under the path specified.

= FAQ =

'''Q''': I used <code>rclone purge</code> or <code>rclone delete</code> and have now deleted all my files; can I get them back somehow?
: '''A''': '''No'''. Swestore does not currently support recovery of data for which the user has explicably requested to be deleted from the system, be it intentionally or by mistake. Therefore '''caution''' is advised while using powerful tools such as <code>rclone</code>.

Accessing Swestore with rclone

2020-03-02T15:24:44Z

Robert Pilstål (NSC): Created page with "Category:Grid computing Category:SweGrid user guide Category:Swestore Category:Swestore user guide < Swestore This guide describes how to use the [..."

[[Category:Grid computing]]
[[Category:SweGrid user guide]]
[[Category:Swestore]]
[[Category:Swestore user guide]]

[[Swestore|< Swestore]]

This guide describes how to use the [https://rclone.org/webdav/ Rclone] ''WebDAV'' client for storing and retrieving files from Swestore. Rclone is versatile and supports many protocols through a simple command line interface (CLI).

= Requirements =
To access Swestore using the rclone you need to be a member of a Swestore storage project, see [[Swestore#Getting access to Swestore]].

To install rclone on your own computer, please follow your systems instructions at the official rclone documentation pages [https://rclone.org/install/ here].

= Quickstart =

== Basic commands ==
: <code>rclone config</code> - configure rclone. See [https://rclone.org/docs/#configure Rclone configuration] for details.
: <code>rclone ls</code> - for listing files. Works similarly to <code>ls</code>. See [https://rclone.org/commands/rclone_ls/ Rclone ls].
: <code>rclone copyto</code> - for copying directories or separate files. Works similarly to <code>cp</code> with wildcards. See [https://rclone.org/commands/rclone_copyto/ Rclone copyto].
: <code>rclone copy</code> - for copying contents of directories. Works similarly to <code>cp -R path/*</code>. See [https://rclone.org/commands/rclone_copy/ Rclone copy].
: <code>rclone mkdir</code> - for creating directories. Works similarly to <code>mkdir -p</code>. See [https://rclone.org/commands/rclone_mkdir/ Rclone mkdir].
: <code>rclone deletefile</code> - for removing specific files. Works similarly to <code>rm</code>. See [https://rclone.org/commands/rclone_deletefile/ Rclone deletefile].
:: More powerful removal functions are available, but '''be careful''' with these;
::: <code>rclone delete</code> - for removing all files under path - i.e. '''you loose your data'''. Works similarly to <code>find path -type f | xargs rm</code>. See [https://rclone.org/commands/rclone_delete/ Rclone delete].
::: <code>rclone rmdir</code> - removing path if empty. Works similarly to <code>rm -d</code>. See [https://rclone.org/commands/rclone_rmdir/ Rclone rmdir].
::: <code>rclone rmdirs</code> - removing all empty directories under path. Works similarly to <code>find path -type d | awk '{ print length, $0 }' | sort -nsr | cut -d" " -f2- | xargs rm -d</code> (example modified from [https://stackoverflow.com/a/5917762 stackoverflow]). See [https://rclone.org/commands/rclone_rmdirs/ Rclone rmdirs].
::: <code>rclone purge</code> - removing all data under path, including path - i.e. '''you loose your data'''. Works similarly to <code>rm -rf</code>. See [https://rclone.org/commands/rclone_purge/ Rclone purge].

Use <code>man</code> and <code>--help</code> to get more info on rclone and its commands. Examples: <code>man rclone</code>, <code>rclone --help</code> or <code>rclone copy --help</code> .

== Paths ==
The rclone commands supports multiple storage protocols. Given that you have configured <code><nowiki>https://webdav.swestore.se</nowiki></code> as the <code>swestore</code> remote, we recommend using WebDAV with paths on the form <code><nowiki>swestore:/snic/YOUR_PROJECT_DIR/...</nowiki></code> .

= Configuration =

You have to configure rclone with your access protocol, URL and user login credentials for it to work. Simply issue the following configuration command to interactively configure rclone;

$ rclone config

For configuring WebDAV, this amounts to answering something along the lines;

: <code>n</code> for '''New remote'''
: <code>swestore</code> for '''name'''
: <code>33</code> for '''Storage''' (WebDAV)
: <code><nowiki>https://webdav.swestore.se</nowiki></code> for '''url'''
: <code>4</code> for '''vendor''' (Other)
: <code>yourusername</code> for '''user''', should be on the format <code>s_user</code>
: <code>y</code> for '''Yes type in my own password'''
:: then enter your swestore password twice
: Just press <code><nowiki><Enter></nowiki></code> for '''bearer_token'''
: <code>n</code> for '''Edit advanced config?'''
: <code>y</code> if you think the resulting config is correct, otherwise <code>e</code> to edit again.
: <code>q</code> to '''Quit config'''

To see your configuartion afterwards, run

$ cat ~/.config/rclone/rclone.conf

You can also list your configured remotes by issuing

$ rclone listremotes

In the following sections, we are assuming your swestore remote is named <code>swestore</code>

= Copying files =

Copying files to and from resources is accomplished using the rclone '''copy''' and '''copyto''' command.

== Copying single files ==

Copying single files is accomplished in the same way as using the
normal '''cp''' command as shown in the following example:

$ rclone copyto archive.tar.gz swestore:/snic/YOUR_PROJECT_DIR/archive.tar.gz

You can also use '''copyto''' in order to rename the file in the process of copying it to the destination, by specifying a different filename on the remote.

== Recursive copying ==

Recursive copying of a directory is accomplished using the '''copy''' command. The command will only copy files that have changed on the source compared to the destination, which is determined by checksums and timestamps. Observe that the source directory is not copied over, only its contents. Also, empty directories are omitted.

Example:

$ rclone copy /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY

The option '''--no-traverse''' can be used to not list files on the destination (good for huge directories). '''--max-age''' can be used to select the most recently modified files for transfer, and '''-P''' gives you status on progress.

Example, copying the last days modifications, with progress:

$ rclone copy --max-age 24h --no-traverse -P /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY

'''NOTE:''' The above example will copy all files in the directory <code>src</code> into
the destination directory <code>DESTINATION_DIRECTORY</code>. If you want the directory <code>src</code>
to be part of the destination path you have to explicitly supply it as shown in the example below:

$ rclone copy /path/to/src swestore:/snic/YOUR_PROJECT_DIR/DESTINATION_DIRECTORY/src

= Listing =

Rclone supports listing all files under a path; you can list recursively with the '''-R''' flag.

Listing files and directories on a resources is done using the '''ls'''
or one of the '''ls*''' commands (see below). The simple '''ls''' command
only lists objects and their sizes;

$ rclone ls swestore:/snic/YOUR_PROJECT_DIR

Further functionality can be be achieved from using any of the the following '''ls*''' commands;

: <code>lsl</code> long listing with additional info
: <code>lsd</code> list only directories
: <code>lsf</code> list objects and directories, in a fashion good for scripting
: <code>lsjson</code> gives advanced output in JSON format

Example:

$ rclone lsl swestore:/snic/YOUR_PROJECT_DIR

= Creating directories =

Directories are generally created on demand. If you copy a file with the destination /snic/YOUR_PROJECT_DIR/newdir/dummyfile the newdir directory will be created if missing. But you can explicitly create directories using the '''mkdir''' command.

$ rclone mkdir swestore:/snic/YOUR_PROJECT_DIR/newdir

= Removing files or directories =

'''Beware''' that the command '''delete''' will recursively delete all file objects under specified path!

To remove the file <code>dummyfile</code> under <code>/snic/YOUR_PROJECT_DIR/newdir</code>,

$ rclone deletefile swestore:/snic/YOUR_PROJECT_DIR/newdir/dummyfile

To remove a directory, they have to be empty, and you use the command

$ rclone rmdir swestore:/snic/YOUR_PROJECT_DIR/newdir/

To remove '''all''' empty directories under a path, use

$ rclone rmdirs swestore:/snic/YOUR_PROJECT_DIR/newdir/

To recursively remove '''all''' files under <code>/snic/YOUR_PROJECT_DIR/newdir</code>, leaving the empty directory structure in place, '''be careful''';

$ rclone delete swestore:/snic/YOUR_PROJECT_DIR/newdir/

'''Do not use''' the command purge, as that will '''delete everything''' under the path specified.

= FAQ =

'''Q''': I used <code>rclone purge</code> or <code>rclone delete</code> and have now deleted all my files; can I get them back somehow?
: '''A''': No.

KTH Certificate Information

2020-01-30T08:02:58Z

Robert Pilstål (NSC): Correcting link as per RT#189423

For employees from KTH the procedure is as follows to be able to request certificates from the eScience(grid) certificate portal:

# Go to KTHs IT support page: https://intra.kth.se/en/it/kontakta-it-support/ and ask them to give to the right to retrieve eScience(grid)-certificates using your KTH id.
# Follow the instructions on [[Requesting_a_grid_certificate_using_the_Digicert_SSO_Portal]]

Swestore-dCache

2020-01-22T12:21:52Z

Robert Pilstål (NSC): /* From a web browser */

[[Category:Storage]]
[[Category:Swestore]]
[[Category:Swestore]]
[[Category:Swestore user guide]]

Swestore is Research Data Storage Infrastructure operated by the Swedish National Infrastructure for Computing (SNIC).

The resources provided by Swestore are made available through open procedures such that the best Swedish research is supported and new research is facilitated. The purpose of Swestore allocations, granted by Swedish National Allocations Committee (SNAC), is to provide large scale data storage for “live” or “working” research data, also known as active research data.

Due to the VR funding, the free allocations on Swestore have some usage limitations.
* Swestore is NOT supposed to be used for backups and such requests for allocation will be rejected. Please, check with your university (home institution/organisation) IT department about backup services, strategies and policies in place. If such services do not exist or if you can’t access them for different reasons, please contact us at support@swestore.se;
* Swestore is NOT supposed to be used as archiving service, long-term storage or repository for “static” data. Once data is no longer in the process of change, and decision on which data should be retained shared and/or preserved has been taken, data should be moved toward appropriate data services. The higher education institutions are responsible for archiving and long-term preservation of research data produced by researchers employed by them;

; Glossary
; Active (Research) data
: is data that is being worked on as part of research project and therefore subject to change. The files containing data will need to be accessed and amended or updated as new data is gathered or processed.
; Static (Research) data: is data that is no longer in the process of change and it can be prepared for preservation and reuse.
; Backup
: is a copy of the digital data to be stored and used as a replacement in case the main copy is either deleted or corrupted.
; Archive
:is a service to record, organise, and store (digital) items in optimal conditions, with standardised labelling to ensure their longevity and continued access. The service is based on application of metadata, archiving policies, records management, and digital preservation actions. Archivists make decisions on selection and retention of items which are usually governed by supporting policies.

Swestore is distributed across the SNIC centres [http://www.c3se.chalmers.se/ C3SE], [http://www.hpc2n.umu.se/ HPC2N], [http://www.lunarc.lu.se/ Lunarc], [http://www.nsc.liu.se/ NSC] and [http://www.uppmax.uu.se Uppmax]. Data is stored in two copies with each copy at a different SNIC centre. This enables the system to cope with a multitude of issues ranging from a simple crash of a storage element to losing an entire site while still providing access to the stored data.

One of the major advantages to the distributed nature of Swestore is the excellent aggregated transfer rates possible. This is achieved by bypassing a central node and having transfers going directly to/from the storage elements if the selected transfer protocol allows it. Swestore can achieve aggregated transfer rates in excess of 100 Gigabit per second, but in practice this is limited by connectivity to the end user, each university or a limited number of files (typically max 1 Gbit/s per file/connection).

To protect against silent data corruption the dCache storage system checksums all stored data and periodically verifies the data using this checksum.

The dCache system does NOT yet provide protection against user errors like inadvertent file deletions.

= Getting access to Swestore=
Before you can access Swestore you need to be a member of a storage project.

== Apply for storage (for the PI) ==
All normal Swestore projects are managed using the [https://supr.snic.se SNIC User and Project Repository portal, SUPR]. Please follow the instructions on the [http://www.snic.se/resources/swestore/ Apply for storage on Swestore] page to apply for storage.

== Apply for project membership (for all users) ==

All project members must register in [https://supr.snic.se SUPR] and be added to the approved project by the PI. This can happen in multiple ways:

* The PI can add you to a project
* You can request membership to a project:
** Log in to [https://supr.snic.se SUPR]
** Click on the ''Projects'' heading in the left hand menu.
** In the ''Request Membership in Project'' section of the page, fill in a project search criteria according to the on-page instructions and click '''Search for Project'''
** Locate the approriate project displayed and click '''Request''' button in the ''Request Membership'' column.
** The PI and any Co-PI will be notified of your request and approve/deny as they deem appropriate.

When your project membership is approved by the PI the Swestore system will map an account for you and add access to the project storage directory. Please wait for up to 10 minutes for this information to be distributed to Swestore.

== Finding the project storage directory name (for all users)==

All Swestore projects are assigned a unique directory name, this is used to locate your storage area.

To find the directory name for a storage project, perform these steps:

* Log in to [https://supr.snic.se SUPR]
* Click on the project ID in the left hand menu.
* The project ''Directory Name'' is shown in the ''Basic Information'' section.

The project storage area is available in the path '''/snic/directory_name/''' on Swestore.

== Set your Swestore password (for users accessing with username/password authentication) ==

The username/password access method is the most common authentication method. It requires you to set a password on your Swestore account.

Follow the instruction on the page [[Setting your Swestore password]].

== Acquire and manage certificate (for users accessing with certificate authentication) ==

Certificate authentication is needed in some special cases, and more convenient for use in automation (ie. Robot certificates).

Some communities require certificate authentication and such users might already have a certificate, that certificate is likely good to use with Swestore.

If you need to use Certificate authentication, follow the instruction on the page [[Certificate Setup for Swestore]].

= Using Swestore =
== Download and upload data ==
=== From the command line ===

There are several command line tools capable of using the protocols provided by Swestore. For usage on SNIC clusters we recommend using the ARC tools which should be installed on all SNIC resources.

As an integration point for building scripts and automated systems we suggest using the curl program and library.

:; Interactive tools
:: Best suited for interactive use with various support for directory listings, wildcards etc.
::;Currently no suitable tools to recommend
:; Command-line tools
:: These tools are also suitable for scripting or automation.
::; rclone
::: Supports multiple protocols.
::: Swestore-specific documentation not written yet. See upstream documentation at https://rclone.org/webdav/
::: Use access URL: https://webdav.swestore.se:1443/
::; cURL
::: Please see the instructions for [[Accessing Swestore with cURL]]. We suggest using this as integration point for building scripts and automated systems.
::; davix
::: Swestore-specific documentation not written yet. See upstream documentation at https://davix.web.cern.ch/davix/docs/master/
::: Use access URL: davs://webdav.swestore.se:1443/
::; ARC
::: Certificate authentication only. Supports multiple protocols.
::: Please see the instructions for [[Accessing Swestore with the ARC client]].
::; gfal2
::: Certificate authentication only. Supports multiple protocols.
::: Swestore-specific documentation not written yet. See upstream documentation at https://dmc.web.cern.ch/projects/gfal-2/documentation
::: Use access URL: gsiftp://gsiftp.swestore.se/
::; https://duck.sh/
::: Command-line client for Windows/macOS/Linux (not documented yet)

=== Using a GUI client ===

Graphical User Interface (GUI) clients are known to work on some operating systems.

:; Cyberduck
:: Please see the instructions for [[Accessing Swestore using Cyberduck]] '''Recommended method on macOS'''
:; WinSCP
:: Please see the instructions for [[Accessing Swestore using WinSCP]] '''Recommended method on Windows'''

=== From a web browser ===

Swestore is accessible in your web browser as a simple directory index interface at https://webdav.swestore.se/.

Web browser access supports both username/password and certificate authentication.

Projects are organized under the <code>/snic</code> directory as <code><nowiki>https://webdav.swestore.se/snic/DIRECTORY_NAME/</nowiki></code>.

==== JavaScript WebDAV client ====

Swestore dCache can also be accessed in your browser, through a JavaScript client, over WebDAV at https://webdav.swestore.se/browser/ .

=== Legacy documentation ===

There are other clients/methods available, but not recommended for new deployments. See [[:Category:Swestore user guide]] for a complete list of documentation.

== Enabled access protocols ==
A design criteria for Swestore is to provide the storage over a number of standardized and public protocols. There is no vendor specific client needed for access.

:; GridFTP
:: Also called gsiftp. Well supported within Swestore.
:: Features: Transfer checksums. Direct transfer from/to storage pools for high speed transfers.
:: Access URL: gsiftp://gsiftp.swestore.se/
:; HTTP/WebDAV
:: Contender for being the recommended protocol for Swestore.
:: Features: Support in web browsers. Supports direct transfer of files from/to storage pools improving performance (varying support in clients).
::; Authenticated access
::: This is the normal read-write access.
::: Access URL: https://webdav.swestore.se/ (non-redirected)
::: Access URL: https://webdav.swestore.se:1443/ (redirected)
::: Access URL: https://webdav.swestore.se:2443/ (redirected reads)
::; Unauthenticated read-only access
::: For special cases only.
::: Access URL: http://webdav.swestore.se/ (unauthenticated, read-only, non-redirected)
::: Access URL: http://webdav.swestore.se:1080/ (unauthenticated, read-only, redirected)
::: Access URL: http://webdav.swestore.se:2080/ (unauthenticated, read-only, redirected reads)
:; NFSv4.1
:: Used by some communities, not recommended for general use
:; SRM - Storage Resource Manager
:: Used by some communities, not recommended for general use.
:: Access URL: srm://srm.swegrid.se/
:; Xrootd
:: Used by some communities, not recommended for general use
:; DCAP
:: Used by some communities, not recommended for general use

== Usage monitoring ==
* On the project page in SUPR: https://supr.snic.se
* On the monitoring server for Swestore: http://status.swestore.se/munin/monitor/monitor/ (only accessible from .se-domains.

= Support =

If you have any issues using Swestore, please do not hesitate to contact [mailto:support@swestore.se support@swestore.se].