Commit Graph

49 Commits

Author SHA1 Message Date
Takashi NATSUME 632150aaa8 doc: Fix nova-manage cell_v2 list_cells output
The output of 'nova-manage cell_v2 list_cells' command
has been modified since Idb306e4f854957fd2ded9ae061fc27f0ef768fc0 and
I96a6d5e59d33c65314fc187c0286ce3408d30bdc.

Fix the output of the command in the install documents.

Change-Id: I45d0e2ee1ff182347345af46f9a388f2884ba6cd
Closes-Bug: #1833647
2019-06-24 10:09:44 +09:00
Stephen Finucane 009fd0f35b docs: Remove references to nova-consoleauth
We're going to remove all the code, but first, remove the docs.

Part of blueprint remove-consoleauth

Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-17 15:18:31 +01:00
Zuul af4cd78e85 Merge "Modifying install-guide to include public endpoint for identity service" 2019-06-14 21:53:31 +00:00
Sharat Sharma 89f8ff449b [Docs] Update the confusing console output
Change-Id: I319eccc1852ad2bb80018eb20fdd968c51a5c284
Closes-Bug: #1784992
2019-06-06 06:59:41 -04:00
Sharat Sharma 97ca86fad7 Modifying install-guide to include public endpoint for identity service
- Adding a line to set www_authenticate_uri to point to the public identity endpoint
- Removing version for public endpoint of identity service as per discussion in
  https://review.opendev.org/#/c/643938/5/doc/source/install/from-pypi.rst@139

Change-Id: Iba5e5c9289196f24f0fbe0ae305d6bd834d18645
Closes-Bug: #1822986
2019-06-06 03:32:49 -04:00
zhang.lei 8f2b7d8128 Remove zeromq from getting started with compute docs
ZeroMQ driver is deprecated, as per the Dublin 2018 PTG decision:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128055.html

This change simply replaces the zeromq mention with a link to the
other oslo.messaging drivers.

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

Change-Id: I0c8d488c1daecc71d7d2817ffb4ae10727771d19
2019-05-30 12:00:00 -04:00
Takashi NATSUME a71af2bead doc: Capitalize keystone domain name
There is an inconsistency for keystone domain names
in the nova doc. ('default' and 'Default')
Replace 'default' with 'Default'.

Change-Id: I437092d04b0cbea78942efd5f565734f34bcbcb2
Closes-Bug: #1821411
2019-03-27 10:37:38 +09:00
Chris Dent f21b07153d Remove placement from nova install docs
In a fairly hack and slash fashion, remove the installation of placement
from the nova install docs. Placement will have its own installation
docs.

Configuring access to placement from the controller and compute nodes is
still described.

The depends-on is to the patch that provides placement install docs.

The output of 'nova-status upgrade check' is updated to reflect the
current state of the output of that command; this means it now
includes a fair bit more than checking cells v2 and the existence
of the placement API.

Depends-On: https://review.openstack.org/#/c/628220/
Change-Id: I9e082a9c6d4b6369f1ec6c17bbd3ccc417a5e97b
2019-02-07 10:39:59 +00:00
Zuul af9977c71c Merge "Restore nova-consoleauth to install docs" 2018-12-17 16:36:28 +00:00
Zuul 5ca357c100 Merge "Use links to placement docs in nova docs" 2018-12-08 10:05:43 +00:00
Zuul 5bf6f6304e Merge "Deprecate the nova-xvpvncproxy service" 2018-12-05 13:18:41 +00:00
Zuul e26ac8f24a Merge "Deprecate the nova-console service" 2018-12-05 13:05:06 +00:00
melanie witt 983e6ea551 Restore nova-consoleauth to install docs
The installation of the nova-consoleauth service was erroneously
removed from the docs prematurely. The nova-consoleauth service
is still being used in Rocky, with the removal being possible in
Stein.

This should have been fixed as part of change
Ibbdc7c50c312da2acc59dfe64de95a519f87f123 but was missed.

This is also related to the release note update in Rocky
under change Ie637b4871df8b870193b5bc07eece15c03860c06.

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

Closes-Bug: #1793255
Related-Bug: #1798188

Change-Id: Ied268da9e70bd2807c2dfe7a479181fbec52979d
2018-11-28 15:21:55 -05:00
Takashi NATSUME 7dd7d9a5fa Use links to placement docs in nova docs
Placement documents have been published since
I667387ec262680af899a628520c107fa0d4eec24.

So use links to placement documents
https://docs.openstack.org/placement/latest/
in nova documents.

Change-Id: I218a6d11fea934e8991e41b4b36203c6ba3e3dbf
2018-11-26 05:39:56 +00:00
caoyuan 9f937c5ab7 Update the description to make it more accuracy
after the changed[1], the nubmers of service components on
controller node should be two rather than three.

[1]: https://review.openstack.org/#/c/604277/

