-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added receptorctl work release documentation (#1061)
- Loading branch information
1 parent
afb23cd
commit fd9ad64
Showing
3 changed files
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |