Commit Graph

1190 Commits

Author SHA1 Message Date
Stephen Finucane 24cdb620f9 doc: Make use of definition lists, literals
Part of bp: doc-migration

Change-Id: I270c29fa9d7f02ccc4437f05a86edb79a3a373ba
2017-08-03 14:42:34 +01:00
Sean Dague a87afe2fc2 reflow rpc doc to 80 columns
And add some additional horizontal white space to make it easier to
understand different long bullets are different.

Part of bp: doc-migration

Change-Id: I36cd7513fa5d482b6cd85a062eace21704c49f85
2017-08-03 14:28:48 +01:00
Sean Dague ea669d3488 fix list rendering in policy-enforcement
Part of bp: doc-migration

Change-Id: Ia0355c14fba16416d0d6068d2478377dccfa2ed9
2017-08-03 08:10:16 -04:00
Sean Dague e6e5e521d2 fix list rendering in cells
Part of bp: doc-migration

Change-Id: If4b369a8d9a1acda0d8290183dd4f94159b6a3c9
2017-08-03 08:05:51 -04:00
Sean Dague 613f55c26a fix list rendering in aggregates
List items need to be exactly 2 spaces off of the parent, and the top
level left justified, otherwise <blockquote> gets thrown into the
html.

Part of bp: doc-migration

Change-Id: I16634edbc562aff69744e5d7c7275689326ab8d0
2017-08-03 08:02:24 -04:00
Sean Dague 3361769910 Fix list rendering in bdm doc.
What looked clear in the rst actually was far from clear when rendered
in HTML. The document was restructured a bit so all the options end up
in a single bullet list, and the combination description is a separate
section.

Part of bp: doc-migration

Change-Id: I2feee4018a332483658d24d299dbb04ec87f2df0
2017-08-03 07:59:41 -04:00
Sean Dague dafd133ab8 fix list rendering in rpc doc
list bullets have to be exactly 2 spaces indented from the parent, and
the top level is left justified, otherwise we get lots of <blockquote>
html tags inserted.

Part of bp: doc-migration

Change-Id: Ie8b311ca286601a47475b33ef80da272efc9be31
2017-08-03 07:50:27 -04:00
Sean Dague 12c0a66657 Fix list rendering in code-review.rst
Sub lists have to be indented exactly 2 additional spaces from their
parent, otherwise it is treated as a blockquote, which isn't what we
want.

Part of bp: doc-migration

Change-Id: Iab46b5e39e4bd0d154f33dc795f24362c77a88a5
2017-08-03 07:45:25 -04:00
Sean Dague ce53afce8c Fix lists in process doc
A lot of our rst was actually misformatted with extra spaces indenting
the bullet lists. This wasn't very visually noticable in the
oslosphinx theme, but it's really bad in the new theme. There will
need to be lots of fixes here, but will do them one page at a time.

Part of bp: doc-migration

Change-Id: Ic1d1383148b005b884fdfa3e9a9658adcb13ee70
2017-08-03 07:29:51 -04:00
Jenkins 2372ed8ad7 Merge "fix rpc broken rst comment" 2017-08-03 00:25:30 +00:00
Jenkins fc36f782d1 Merge "sort redirectmatch lines" 2017-08-03 00:24:51 +00:00
Jenkins a42805c804 Merge "add top 404 redirect" 2017-08-03 00:24:13 +00:00
Jenkins 930be1bd97 Merge "Add redirect for api-microversion-history doc" 2017-08-03 00:21:13 +00:00
Sean Dague dc94d8ad5b fix rpc broken rst comment
The license header isn't in a comment correctly, so it shows up
inline in the rpc page and looks pretty ugly. Add missing '.'

Change-Id: I7c05ee9c4074d1e29f77b4c1c292196bcf0b801d
2017-08-02 20:47:36 +00:00
Sean Dague c0339a3b73 sort redirectmatch lines
Just to make it easier to see if items are in the list or not, we
should keep them sorted. No fancy hacking rules for this, just being
dilligent.

