153 Commits

Author SHA1 Message Date
Naohiro Tamura
e852f5f16c Replace DIB installation step from git clone to pip
This replaces DIB installation step from git clone to pip
in Bare Metal Service Installation Guide so that all of DIB required
packages such as dib-utils can be installed automatically.
Without this change, diskimage-builder command fails due to
"dib-run-parts: command not found".
The install-dependencies script which tripleo-incubator provides
doesn't install all of DIB required packages.

Closes-Bug: #1414510
Change-Id: I0f68fc79b5addbf38713a42e8ac2d631e4f2f219
2015-01-26 23:09:08 +09:00
David Shrewsbury
0e95cc1e03 Add ipmitool to quickstart guide for Ubuntu
The ipmitool package was missing for the Ubuntu package list in
the quickstart guide. This has to be installed for the examples.

Change-Id: If7ec49540f9c46d96b5b381ebad6e652f5c90af8
2015-01-22 14:51:54 -05:00
Jenkins
7c8cd56d2a Merge "improve the neutron configuration in install-guide" 2015-01-16 03:42:59 +00:00
Hugo Nicodemos
7cb56b732e Rename localrc for local.conf
renamed since localrc file is not used anymore due to local.conf

Closes-Bug: #1411241
Change-Id: I3ee5707b101b6ac3da64ba1aac844d8fbd0cc436
2015-01-15 12:57:25 -03:00
Jenkins
0950370df4 Merge "Remove links autogenerated from module names" 2015-01-15 13:41:47 +00:00
Satoru Moriya
43355e180f Remove links autogenerated from module names
Having links autogenerated from module names in the developer
documentation is prone to bit rot as modules get renamed or moved
around.

One should use module index to get the same kind of information.

Change-Id: I499343ba669893736324116b44df01c69391fff1
Partial-bug: 1277282
2015-01-15 11:22:51 +09:00
Jenkins
b4872913e7 Merge "Add state machine to documentation" 2015-01-14 21:13:56 +00:00
Jay Faulkner
d1f772a8c5 Document dependency on fuser for pxe driver
This is provided by the package `psmisc` on all three documented
distributions.

Change-Id: Ie0e5b7c20e2ba701d75ed2853190b318c63c0413
Closes-bug: 1358820
2015-01-13 10:55:12 -08:00
Joshua Harlow
27d9f8b1d3 Add state machine to documentation
Since we can now generate the state machine that ironic
uses using the tools/states_to_dot.py generator we can
now build it and include it in the documentation for others
to view.

Change-Id: I4ffc298d0708cbac2573e1e2aee2d73836c27a80
2015-01-12 17:05:39 -08:00
Jenkins
dac82900e0 Merge "Delete unnecessary document files" 2015-01-12 11:56:37 +00:00
Jenkins
8c893fafa8 Merge "Add documentation to create in RegionOne" 2015-01-08 18:23:30 +00:00
Steven Dake
e8e4ee6d1c Add documentation to create in RegionOne
The default development documentation may not work with the
python-ironicclient.  It might print out an error about not
finding the region "regionOne" (eg if being used in
conjunction with some other OpenStack projects). Updated the
documentation with a note on how to address this -- by creating
in "RegionOne".

Change-Id: I9d569b84f1c6e5ae1354ba2668c334e8cb01a450
2015-01-08 14:06:16 +00:00
Satoru Moriya
afde5bf1f8 Delete unnecessary document files
This patch deletes unnecessary files and references to them
because they are just TOC files and also cause some warnings
in doc building.

Change-Id: I3bd230cc3b38a6d7a8d9d9b8c230eb34b90dd936
Partial-bug: 1277282
2015-01-08 16:01:35 +09:00
Haomeng, Wang
d598772d5b Fix typo in install-guide.rst
Change 'Bare Metal Servive' to 'Bare Metal Service'

Change-Id: I772b02c21ae0d30d688dffd4c7660cf8a1495132
2014-12-28 09:45:31 +00:00
Haomeng, Wang
fe54cbb22f improve the neutron configuration in install-guide
In this patch, improve the neutron configuration for the flat network:

