Skip to content

Commit

Permalink
Added receptorctl work release documentation (#1061)
Browse files Browse the repository at this point in the history
  • Loading branch information
thom-at-redhat authored Jun 11, 2024
1 parent afb23cd commit fd9ad64
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/source/receptorctl/receptorctl_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ The Receptor client, ``receptorctl``, provides a command line interface for inte
receptorctl_version
receptorctl_work_cancel
receptorctl_work_list
receptorctl_work_release
2 changes: 1 addition & 1 deletion docs/source/receptorctl/receptorctl_work_cancel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Command syntax: ``receptorctl --socket=<socket_path> work cancel <<Unit ID>> [..
``ps -fp $(pidof receptor)``
``lsof -p <pid>``

``Unit ID`` is a unique identifier for a work unit (job). When running the ``work cancel`` command, you should specify the ``Unit ID`` for the Receptor instance to which you are connected.
``Unit ID`` is a unique identifier for a work unit (job). When running the ``work cancel`` command, you should specify the ``Unit ID`` for the Receptor node to which you are connected.
29 changes: 29 additions & 0 deletions docs/source/receptorctl/receptorctl_work_release.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
------------
work release
------------

.. contents::
:local:

``receptorctl work release`` deletes one or more units of work.

Command syntax: ``receptorctl --socket=<socket_path> work release [<<Options>>] <<Unit ID>> [...]``

``socket_path`` is the control socket address for the Receptor connection.
The default is ``unix:`` for a Unix socket.
Use ``tcp://`` for a TCP socket.
The corresponding environment variable is ``RECEPTORCTL_SOCKET``.

.. code-block:: text
ss --listening --processes --unix 'src = unix:<socket_path>'
Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process
u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7))
``ps -fp $(pidof receptor)``
``lsof -p <pid>``

``Unit ID`` is a unique identifier for a work unit (job). When running the ``work release`` command, you should specify the ``Unit ID`` for the Receptor node to which you are connected.

``--all`` deletes all work units known by the Receptor node to which you are connected.
``--force`` deletes work units locally on the Receptor node to which you are connected and takes effect even if the remote Receptor node is unreachable.

0 comments on commit fd9ad64

Please sign in to comment.