Change-Id: Iada43eb7f36f946d1713b20a50ebdeb8c69d0545
Closes-Bug: #1801444
2018-11-03 09:48:49 +08:00
Stephen Finucane 4e6cffe45e Deprecate the nova-xvpvncproxy service
This is a relic that has long since been replaced by the noVNC proxy
service. Start preparing for its removal.

Change-Id: Icb225dec3ad291b751e475bd3703ce0eb30b44db
2018-10-15 10:03:13 +01:00
Stephen Finucane f18ae13e36 Deprecate the nova-console service
As discussed on the mailing list [1].

[1] http://lists.openstack.org/pipermail/openstack-dev/2018-October/135413.html

Change-Id: I1f1fa1d0f79bec5a4101e03bc2d43ba581dd35a0
2018-10-15 10:03:08 +01:00
zhang.lei 1423f920bb Remove useless TODO section
Change-Id: Ia55924d36e75e050e65c19389d62e21f87dea98b
Closes-Bug: #1796676
2018-10-09 01:43:22 +00:00
YI-JIE,SYU bc479a992d Remove deprecated nova-consoleauth reference from doc
Because nova-consoleauth had deprecated since version 18.0.0,
it is better not to give reference of this service in verify operation
documentation file.

Change-Id: I0c3b9cfe96bcc3d7b6106c3e972ee9e2f79e419b
2018-09-21 10:18:34 +00:00
Matt Riedemann 7c3c3b9863 Add contributor guide for upgrade status checks
This adds some background, guidelines and structural
notes on writing nova-status upgrade checks.

This is intentionally written with some potentially
redundant information or nova developers as it's
also meant to be consumed outside nova as part of the
community-wide "upgrade-checkers" goal for Stein [1].

Story: 2003570

[1] https://governance.openstack.org/tc/goals/stein/upgrade-checkers.html

Change-Id: I340b25edeab3ac19c5d0bedfc69acd037d57bdd2
2018-09-19 18:50:25 +00:00
Zuul 03ccb1f933 Merge "Update install guide for placement database configuration" 2018-07-31 10:32:49 +00:00
jichenjc e0546870cd Enhance doc to guide user to use nova user
The document doesn't follow previous pattern to guide use
in using nova user to execute command and lead to issue

Change-Id: I795706a8f78ab4154bd39ce6259901800b34890e
Closes-Bug: 1781573
2018-07-23 23:48:33 +00:00
chenxing e06c287cbf Update install guide for placement database configuration
Change-Id: I295fe539321bcce3449b522d54121985577c4b35
Partial-Bug: #1778227
2018-07-05 11:21:31 +08:00
Zuul d741f624c8 Merge "doc: Start using openstackdoctheme's extlink extension" 2018-05-30 15:21:12 +00:00
smartu3 c0c2cbfe51 Fix doc mistakes
Change-Id: I8000aa98e09f8eea382f85fff9c2431b9390502b
2018-05-29 18:44:35 +08:00
Zuul c8fd5ce108 Merge "Fix inconsistency in docs" 2018-05-18 16:30:51 +00:00
chenxing d163fb6d69 Update the deprecate os_region_name option
Option "os_region_name" from group "placement" is deprecated. Use
option "region_name" from group "placement".

Change-Id: Id44d456bb1bdb0c5564ad4f5d9cdee2f41226052
Related-Bug: #1762106
2018-05-18 15:35:31 +00:00
Robin Naundorf dd1dea22f2 Fix inconsistency in docs
* Make the `True` lowercase to reflect examples in config and
    other parameters in docs

TrivialFix

Change-Id: I259d36bc15e034c248ec39b2c5c97ff95986b31b
2018-05-18 09:37:02 +02:00
caoyuan 17105cce3a Update auth_url in install docs
1. Beginning with the Queens release, the keystone install guide
recommends running all interfaces on the same port. This patch
updates the install guide to reflect that change.
2. update the deprecated neutron auth options

Change-Id: I5c0a6389b759153bae06fa43846f03ac083c3db4
2018-05-15 13:06:07 +00:00
melanie witt e91dad3ee9 Deprecate the nova-consoleauth service
Part of blueprint convert-consoles-to-objects

Change-Id: I9bfa89d2d8fe2b5803b4e1478377e13dc3231b1c
2018-05-03 10:02:29 -04:00
Stephen Finucane dd1a416bc9 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-05-03 14:34:47 +01:00
Matt Riedemann 698630e1a4 Update docs for [keystone_authtoken] changes since Queens
The auth_uri option was deprecated and renamed in Queens:

  I0cf11da3d395749df28077427689fdafc8a6b981

The auth_uri option is also no longer necessary, at least
for the purpose of the nova install guide, since all identity
service requests can be served through the single auth_url.

This change removes auth_uri usage and also updates the
auth_url value to match what is in the keystone install
guide:

https://docs.openstack.org/keystone/queens/install/keystone-install-ubuntu.html

