Structure cli page

The cli page was just a straight list of cli links. This groups them
by function with a preamble to make it more clear why you'd want to go
look at any particular ones.

Part of bp: doc-migration

Change-Id: Iecf99e173be3c3d5a2d5dd758c09f79d443729b9
This commit is contained in:
Sean Dague
2017-08-09 08:02:43 -04:00
parent da224b3a05
commit 104efa6fb6

View File

@@ -20,27 +20,75 @@ Command-line Utilities
In this section you will find information on Nova's command line utilities. In this section you will find information on Nova's command line utilities.
Reference 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-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-console
nova-consoleauth
nova-novncproxy
nova-scheduler
nova-serialproxy
nova-spicehtml5proxy
nova-xvpvncproxy
WSGI Services
-------------
Starting in the Pike release, the prefered 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:: .. toctree::
:maxdepth: 1 :maxdepth: 1
nova-api-metadata nova-api-metadata
nova-api-os-compute nova-api-os-compute
nova-api
nova-cells Additional Tools
nova-compute ----------------
nova-conductor
nova-console There are a few additional cli tools which nova services call when
nova-consoleauth appropriate. This should not need to be called directly by operators, but they
nova-dhcpbridge are documented for completeness and debugging if something goes wrong.
nova-idmapshift
nova-manage .. toctree::
nova-network :maxdepth: 1
nova-novncproxy
nova-rootwrap nova-rootwrap
nova-scheduler nova-idmapshift
nova-serialproxy
nova-spicehtml5proxy Deprecated Services
nova-status -------------------
nova-xvpvncproxy
The following services are deprecated in nova. They should not be used in new
deployments, but are documented for existing ones.
.. toctree::
:maxdepth: 1
nova-cells
nova-dhcpbridge
nova-network