Change-Id: Icbfdcffbc15c5c32ca48ddd6fbac15d425ab8c44
2017-08-02 16:38:42 -04:00
Sean Dague a1f9edd6f6 add top 404 redirect
From http://paste.openstack.org/show/617316/ this devref linked page
is our top 404 at the moment, add a redirect match for it.

Change-Id: Ie42935e5fa5d2199f9878edc2951ba0734e95a7c
2017-08-02 20:37:00 +00:00
Matt Riedemann c2f5864066 Add redirect for api-microversion-history doc
The api-microversion-history doc has now moved under "reference/"
so we need a redirect.

This also removes the draft site redirect for cells since that
was only in here for CI testing to make sure the redirects work,
which we know they do now:

  https://docs.openstack.org/nova/latest/cells.html

Change-Id: I21bcd71b21af3108e1b14229f90b5ec07cc8188b
2017-08-02 05:22:21 +00:00
Jenkins f17feb558c Merge "Deprecate cells v1" 2017-08-02 01:49:24 +00:00
Jenkins 3a99089a3e Merge "add redirects for existing broken docs urls" 2017-08-02 01:48:28 +00:00
Jenkins 1f9e52a5d0 Merge "Add some more cellsv2 doc goodness" 2017-08-02 00:57:33 +00:00
Sean Dague 122efa35f6 add redirects for existing broken docs urls
This adds the redirects to the existing broken doc urls, and explains
how we generate this.

Change-Id: Ied2b95f4e7d8b35c9eee5740f17bfe75e479f3c4
2017-08-01 12:20:35 -04:00
Dan Smith 7c17010448 Add some more cellsv2 doc goodness
This adds a fresh cellsv2 overview document that talks about
deployment decisions for single and multiple cell environments
in an attempt to help address confusion about what the service
layouts look like in a multi-cell setup.

Change-Id: I1da7c375dbb98c125aebabec548280de8d8ed381
2017-08-01 09:20:06 -07:00
Matt Riedemann 3414ab14ca Deprecate cells v1
With multi-cell support in Pike, we should deprecate cells v1
so we can at least start the deprecation signaling in the
docs and release notes. We may not end up removing cells v1
code in Queens, but this at least gives us the option.

Note that we also want to do this because nova-network cannot
be removed until we remove cells v1.

Change-Id: I1a173f7ce0715e684850e030c358e8175fa8724c
2017-08-01 11:07:55 -04:00
Jenkins f9e353a585 Merge "add a redirect for the old cells landing page" 2017-08-01 13:33:30 +00:00
Doug Hellmann 74b6b7741b add a redirect for the old cells landing page
Redirect from /nova/$series/cells.html to /nova/$series/admin/cells.html

Depends-On: I236b7b0a9aae065167bd0aef316603d258e4c3c6
Change-Id: I56b1c077dd604c2947c791c7d5ccdddb9fb815a2
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-28 08:27:05 -04:00
Matt Riedemann c73f9eef6b doc: add FAQ entry for cells v1 config options
It's super confusing for new people to nova and cells
to see config options in a [cells] group and think they
should be changing those, like enable and cell_type.

While we have warnings in the config option help text,
let's also put a reminder in the FAQ page in the docs.

Change-Id: I5e106d9e0743d918e2115d809ac3732c5a3d7a5a
2017-07-27 12:47:50 -04:00
Satoru Moriya 3e1a3c9f82 Ironic: Support boot from Cinder volume
This enables Ironic to boot bare metal machines from Cinder
volume. Ironic virt driver needs to pass the remote volume
connection information down to Ironic when spawning a new
bare metal instance requested to boot from a Cinder volume.

This implements get_volume_connector method for the Ironic
driver. It will get connector information from the Ironic service
and pass it to Cinder's initialize_connection method for attached
volumes. And then it puts the returned value into Ironic.

This patch changes the required Ironic API version to 1.32 for using
new API for volume resources.