Change-Id: Iff332890cbe1ba5b3876874e351b09c377d8dd5d
Closes-Bug: #1765144
2018-04-19 15:50:33 -04:00
Matt Riedemann a6d9655d78 doc: add a link in the install guides about configuring neutron
It is not uncommon to triage bugs on a weekly basis where the
[neutron] auth credentials are not configured in nova.conf, which
generally leads to a 500 response in the compute API because of
the auth error.

With respect to neutron, the compute install guides really only
say to set use_neutron=True, but don't mention that configuring
the [neutron] section for auth is required. The networking service
install guide does, so it's a bit confusing why people make this
mistake in the first place, but as a reminder, this change adds
links from the compute install guide to the relevant sections
in the networking service install guides.

Change-Id: Id17457bd2770fcbebd6231919ba4002e75410089
Closes-Bug: #1761487
2018-04-06 14:46:45 -04:00
Zuul 3630abe816 Merge "Re-work the metadata service docs" 2018-03-13 21:44:45 +00:00
Matt Riedemann 43f91a87cb Re-work the metadata service docs
The metadata service docs were hard to find since they were nested
down in some nova-network admin guide docs, and they were a mix of
end user and admin deployment guide information.

This change splits out the end-user facing content into a user
guide and leaves the deployment-specific information in the admin
guide, and links are updated appropriately.

The admin guide portion also referenced some config options that no
longer exist, so those are also removed and vendordata_providers
is added with a link to the vendordata guide. The options themselves
are cleaned up for their current groups and linked to the config option
docs.

Change-Id: I66035366f3a7ca62ea12d6afa74d13db01ec9f8d
2018-03-08 11:54:41 -05:00
Nicolas Bock d8a3956e42 install-guide: Wrap long console command
Long console commands should be wrapped into several lines for
readability.

Change-Id: I159e11ab4dbc3a29d310d13afb094dc626e9437c
2018-02-13 16:22:14 -07:00
Nicolas Bock 37d86888cb install-guide: Make formatting of console consistent
The formatting of the console commands is inconsistent between the
endpoint creation of the `compute` and the `placement` services. This
change reformats the commands.

Change-Id: I18f1cb8d5b3335d03e20c955c3c901b8dc1a8129
2018-02-13 14:00:08 -07:00
Zuul 21ec64b2c6 Merge "Fix SUSE Install Guide: Placement port" 2018-02-05 10:03:45 +00:00
zhang.lei 020980d965 Fix the incorrect RST convention
This blank line cause the font size of nova-api service description
rendered bigger than other content[1]. We should remove it.

[1] https://docs.openstack.org/nova/latest/install/get-started-compute.html

Change-Id: Ic8e487f6db9ad62027ac17853eeb04c0fdaaa6b4
2018-01-26 10:00:18 +00:00
Andreas Jaeger 0f8cdc606f Fix SUSE Install Guide: Placement port
The bug report says all:
"There is a mismatch configuration for placement.
 In the controller configuration, the guide suggests endpoints creation
 pointing to port 8778, however in the default file provided in SLES 12
 SP3, the port used is 8780."

Fix documentation to match sample file.

Change-Id: Ib4c881058b9b90ba136ff223064c113e63f98379
Closes-Bug: #1741329
2018-01-26 08:06:45 +01:00
Guoqiang Ding 66a44c95f1 Update the documentation links
The documentation about "ops-guide" has been moved.

Change-Id: I151d1f989cb032c3a3775e5bfffcec58a2cf0121
2017-11-28 11:07:36 +08:00
Ken'ichi Ohmichi bf090ab0d6 Remove doc todo related to bug/1506667
As the bug report 1506667, the bug has been fixed already since 2016-11-22.
In addition, the bug is just kind of reminder to avoid forgetting to
include example config files of upstream in ubuntu packages.
That[1] makes readers confused, so let's just remove it.

[1]: https://docs.openstack.org/nova/pike/install/controller-install-ubuntu.html#install-and-configure-components

Change-Id: I793d58dbc6bad097c772f7715430e75d74521253
Related-bug: #1506667
2017-10-03 17:15:04 -07:00
Jenkins b73cd8658b Merge "conf: Rename two VNC options" 2017-09-20 14:27:20 +00:00
Takashi NATSUME 2fce8a1396 Fix the ocata config-reference URLs
Replace the ocata config-reference URLs with
URLs in each project repo.

Change-Id: I48d7c77a6e0eaaf0efe66f848f45ae99007577e1
Closes-Bug: #1715545
2017-09-19 06:38:15 +00:00
Andreas Jaeger 4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
Stephen Finucane e5a03e3c54 conf: Rename two VNC options
Make the lives of operators easier by using consistent opt naming for
similar features.

Change-Id: Ic05c2c8364e015f6878b0bc25449216624568ad5
2017-09-04 17:22:16 +01: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
Alexandra Settle 85cd4574b8 Update install guide to clearly define between package installs
Change-Id: I59ada8a4d4c9ff59fe494929510760f397396dc6
2017-08-04 12:45:55 +00: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