227 Commits

Author SHA1 Message Date
Dmitry Tantsur
acc6ce3498 Minor improvements to the resource classes documentation
This change makes it clearer that scheduling based on resource classes
is the default now. Also fixes small issues and nits spotted on review
I22234aafdd195dd76c621b93042a67cdb36f3e65.

Change-Id: Ia9a06d6b59024781069bb6fd9a9fb18e1217a949
2017-08-30 15:22:00 +00:00
Dmitry Tantsur
9935093ead Update Nova configuration documentation
* Actually explain *why* we change options, instead of merely copy-pasting
  an old version of their description.
* Document the new consecutive_build_service_disable_threshold, which may
  be quite confusing at first.
* Do not force options that are not needed with resource classes.
* Remove excessive indentation from the list.
* Small wording fixes here and there.

Change-Id: Ia60fedb8b28936530b24f5f05a654e083fc67499
2017-08-30 15:21:34 +00:00
Shivanand Tendulker
cb793d0136 Fix indentation in few of the documentation pages
Partial-Bug: #1712860
Change-Id: Id467f5a917e61643823a9d82faa94516ea250f43
2017-08-29 05:49:52 -04:00
Jenkins
57ac383316 Merge "Configuration documentation migrated" 2017-08-23 14:11:16 +00:00
Jenkins
e48abbdf01 Merge "Documentation for irmc hardware type" 2017-08-23 13:57:32 +00:00
Ilya Etingof
af8f46b7f4 Configuration documentation migrated
Documentation layout aligned with the OS standards.

The admin page cleaned up - unrelated references moved
elsewhere linking merely admin pages.

The configuration page refactored, ironic.conf
and policy.conf documentation and samples
automatically generated by oslo_config.sphinxext.

Change-Id: I9075e2688f59ecd8ab5c489679f2c53d6294f28d
2017-08-23 15:39:29 +02:00
Dao Cong Tien
d68834ab1b Documentation for irmc hardware type
Added documentation for irmc hardware type. Also added
some anchors into enabling-drivers.rst due to the current
doc needs to refer to some parts of that one.

Change-Id: Ie5bb4bb06120a8dd42eb900c8c3a18e7e97ee6f0
Closes-Bug: #1659209
2017-08-23 09:37:28 +07:00
Ruby Loo
8aadc1a229 Correct URLs in install docs
This corrects the URLs in the install documentation. The changes include:
- changing http to https
- changing absolute links to relative links (where applicable)
- updating links (due to doc migrations)
- removing old links

Change-Id: Iecca07e0da5e6b326baa0142f366449a4c5cfd89
2017-08-22 16:47:46 -04:00
Jenkins
8c5d783ffe Merge "Add storage interface to enabling-drivers doc" 2017-08-16 19:29:22 +00:00
Julia Kreger
f471601f7b Add storage interface to enabling-drivers doc
Adds the storage interface to the enabling-drivers documentation
with example configuration, and notes that the interface is
explicitly an "opt-in" interface.

Change-Id: If471708c7827954a1935b4f6c0a312b9fa258c43
Partial-Bug: #1559691
2017-08-16 18:13:33 +00:00
Jenkins
cc79484e86 Merge "Update the documentation links - install guide" 2017-08-15 07:42:32 +00:00
Pavlo Shchelokovskyy
5ff1e90e93 Update the documentation links - install guide
This patch updates the old links existing in install guide.

Change-Id: I3a9b4d896ecd7dff2cdc118d3612d5fbd4d32fc9
Co-Authored-By: Chason Chan <chen.xing@99cloud.net>
2017-08-15 09:46:59 +03:00
Dmitry Tantsur
c7d7f18ba2 Update the resource classes documentation based on recent progress
The feature works now, so we can remove uncertaincy from the docs. Also adds
an upgrade release note to populate the resource_class field before the upgrade.

Change-Id: I22234aafdd195dd76c621b93042a67cdb36f3e65
2017-08-11 17:38:56 +02:00
Jenkins
45c7d8e1de Merge "Guide on upgrading to hardware types" 2017-08-11 14:43:19 +00:00
Dmitry Tantsur
d39f9af92b Guide on upgrading to hardware types
Only covers the generic cases for now. More drivers should be added later.

Related-Bug: #1524745
Partial-Bug: #1690185
Change-Id: Ic63c7ec7068db84931ac4ede712691327547810e
2017-08-10 16:05:41 +02:00
Pavlo Shchelokovskyy
3d9895cc0b Remove SSH-based driver interfaces and drivers
SSH drivers are being unsupported for about a year now. All current
stable branches of ironic are officially supporting IPMI-capable HW
simulation via virtualbmc.
All ironic-related gate jobs have already been switched
to not use or enable those drivers.