Co-Authored-By: Satoru Moriya <satoru.moriya.br@hitachi.com>
Co-Authored-By: Hironori Shiina <shiina.hironori@jp.fujitsu.com>
Change-Id: I319779af265684715f0142577a217ab66632bf4f
Implements: blueprint ironic-boot-from-volume
2017-07-25 03:57:51 +00:00
Jenkins b25ca6b898 Merge "Update ironic feature matrix" 2017-07-24 22:25:45 +00:00
Jenkins ce21958680 Merge "doc: Populate the 'user' section" 2017-07-24 22:25:10 +00:00
Jenkins bd7b6a9c06 Merge "doc: Populate the 'reference' section" 2017-07-24 22:13:10 +00:00
Jenkins 2f110810be Merge "doc: Populate the 'contributor' section" 2017-07-24 22:12:41 +00:00
Jenkins 9a33b21140 Merge "doc: Populate the 'configuration' section" 2017-07-24 22:12:10 +00:00
Jenkins 716dabdb0e Merge "Deprecate useless quota_usage_refresh from nova-manage" 2017-07-23 16:52:16 +00:00
Vladyslav Drok 176725180e Update ironic feature matrix
Set the attach and detach interface features as complete.

Implements: blueprint ironic-hotplug-interfaces
Depends-On: I48c4706b3eb6e0a5105e463236870921d55dbd93
Change-Id: I8ed286d57ccaab9a6cb0eda62e30859e7a17e826
2017-07-21 16:44:38 +03:00
chenxing fa0e8f69b4 doc: Switch to openstackdocstheme
Change-Id: If7afc2cb58759b16fc6f7caa44d0cf6b7bcf4d06
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
2017-07-21 11:35:48 +01:00
Dan Smith f2606322f7 Deprecate useless quota_usage_refresh from nova-manage
Since we no longer use usage records, we don't need the nova-manage
command to sync usage records with actual resource consumption.

Co-Authored-By: melanie witt <melwittt@gmail.com>

Part of blueprint cells-count-resources-to-check-quota-in-api

Change-Id: I55f7a2b6e15eec6e6ec97be23903325ad22bd4d4
2017-07-19 19:33:23 +00:00
Stephen Finucane ef9cbc0017 doc: Populate the 'user' section
Per the spec [1]:

  user/ – end-user content such as concept guides, advice, tutorials,
  step-by-step instructions for using the CLI to perform specific tasks,
  etc.

The remaining content all ends up in here.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I480eee9cd7568efe2f76dd185004774588eb4a99
2017-07-18 15:41:20 +01:00
Stephen Finucane 83e7763518 doc: Populate the 'reference' section
Per the spec [1]:

  reference/ – any reference information associated with a project that
  is not covered by one of the above categories. Library projects should
  place their automatically generated class documentation here.

There are a couple of documents that focus on nova internals, but won't
necessarily be applicable to user. These are moved here.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I94614c2383329e1fbed60d9c5aca3fab5170ef8f
2017-07-18 15:41:20 +01:00
Stephen Finucane a2165cf651 doc: Populate the 'contributor' section
Per the spec [1]:

  contributor/ – anything related to contributing to the project or how
  the team is managed. Applies to some of the current content under
  /developer, we are changing the name to emphasize that not all
  contributors are developers and sometimes developers are users but not
  contributors.

We currently have a handful of docs that focus on the "how to develop or
contribute" aspects of nova, and these are moved. Docs that focus on
architecture or design decisions for nova are not moved, as these will
go into 'reference'.

A TODO is added to the former 'api_plugins' document as it's mega
out-of-date and needs some serious work.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: Iad770688b4eafeb9caa710b4398b02d80a017a70
2017-07-18 15:41:19 +01:00
Stephen Finucane 18be5324d6 doc: Populate the 'configuration' section
Per the spec [1]:

  configuration/ – automatically generated configuration reference
  information based on oslo.config’s sphinx integration (or manually
  written for projects not using oslo.config). Step-by-step guides for
  doing things like enabling cells or configuring a specific driver
  should be placed in the admin/ section.

Only the 'sample_policy' and 'sample_config' files fit into this
category at present. We may wish to add files that use the oslo.config
and oslo.policy Sphinx integrations, but that can come later.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I587551ada1932876bca51a362f8dfeef6f7dd70b
2017-07-18 15:41:19 +01:00
Stephen Finucane be8fa67024 doc: Populate the 'cli' section
Per the spec [1]:

  cli/ – command line tool reference docs, similar to man pages These
  may be automatically generated with cliff's sphinx integration, or
  manually written when auto-generation is not possible.

