nova/doc/source/cli/index.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

79 lines
2.1 KiB
ReStructuredText

..
Copyright 2010-2011 United States Government as represented by the
Administrator of the National Aeronautics and Space Administration.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Command-line Utilities
======================
In this section you will find information on Nova's command line utilities.
Nova Management Commands
------------------------
These commands are used to manage existing installations. They are designed to
be run by operators in an environment where they have direct access to the nova
database.
.. toctree::
:maxdepth: 1
nova-manage
nova-policy
nova-status
Service Daemons
---------------
The service daemons make up a functioning nova environment. All of these are
expected to be started by an init system, expect to read a nova.conf file, and
daemonize correctly after starting up.
.. toctree::
:maxdepth: 1
nova-api
nova-compute
nova-conductor
nova-novncproxy
nova-scheduler
nova-serialproxy
nova-spicehtml5proxy
WSGI Services
-------------
Starting in the Pike release, the preferred way to deploy the nova api is in a
wsgi container (uwsgi or apache/mod_wsgi). These are the wsgi entry points to
do that.
.. toctree::
:maxdepth: 1
nova-api-metadata
nova-api-os-compute
Additional Tools
----------------
There are a few additional cli tools which nova services call when
appropriate. This should not need to be called directly by operators, but they
are documented for completeness and debugging if something goes wrong.
.. toctree::
:maxdepth: 1
nova-rootwrap