Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace all references to the tutorial endpoints #907

Merged
merged 1 commit into from
Dec 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Other

* Replaced all references to the tutorial endpoints.
4 changes: 2 additions & 2 deletions src/globus_cli/commands/bookmark/create.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

[source,bash]
----
$ globus bookmark create 'ddb59aef-6d04-11e5-ba46-22000b92c6ec:/~/' mybookmark
$ globus bookmark create 'aa752cea-8222-5bc8-acd9-555b090c0ccb:/~/' mybookmark
----

Take a specific field from the JSON output and format it into unix-friendly
Expand All @@ -28,7 +28,7 @@
[source,bash]
----
$ globus bookmark create \
'ddb59aef-6d04-11e5-ba46-22000b92c6ec:/~/' mybookmark \
'aa752cea-8222-5bc8-acd9-555b090c0ccb:/~/' mybookmark \
-F unix --jmespath 'id'
----
""",
Expand Down
8 changes: 4 additions & 4 deletions src/globus_cli/commands/delete.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,23 @@

[source,bash]
----
$ ep_id=ddb59af0-6d04-11e5-ba46-22000b92c6ec
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus delete $ep_id:~/myfile.txt
----

Delete a directory recursively.

[source,bash]
----
$ ep_id=ddb59af0-6d04-11e5-ba46-22000b92c6ec
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus delete $ep_id:~/mydir --recursive
----

Use the batch input method to transfer multiple files and or dirs.

[source,bash]
----
$ ep_id=ddb59af0-6d04-11e5-ba46-22000b92c6ec
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus delete $ep_id --batch - --recursive
~/myfile1.txt
~/myfile2.txt
Expand All @@ -62,7 +62,7 @@

[source,bash]
----
$ ep_id=ddb59af0-6d04-11e5-ba46-22000b92c6ec
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ task_id="$(globus delete $ep_id:~/mydir --recursive \
--jmespath 'task_id' --format unix)"
$ echo "Waiting on $task_id"
Expand Down
6 changes: 3 additions & 3 deletions src/globus_cli/commands/endpoint/activate.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint activate $ep_id
----

Activate an endpoint using Web activation

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint activate $ep_id --web
----

Activate an endpoint using Myproxy activation, skipping the username prompt.

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint activate $ep_id --myproxy -U username
----
""",
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/deactivate.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint deactivate $ep_id
----
""",
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/delete.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
short_help="Delete an endpoint",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint delete $ep_id
----
""",
Expand Down
6 changes: 3 additions & 3 deletions src/globus_cli/commands/endpoint/is_activated.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@
""",
adoc_examples=r"""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint is-activated $ep_id
----

Check *globus endpoint is-activated* as part of a script:

[source,bash]
----
ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
globus endpoint is-activated $ep_id
if [ $? -ne 0 ]; then
echo "$ep_id is not activated! This script cannot run!"
Expand All @@ -46,7 +46,7 @@

[source,bash]
----
ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
output="$(globus endpoint is-activated "$ep_id" \
--jmespath expires_in --format unix)"
if [ $? -eq 0 ]; then
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
short_help="List all shared endpoints on an endpoint by the current user",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint my-shared-endpoint-list $ep_id
----
""",
Expand Down
4 changes: 2 additions & 2 deletions src/globus_cli/commands/endpoint/permission/create.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint permission create $ep_id:/dir --permissions r --anonymous
----

Give read and write access to a specific user.

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint permission create $ep_id:/ --permissions rw --identity [email protected]
----
""",
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/permission/delete.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
short_help="Delete an access control rule",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ rule_id=1ddeddda-1ae8-11e7-bbe4-22000b9a448b
$ globus endpoint permission delete $ep_id $rule_id
----
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/permission/list.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
short_help="List access control rules",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint permission list $ep_id
----
""",
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/permission/show.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
short_help="Display an access control rule",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ rule_id=1ddeddda-1ae8-11e7-bbe4-22000b9a448b
$ globus endpoint permission show $ep_id $rule_id
----
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/permission/update.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ rule_id=1ddeddda-1ae8-11e7-bbe4-22000b9a448b
$ globus endpoint permission update $ep_id $rule_id --permissions r
----
Expand Down
4 changes: 2 additions & 2 deletions src/globus_cli/commands/endpoint/role/create.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@
"containing the ID of the created role."
),
adoc_examples="""Grant '[email protected]' the 'activity_monitor' role on
'ddb59aef-6d04-11e5-ba46-22000b92c6ec':
'aa752cea-8222-5bc8-acd9-555b090c0ccb':

