Commit Graph

1240 Commits

Author SHA1 Message Date
Jenkins f28da08a1b Merge "Fix contributor documentation" 2017-08-17 04:55:56 +00:00
Jenkins c7153048f3 Merge "Clean up *most* ec2 / euca2ools references" 2017-08-16 19:55:12 +00:00
Jenkins 029c42243f Merge "Add documentation for documentation contributions" 2017-08-16 19:54:35 +00:00
Ken'ichi Ohmichi 547725946b Fix contributor documentation
There are some small comments on the review of
Ib2b49f70c55311195535a5ef250ff555e227fa0a
This is a follow-up for these comments.

Change-Id: I1d2d95a0864578161a34084db31eb460e895c1ec
2017-08-16 10:20:12 -07:00
Jenkins 5cf3d55259 Merge "Update api doc with latest updates in api framework" 2017-08-15 17:28:30 +00:00
ghanshyam 796f3036c2 Update api doc with latest updates in api framework
api.rst has many stale information now as we have done
many changes in api framework specially removal of
stevedore extensions loading and plain routing.

This commit modify this doc to reflect latest information
and remove v2 specific info which are no longer valid.

Note- in next part we will merge api_2.rst in this doc and
show 'adding api method' step by step.

Change-Id: I0628d8fa0b19c3fb09f1896402fc85dcae90916f
2017-08-15 07:02:40 +00:00
Jenkins 1bdf7991f9 Merge "doc: Extend nfv feature matrix with pinning/NUMA" 2017-08-14 21:24:13 +00:00
Stephen Finucane 8797ed5ac8 doc: Extend nfv feature matrix with pinning/NUMA
Detail these features, including links to the documentation. No tests
are provided as no upstream Tempest tests currently exist.

Change-Id: I1bb3674f35f83e2a33243103a267b4aff70f852e
2017-08-14 20:01:49 +00:00
Jenkins 33f3614135 Merge "doc: address review comments in stable-api guide updates" 2017-08-14 08:02:09 +00:00
Matt Riedemann c62ed630a9 doc: add superconductor up-call caveat for cross_az_attach=False
When attaching a volume, if CONF.cinder.cross_az_attach=False,
we attempt to lookup the AZ that the instance is in and compare
that to the volume AZ. The instance AZ lookup involves getting
host aggregates which are in the API database, and in superconductor
mode the cell conductor can't access to the API database.

For volume attach, we could remove this check from the compute
service since we already check this in nova-api so the check in
nova-compute is redundant.

However, we still have a problem with checking this during boot
from volume where nova-compute creates the volume and then
attaches it. At that point it's too late and we'll fail.

We should eventually create volumes during boot from volume in
conductor, like we've talked about doing with neutron ports
during server create, but that's not something we have today
so we need to point out this limitation.

Change-Id: I9cbe41e41f8ccdc9962ab593f313b5a47314a9d1
2017-08-11 09:22:27 -04:00
Matt Riedemann 904c4a1d9a doc: add another up-call caveat for cells v2 for xenapi aggregates
There is an up-call from the xenapi driver when performing a live
migration and --block-migrate is not specified such that the driver
checks to see if the source and destination hosts are in the same
aggregate. This fails in a super-conductor setup because the
aggregates are now in the API database and the cell conductor
won't be able to access that database by design.

Change-Id: I6c880c72d87eb0116cb57371e5d600dced2915f7
Related-Bug: #1709594
2017-08-11 09:05:14 -04:00
Jenkins f401d18a3d Merge "Improve stable-api doc with current API state" 2017-08-10 22:01:02 +00:00
Matt Riedemann 430af62aa3 doc: address review comments in stable-api guide updates
This addresses review comments made in change
I6522100a78241400b1ea059a39a32c259fe6ab90 which
updated the stable API docs.

Change-Id: Ib0ffe3e9702fd39914b2025096667e699bc432a0
2017-08-10 17:11:50 -04:00
Jenkins ba7b051d26 Merge "Structure cli page" 2017-08-10 21:04:44 +00:00
Jenkins 01e596e730 Merge "doc: Import configuration reference" 2017-08-10 21:04:01 +00:00
Jenkins d92eafbd85 Merge "Bulk import all config reference figures" 2017-08-10 21:00:36 +00:00
Jenkins b2301eacb3 Merge "rework index intro to describe nova" 2017-08-10 20:59:52 +00:00
Jenkins 15cc823466 Merge "Add For Operators section to front page" 2017-08-10 20:59:08 +00:00
Jenkins 45ac76d774 Merge "add cli to support matrix" 2017-08-10 00:51:03 +00:00
Jenkins 963d284350 Merge "Document service layout for consoles with cells" 2017-08-09 19:03:41 +00:00
Jenkins e62fe1accf Merge "doc: provide more details on scheduling with placement" 2017-08-09 19:01:12 +00:00
Sean Dague 7e693e9c5c Clean up *most* ec2 / euca2ools references
The ec2 / euca2ools command references definitely don't work any more,
this deletes most of them. The exception is the policy reference doc
which is over a year out of date, and needs more then surgical removal
of ec2 from it.