If neutron-openvswitch-agent run with ovs_neutron_plugin.ini as the input
"--config-file", we have to edit ovs_neutron_plugin.ini, to add the [ovs]
section to enable the bridge mappings configuration.

Change-Id: Ibbd4fe384366c571d750cc1af44b2e866d6902b6
2014-12-23 02:26:52 +00:00
Junya Akahira
b6329aa627 Update command options in the Installation Guide
Fixed some of deprecated options.
  - python-glanceclient: --public option is ignored. (from version 0.15.0)
  - diskimage-builder: disk-image-get-kernel is deprecated.

Change-Id: I77154e578f5c98e8f3fb055005454d9a852f6c98
2014-12-17 23:32:42 +09:00
Jenkins
d98ce6c38f Merge "Add new enrollment and troubleshooting doc sections" 2014-12-16 10:27:27 +00:00
Devananda van der Veen
f28af8597b Add new enrollment and troubleshooting doc sections
Add a new Enrollment section to the install guide, explaining
the process of adding Nodes to Ironic.

Add a minimal Troubleshooting section as well, with some basic info
that can be expanded upon later.

Change-Id: I6299aae2b9e7511c61456a7619b9d4e521e48897
2014-12-15 14:46:52 -08:00
Ruby Loo
97ab88d818 Update dev quick-start for devstack
The devstack section of the developer's quick-start documentation is
updated:
1. replaces the https://devstack.org link (doesn't work) with
   http://docs.openstack.org/developer/devstack/
2. clarifies how to configure usage of the PXE or agent driver

Change-Id: I2220f685c862832f73b28157355e11c7b49ce29b
Closes-Bug: #1400461
2014-12-10 21:15:06 +00:00
Jenkins
3338c635b9 Merge "Remove duplicate dependencies from dev-quickstart docs" 2014-12-09 17:31:05 +00:00
Jim Rollenhagen
31a6092e73 Remove duplicate dependencies from dev-quickstart docs
Turns out certain versions of Ubuntu packages tox to use Python
3, which breaks installing MySQL-Python into 2.x virtualenvs.
Since we already have "pip install tox" in these docs, let's
stick with that method rather than depending on what distros do.

Also remove other packages from SUSE line that are
duplicated by the "pip install" line.

Change-Id: I472704ab879446586ec7fa7ecd79da4f7212b81d
Closes-Bug: 1399463
2014-12-09 07:50:50 -08:00
Jeremy Stanley
eb150c51df Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Dropped sections that duplicate each other after the change.

Co-Authored-By: Dmitry Tantsur <dtantsur@redhat.com>
Change-Id: I233df03368dbb4b7805d6dce28de00fa037353c7
2014-12-05 16:55:23 +01:00
Chris Krelle
4610c25c40 Add info on creating a tftp map file
This add instructions on how to create a tftp map file to the
install-guide. Also remove hard coded section numbers from iPxe
section.

Partial-Bug: #1323589
Change-Id: I0b5c36246f9170c512172929819b7d6a487804f4
2014-12-04 08:57:59 -08:00
Harshada Mangesh Kakad
919e6744bf Add documentation for SeaMicro driver
This commit documents the information on enabling and
configuring SeaMicro driver.
Closes-Bug: #1394918

Change-Id: Ic65557638234bf4cbf404fc6ddf6c2e6288752e2
2014-12-02 06:36:43 -08:00
Jenkins
a85e7038d8 Merge "Improve docs for running IPA in Devstack" 2014-11-26 17:23:27 +00:00
Jay Faulkner
5757300194 Improve docs for running IPA in Devstack
Documented what the settings are in the localrc, as well as adding the
credentials for swift so when your localrc is setup as documented,
devstack runs without prompting.

Change-Id: Ie965a6c3b4f97b14e97e78e8cf77c789a891a387
2014-11-25 08:58:50 -08:00
Ruby Loo
12c83984b6 Update 'Introduction to Ironic' document
The first few sections of the 'Introduction to Ironic' document were updated to:
- mention that it is included with OpenStack releases starting with Kilo
- mention that Swift is missing from the Conceptual Architecture diagram
- removes Figure 1.3.1 "Deployment Architecture" and the text surrounding
  that for several reasons: it places ir-cond on the same host as n-cpu, which
  is not advisable in some situations; it suggests placing ir-api on a
  monolithic "Cloud Controller Node", but does not explain why this unusual
  choice was made; and it does not include any depiction of the physical
  servers which Ironic is going to manage, nor the IPMI network connectivity
  to them which is required.
