Merge branch 'dvo0012-dice-patch' into 'master'

Dvo0012 dice patch

See merge request sccs/docs.it4i.cz!393

docs.it4i/config.yml

+host: irods1.it4i.cz
+port: 1247
+proxy_user: some_user
+client_user: some_user
+zone: IT4I
+
+authscheme: "pam"
+ssl_ca_cert_file: "~/irods1.it4i.cz.crt"
+ssl_encryption_key_size: 32
+ssl_encryption_algorithm: "AES-256-CBC"
+ssl_encryption_salt_size: 8
+ssl_encryption_hash_rounds: 16
+
+path_mappings:
+  - irods_path: /IT4I/home/some_user
+    mapping_path: /
+    resource_type: dir

docs.it4i/dice.md

@@ -18,11 +18,7 @@ The integrated Rule-Oriented Data System (iRODS) is an open source data manageme
 
 We have to be sure about your identity, this will be done throught this steps:
 
-- at the first, fill this request for [EUDAT][h]
-
-![](img/eudat_request.jpg)
-
-- sign to [MyAccessID][g] , after that, please create account at [B2ACCESS][d] , pages requests valid personal certificate (e.g from GEANT)
+- sign in with your organisation [B2ACCESS][d] , pages requests valid personal certificate (e.g from GEANT) . Account with "Low" level of assurance, will not have access to IT4I zone
 
 - confirm your certificate in browser
 
@@ -36,18 +32,21 @@ We have to be sure about your identity, this will be done throught this steps:
 
 ![](img/eudat.jpg)
 
-- after successfull login to B2Access, please sign in to our [AAI][f] throught your B2Access account. You can set new password. this new password will work for cyberduck and icommands.
+- after successfull login to B2Access, please sign in to our [AAI][f] throught your B2Access account. You have to set new password - it is for iRods access.
 
 ![](img/aai.jpg)
 ![](img/aai2.jpg)
 ![](img/aai3-passwd.jpg)
 
-- finally, contact our support@it4i.cz by mail, we will create your account at our iRODS server.
+- contact our support@it4i.cz by mail, we will create your account at our iRODS server.
+- fill this request for [EUDAT][h], please specify requested capacity.
+- ![](img/eudat_request.jpg)
 
-### ***IT4I User (You Have IT4I Account With Access to Cluster Already)***
+## ***Access to iRods Collection From Karolina***
 
+- access to cluster is must (it4i account)
 - iRODS clients are provided as a module on our ***Karolina*** cluster ( Barbora is in progress )
-- module irodsfs contains config file for irodsfs nad for icommands too
+- module irodsfs loads config file for irodsfs nad for icommands too
 - PAM passwords is password, you set in aai.it4i.cz
 
 ***How to mount your collection***
@@ -57,7 +56,6 @@ ssh some_user@karolina.it4i.cz
 ml irodsfs
 ```
 
-- config files for irodsfs and icommands will be loaded
 - now you can choose between Fuse client or iCommands
 
 ***Fuse***
@@ -95,7 +93,7 @@ To unmount it, run
 fusermount -u ~/IRODS
 ```
 
-you can work with fuse as an ordinary directory  ( ls, cd, cp, mv etc )
+- you can work with fuse as an ordinary directory  ( `ls, cd, cp, mv` etc )
 
 ***iCommands***
 
@@ -108,12 +106,10 @@ irodsfs configuration file has been created at /home/dvo0012/.irods/config.yml.
 iCommands environment file has been created at /home/$USER/.irods/irods_environment.json.
       to start iCommands run: iinit
 
-[some_use@login4.karolina ~]$ iinit
+[some_user@login4.karolina ~]$ iinit
 Enter your current PAM password:
 ```
 
-- put you password you set in keycloak
-
 ```console
 [some_use@login4.karolina ~]$ ils
 /IT4I/home/some_user:
@@ -126,66 +122,44 @@ Enter your current PAM password:
 - upload `iput` , download `iget`
 - for more help, type `ihelp`
 
-### ***Users Without IT4I Account (No Access to Cluster)***
+## ***Access to iRods Collection From Other Resource***
 
 - we suppose, you will upload your data from your local pc/vm
+- password from [AAI][f]
 
-#### You Need a Client to Connect to iRods Server
+### You Need a Client to Connect to iRods Server
 
 - There are many iRods clients, but we recommend theese:
-- Cyberduck - for windows / mac, GUI . Password from aai.it4i.cz (keycloak) works
+- Cyberduck - for windows / mac, GUI .
 - Fuse (irodsfs lite) - for linux, cli
-- iCommands - for linux, cli . Password from aai.it4i.cz (keycloak) works
+- iCommands - for linux, cli .
+- for access set PAM passwords at [AAI][f]
 
-#### Cyberduck
+### Cyberduck
 