[source,bash]
----
$ globus endpoint role create 'ddb59aef-6d04-11e5-ba46-22000b92c6ec' \
$ globus endpoint role create 'aa752cea-8222-5bc8-acd9-555b090c0ccb' \
--identity '[email protected]' --role activity_monitor
----
""",
Expand Down
4 changes: 2 additions & 2 deletions src/globus_cli/commands/endpoint/role/delete.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
short_help="Remove a role from an endpoint",
adoc_output="Textual output is a simple success message in the absence of errors.",
adoc_examples="""Delete role '0f007eec-1aeb-11e7-aec4-3c970e0c9cc4' on endpoint
'ddb59aef-6d04-11e5-ba46-22000b92c6ec':
'aa752cea-8222-5bc8-acd9-555b090c0ccb':

[source,bash]
----
$ globus endpoint role delete 'ddb59aef-6d04-11e5-ba46-22000b92c6ec' \
$ globus endpoint role delete 'aa752cea-8222-5bc8-acd9-555b090c0ccb' \
'0f007eec-1aeb-11e7-aec4-3c970e0c9cc4'
----
""",
Expand Down
4 changes: 2 additions & 2 deletions src/globus_cli/commands/endpoint/role/list.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
types the principal is. The term "Principal" is used in the sense of "a
security principal", an entity which has some privileges associated with it.
""",
adoc_examples="""Show all roles on 'ddb59aef-6d04-11e5-ba46-22000b92c6ec':
adoc_examples="""Show all roles on 'aa752cea-8222-5bc8-acd9-555b090c0ccb':

[source,bash]
----
$ globus endpoint role list 'ddb59aef-6d04-11e5-ba46-22000b92c6ec'
$ globus endpoint role list 'aa752cea-8222-5bc8-acd9-555b090c0ccb'
----
""",
)
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/server/add.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint server add $ep_id --hostname gridftp.example.org
----
""",
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/server/delete.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def _detect_mode(server: str) -> Literal["id", "uri", "hostname", "hostname_port
short_help="Delete a server belonging to an endpoint",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ server_id=294682
$ globus endpoint server delete $ep_id $server_id
----
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/server/list.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def parse(self, value: t.Any) -> str:
short_help="List all servers for an endpoint",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus endpoint server list $ep_id
----
""",
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/server/show.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def render(self, value: tuple[PORT_RANGE_T, PORT_RANGE_T]) -> str:
short_help="Show an endpoint server",
adoc_examples="""[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ server_id=207976
$ globus endpoint server show $ep_id $server_id
----
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/endpoint/server/update.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ server_id=294682
$ globus endpoint server update $ep_id $server_id --scheme ftp
----
Expand Down
10 changes: 5 additions & 5 deletions src/globus_cli/commands/ls.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ def parse(self, data: t.Any) -> str:

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus ls $ep_id
----

List files and dirs on a specific path on an endpoint

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus ls $ep_id:/share/godata/
----

Expand All @@ -75,7 +75,7 @@ def parse(self, data: t.Any) -> str:

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus ls $ep_id:/share/godata/ \
--jmespath 'DATA[*].[type, permissions, name, last_modified]' \
--format UNIX
Expand All @@ -88,7 +88,7 @@ def parse(self, data: t.Any) -> str:

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus ls $ep_id:/share/godata/ --filter '~*.txt' # all txt files
$ globus ls $ep_id:/share/godata/ --filter '!~file1.*' # not starting in "file1."
$ globus ls $ep_id:/share/godata/ --filter '~*ile3.tx*' # anything with "ile3.tx"
Expand All @@ -103,7 +103,7 @@ def parse(self, data: t.Any) -> str:

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus ls $ep_id:/share/godata/ | egrep '.*\.txt$' # done with grep, okay
$ globus ls $ep_id:/share/godata/ --filter '~*.txt' # done with --filter, better
----
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/mkdir.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ mkdir ep_id:~/testfolder
----
""",
Expand Down
2 changes: 1 addition & 1 deletion src/globus_cli/commands/rename.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

[source,bash]
----
$ ep_id=ddb59aef-6d04-11e5-ba46-22000b92c6ec
$ ep_id=aa752cea-8222-5bc8-acd9-555b090c0ccb
$ globus rename $ep_id:~/tempdir $ep_id:~/project-foo
----
""",
Expand Down
4 changes: 2 additions & 2 deletions src/globus_cli/commands/rm.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@

[source,bash]
----
$ ep_id=ddb59af0-6d04-11e5-ba46-22000b92c6ec
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus rm $ep_id:~/myfile.txt
----

Delete a directory recursively.

[source,bash]
----
$ ep_id=ddb59af0-6d04-11e5-ba46-22000b92c6ec
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus rm $ep_id:~/mydir --recursive
----
""",
Expand Down
Loading