- mentions that for security reasons, ir-cond should be placed on an isolated
  host, as it is the *only* service which requires access to both data plane
  and IPMI control plane.
- modified (what was Figure 1.3.2) deployment_architecture_2.png so that it
  doesn't include a figure number

Change-Id: Ifeeba636c9e7de65385e9f9c631709b2dd09e25b
Partial-Bug: #1353688
2014-11-24 15:13:31 +00:00
Devananda van der Veen
93b4d6cf6b Correct link in user guide
The user guide was referencing the old Baremetal wiki page.
This has been corrected to reference Ironic's wiki instead.

Change-Id: I1a725e0f8ebafc1ac3c80b0976ccc3c3312416f6
2014-11-20 16:11:34 -08:00
Devananda van der Veen
1c8590890a Minor fix to install guide for associating k&r to nodes
Improve the install guide's instructions for associating a deploy kernel
& ramdisk to a node, rather than creating a new node.

Change-Id: Ibfbe805e5b762e6d146ffc50514fa7d6f3ebebe4
2014-11-20 16:00:27 -08:00
Jenkins
28adda80e0 Merge "Add documentation about Vendor Methods" 2014-11-19 19:21:20 +00:00
Sergey Lupersolsky
2d5f845e8d Adds help for installing prerequisites on RHEL
Certain prerequisites are not found by yum by default on RHEL. The yum
command specified in the RHEL instructions for installing prerequisites
fails to install python-pip and git-review. Adding a sentence directing
readers to use the EPEL software repository which has the missing
packages.

Closes-Bug: 1392355
Change-Id: Ibcbe9ff9e5d8eeb9f2511915d67dc53ac1dc1b63
2014-11-18 14:28:26 -08:00
Lucas Alvares Gomes
8cf772b494 Add documentation about Vendor Methods
This patch adds a quick tutorial on writing vendor specific methods to
a driver.

Implements: blueprint extended-vendor-passthru
Change-Id: Id23e73715e0058ce162a5dde8eeb3ad61d9e7131
2014-11-18 18:21:58 +00:00
Jenkins
d4bfa343e9 Merge "dev-quickstart.rst update to add required packages" 2014-11-17 19:51:42 +00:00
Jenkins
13945b21f3 Merge "Add ipmitool as dependency on RHEL/Fedora systems" 2014-11-17 13:53:59 +00:00
Peeyush Gupta
1347994971 Add ipmitool as dependency on RHEL/Fedora systems
Conductor has problems if ipmitool is absent on dev
machines. So add ipmitool as install prerequisite.

Closes-Bug: #1387495
Change-Id: I0f52f63ab2478634f6650657fd120e14a9b7925b
2014-11-17 10:29:08 +00:00
Naohiro Tamura
6e612260b7 dev-quickstart.rst update to add required packages
* added unspecifed required package "python-tox" for Ubuntu/Debian,
  and removed "py26" from "tox.ini" so that "tox" command doesn't
  invoke the tests in Python 2.6 environment.

Change-Id: I57df22a54fc08f2bb53a17d13b70706952815871
Closes-Bug: #1392304
2014-11-17 10:51:13 +09:00
Jenkins
8d931b83ef Merge "Add gendocs tox job for generating the documentation" 2014-11-16 02:54:42 +00:00
Lucas Alvares Gomes
f8e4eab684 Add gendocs tox job for generating the documentation
We already use tox to generate the sample configuration, run the tests,
etc.. This patch is adding a new 'gendocs' tox job for generating the
documentation. I always have a hard time remembering the syntax to
generate the docs, by adding it to tox I hope it may facilitate it a bit.

You can now (re)generate the docs with this tox job:

tox -egendocs

The quick start guide was also updated with the new command.

Change-Id: I6a755c31382310420d706e51a3e014941fd49872
2014-11-14 17:19:17 +00:00
Jay Faulkner
ecb8fbddd8 Add gettext to packages needed in dev quickstart
Our tests now require the binary "msgfmt" to be installed. This is
provided by the gettext package on Ubuntu and Fedora, and the
gettext-runtime package on OpenSuSE.

