You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> The Integrated Rule-Oriented Data System (iRODS) is an open-sourcedata management software used by research organizations and government agencies worldwide.
4
+
The Integrated Rule-Oriented Data System (iRODS) is an open-source, policy-based data management software used by research, commercial, and governmental organizations worldwide.
5
5
6
6
:::{admonition} iRODS ...
7
7
:class: tip
8
8
9
9
- ... enables data discovery using a metadata catalog that describes every file, every directory, and every storage resource in the data grid.
10
10
- ... automates data workflows, with a rule engine that permits any action to be initiated by any trigger on any server or client in the grid.
11
11
- ... enables secure collaboration, so users only need to log in to their home grid to access data hosted on a remote grid.
12
-
- ... implement data virtualization, allowing access to distributed storage assets under a unified namespace, and freeing organizations from getting locked into single-vendor storage solutions.
12
+
- ... implements data virtualization, allowing access to distributed storage assets under a unified namespace, and freeing organizations from getting locked into single-vendor storage solutions.
13
+
:::
14
+
15
+
:::{important}
16
+
Requires iRODS 4.3.2 or newer.
13
17
:::
14
18
15
19
## Connecting
@@ -22,49 +26,143 @@ Connection profiles can be installed from *Preferences → Profiles*.
22
26
23
27
### Provider
24
28
25
-
-[CyVerse Data Store](http://www.cyverse.org/data-store) (Formerly iPlant Collaborative) - {download}`Connection Profile<https://profiles.cyberduck.io/iRODS%20(iPlant%20Collaborative).cyberduckprofile>`
A general purpose iRODS connection profile is available {download}`here<https://profiles.cyberduck.io/iRODS.cyberduckprofile>`.
30
+
31
+
All configuration properties described on this page are also documented in the connection profile.
28
32
29
33
### Authentication
30
34
31
-
#### Authentication With Native Scheme
35
+
#### Authentication with the Native scheme
32
36
33
-
This is the default with no additional configuration required.
37
+
To authenticate, set the **Authorization** value to `native` or `standard` in the [connection profile](index.md#connection-profiles). Defaults to `native`.
38
+
39
+
```
40
+
<key>Authorization</key>
41
+
<string>native</string>
42
+
```
43
+
44
+
`standard` is an alias for `native`. It is provided for backward compatibility.
45
+
46
+
#### Authentication with the PAM scheme
47
+
48
+
:::{note}
49
+
PAM requires a secure connection to the server. See [Secure Communication](#secure-communication) to learn more.
50
+
:::
51
+
52
+
To authenticate with PAM, set the **Authorization** value to `pam_password` or `pam` in the [connection profile](index.md#connection-profiles).
53
+
54
+
```
55
+
<key>Authorization</key>
56
+
<string>pam_password</string>
57
+
```
58
+
59
+
`pam` is an alias for `pam_password`. It is provided for backward compatibility.
60
+
61
+
#### Configuring the iRODS Zone
62
+
63
+
The zone of the target server must be specified before connecting to it. To do that, set the **Region** value in the [connection profile](index.md#connection-profiles).
64
+
65
+
```
66
+
<key>Region</key>
67
+
<string>zone_name</string>
68
+
```
34
69
35
-
#### Authentication With PAM Scheme
70
+
###Secure Communication
36
71
37
-
To authenticate with PAM, prefix the username with PAM:or set it in the [connection profile](index.md#connection-profiles) using as
72
+
To require secure communication, you must first set the **Client Server Negotiation** value to `CS_NEG_REQUIRE`in the [connection profile](index.md#connection-profiles).
38
73
39
74
```
40
-
<key>Authorization</key>
41
-
<string>PAM</string>
75
+
<key>Properties</key>
76
+
<dict>
77
+
<key>Client Server Negotiation</key>
78
+
<string>CS_NEG_REQUIRE</string>
79
+
</dict>
42
80
```
43
81
44
-
### Resource Server
82
+
Set the value to `CS_NEG_DONT_CARE` to let the server decide whether to use secure communication. Set it to `CS_NEG_REFUSE` to require an insecure channel. If the client and server cannot agree on how to proceed, the connection will fail and result in an error.
45
83
46
-
You can specify a non-default resource server in the Region key of the [connection profile](index.md#connection-profiles) using a colon-separated syntax (Issue [#8721](https://github.com/iterate-ch/cyberduck/issues/8721)) such as
84
+
Next, configure the encryption values to match those of the server. Consult the administrator of the iRODS zone to obtain the correct values.
47
85
48
86
```
49
-
<key>Region</key>
50
-
<string>iplant:storageresourcename</string>
87
+
<key>Properties</key>
88
+
<dict>
89
+
<key>Encryption Algorithm</key>
90
+
<string>AES-256-CBC</string>
91
+
92
+
<key>Encryption Key Size</key>
93
+
<string>32</string>
94
+
95
+
<key>Encryption Salt Size</key>
96
+
<string>8</string>
97
+
98
+
<key>Encryption Hash Rounds</key>
99
+
<string>16</string>
100
+
</dict>
101
+
```
102
+
103
+
#### Storage Resource
104
+
105
+
To upload files to a specific resource, set the **Destination Resource** value in the [connection profile](index.md#connection-profiles). The specified resource must be the root of a resource hierarchy. This property supersedes any resource defined by the **Region** property.
106
+
107
+
```
108
+
<key>Properties</key>
109
+
<dict>
110
+
<key>Destination Resource</key>
111
+
<string>resource_name</string>
112
+
</dict>
113
+
```
114
+
115
+
For backward compatibility, it can also be set by appending the name of the resource to the **Region**'s value. This method may be removed in the future.
116
+
117
+
```
118
+
<key>Region</key>
119
+
<string>zone_name:resource_name</string>
51
120
```
52
121
53
122
## Transfers
54
123
55
-
### Use Parallel Connections
124
+
### Parallel Transfer
125
+
126
+
Large file uploads will use parallel transfer when the requirements are satisfied. By default, a file must be larger than 32MB in order to trigger parallel transfer.
56
127
57
-
If [multiple connections](../cyberduck/transfer.md#connections) are configured by default in *Preferences* or set in the bookmark options with *Transfer Files: Open multiple connections*, get and put transfers to the data store use parallel concurrent connections.
128
+
The default values for parallel transfer are shown below. Descriptions of each property follow.
**Parallel Transfer Threshold** is the size (in bytes) of a file to upload that must be exceeded before parallel transfer is used. The value must satisfy the range [1, 2<sup>31</sup>-1].
60
145
61
-
The number of parallel connections is controlled using the lower right stepper control in the [Transfers](../cyberduck/transfer.md) window.
146
+
**Parallel Transfer Connections** is the number of connections used to upload a single file when parallel transfer is used. The value must satisfy the range [2, 10].
62
147
63
-
148
+
**Parallel Transfer Buffer Size** is the size (in bytes) of each buffer used to transfer bytes to the server. This property applies to uploads and downloads. The value must satisfy the range [1, 128MB].
149
+
150
+
### Trash Policy
151
+
152
+
To delete data objects and collections permanently, set the **Delete Objects Permanently** value to `yes` in the [connection profile](index.md#connection-profiles). Defaults to `no`.
153
+
154
+
```
155
+
<key>Properties</key>
156
+
<dict>
157
+
<key>Delete Objects Permanently</key>
158
+
<string>yes</string>
159
+
</dict>
160
+
```
64
161
65
162
## References
66
163
67
-
-[irods.org](http://irods.org/)
164
+
-[irods.org](https://irods.org/)
165
+
-[docs.irods.org](https://docs.irods.org/)
68
166
-[Downloading and Uploading Data](https://cyverse.atlassian.net/wiki/spaces/DS/pages/241869862/Downloading+and+Uploading+Data)
69
167
-[Using Cyberduck for Uploading and Downloading to the Data Store](https://cyverse.atlassian.net/wiki/spaces/DS/pages/241869843/Using+Cyberduck+for+Uploading+and+Downloading+to+the+Data+Store)
0 commit comments