Skip to content

Commit e2448b5

Browse files
committed
add cli doc; add badge
1 parent fb7139c commit e2448b5

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PyUNICORE, a Python library for using UNICORE and UFTP
22

3-
3+
[![Unit tests](https://github.com/HumanBrainProject/pyunicore/actions/workflows/unit-test.yml/badge.svg)](https://github.com/HumanBrainProject/pyunicore/actions/workflows/unit-test.yml)
44
[![Integration test](https://github.com/HumanBrainProject/pyunicore/actions/workflows/integration-test.yml/badge.svg)](https://github.com/HumanBrainProject/pyunicore/actions/workflows/integration-test.yml)
55
[![PyPI](https://img.shields.io/badge/PyPI-passed-green)](https://pypi.org/project/pyunicore/)
66

docs/source/CLI.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Commandline utility 'unicore'
2+
-----------------------------
3+
4+
PyUNICORE comes with a commandline utility ``unicore`` class, which is modeled
5+
after the UNICORE Commandline Client (UCC) and supports many of UCC's features.
6+
7+
You can use it to run jobs, access data, etc.
8+
9+
Have a look at:
10+
11+
.. code:: console
12+
13+
unicore --help
14+
15+
and the UCC documentation.

docs/source/port_forwarding.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,19 @@ If you want to tunnel to a compute node, you need to specify the compute node in
4545
python3 -m pyunicore.forwarder --token <your_auth_token> \
4646
-L $LOCAL_PORT \
4747
$JOB_URL/forward-port?port=$REMOTE_PORT?host=$COMPUTE_NODE \
48+
49+
50+
If the remote UNICORE server is 10.2.1 or later, it is also supported to connect to a UNIX domain socket
51+
file on a login node. This is usually preferable for security reasons. The domain socket file must be in the
52+
UNICORE job working directory. To connect, simply specify the domain socket filename like so:
53+
54+
.. code:: console
55+
56+
LOCAL_PORT=4322
57+
SOCKET_FILE=sock
58+
JOB_URL=https://localhost:8080/DEMO-SITE/rest/core/jobs/some_job_id
59+
python3 -m pyunicore.forwarder --token <your_auth_token> \
60+
-L $LOCAL_PORT \
61+
$JOB_URL/forward-port?file=$SOCKET_FILE \
62+
63+
Again, this will only work if the job is running on a login node.

0 commit comments

Comments
 (0)