Change-Id: Ib8da08a89506325cacdd387728562a714f6b1119
2014-11-14 08:00:23 -08:00
Jenkins
9af038abb3 Merge "Update iLO driver documentation" 2014-11-14 15:32:21 +00:00
Ramakrishnan G
68ec55abad Update iLO driver documentation
This commit updates the iLO driver documentation - to change some
information in tested platforms, to add some examples, and to
make document more clear.

Change-Id: I0e50dd72764dc1fabbda93a16e131aa62759ddbd
2014-11-14 15:30:58 +05:30
Ruby Loo
c73e0b1977 Fix documentation on Standard driver interfaces
This fixes the documentation by removing 'rescue' (since we don't
yet have any rescue interface) and adding 'management' interface
to the list of Standard driver interfaces.

Change-Id: I34110fecbcff9c75d0f769eb3694eb509ec39e27
2014-11-11 16:13:57 +00:00
David Shrewsbury
eebb278452 Update install guide to install tftp
Our installation guide never mentioned the need to install the TFTP
server. This updates the PXE section instructions to correct that.

Change-Id: I2e0c43d377888520d274e36b3523aceca72013d6
2014-10-28 16:26:35 -04:00
Ruby Loo
7d6dea06f1 Put nodes-related API in same section
The documentation for our web API (v1) has the nodes-related API
in three different sections: Nodes, NodeStates, and BootDevice.
This makes it difficult to find all the available nodes-related
API.

This puts all the nodes-related API in the same Nodes section,
removing the NodeStates and BootDevice sections.

The ConsoleInfo class/type is included in the documentation as well.

Change-Id: I3bdcb2df13861d3a098b1880062b8115855c28b6
Closes-Bug: #1386291
2014-10-27 16:20:50 +00:00
Ruby Loo
201aec4a96 Add maintenance to RESTful web API documentation
This adds [PUT|DELETE] v1/nodes/(node_uuid)/maintenance
to our RESTful web API documentation. It will show up at

http://docs.openstack.org/developer/ironic/webapi/v1.html#nodes

Change-Id: I42171e429ec72d270b51b246d7c8c6c38fed2e1e
Implements: blueprint maintenance-reason
2014-10-22 14:06:09 +00:00
Devananda van der Veen
92e7fc73db Update doc headers at end of Juno
- remove note that Ironic is incubated
- remove statements about Icehouse being beta quality
- add note to deploy/install-guide that it refers to Juno release

Change-Id: I1fb7059bdd01d2bd9a6d20c8f131d51608188451
2014-10-16 09:41:44 +01:00
Ramakrishnan G
89c7500311 Add documentation for iLO driver(s)
This commit documents the information on enabling and
configuring iLO driver(s).

Change-Id: I596b1c5631438bed783bf94df1fa92190b9ba0fd
2014-10-14 21:15:09 +05:30
Vinay B S
befe332e28 Adds instructions for deploying instances on real hardware
The following sections have been added to the install-guide:

1. Set of instructions for configuring Neutron to talk to baremetal.
   Flat networking is taken as the usecase. Instructions for using
   other types of networks will be added eventually.
2. Set of instructions for adding the required images to glance.
   Includes instructions for creating the deploy and user images
   using disk-image builder.
3. Set of instructions for creating the baremetal flavor and
   associating the deploy images to the flavor.
4. Instruction for checking that the ipmitool on the openstack setup
   is able to control baremetal's power state.

Change-Id: If45f0f32808308cf2d451a905ca7cd840c81c7d2
Partial-Bug: 1323589
2014-10-09 21:51:27 +00:00
Jenkins
78b3921dc8 Merge "Add documentation for PXE UEFI setup" 2014-10-09 21:19:33 +00:00
Vladyslav Drok
91fde155be Fix markup-related issues in documentation
This change fixes all markup mistakes in docstrings that lead to
warnings and errors during docs building.

Partial-bug: #1277282
Change-Id: I092a684b7587b802427d57f4292398bfd21deeb1
2014-10-09 15:06:22 +03:00