From d7fe58167f0e4f9e102e4713389c48392a4d0d3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Pansanel?= Date: Tue, 11 May 2021 20:30:35 +0200 Subject: [PATCH 1/3] Add some details; fix copyright --- irods-fr/conf.py | 10 +-- irods-fr/guide-utilisation-fg-irods.rst | 83 ++++++++++++++++--------- irods-fr/index.rst | 2 +- 3 files changed, 58 insertions(+), 37 deletions(-) diff --git a/irods-fr/conf.py b/irods-fr/conf.py index 8f236ab..7e9c1b4 100644 --- a/irods-fr/conf.py +++ b/irods-fr/conf.py @@ -47,19 +47,19 @@ # General information about the project. project = 'Guide d\'utilisation du service FG-iRODS' -copyright = '2021, CNRS et Université de Strasbourg' -author = 'Jérôme Pansanel' +copyright = '2021, CNRS, Université de Bordeaux et Université de Strasbourg' +author = 'Équipe FG-iRODS' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '1.0' +version = '1.2' # The full version, including alpha/beta/rc tags. -release = '1.0' +release = '1.2' -today = '29 avril 2021' +today = '11 mai 2021' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/irods-fr/guide-utilisation-fg-irods.rst b/irods-fr/guide-utilisation-fg-irods.rst index 2623e1d..2df9083 100644 --- a/irods-fr/guide-utilisation-fg-irods.rst +++ b/irods-fr/guide-utilisation-fg-irods.rst @@ -14,7 +14,7 @@ Biscarat, Pierre Gay et Jérôme Pansanel. La dernière version de ce document est disponible sur : https://github.com/FranceGrilles/user-docs/tree/main/irods-fr. -| Copyright (c) 2021 CNRS et Université de Strasbourg. +| Copyright (c) 2021 CNRS, Université de Bordeaux et Université de Strasbourg. | Ce document est distribué sous la licence `Creative Commons Attribution 4.0 International license `_. @@ -190,18 +190,37 @@ répertoire utilisateur) : * */home/* : votre répertoire personnel +Il est possible de modifier le répertoire sur lequel le client +iRODS se connecte en ajoutant la lignes suivante au fichier +de configuration iRODS : + +.. code-block:: console + + "irods_cwd": "", + "irods_home": "", + +Il faut remplacer ** par le chemin souhaité par +défaut. + Chargement des données ---------------------- -Dans cette section, des fichiers vont être chargés vers FG-iRODS. Tout d'abord, -créez un fichier exemple, tel que ``foo.txt``. +Dans cette section, des fichiers vont être chargés vers FG-iRODS. Le +fichier utilisé pour ces exemples est ``foo.bin``, et peut être +remplacé par un autre fichier de votre choix. Si vous souhaitez travailler +avec le fichier ``foo.bin``, vous pouvez le créer avec la commande +suivante : + +.. code-block:: shell-session + + $ dd if=/dev/urandom of=foo.bin count=65536 Le fichier est copié vers l'infrastructure iRODS avec la commande : .. code-block:: shell-session - $ iput -K foo.txt + $ iput -K foo.bin L'option *-K* permet de vérifier le *checksum* et de le stocker dans la base de données. Il est recommandé de l'utiliser systématiquement. Le fichier @@ -211,20 +230,20 @@ est maintenant disponible sur FG-iRODS : $ ils /FranceGrillesZone/home/: - foo.txt + foo.bin Le fichier peut être supprimé avec la commande suivante : .. code-block:: shell-session - $ irm foo.txt + $ irm foo.bin Espace de nom et chemin physique -------------------------------- iRODS fournit une abstraction de l'emplacement physique des fichiers. -Par exemple, ``/FranceGrillesZone/home//foo.txt`` est le chemin +Par exemple, ``/FranceGrillesZone/home//foo.bin`` est le chemin logique utilisé par iRODS. Pour savoir où sont réellement stockées les données, il faut utiliser l'option **-L** avec la commande **ils** : @@ -232,14 +251,14 @@ les données, il faut utiliser l'option **-L** avec la commande **ils** : $ ils -L /FranceGrillesZone/home/: - 0 mcia;mcia-fgirods1 483 2020-11-20.09:30 & foo.txt - sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//foo.txt + 0 mcia;mcia-fgirods1 33554432 2020-11-20.09:30 & foo.bin + sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//foo.bin Cette commmande nous indique que : - * le fichier ``foo.txt`` est enregistré par FG-iRODS comme : - ``/FranceGrillesZone/home//foo.txt`` ; + * le fichier ``foo.bin`` est enregistré par FG-iRODS comme : + ``/FranceGrillesZone/home//foo.bin`` ; * son propriétaire est ** ; @@ -247,7 +266,7 @@ Cette commmande nous indique que : * il n'y a qu'un seul réplica, dont l'identifiant est *0* ; - * sa taille est de 483 octets ; + * sa taille est de 33554432 octets ; * son *checksum* a été enregistré (*sha:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8=*). @@ -259,9 +278,9 @@ Le fichier stocké dans FG-iRODS peut être téléchargé avec : .. code-block:: shell-session - $ iget -K foo.txt foo-restore.txt + $ iget -K foo.bin foo-restore.txt -Le fichier ``foo.txt`` a été téléchargé et nommé ``foo-restore.txt``. +Le fichier ``foo.bin`` a été téléchargé et nommé ``foo-restore.txt``. Avec l'option **-K** option, le *checksum* du fichier local est comparé avec le *checksum* du fichier sur FG-iRODS. @@ -282,16 +301,16 @@ Pour créer une collection iRODS : $ imkdir mycollection -Le fichier ``foo.txt`` peut être déplacé dans la collection +Le fichier ``foo.bin`` peut être déplacé dans la collection *mycollection* avec : .. code-block:: shell-session - $ imv foo.txt mycollection + $ imv foo.bin mycollection $ ils -L mycollection /FranceGrillesZone/home//mycollection: - 0 mcia;mcia-fgirods1 483 2020-11-20.10:18 & foo.txt - sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//mycollection/foo.txt + 0 mcia;mcia-fgirods1 33554432 2020-11-20.10:18 & foo.bin + sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//mycollection/foo.bin Vous pouver voir que le chemin logique de la collection ``/FranceGrillesZone/home//mycollection`` a un @@ -307,8 +326,7 @@ Les données peuvent être chargées directement dans une collection : $ ils /FranceGrillesZone/home//mycollection /FranceGrillesZone/home//mycollection: bar.txt - foo.txt - + foo.bin L'option **-r** permet un chargement récursif. @@ -316,7 +334,9 @@ L'option **-r** permet un chargement récursif. Naviguer à travers les collections ++++++++++++++++++++++++++++++++++ -Pour afficher votre répertoire courant sur iRODS, utilisez : +Le répertoire courant de travail correspond à l'emplacement sur lequel +vous vous trouvez dans l'arborescence iRODS. Pour afficher votre répertoire +courant sur iRODS, utilisez : .. code-block:: shell-session @@ -325,8 +345,9 @@ Pour afficher votre répertoire courant sur iRODS, utilisez : Si vous ne spécifiez pas le chemin complet, mais uniquemenet un chemin relatif tel que ``mycollection/``, iRDS utilise automatiquement -le répertoire courant de travail comme préfixe. Le répertoire courant -de travail peut être modifié avec : +le répertoire courant de travail comme préfixe. Vous pouvez vous déplacer +dans l'arborescence et modifier ce répertoire courant de travail avec la +commande **icd** : .. code-block:: shell-session @@ -349,14 +370,14 @@ recherchés. Les métadonnées sont ajoutées avec la commande : .. code-block:: shell-session - $ imeta add -d foo.txt 'length' '20' 'words' + $ imeta add -d foo.bin 'length' '20' 'words' Le champs *Unit* peut être vide : .. code-block:: shell-session - $ imeta add -d foo.txt 'project' 'example' + $ imeta add -d foo.bin 'project' 'example' Les métadonnnées peuvent également être ajoutées à une collection : @@ -373,8 +394,8 @@ faut entrer : .. code-block:: shell-session - $ imeta ls -d foo.txt - AVUs defined for dataObj /FranceGrillesZone/home//mycollection/foo.txt: + $ imeta ls -d foo.bin + AVUs defined for dataObj /FranceGrillesZone/home//mycollection/foo.bin: attribute: length value: 20 units: words @@ -400,7 +421,7 @@ est effectuée avec la commande suivante : $ imeta qu -d 'length' = '20' collection: /FranceGrillesZone/home//mycollection - dataObj: foo.txt + dataObj: foo.bin @@ -457,7 +478,7 @@ d'accès à la collection actuelle : Inheritance - Disabled bar.txt ACL - #FranceGrillesZone:own - foo.txt + foo.bin ACL - #FranceGrillesZone:own @@ -475,7 +496,7 @@ La modification des droits d'accès pour autoriser un collègue à accéder .. code-block:: shell-session - $ ichmod read foo.txt + $ ichmod read foo.bin L'utilisateur ** peut maintenant accéder en lecture au -fichier ``foo.txt``. +fichier ``foo.bin``. diff --git a/irods-fr/index.rst b/irods-fr/index.rst index eac6179..da6e779 100644 --- a/irods-fr/index.rst +++ b/irods-fr/index.rst @@ -1,5 +1,5 @@ .. - Copyright 2021 CNRS and University of Strasbourg + Copyright 2021 CNRS, University of Bordeaux and University of Strasbourg This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit From 7e542865fe135e3fb59defb2706f081ea318a188 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Pansanel?= Date: Wed, 12 May 2021 19:44:57 +0200 Subject: [PATCH 2/3] Release v1.2 --- irods-en/conf.py | 12 +- irods-en/fg-irods-user-guide.rst | 314 +++++++++++++++++++------------ irods-en/index.rst | 2 +- 3 files changed, 199 insertions(+), 129 deletions(-) diff --git a/irods-en/conf.py b/irods-en/conf.py index 5d4dd8a..41feaf1 100644 --- a/irods-en/conf.py +++ b/irods-en/conf.py @@ -47,17 +47,19 @@ # General information about the project. project = 'FG-iRODS User Guide' -copyright = '2021, CNRS and University of Strasbourg' -author = 'Jérôme Pansanel' +copyright = '2021, CNRS, University of Bordeaux and University of Strasbourg' +author = 'FG-iRODS Team' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '1.0' +version = '1.2' # The full version, including alpha/beta/rc tags. -release = '1.0' +release = '1.2' + +today = '12 mai 2021' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -140,7 +142,7 @@ # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'fg-irods-user-guide.tex', 'FG-iRODS User Guide', - 'Jérôme Pansanel', 'manual'), + 'FG-iRODS Team', 'manual'), ] diff --git a/irods-en/fg-irods-user-guide.rst b/irods-en/fg-irods-user-guide.rst index 75649b9..876ade8 100644 --- a/irods-en/fg-irods-user-guide.rst +++ b/irods-en/fg-irods-user-guide.rst @@ -1,54 +1,73 @@ +Introduction +============ + About this document -=================== +------------------- This document describes the use of the `iRODS `_ -client with the `France Grilles iRODS service +client with the `iRODS-based service `_ -(FG-iRODS). +(FG-iRODS) provided by France Grilles. It is based on the online +documentation written by Catherine Biscarat, Pierre Gay and Jérôme +Pansanel. The last version of this document is made available on: https://github.com/FranceGrilles/user-docs/tree/main/irods-en. -| Copyright (c) 2021 CNRS and University of Strasbourg. +| Copyright (c) 2021 CNRS, University of Bordeaux and University of Strasbourg. | This document is licensed under a `Creative Commons Attribution 4.0 International license `_. -FG-iRODS -======== +The FG-iRODS service +-------------------- + +The FG-iRODS service, provided by the `France Grilles `_ +French Research Infrastructure, aims to provide a convenient way to manage +research data. It is composed of the following elements: + +* a highly available storage infrastructure which permit to distribute the + data geographically ; + +* the iRODS software ; -The FG-iRODS service is proposed by the French `France-Grilles `_ -Research Infrastructure. Access to the service is nominative and is -available on request to info@france-grilles.fr. Once access to the service -has been validated by the France-Grilles team, you will be able to access -the service with your certificate or with your password. +* a dedicated user support ; -To access the service, you will be asked to: +* a set of tools to make the solution simple to use -* Sign the conditions of access to the service: http://www.france-grilles.fr/IMG/pdf/iRODS_Service_Policy.pdf; +The access to the service is nominative and realised through a simple +application sent to `info@france-frilles.fr `_. +Once the application is processed, and before the account creation, the +following additionnal information are requested: -* Provide a data management plan (the template is free, France Grilles needs - only the information concerning it as a service provider). +* to sign the policies of the service: http://www.france-grilles.fr/IMG/pdf/iRODS_Service_Policy.pdf; -At the end of the registration procedure, you will be provided with a contact -for your support. +* to provide a light data management plan (DMP). Several examples of DMP + are made available by DMP OPIDoR ``_. +At the end of the registration procedure, the access to the service is open +to the requester and the documentation of the service is sent to the users. -Getting Started -=============== + +Client Installation +=================== Prerequisite ------------ -The user needs an access to a computer with a GNU/Linux system. The -installation of the iRODS client is detailed in the next section. +The user needs an access to a computer with a GNU/Linux operating system, +like CentOS 7 or Ubuntu (16.04, 18.04). He needs also to have the right +to install new softwares on this system. + Environment ----------- -First, create the *~/irods/irods_environment.json* file with the following content: +The iRODS CLI client use a file for storing most of the configuration +details. This file is ``~/irods/irods_environment.json`` and need to +be created with the following content: -:: +.. code-block:: console { "irods_host": "ccirodsfg.in2p3.fr", @@ -73,19 +92,19 @@ The ** and ** should be replaced by the values given to you during the registration procedure. -Client Installation -------------------- +Package Installation +-------------------- The client packages are made available for CentOS 7, Ubuntu 16.04 and Ubuntu 18.04. Instructions for configuring your package manager to include the iRODS *APT* or -*YUM*-based repository may be found at https://packages.irods.org. +*YUM*-based repository can be found at https://packages.irods.org. Once the repository has been configured, install the *irods-icommands* package. Check that your client installation is working with: -:: +.. code-block:: shell-session ~$ iinit @@ -96,7 +115,7 @@ finished working with FG-iRODS, you can close the session with The **ienv** command display your iRODS environment: -:: +.. code-block:: console irods_version - 4.2.8 irods_client_server_negotiation - request_server_negotiation @@ -122,12 +141,15 @@ The **ienv** command display your iRODS environment: Using the FG-iRODS service ========================== +Interactive Help +---------------- + **ihelp** permits to display the list of iRODS commands, as well as the help on a specific command: -:: +.. code-block:: shell-session - ~$ ihelp ils + $ ihelp ils Usage: ils [-ArlLv] dataObj|collection ... Usage: ils --bundle [-r] dataObj|collection ... Display data Objects and collections stored in irods. @@ -145,16 +167,18 @@ help on a specific command: iRODS Version 4.2.8 ils -A full description of the icommands is available in the `iRODS documentation `_. +A full description of the icommands is available in the +`iRODS documentation `_. The Working Directory --------------------- -The **ils** command permits you to display the data in your iRODS-home -directory. +The **ils** command permits you to display the content of the current +working directory. By default, the working directory is your user +directory : -:: +.. code-block:: shell-session ~$ ils /FranceGrillesZone/home/: @@ -163,72 +187,98 @@ directory. * */home/*: your default working directory +It is possible to modify the default directory used when you connect +by adding the following lines to your iRODS configuration file : + +.. code-block:: console + + "irods_cwd": "", + "irods_home": "", + +The value of ** needs to be replaced by the desired path. + + Uploading Data -------------- -In this section, some files will be uploaded to iRODS. First, create an -example file, like ``foo.txt``. +In this section, some files will be uploaded to FG-iRODS. The file used +in the following examples is ``foo.bin``. It can be replaced by a file +of your choice. If you want to work with the ``foo.bin`` file, you can +create it with the following command: -The file is uploaded to the iRODS server: +.. code-block:: shell-session -:: + $ dd if=/dev/urandom of=foo.bin count=65536 - iput -K foo.txt +The file is uploaded to the iRODS infrastructure with: -The *-K* option permits to verify the checksum. The file is now -available on the iRODS server: +.. code-block:: shell-session -:: + $ iput -K foo.bin - ~$ ils +The *-K* option permits to verify the checksum and to store it in the +iRODS database. It is recommanded to always use this option. The file is +now available on FG-iRODS: + +.. code-block:: shell-session + + $ ils /FranceGrillesZone/home/: - foo.txt + foo.bin **Note:** the commands to steer iRODS are very similar to bash commands and can easily be confused! The file can be deleted with this command: -:: +.. code-block:: shell-session - irm foo.txt + $ irm foo.bin Logical and Physical Namespace ------------------------------ iRODS provides an abstraction from the physical location of the files, -e.g. ``/FranceGrillesZone/home//foo.txt`` is the logical path +e.g. ``/FranceGrillesZone/home//foo.bin`` is the logical path which only iRODS knows. To get more details about the physical namespace, -use: +use the **-L** option with the **ils** command: -:: +.. code-block:: shell-session - ~$ ils -L + $ ils -L /FranceGrillesZone/home/: - 0 mcia;mcia-fgirods1 483 2020-11-20.09:30 & foo.txt - sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//foo.txt + 0 mcia;mcia-fgirods1 33554432 2020-11-20.09:30 & foo.bin + sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//foo.bin + +The result of this command indicate us that: + + * file ``foo.bin`` is registered by FG-iRODS as + ``/FranceGrillesZone/home//foo.bin``; + + * its owner is **; + + * it lies on the storage resource *mcia*; + + * there is only a single replica, with the id *0*; + * the file has a size of 33554432 bytes; -The file ``foo.txt`` that bas been uploaded is known in iRODS as ``/FranceGrillesZone/home//foo.txt``. -It is owned by the user ** and lies on the storage resource -*mcia*. There is no other replica of that file in the iRODS system (0 -in front of *mcia*). The size of the file is 483B. It is stored with a -time stamp and a checksum. Actually, the checksum calculation was -triggered by the option '-K' of the **iput** command. + * its checksum has been registered + (*sha:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8=*); Downloading Data ---------------- -The file stored in iRODS can be downloaded with: +The file stored in FG-iRODS can be downloaded with: -:: +.. code-block:: shell-session - ~$ iget -K foo.txt foo-restore.txt + $ iget -K foo.bin foo-restore.txt -The ``foo.txt`` file has been downloaded and renamed to ``foo-restore.txt``. +The ``foo.bin`` file has been downloaded and renamed to ``foo-restore.txt``. With the *-K* option, the checksum of the local file is compared with the checksum of the file on the iRODS server. @@ -244,34 +294,35 @@ organising them the same way. However, folders are called *collections*. To create an iRODS collection: -:: +.. code-block:: shell-session - ~$ imkdir mycollection + $ imkdir mycollection -The ``foo.txt`` file can be moved to that collection with: +The ``foo.bin`` file can be moved to that collection with: -:: +.. code-block:: shell-session - ~$ imv foo.txt mycollection - ~$ ils -L mycollection + $ imv foo.bin mycollection + $ ils -L mycollection /FranceGrillesZone/home//mycollection: - 0 mcia;mcia-fgirods1 483 2020-11-20.10:18 & foo.txt - sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//mycollection/foo.txt + 0 mcia;mcia-fgirods1 33554432 2020-11-20.10:18 & foo.bin + sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//mycollection/foo.bin -You see that the logical iRODS collection ``/FranceGrillesZone/home//mycollection`` -has the physical counterpart ``/vault1/resc/home//mycollection``. +You see that the logical iRODS collection +``/FranceGrillesZone/home//mycollection`` has the physical +counterpart ``/vault1/resc/home//mycollection``. So data does not end up on the iRODS server randomly but follows the structure. Data can also be put directly into an iRODS collection: -:: +.. code-block:: shell-session - ~$ iput -K -r bar.txt mycollection - ~$ ils /FranceGrillesZone/home//mycollection + $ iput -K -r bar.txt mycollection + $ ils /FranceGrillesZone/home//mycollection /FranceGrillesZone/home//mycollection: bar.txt - foo.txt + foo.bin The *-r* flag can be used for recursive upload. @@ -280,20 +331,23 @@ The *-r* flag can be used for recursive upload. Navigating through Collections ++++++++++++++++++++++++++++++ -To get your current iRODS working directory, use: +The current working directory corresponds to the place where you are +working in the folder hierarchy of iRODS. To display your current +iRODS working directory, use: -:: +.. code-block:: shell-session - ~$ ipwd + $ ipwd /FranceGrillesZone/home/ -If you do not specify a full path, but only a partial path like ``mycollection/``, -iRDS automatically uses the current working directory as a prefix. This -directory can be modified with: +If you do not specify a full path, but only a partial path like +``mycollection/``, iRODS automatically uses the current working +directory as a prefix. You can move along the folder hierarchy and +modify your current working directory with the **icd** command: -:: +.. code-block:: shell-session - ~$ icd mycollection + $ icd mycollection Managing Metadata @@ -308,22 +362,22 @@ Each file can be annoted with *Attribute*, *Value*, *Unit* triples (AVU). These triples are added to the iRODS database (iCAT) and are searchable. Metadata can be added to a file with: -:: +.. code-block:: shell-session - ~$ imeta add -d foo.txt 'length' '20' 'words' + $ imeta add -d foo.bin 'length' '20' 'words' -The Unit field can be empty: +The *Unit* field can be empty: -:: +.. code-block:: shell-session - ~$ imeta add -d foo.txt 'project' 'example' + $ imeta add -d foo.bin 'project' 'example' Metadata can also be added to a collection: -:: +.. code-block:: shell-session - ~$ imeta add -C mycollection 'author' 'John Smith' + $ imeta add -C mycollection 'author' 'John Smith' Listing Metadata @@ -331,17 +385,17 @@ Listing Metadata To list metadata on data objects (files), do: -:: +.. code-block:: shell-session - ~$ imeta ls -d foo.txt - AVUs defined for dataObj /FranceGrillesZone/home//mycollection/foo.txt: + $ imeta ls -d foo.bin + AVUs defined for dataObj /FranceGrillesZone/home//mycollection/foo.bin: attribute: length value: 20 units: words and the following on collections: -:: +.. code-block:: shell-session ~$ imeta ls -C mycollection AVUs defined for collection /FranceGrillesZone/home//mycollection: @@ -350,40 +404,52 @@ and the following on collections: units: - Querying Metadata +++++++++++++++++ -To query the iCAT metadata catalogue, the **iquest** is used: +To query the iCAT metadata catalogue, use the following command: -:: +.. code-block:: shell-session - ~$ iquest "select COLL_NAME, META_COLL_ATTR_VALUE where META_COLL_ATTR_NAME like 'author'" - COLL_NAME = /FranceGrillesZone/home//mycollection - META_COLL_ATTR_VALUE = John Smith - ------------------------------------------------------------ + $ imeta qu -d 'length' = '20' + collection: /FranceGrillesZone/home//mycollection + dataObj: foo.bin -If you are looking for a data object rather than a collection, replace -the *META_COLL_ATTR_NAME* attribute with *META_DATA_ATTR_NAME*. There -are a lot of predefined attributes that can be used in your searches: +Advanced search ++++++++++++++++ -:: +In order to perform a more accurate selection of files or collections, +it is possible to directly interact with the iCAT catalogue with the +**iquest** command: - ~$ iquest attrs +.. code-block:: shell-session + $ iquest "select COLL_NAME, META_COLL_ATTR_VALUE where META_COLL_ATTR_NAME like 'author'" + COLL_NAME = /FranceGrillesZone/home//mycollection + META_COLL_ATTR_VALUE = John Smith + ------------------------------------------------------------ -The output can be filtered for a specific attribute value: +The results can be filtered with one or more attributes: -:: +.. code-block:: shell-session - ~$ iquest "select COLL_NAME, META_COLL_ATTR_VALUE where META_COLL_ATTR_NAME like 'author' \ + $ iquest "select COLL_NAME, META_COLL_ATTR_VALUE where META_COLL_ATTR_NAME like 'author' \ and META_COLL_ATTR_VALUE like 'John%'" COLL_NAME = /FranceGrillesZone/home//mycollection META_COLL_ATTR_VALUE = John Smith ------------------------------------------------------------ +**NOTE**: the '%' symbol is a wildcard. + +If you are looking for a data object rather than a collection, replace +the *META_COLL_ATTR_NAME* attribute with *META_DATA_ATTR_NAME*. There +are a lot of predefined attributes that can be used in your searches. +To display the list of these attributes, use: + +.. code-block:: shell-session + + $ iquest attrs -**NOTE**: the '%' is a wildcard. Access Control -------------- @@ -392,30 +458,32 @@ iRODS has similar Access Control Lists (ACL) as a unix file system, with read, write and own rights. The current access rights of your data can be checked with: -:: + .. code-block:: shell-session - ~$ ils -r -A + $ ils -r -A /FranceGrillesZone/home//mycollection: ACL - jpansanel#FranceGrillesZone:own Inheritance - Disabled bar.txt ACL - #FranceGrillesZone:own - foo.txt + foo.bin ACL - #FranceGrillesZone:own -After the *ACL* keyword, the rights are specified. In this case, -** owns all files listed. None else has access rights. +The access rights are specified after the *ACL* keyword. In this example, +** owns all files listed. No one else can access the files. + +Collections have a *Inheritance* attribut. If this value of this attribut +is set to *Enabled*, all content of the collection will inherit the access +rights from the collection. The inheritance applies only to newly uploaded files. -Collections have a *Inheritance* flag. If this flag is set to true, -all content of the folder will inherit the accession rights from the -folder. The inheritance applies only to newly uploaded files. +To give read access to a file to a colleague, use the following command: -To add accession rights to a colleague: +.. code-block:: shell-session -:: - ~$ ichmod read foo.txt + $ ichmod read foo.bin -The user `` can now access the ``foo.txt`` file. +The user ** can now access the ``foo.bin`` file, but it will not +be able to modify or delete it. diff --git a/irods-en/index.rst b/irods-en/index.rst index ea25dba..d8bf47f 100644 --- a/irods-en/index.rst +++ b/irods-en/index.rst @@ -1,5 +1,5 @@ .. - Copyright 2021 CNRS and University of Strasbourg + Copyright 2021 CNRS, University of Bordeaux and University of Strasbourg This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit From 41ab608d51df40c9f06b1038cab54e926a21c7e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Pansanel?= Date: Wed, 12 May 2021 19:45:16 +0200 Subject: [PATCH 3/3] Release v1.2 FR --- irods-fr/conf.py | 2 +- irods-fr/guide-utilisation-fg-irods.rst | 32 ++++++++++++------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/irods-fr/conf.py b/irods-fr/conf.py index 7e9c1b4..78d2ae6 100644 --- a/irods-fr/conf.py +++ b/irods-fr/conf.py @@ -142,7 +142,7 @@ # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'guide-utilisation-fg-irods.tex', 'Guide d\'utilisation du service FG-iRODS', - 'Jérôme Pansanel', 'manual'), + 'Équipe FG-iRODS', 'manual'), ] diff --git a/irods-fr/guide-utilisation-fg-irods.rst b/irods-fr/guide-utilisation-fg-irods.rst index 2df9083..b787b62 100644 --- a/irods-fr/guide-utilisation-fg-irods.rst +++ b/irods-fr/guide-utilisation-fg-irods.rst @@ -42,7 +42,7 @@ aux utilisateurs : * de signer les conditions d'accès au service FG-iRODS : http://www.france-grilles.fr/IMG/pdf/iRODS_Service_Policy.pdf ; * de fournir un plan de gestion de données (PGD). Plusieurs exemples de PGD - sont disponibles sur le site de DMP OPIDoR ``_ . + sont disponibles sur le site de DMP OPIDoR ``_. Une fois les documents reçus, l'accès au service est ouvert, les identifiants et la documentation du service transmis aux @@ -65,7 +65,7 @@ Environnement Le client en ligne de commande iRODS utilise un fichier pour stocker la configuration pour se connecter à l'infrastructure iRODS. Ce fichier -est *~/irods/irods_environment.json* et doit être créé avec le contenu +est ``~/irods/irods_environment.json`` et doit être créé avec le contenu suivant : .. code-block:: console @@ -144,8 +144,8 @@ La commande **ienv** affiche l'environnement iRODS : Utilisation du service FG-iRODS =============================== -Aide en ligne -------------- +Aide interactive +---------------- **ihelp** permet d'afficher la liste des commandes iRODS, ainsi que l'aide sur une commande spécifique : @@ -207,7 +207,7 @@ Chargement des données ---------------------- Dans cette section, des fichiers vont être chargés vers FG-iRODS. Le -fichier utilisé pour ces exemples est ``foo.bin``, et peut être +fichier utilisé pour ces exemples est ``foo.bin``, il peut être remplacé par un autre fichier de votre choix. Si vous souhaitez travailler avec le fichier ``foo.bin``, vous pouvez le créer avec la commande suivante : @@ -255,7 +255,7 @@ les données, il faut utiliser l'option **-L** avec la commande **ils** : sha2:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8= generic /vault1/resc/home//foo.bin -Cette commmande nous indique que : +Le résultat de cette commande nous indique que : * le fichier ``foo.bin`` est enregistré par FG-iRODS comme : ``/FranceGrillesZone/home//foo.bin`` ; @@ -268,7 +268,8 @@ Cette commmande nous indique que : * sa taille est de 33554432 octets ; - * son *checksum* a été enregistré (*sha:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8=*). + * son *checksum* a été enregistréi + (*sha:veVzp+ApMzyVRzZN0BZIkDyFuqUp/4tM4sLVACp00B8=*). Téléchargement de données @@ -335,7 +336,7 @@ Naviguer à travers les collections ++++++++++++++++++++++++++++++++++ Le répertoire courant de travail correspond à l'emplacement sur lequel -vous vous trouvez dans l'arborescence iRODS. Pour afficher votre répertoire +vous travaillez dans l'arborescence iRODS. Pour afficher votre répertoire courant sur iRODS, utilisez : .. code-block:: shell-session @@ -343,7 +344,7 @@ courant sur iRODS, utilisez : $ ipwd /FranceGrillesZone/home/ -Si vous ne spécifiez pas le chemin complet, mais uniquemenet un chemin +Si vous ne spécifiez pas le chemin complet, mais uniquement un chemin relatif tel que ``mycollection/``, iRDS utilise automatiquement le répertoire courant de travail comme préfixe. Vous pouvez vous déplacer dans l'arborescence et modifier ce répertoire courant de travail avec la @@ -373,13 +374,13 @@ recherchés. Les métadonnées sont ajoutées avec la commande : $ imeta add -d foo.bin 'length' '20' 'words' -Le champs *Unit* peut être vide : +Le champ *Unit* peut être vide : .. code-block:: shell-session $ imeta add -d foo.bin 'project' 'example' -Les métadonnnées peuvent également être ajoutées à une collection : +Les métadonnées peuvent également être ajoutées à une collection : .. code-block:: shell-session @@ -412,7 +413,7 @@ et pour une collection, la commande suivante : Recherche avec les métadonnées ------------------------------- +++++++++++++++++++++++++++++++ La recherche de fichiers ou de collections à l'aide des métadonnées est effectuée avec la commande suivante : @@ -424,9 +425,8 @@ est effectuée avec la commande suivante : dataObj: foo.bin - Recherche avancée ------------------ ++++++++++++++++++ Afin d'effectuer une recherche plus fine de fichiers ou de collections, il est possible d'interroger directement le catalogue iCAT avec la @@ -439,7 +439,7 @@ commande **iquest** : META_COLL_ATTR_VALUE = John Smith ------------------------------------------------------------ -Les résultats peuvent être filtrés en fonction d'une valeur spécifique : +Les résultats peuvent être filtrés à l'aide d'un ou plisusieurs attributs : .. code-block:: shell-session @@ -450,7 +450,7 @@ Les résultats peuvent être filtrés en fonction d'une valeur spécifique : ------------------------------------------------------------ -**NOTE**: le caractère '%' est un caractère générique (*wildcard*). +**NOTE** : le caractère '%' est un caractère générique (*wildcard*). Si vous recherchez un objet de données plutôt qu'une collection, il faut remplacer *META_COLL_ATTR_NAME* par *META_DATA_ATTR_NAME*. De