All of the docs currently found in 'man' fit that category, so those and
those alone are moved. It'll be a great day in the parish when we can
replace all of these with cliff's Sphinx integration.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I45bed324ec37cfea7c1a574ec06af38e7b875a1c
2017-07-13 14:54:11 +01:00
Jenkins 6205a3f8c4 Merge "doc: Enable pep8 on doc generation code" 2017-07-13 12:44:06 +00:00
Jenkins b70476304b Merge "Add ability to signal and perform online volume size change" 2017-07-13 01:14:07 +00:00
Mathieu Gagné bbe0f313bd Add ability to signal and perform online volume size change
Allow Cinder to use external events to signal a volume extension.

1) Nova will then call os-brick to perform the volume extension
   so the host can detect its new size.
2) Compute driver will resize the device in QEMU so instance can detect
   the new disk size without rebooting.

This change:

* Adds the 'volume-extended' external event.
  The event tag needs to be the extended volume id.
* Bumps the latest microversion to 2.51.
* Exposes non-traceback instance action event details for
  non-admins on the microversion. This is needed for the
  non-admin API user that initiated the volume extend
  operation to be able to tell when the nova-compute side
  is complete.

Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>

Blueprint: nova-support-attached-volume-extend

Change-Id: If10cffd0dc4c9879f6754ce39bee5fae1d04f474
2017-07-12 11:53:20 -04:00
Stephen Finucane 62ccbe1c3f doc: Enable pep8 on doc generation code
As pep8 does not run on doc generation python code so we have some
style violations there. As it not too hard to fix the problems and
therefore enable pep8 on these files this patch proposes such a
change.

Change-Id: I26104ea66fc4f3e67f8227025f43202e483beb25
2017-07-12 14:20:25 +01:00
Stephen Finucane 6671ddc832 doc: Remove dead plugin
Whatever extra functionality the 'nova.ext.nova_todo' plugin provided
over the stock 'sphinx.ext.todo' extension, we're no longer using it and
it prevents us from using the stock one. Remove it and enable the stock
one instead.

Change-Id: I57fde86bf77dad87bb4d41ef8ad19f933f5c1260
2017-07-12 14:05:14 +01:00
Stephen Finucane bf7203ac89 doc: Use consistent author, section for man pages
There's a lot of duplication here. Given that 'conf.py' is Python, we
can simplify this greatly and focus on the real content differences.

The description text is the same for all options, but this isn't
centralized as it shouldn't be the same (this field should contain a
description of each individual tool).

Change-Id: I1a2a55ac7f041387597ef93be62411fe1673f8c1
2017-07-12 11:47:52 +01:00
Stephen Finucane 19f69bee80 doc: Remove cruft from conf.py
We're going to be doing some surgery on the docs, so clean this up
before we start.

Change-Id: I02f129783ebf272d8a92d1364301ab864c97e057
2017-07-12 10:36:08 +01:00
Jay Pipes 48268c73e3 placement: scheduler uses allocation candidates
This patch replaces the scheduler's use of GET
/resource_providers?resources=XXX with GET
/allocation_candidates?resources=XXX.

In doing so, we move the interaction with the placement API out of the
scheduler driver interface and up into the scheduler manager. This
allows us to make fewer changes to the underlying HostManager and
SchedulerDriver interfaces and isolate communication with the placement
API in a single place.

The provider_summaries part of the response from GET
/allocation_candidates is used to generate the UUIDs that winnow the
number of compute nodes retrieved by the filter scheduler during
scheduling. Following patches will add in support for actually doing
the claim from the scheduler against one or more resources providers by
examining the allocation_requests part of the HTTP response and picking
one that contains the host the scheduler picked during its _schedule()
loop.

Change-Id: I1c0bd2987dcbc38f23b71db2bc8e3267f85168c8
blueprint: placement-allocation-requests
2017-07-07 11:35:54 -04:00
Jenkins 4e6a7c18b1 Merge "[placement] Update placement devref to modern features" 2017-06-20 21:17:21 +00:00