Last modified by luehrs on 2023/04/12 09:26
From version 3.3
edited by luehrs
on 2023/04/12 07:10
Change comment: There is no comment for this version
To version 5.1
edited by luehrs
on 2023/04/12 07:16
Change comment: Uploaded new attachment "image-20230412091641-1.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -64,33 +64,45 @@
64 64  
65 65  To install the RPM package one needs to run the following command:
66 66  
67 -{{{[promt]$ yum install fts-rest-client-1.0.0-%{_release}.el7.noarch}}}
67 +##[promt]$ yum install fts-rest-client-1.0.0-%{_release}.el7.noarch##
68 68  
69 -Should the user prefer to build the fts-rest-client him/herself, the scripts can be found in the fts-rest-flask repository here: [[https:~~/~~/gitlab.cern.ch/fts/fts-rest-flask/-/tree/swift>>url:https://gitlab.cern.ch/fts/fts-rest-flask/-/tree/swift]]. The user can clone the repository, switch to the swift branch, and cd into it. We advise creating a venv for this project. Then run pip install . or python setup.py install to install the fts package. After that, the user may run the scripts in src/cli the same way he/she uses the FTS commands.
69 +Should the user prefer to build the fts-rest-client him/herself, the scripts can be found in the fts-rest-flask repository here: [[https:~~/~~/gitlab.cern.ch/fts/fts-rest-flask/-/tree/swift>>url:https://gitlab.cern.ch/fts/fts-rest-flask/-/tree/swift]]. The user can clone the repository, switch to the swift branch, and ##cd## into it. We advise creating a ##venv## for this project. Then run ##pip install .## or ##python setup.py## install to install the fts package. After that, the user may run the scripts in src/cli the same way he/she uses the FTS commands.
70 70  
71 71  === Valid OIDC token ===
72 72  
73 73  To obtain a valid OIDC token, the user needs to login via her/his institute’s IdP or HBP user account, and she/he should be able to see her/his access token on the [[https:~~/~~/fts.bsc.es>>url:https://fts.bsc.es]] website. The user should copy the token to run the FTS commands. We advise all users to perform this action at least once to have their credentials registered with FTS properly. Please, note that this is a temporary solution for retrieving the access token.
74 74  
75 +For CLI users, Device Code Flow ([[RFC 8628>>url:https://www.rfc-editor.org/rfc/rfc8628.html]]) is the recommended authorisation grant to obtain OIDC tokens. The user can install [[oidc-agent>>url:https://indigo-dc.gitbook.io/oidc-agent/]] to perform such workflows. To use oidc-agent with Fenix AAI, a development version 4.4.1 is needed; such packages can be found here: [[https:~~/~~/repo.data.kit.edu/devel/>>url:https://repo.data.kit.edu/devel/]].
75 75  
76 -For CLI users, Device Code Flow ([[RFC 8628>>url:https://www.rfc-editor.org/rfc/rfc8628.html]]) is the recommended authorisation grant to obtain OIDC tokens. The user can install [[oidc-agent>>url:https://indigo-dc.gitbook.io/oidc-agent/]] to perform such workflow. To use oidc-agent with Fenix AAI, a development version 4.4.1 is needed, such packages can be found here: [[https:~~/~~/repo.data.kit.edu/devel/>>url:https://repo.data.kit.edu/devel/]].
77 -
78 78  1. Add the following line to /etc/oidc-agent/pubclients.config (for the first time):
78 +##APP-EF25A717-2059-461D-8275-A71CC098B82B@https:~/~/central-proxy.fenix-ri.eu##
79 +1. Initiate oidc-agent:
80 +##[promt]$ eval $(oidc-agent)##
81 +1. The user needs to run the oidc-gen command to generate account info for Fenix:
82 +##[promt]$ oidc-gen ~-~-pub ~-~-issuer https:~/~/central-proxy.fenix-ri.eu \
83 +~-~-configuration-endpoint https:~/~/central-webapp.fenix-ri.eu/oidc/.well-known/openid-configuration \
84 +~-~-flow device ~-~-no-save <define_an_account_name>##
85 +Follow the instructions of the output, login to Fenix AAI.
86 +1. Obtain an OIDC token:
87 +##[promt]$ oidc-token <defined_account_name>##
79 79  
80 -APP-EF25A717-2059-461D-8275-A71CC098B82B@https:~/~/central-proxy.fenix-ri.eu
89 +== How to perform a data transfer with FTS ==
81 81  
82 -1. Initiate oidc-agent:
91 +In this section, the user can find useful commands and examples. More detailed commands are available at [[FTS3 Documentation - CERN>>url:https://fts3-docs.web.cern.ch/fts3-docs/]].
83 83  
84 -[promt]$ eval $(oidc-agent)
93 +=== FTS commands ===
85 85  
86 -1. The user needs to run the oidc-gen command to generate account info for Fenix:
95 +The FTS transfers are managed by the following commands:
87 87  
88 -[promt]$ oidc-gen ~-~-pub ~-~-issuer https:~/~/central-proxy.fenix-ri.eu \ ~-~-configuration-endpoint https:~/~/central-webapp.fenix-ri.eu/oidc/.well-known/openid-configuration \
97 +* fts-rest-transfer-submit             //to submit transfer job//
98 +* fts-rest-transfer-status              //to query a transfer job//
99 +* fts-rest-transfer-list                   //to list transfer jobs//
100 +* fts-rest-transfer-cancel             //to cancel a transfer job//
89 89  
90 -~-~-flow device ~-~-no-save <define_an_account_name>
102 +=== Source/destination URL format ===
91 91  
92 -Follow the instructions of the output, login to Fenix AAI.
104 +FTS is a protocol-specific transfer service. If the user wants to transfer from/to a Swift endpoint, she/he should specify ##swifts:~/~/ + storage name## instead of ##https:~/~/ + storage name## in the source/destination URL. The ##swifts:~/~/## is to specify she/he is using Swift protocol with FTS.
93 93  
94 -1. Obtain an OIDC token:
106 +The format of a Swift url to submit to FTS is ##swifts:~/~/ + storage name + container name + (folder name(s)) + object name##.
95 95  
96 -[promt]$ oidc-token <defined_account_name>
108 +For example, ##swifts:~/~/swift.bsc.es/testcontainer/data.txt## locates the data.txt file in container testcontainer in the BSC object store.
image-20230412091641-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.luehrs
Size
... ... @@ -1,0 +1,1 @@
1 +24.0 KB
Content