8000 Cleanup work submit options documentation by thom-at-redhat · Pull Request #1077 · ansible/receptor · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Cleanup work submit options documentation #1077

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Cleanup work submit options documentation #1077

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1571a4d
Cleanup work submit options documentation
thom-at-redhat Jul 1, 2024
f13939c
Change from bullet list to table
thom-at-redhat Jul 1, 2024
a31e205
Address reviewer suggestions
thom-at-redhat Jul 3, 2024
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
36 changes: 26 additions & 10 deletions docs/source/receptorctl/receptorctl_work_submit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,29 @@ Work submit options

You can use the following options with the ``work submit`` command:

``-a``, ``--param <<KEY>>=<<VALUE>>`` adds a Receptor parameter in key=value format.
``-f``, ``--follow`` keeps Receptorctl to remain attached to the job and displays the job results.
``-l``, ``--payload-literal <<TEXT>>`` uses the value of ``<<TEXT>>`` as the literal unit of work data.
``-n``, ``--no-payload`` sends an empty payload.
``--node <<Node ID>>`` is the Receptor node on which the work runs. The default is the local node.
``-p``, ``--payload <<TEXT>>`` specifies the file that contains data for the unit of work. Specify ``-`` for standard input (stdin).
``--rm`` releases the work unit after completion.
``--signwork`` digitally signs remote work submissions to standard output (stdout).
``--tls-client <<TEXT>>`` specifies the TLS client that submits work to a remote node.
``--ttl <<TEXT>>`` specifies the time to live (TTL) for remote work requests in ``##h##m##s`` format; for example ``1h20m30s`` or ``30m10s``. Use the ``receptorctl work list`` command to display units of work on Receptor nodes and determine appropriate TTL values.
.. list-table::
:header-rows: 1
:widths: auto

* - Option
- Description
* - ``-a``, ``--param <<KEY>>=<<VALUE>>``
- Adds a Receptor parameter in key=value format.
* - ``-f``, ``--follow``
- Keeps Receptorctl to remain attached to the job and displays the job results.
* - ``-l``, ``--payload-literal <<TEXT>>``
- Uses the value of ``<<TEXT>>`` as the literal unit of work data.
* - ``-n``, ``--no-payload``
- Sends an empty payload.
* - ``--node <<Node ID>>``
- Specifies the Receptor node on which the work runs. The default is the local node.
* - ``-p``, ``--payload <<TEXT>>``
- Specifies the file that contains data for the unit of work. Specify ``-`` for standard input (stdin).
* - ``--rm``
- Releases the work unit after completion.
* - ``--signwork``
- Digitally signs remote work submissions to standard output (stdout).
* - ``--tls-client <<TEXT>>``
- Specifies the TLS client that submits work to a remote node.
* - ``--ttl <<TEXT>>``
- Specifies the time to live (TTL) for remote work requests in ``##h##m##s`` format; for example ``1h20m30s`` or ``30m10s``. Use the ``receptorctl work list`` command to display units of work on Receptor nodes and determine appropriate TTL values.
Loading
0