This patch finally removes SSH-based power and managemtnt driver interfaces
and all classic drivers using those from ironic code and documentation.
Related exceptions and `ssh_connect` function, together with dependency
on `paramiko` package are removed as well.

Change-Id: Ieda7249b9cd78e3be1eff37804996295fc8d3969
Closes-Bug: #1570301
Depends-On: I9b60c9fa24652e9e64e787cd4e5b0152f51e7a28
2017-08-01 12:39:39 +00:00
Jenkins
71f65f5baa Merge "Update comments related to ipmi & old BMCs" 2017-07-26 19:09:39 +00:00
Jenkins
338fdb94fc Merge "Fix small issues in the installation documentation" 2017-07-26 13:49:56 +00:00
Dmitry Tantsur
fe295ffb5a Fix small issues in the installation documentation
Fixes nits spotted on the following reviews:
* https://review.openstack.org/#/c/461834/
* https://review.openstack.org/#/c/462151/
* https://review.openstack.org/#/c/466741/
* https://review.openstack.org/#/c/466734/

Also updated links in the touched files.

Related-Bug: #1524745
Change-Id: I12cfbbd4cbdd9423f86d0b3d9f4209427313c472
2017-07-25 19:30:29 +02:00
Alexandra Settle
4463d44dd3 Adding note for ironic virt driver nova-compute changes
Backport: ocata newton
Change-Id: I2f56fc66311c5489714d1996943bc3946fc2193f
2017-07-24 14:13:07 +00:00
Ruby Loo
3f345c4a37 Update comments related to ipmi & old BMCs
The help string for [ipmi]/command_retry_timeout is incorrect. From Sam Betts [1]:
so looking at when this option was introduced ... it was originally introduced
by the ipminative driver which used it as the timeout for waiting until the power
state changed to the requested state. Reading between the lines in the commits
that added this option and documentation, the "setting this too low might break
things" comment originates from bugs in IPMInative. Later on the IPMItool driver
then overloaded this configuration option and changed its meaning by introducing
the min_command_interval config option. It continued to be used for the timeout
for waiting for requested state, but it also now contributed to the the number
of times a IPMItool command would retry retryable errors, which was/is worked out
by dividing retry_timeout by min_command_interval. Now IPMInative no longer in
tree I think we should clean up some of this information.

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

Change-Id: I8cd8e25a2fb224d477799a2e561573406f9427a9
2017-07-13 10:37:27 -04:00
Ruby Loo
578f01678c Follow-up to fix for power action failure
This is a follow-up patch to the patch so that the power status
is not retried if a power action fails:
ee5d4942a1c33736ffe05ec01619142be400c2f4

It addresses the comments as well as adds more clarification
and updates the documentation to refer to the new
[ipmi]command_retry_timeout config option.

Change-Id: Ib21544da260565ae399e2d07b32af9bd8b810280
Related-Bug: #1692895
2017-07-13 10:19:27 -04:00
Sam Betts
5647bfc246 Move doc/source/dev to doc/source/contributor
Change-Id: I6a3d143cff31348c62d8825f29f7484bafb9c8f0
2017-07-06 12:59:24 +01:00
Sam Betts
02015a4be6 Move operator docs into into doc/source/admin
Change-Id: I13f90a0b183b7799b4c8b5c340052d96f717fa9f
2017-07-05 12:16:37 +01:00
Sam Betts
aeb5306093 Move install guide into new doc/source/install location
Change-Id: I7d853142aaf794869466a1ba1bfaa82fd8851b7a
2017-07-05 12:16:37 +01:00
Devananda van der Veen
a0a013c927 Some minor clean up of various doc pages
* simplify the links on index.rst
* update the main description on the index page

* move install/ironic-install under deploy/
* rename ironic-install to install-guide
* rename userguide to user-guide
* clarify a few things in the install-guide

Change-Id: Ic6eff035df42d0c3fa78f54eac7ad8322ebb0afc
2014-04-15 12:08:43 -07:00
Ruby Loo
2adc6bbf66 Install guide for Ironic
This contains the beginnings of documentation on how to
install and configure the Bare Metal Service (ironic).

This is modelled after documentation available at
http://docs.openstack.org/havana/install-guide/install/apt/content/.

Change-Id: I7bf0a9caaf5bd5a2fcfc6fd0b0addeedb7ca26cb
2014-04-15 13:28:09 +00:00