Commit Graph

1208 Commits

Author SHA1 Message Date
Sean Dague 53f752a669 Create For End Users index section
This reorganizes the pieces that are for end users into a convenient
chunk up front in the main index page.

Part of bp: doc-migration

Change-Id: Ic2fcabbf3faa531fccb19cffa2564f005142e463
2017-08-08 15:19:01 -04:00
Jenkins 3f12c8badd Merge "doc: Add additional content to admin guide" 2017-08-08 19:06:38 +00:00
Jenkins 3bc32c47e5 Merge "Create reference subpage" 2017-08-08 19:05:46 +00:00
Stephen Finucane cadd25e9bc doc: Add additional content to admin guide
Import the following documents from the admin guide [1]:

- cli-manage-flavors.rst
- cli-nova-evacuate.rst
- cli-nova-manage-projects-security.rst
- cli-nova-manage-services.rst
- cli-nova-numa-libvirt.rst
- cli-nova-specify-host.rst
- cli-set-quotas.rst
- cli-set-compute-quotas.rst
- cli-os-migrate.rst
- cli-os-migrate-cfg-ssh.rst
- ts-no-emulator-x86-64.rst
- ts-multipath-warn.rst
- ts-failed-connect-vol-FC-SAN.rst
- ts-failed-attach-vol-no-sysfsutils.rst
- ts-failed-attach-vol-after-detach.rst
- ts-vol-attach-miss-sg-scan.rst

These were missed in the original import [2]. All 'ts-' files are merged
into a single 'support-compute' document, which is already in-tree.

[1] https://github.com/openstack/openstack-manuals/tree/stable/ocata/doc/admin-guide/source
[2] https://review.openstack.org/#/c/477497/

Change-Id: Ifa0039e270e54ea2fb58ab18ce6724e5e8e061a1
Closes-Bug: #1708666
2017-08-08 14:04:14 +01:00
Sean Dague b9efc9d641 Create reference subpage
In an attempt to make the main navigation sidebar not be visual mud
(and really confusing) create a reference sub page that explains all
the references.

Part of bp: doc-migration

Change-Id: I005fc24e49487631d7fe73cb498c61619bcaac9d
2017-08-08 12:28:50 +00:00
Sean Dague ecc6928a4a Fix all >= 2 hit 404s
This fixes all the >= 2 hit 404s from 2017-08-07 with
redirects. nova-cert is being referenced somewhere, in that case we
provide a 410 because that's never coming back.

Part of bp: doc-migration

Change-Id: I313e4a22dc2ad3faa890de864d00943b802e8b30
2017-08-08 07:32:31 -04:00
Jenkins b93432e907 Merge "Add Contributor Guide section page" 2017-08-07 17:18:25 +00:00
Sean Dague a5acc83c21 Add Contributor Guide section page
In order to wrangle together a top level TOC that makes sense, stop
including everything in the TOC (ideally we could convince sphinx to
not warn on that).

This creates a Contributor Documentation landing page with deep links
to all the relevant documents. It removes all those links from the
front page, and the TOC. They can be found by deep links or search,
and it is a less confusing initial experience for folks.

Part of bp: doc-migration

Change-Id: If5e7940ddd0ae3316f7475742c02abfe3df28ac4
2017-08-04 10:51:15 -04:00
Alexandra Settle 85cd4574b8 Update install guide to clearly define between package installs
Change-Id: I59ada8a4d4c9ff59fe494929510760f397396dc6
2017-08-04 12:45:55 +00:00
Jenkins 584cfa7335 Merge "doc: Import administration guide" 2017-08-04 12:03:39 +00:00
chenxing 575b529118 doc: Import administration guide
Import all docs from openstack-manuals.

Part of bp: doc-migration

Change-Id: I28bb8ce1f4a8653f176a554d2e95b4423c437972
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
2017-08-04 07:00:45 -04:00
chenxing 036642ce33 doc: Import installation guide
Import all docs from openstack-manuals.

Part of bp: doc-migration

Change-Id: If1fa15f5495a8a207042e7a43d34d32671c59ee1
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
2017-08-04 06:07:59 -04:00
Jenkins 8e23c0d45a Merge "doc: Start using oslo_policy.sphinxext" 2017-08-04 07:00:56 +00:00
Jenkins 68486465fa Merge "Add a caveat section about cellsv2 upcalls" 2017-08-03 22:19:34 +00:00
Dan Smith 916ba166c8 Add a caveat section about cellsv2 upcalls
This adds another subsection to the caveat section about operations that
require upcalls in Pike not being supported.

Change-Id: If95be4f631f929cd8c6528671433ae0fc747a6be
2017-08-03 21:20:58 +00:00
Stephen Finucane b03e815134 doc: Start using oslo_policy.sphinxext
Providing a sample policy file is all well and good, but it's not
exactly designed for readability on the web. Make use of the 'sphinxext'
module built into oslo.policy to do this.

Change-Id: I6cceeca7edcacb762daa1f22f2138e2d2334b3a2
2017-08-03 16:06:14 -04:00
Stephen Finucane 83a9c2ac33 doc: Start using oslo_config.sphinxext
Providing a sample configuration file is all well and good, but it's not
exactly designed for readability on the web. Make use of the 'sphinxext'
module built into oslo.config to do this.

Change-Id: I75e8f0adae7cfaaa6020870cdb20dc2144fc70eb
2017-08-03 16:06:14 -04:00
Stephen Finucane 7bc2ca1f28 doc: Remove dead files
The Sphinx themes now include Google Analytics code, therefore, it's not
necessary to keep the local version. In addition, some images are no
longer referenced anywhere and can therefore go away.

Change-Id: I4a3b48f726220e8db3dc79f0b4b5405df6d28f13
TrivialFix
2017-08-03 16:01:16 -04:00
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