-- download at [https://cyberduck.io/download/][i]
-- download connection profile for IT4I irods server [irods.cyberduckprofile][1]
-- left doubleclick at this profile file opens connection
+- download [Cyberduck][i]
+- download [connection profile][1] for IT4I irods server
+- left doubleclick at this file opens connection
 
 ![](img/irods-cyberduck.jpg)
 
-#### Irodsfs Lite
+### Fuse
 
 - work with your irods collection like ordinary directory
 - this is linux client only, basic knowledge of commandline is neccessary
-- PAM passwords is password, you set in aai.it4i.cz
 
 ```console
 cd ~
-wget https://docs.it4i.cz/irods1.it4i.cz.crt [k]
+wget https://docs.it4i.cz/irods1.it4i.cz.crt[k]
 wget https://github.com/cyverse/irodsfs/releases/download/v0.7.6/irodsfs_amd64_linux_v0.7.6.tar
 tar -xvf ~/irodsfs_amd64_linux_v0.7.6.tar
-mkdir ~/IRODS
+mkdir ~/IRODS ~/.irods
+cd ~/.irods && wget https://docs.it4i.cz/config.yml[3]
 ```
 
-settings:
+- edit `~/.irods/config.yml` with apropriate username
 
-```console
-[some_user@local_pc ~]$ vim ~/.rods/config.yml
-```
-
-```console
-host: irods1.it4i.cz
-port: 1247
-proxy_user: some_user
-client_user: some_user
-zone: IT4I
-
-authscheme: "pam"
-ssl_ca_cert_file: "~/irods1.it4i.cz.crt"
-ssl_encryption_key_size: 32
-ssl_encryption_algorithm: "AES-256-CBC"
-ssl_encryption_salt_size: 8
-ssl_encryption_hash_rounds: 16
-
-path_mappings:
-  - irods_path: /IT4I/home/some_user
-    mapping_path: /
-    resource_type: dir
-```
-
-***How to start - mount your collection:***
+***How to mount your collection:***
 
 ```console
 [some_user@local_pc ~]$ ./irodsfs -config ~/.irods/config.yml ~/IRODS
@@ -220,41 +194,23 @@ total 0
 [some_user@local_pc ~]$ fusermount -u ~/IRODS
 ```
 
-#### iCommands
+### iCommands
 
 - this is linux client only, basic knowledge of commandline is neccessary
 - manual is for centos7
 - for ubuntu20 - there is [http://docs.snic.se/wiki/IRODS_iCommands_installation_on_Ubuntu_20.04#Authenticate_and_test_iRODS_iCommands_client][j]
-- ***please do NOT install icommands 4.3.0, it is NOT working with PAM***
 
 ```console
 sudo rpm --import https://packages.irods.org/irods-signing-key.asc
 sudo wget -qO - https://packages.irods.org/renci-irods.yum.repo | sudo tee /etc/yum.repos.d/renci-irods.yum.repo
 sudo yum install epel-release -y
 sudo yum install python-psutil python-jsonschema
-sudo yum install irods-icommands-4.2.7-1.x86_64
-mkdir ~/.irods/
-cd ~ && wget https://docs.it4i.cz/irods1.it4i.cz.crt [k]
+sudo yum install irods-icommands
+cd ~ && wget https://docs.it4i.cz/irods1.it4i.cz.crt[k]
+mkdir ~/.irods/ && cd "$_" && wget https://docs.it4i.cz/irods_environment.json[2]
 ```
 
-Copy&paste + edit ***irods_user_name***
-
-```console
-[some_user@local_pc ~]$ vim ~/.irods/irods_environment.json
-{
-    "irods_host": "irods1.it4i.cz",
-    "irods_port": 1247,
-    "irods_user_name": "some_user",
-    "irods_zone_name": "IT4I",
-    "irods_authentication_scheme": "PAM",
-    "irods_ssl_verify_server": "cert",
-    "irods_ssl_ca_certificate_file": "~/irods1.it4i.cz.crt",
-    "irods_encryption_algorithm": "AES-256-CBC",
-    "irods_encryption_key_size": 32,
-    "irods_encryption_num_hash_rounds": 16,
-    "irods_encryption_salt_size": 8
-}
-```
+- edit ***irods_user_name*** in `~/.irods/irods_environment.json`
 
 ```console
 [some_user@local_pc ~]$ pwd
@@ -303,12 +259,13 @@ ls -la ~
 For more commands, use the `ihelp` command.
 
 [1]: irods.cyberduckprofile
+[2]: irods_environment.json
+[3]: config.yml
 
 [b]: http://www.diceproject.eu/
 [c]: https://irods.org/
 [d]: https://b2access.eudat.eu/
 [f]: https://aai.it4i.cz/realms/IT4i_AAI/account/#/
-[g]: https://mms.myaccessid.org/profile/
 [h]: https://www.eudat.eu/contact-support-request?Service=B2SAFE
 [i]: https://cyberduck.io/download/
 [j]: http://docs.snic.se/wiki/IRODS_iCommands_installation_on_Ubuntu_20.04#Authenticate_and_test_iRODS_iCommands_client

docs.it4i/irods_environment.json

+{
+    "irods_host": "irods1.it4i.cz",
+    "irods_port": 1247,
+    "irods_user_name": "some_user",
+    "irods_zone_name": "IT4I",
+    "irods_authentication_scheme": "pam_password",
+    "irods_ssl_verify_server": "cert",
+    "irods_ssl_ca_certificate_file": "~/irods1.it4i.cz.crt",
+    "irods_encryption_algorithm": "AES-256-CBC",
+    "irods_encryption_key_size": 32,
+    "irods_encryption_num_hash_rounds": 16,
+    "irods_encryption_salt_size": 8
+}