Change-Id: I963170f99037d5ed085e8c676ab55750c7f6372e
2017-08-09 11:20:12 -04:00
Sean Dague 54529f03c9 Add documentation for documentation contributions
Missing from our contributor guides is documentation guidelines,
starting a page there for now especially as there are a couple of
things that emerged in the great pike import that would be good to
write down.

Part of bp: doc-migration

Change-Id: Ib2b49f70c55311195535a5ef250ff555e227fa0a
2017-08-09 11:20:12 -04:00
Sean Dague 104efa6fb6 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
2017-08-09 11:20:12 -04:00
Stephen Finucane da224b3a05 doc: Import configuration reference
Import the following files from the former config-reference [1]:

  api.rst
  cells.rst
  fibre-channel.rst
  hypervisor-basics.rst
  hypervisor-hyper-v.rst
  hypervisor-kvm.rst
  hypervisor-lxc.rst
  hypervisor-qemu.rst
  hypervisor-virtuozzo.rst
  hypervisor-vmware.rst
  hypervisor-xen-api.rst
  hypervisor-xen-libvirt.rst
  hypervisors.rst
  index.rst
  iscsi-offload.rst
  logs.rst
  resize.rst
  samples/api-paste.ini.rst
  samples/index.rst
  samples/policy.yaml.rst
  samples/rootwrap.conf.rst
  schedulers.rst

The below files are skipped as they're already included, in slightly
different forms, in the nova documentation.

  config-options.rst
  nova-conf-samples.rst
  nova-conf.rst
  nova.conf

Part of bp: doc-migration

Change-Id: I145e38149bf20a5e068f8cfe913f90c7ebeaad36
2017-08-09 11:20:12 -04:00
ghanshyam a03c667109 Improve stable-api doc with current API state
extensions, stevedore and extensions config options are gone
and plain router is introduced in Pike.

Also this documents was little bit confusing about current and
old state of APIs.

This commit makes it more clear and reflect the current API state
and also describe the evolution of APIs.

Change-Id: I6522100a78241400b1ea059a39a32c259fe6ab90
2017-08-09 14:13:17 +00:00
Sean Dague 6b21efbc7f Bulk import all config reference figures
Most of these are used by the follow on patch, however because all
this content is deleted from openstack-manuals pulling these out of
history there is less straight forward. So bulk import even the ones
that aren't currently used into a top level figures repository.

Part of bp: doc-migration

Change-Id: I57929f3035f0a9f41398b50d93afee267d981f12
2017-08-09 08:10:47 -04:00
Sean Dague 8b072d7532 rework index intro to describe nova
The index previously was written for the developer docs, but this is
more than developer docs now. That also means this is the general
google landing page for people, so a basic "what is nova" is
appropriate.

Part of bp: doc-migration

Change-Id: I5fdafd9f6cf07a19bf86a6343663dad410887dcb
2017-08-09 08:10:46 -04:00
Matt Riedemann 204e7d7f42 doc: provide more details on scheduling with placement
This provides a more detailed, but still high level, explanation
of how the FilterScheduler is using allocation candidates to pick
hosts during scheduling, and how the allocations are handled during
a move operation, including a resize to the same host.

Ideally this content will live somewhere else in the devref, or
would be updated in the spec for blueprint placement-claims, but
for now this should suffice for Pike release notes that can point
at this upgrade doc.

Change-Id: I274c684f829bc310ebb17faabf498d36f4ceea0c
2017-08-08 21:56:14 -04:00
melanie witt 4a3e8ecf38 Document service layout for consoles with cells
This adds information about where the consoleauth service and console
proxies should run with multiple cells in Cells v2.

Change-Id: Ib817581dfe0c32d3888c242166e3daa7b954320a
2017-08-08 20:31:02 +00:00
Sean Dague ad69d0507f Add For Operators section to front page
This attempts to reorganize the front page content relevant to
operators into digestable chunks, including some summaries of links to
explain to people why they might want to follow those links to learn
more.

Part of bp: doc-migration

Change-Id: I6815958b2533d462a2e5d27e7be57440d9f4f40a
2017-08-08 15:21:02 -04:00
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