nova/doc/source/cli/nova-serialproxy.rst
Stephen Finucane b5edc294a1 docs: Add man pages for 'nova-policy'
I don't actually grok what this does that 'oslopolicy-checker' couldn't
do, so perhaps we can deprecate this in the future. For now though,
simply document the thing. While we're here, we make some additional
related changes:

- Remove references to the 'policy.yaml' file for services that don't
  use policy (i.e. everything except the API services and, due to a bug,
  the nova-compute service).
- Update remaining references to the 'policy.yaml' file to include the
  'policy.d/' directory
- Update the help text for the '--api-name' and '--target' options of
  the 'nova-policy policy check' command to correct tense and better
  explain their purpose.

Also, yes, 'nova-policy policy check' is dumb. Don't blame me :)

Change-Id: I913b0de9ec40a615da7bf9981852edef4a88fecb
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Related-bug: #1675486
2021-04-19 10:47:17 +01:00

69 lines
1.5 KiB
ReStructuredText

================
nova-serialproxy
================
.. program:: nova-serialproxy
Synopsis
========
::
nova-serialproxy [<options>...]
Description
===========
:program:`nova-serialproxy` is a server daemon that serves the Nova Serial
Websocket Proxy service, which provides a websocket proxy that is compatible
with OpenStack Nova serial ports.
Options
=======
.. rubric:: General options
.. include:: opts/common.rst
.. rubric:: Websockify options
.. include:: opts/websockify.rst
.. rubric:: Serial options
.. option:: --serial_console-serialproxy_host SERIAL_CONSOLE_SERIALPROXY_HOST
The IP address which is used by the ``nova-serialproxy`` service to listen
for incoming requests. The ``nova-serialproxy`` service listens on this IP
address for incoming connection requests to instances which expose serial
console.
.. option:: --serial_console-serialproxy_port SERIAL_CONSOLE_SERIALPROXY_PORT
The port number which is used by the ``nova-serialproxy`` service to
listen for incoming requests. The ``nova-serialproxy`` service listens on
this port number for incoming connection requests to instances which expose
serial console.
.. rubric:: Debugger options
.. include:: opts/debugger.rst
Files
=====
* ``/etc/nova/nova.conf``
* ``/etc/nova/rootwrap.conf``
* ``/etc/nova/rootwrap.d/``
See Also
========
:doc:`nova-novncproxy(1) <nova-novncproxy>`,
:doc:`nova-spicehtml5proxy(1) <nova-spicehtml5proxy>`
Bugs
====
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__