Skip to content

Commit 231d8f2

Browse files
voetbergvoetberg
committed
Rename from review suggestions
1 parent 27e2875 commit 231d8f2

File tree

4 files changed

+126
-11
lines changed

4 files changed

+126
-11
lines changed

‎docs/user/migrating_from_35_client.md renamed to ‎docs/user/migrate_36_cli.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
title: Migrating from pre-36.0.0 Clients
33
---
44

5-
In Rucio 36.0.0, a new rucio client was released.
6-
This new client redos the entire structure of both `rucio` and `rucio-admin`.
7-
`rucio-admin` is made redundant by the update, their commands are included in the `rucio >=36.0` client.
5+
In Rucio 36.0.0, a new Rucio client was released, with breaking changes to the structure of both `rucio` and `rucio-admin`.
6+
`rucio-admin` is made redundant by the update, and its commands are included in the `rucio >=36.0` client.
87

98
Note:
109
Please report any issues you have with the new client [on this github issue](https://github.com/rucio/rucio/issues/7224)
@@ -13,8 +12,8 @@ Note:
1312

1413
* Using `rucio-admin` or `rucio --legacy` automatically uses the old version. Old help menus are still visible with this method.
1514
* Old commands still work - they display a warning.
16-
* Not all commands are included in the 36 Client Release. Not all are one-to-one mapped.
17-
* A warning it printed (not logged) to consoles to encourage migration, along with the closest mapped command.
15+
* Not all commands are migrated to the new client structure. Not all included commands are one-to-one mapped.
16+
* A warning is printed (not logged) to consoles to encourage migration, along with the closest mapped command.
1817

1918

2019
# Remapping Existing Commands
@@ -48,7 +47,7 @@ Note:
4847
| rucio list-account-limits | rucio account limit list |
4948
| rucio add-rule | rucio rule add |
5049
| rucio delete-rule | rucio rule remove |
51-
| rucio rule-info | rucio rule info |
50+
| rucio rule-info | rucio rule show |
5251
| rucio list-rules | rucio rule list |
5352
| rucio list-rules-history | rucio rule history |
5453
| rucio update-rule | rucio rule update |

‎docs/user/migrate_to_36_cli.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
title: Migrating from pre-36.0.0 Clients
3+
---
4+
5+
In Rucio 36.0.0, a new Rucio client was released, with breaking changes to the structure of both `rucio` and `rucio-admin`.
6+
`rucio-admin` is made redundant by the update, and its commands are included in the `rucio >=36.0` client.
7+
8+
Note:
9+
Please report any issues you have with the new client [on this github issue](https://github.com/rucio/rucio/issues/7224)
10+
11+
# Legacy Mapping
12+
13+
* Using `rucio-admin` or `rucio --legacy` automatically uses the old version. Old help menus are still visible with this method.
14+
* Old commands still work - they display a warning.
15+
* Not all commands are migrated to the new client structure. Not all included commands are one-to-one mapped.
16+
* A warning is printed (not logged) to consoles to encourage migration, along with the closest mapped command.
17+
18+
19+
# Remapping Existing Commands
20+
21+
|`rucio <36.0`| `rucio >=36.0`|
22+
| ------------- | ------------- |
23+
| rucio list-file-replicas | rucio replica list |
24+
| rucio list-dataset-replicas | rucio replica dataset |
25+
| rucio add-dataset | rucio did add --type dataset |
26+
| rucio add-container | rucio did add --type container |
27+
| rucio attach | rucio did content add |
28+
| rucio detach | rucio did content remove |
29+
| rucio ls | rucio did list |
30+
| rucio list-dids | rucio did list |
31+
| rucio list-parent-dids | rucio did show --parent |
32+
| rucio list-scopes | rucio scope list |
33+
| rucio close | rucio did update --close |
34+
| rucio reopen | rucio did update --open |
35+
| rucio stat | rucio did show |
36+
| rucio erase | rucio did remove |
37+
| rucio list-content | rucio did content list |
38+
| rucio list-content-history | rucio did content history |
39+
| rucio upload | rucio upload |
40+
| rucio get | rucio download |
41+
| rucio download | rucio download |
42+
| rucio get-metadata | rucio did metadata list |
43+
| rucio set-metadata | rucio did metadata add |
44+
| rucio delete-metadata | rucio did metadata remove |
45+
| rucio list-rse-usage | rucio rse show |
46+
| rucio list-account-usage | rucio account usage |
47+
| rucio list-account-limits | rucio account limit list |
48+
| rucio add-rule | rucio rule add |
49+
| rucio delete-rule | rucio rule remove |
50+
| rucio rule-info | rucio rule show |
51+
| rucio list-rules | rucio rule list |
52+
| rucio list-rules-history | rucio rule history |
53+
| rucio update-rule | rucio rule update |
54+
| rucio move-rule | rucio rule update --move |
55+
| rucio list-rses | rucio rse list |
56+
| rucio list-suspicious-replicas | rucio replica state suspicious |
57+
| rucio list-rse-attributes | rucio rse attribute list |
58+
| rucio touch | rucio did update --touch |
59+
| rucio add-lifetime-exception | rucio lifetime-exception add |
60+
61+
|`rucio-admin <36.0`| `rucio >=36.0`|
62+
| ------------- | ------------- |
63+
| rucio data import | rucio upload |
64+
| rucio data export | rucio download |
65+
| rucio account -h | rucio account -h |
66+
| rucio account add | rucio account add |
67+
| rucio account delete | rucio account remove |
68+
| rucio account info | rucio account show |
69+
| rucio account update | rucio account update |
70+
| rucio account set-limits | rucio account limit add |
71+
| rucio account get-limits | rucio account limit list |
72+
| rucio account delete-limits | rucio account limit remove |
73+
| rucio account ban | rucio account update --ban True |
74+
| rucio account unban | rucio account update --ban False |
75+
| rucio account list-attributes | rucio account attribute list |
76+
| rucio account add-attribute | rucio account attribute add |
77+
| rucio account delete-attribute | rucio account attribute remove |
78+
| rucio identity -h | rucio account identity -h |
79+
| rucio identity add | rucio account identity add |
80+
| rucio identity delete | rucio account identity remove |
81+
| rucio rse -h | rucio rse -h |
82+
| rucio rse add | rucio rse add |
83+
| rucio rse list | rucio rse list |
84+
| rucio rse update | rucio rse update |
85+
| rucio rse info | rucio rse show |
86+
| rucio rse set-attribute | rucio rse attribute add |
87+
| rucio rse delete-attribute | rucio rse attribute remove |
88+
| rucio rse delete-distance | rucio rse distance remove |
89+
| rucio rse get-distance | rucio rse distance list |
90+
| rucio rse get-attribute | rucio rse attribute list |
91+
| rucio rse add-protocol | rucio rse protocol add |
92+
| rucio rse delete-protocol | rucio rse protocol remove |
93+
| rucio rse delete | rucio rse remove |
94+
| rucio rse add-qos-policy | rucio rse qos add |
95+
| rucio rse add-distance | rucio rse distance add |
96+
| rucio rse delete-qos-policy | rucio rse qos remove |
97+
| rucio rse list-qos-policies | rucio rse qos list |
98+
| rucio rse set-limit | rucio rse limit add |
99+
| rucio rse delete-limit | rucio rse limit remove |
100+
| rucio scope -h | rucio scope -h |
101+
| rucio scope add | rucio scope add |
102+
| rucio scope list | rucio scope list |
103+
| rucio config -h | rucio config -h |
104+
| rucio config get | rucio config list |
105+
| rucio config set | rucio config add |
106+
| rucio config delete | rucio config remove |
107+
| rucio subscription -h | rucio subscription -h |
108+
| rucio subscription add | rucio subscription add |
109+
| rucio subscription list | rucio subscription |
110+
| rucio subscription update | rucio subscription update |
111+
| rucio subscription reevaluate | rucio subscription touch |
112+
| rucio replicas -h | rucio replica -h |
113+
| rucio replicas quarantine | rucio replica state quarantine |
114+
| rucio replicas declare-bad | rucio replica state bad |
115+
| rucio replicas declare-temporary-unavailable | rucio replica state unavailable |
116+
| rucio replicas set-tombstone | rucio replica remove |
117+
| rucio replicas list-pfns | rucio replica list file --pfns |

‎docs/user/using_the_client.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ title: Using the Client
66
Rucio provides several commands for the end-user. See [executables](bin/rucio.md).
77
The command line client is called ``rucio``.
88

9-
Please note that these commands are not meant to be included in python scripts.
10-
For such applications, we encourage using the [python client](pathname:///html/site/client.html).
9+
Note: for Python scripts, we encourage using the [Python client](pathname:///html/site/client.html) instead of the commands listed here.
1110

12-
If you are using a version of the client prior to ~36.0, please view the [migration guide](user/migrating_from_35_client.md).
11+
If you are using a version of the client prior to ~36.0, please view the [migration guide](user/migrate_to_36_cli.md).
1312

1413
# Basic Commands
1514

@@ -442,7 +441,7 @@ You can set attributes to the users:
442441
And list these attributes:
443442
444443
```bash
445-
$ rucio-admin account attribute list --account jdoe
444+
$ rucio account attribute list --account jdoe
446445
+---------+-------+
447446
| Key | Value |
448447
|---------+-------|

‎website/sidebars.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"user/configuring_the_client",
3333
"user/using_the_client",
3434
"user/developing_with_rucio",
35-
"user/migrating_from_35_client"
35+
"user/migrate_36_cli"
3636
],
3737
"Operator": [
3838
"operator/setting_up_demo",

0 commit comments

Comments
 (0)