31 Commits

Author SHA1 Message Date
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
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
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
Alberto Planas
3e57528b0b Adds openSUSE support for developer documentation
Support for openSUSE documentation is updated in this patch.

Change-Id: I3606c999fd1a17df975d9dd734c2582841ecc152
2014-09-26 15:51:20 +02:00
Lucas Alvares Gomes
1a4a5e282f Separate the agent driver config from the base localrc config
This makes the copy&paste much easier.

Change-Id: I22737c634fd20e0a1c4aaab71b1e2c769678eeec
2014-09-24 14:44:52 +01:00
Jenkins
9351bb49a0 Merge "Update devstack docs, require Ubuntu 14.04" 2014-09-24 10:04:33 +00:00
David Shrewsbury
de690bd21c Update docs with new dbsync command
The ironic-dbsync utility was updated with a new 'create_schema'
command with this review:

https://review.openstack.org/107629

This updates the quickstart guide to use this new command. We also
change the deploy guide to use it, mainly for consistency of usage
in our documentation.

Change-Id: I2b0e8620c1143822c1ba263d4004499ad5ea9cff
Closes-Bug: #1347604
2014-09-23 16:37:56 -04:00
Adam Gandelman
d6bf24f48e Update devstack docs, require Ubuntu 14.04
We no longer test deploying Devstack + Ironic on Precise 12.04 anywhere,
so we should no longer promise that it is functional there.  This removes steps
of the DevStack documentation that sets up access to the Cloud Archive and
explains that Ubuntu 14.04 is the minimum supported OS.

Closes-bug: 1371300

Change-Id: I99b7705c2c78443c7a95ff499b8c9fde33964c46
2014-09-23 10:37:30 -07:00
Jim Rollenhagen
8d9b80684b Fix Devstack docs for zsh users
The current docs fail with the following error:
$ image=$(nova image-list | egrep "$DEFAULT_IMAGE_NAME[^-]" | awk '{print $2 }')
zsh: bad math expression: operand expected at `^-'

With this change, these docs work as expected for zsh users.

Change-Id: I56c39718cfe40208f62ea4786d684f6b24431ed9
2014-09-15 16:42:03 -07:00
Lucas Alvares Gomes
1bd831bf33 Update DevStack guide when querying the image UUID
The command to query the UUID of the default image to be deployed
was retuning more than one UUID because of a grep problem, that would
also cause the "nova boot" command to fail because it was passing more
arguments that expected.

This commit fix the regex to query the UUID of the image by ignoring
what comes after the name of the image.

Change-Id: I03ad610fdd3313977b61d0d82bd1b33811f7ece1
2014-08-19 12:00:07 +01:00
Jim Rollenhagen
e7c8b2d7a6 Add docs for agent driver with devstack
This allows users to run Ironic with the agent driver in devstack.

Change-Id: I9703041bde6bd1c5f19b1c732cda7e7b025aa8c1
2014-08-16 10:13:24 -07:00
Daryl Walleck
6958e4085f Updates the Ironic on Devstack dev documentation
The current devstack configuration in the dev documentation
is out of date and will not successfully spin up a
Nova with Ironic driver environment. One of the critical
changes necessary is to set the IRONIC_VM_SPECS_RAM to 1024,
as that is now the minimum size for a virtual Ironic node.

This change also updates the configurations to more closely match
the ones being used for the virtual ironic Devstack job and
explicitly sets file logging to make debugging easier.

Change-Id: Ifbe0af9759483ccd80e74b24d45eaa4726c4b101
2014-07-06 22:33:38 -05:00
Ruby Loo
84842d15ff Update "Exercising the Services Locally" doc
The sample config used to have several drivers enabled, but this was changed
to default to the 'pxe_ipmitool' production driver. The developer documentation
for "Exercising the Services Locally", has examples using the 'fake_ipmitool'
driver. It won't work since only the pxe_ipmitool driver is available. This adds
instructions for updating the config file to enable fake_ipmitool instead of
pxe_ipmitool.

Users sometimes encounter the 'NodeLocked' exception while trying out the
sample "ironic" commands, due to the periodic sync_power_state task locking
the node. Documentation was added with instructions on how to turn off this
background sync_power_state task via a config setting.

Change-Id: Id53db08df59d13ca7a52505d6b3c0931551f4bf4
2014-06-26 13:27:38 +00:00
David Shrewsbury
1141e7ad9c Update dev quickstart guide for ephemeral testing
Devstack now supports the IRONIC_VM_EPHEMERAL_DISK variable
which allows the user to specify the size of the ephemeral
disk partition. This change documents how to use this variable
to boot an instance with ephemeral storage.

Change-Id: Idd3bf8c4c63d32a8ed2bacd37ba642eb70f709db
2014-05-19 14:39:14 -04:00
Adam Gandelman
c02a2a3fba Remove some obsolete settings from DevStack doc
The BM_* variables are no longer used by Devstack for Ironic
deployment and the new defaults should work fine. Removes
references to the old settings.

Change-Id: Ia19dccaf389273c5a224b804eb270c08d31a1811
2014-03-27 12:26:50 -07:00
Adam Gandelman
e9e5a1e335 Documentation for deploying DevStack /w Ironic
Adds a section to the developer quickstart doc explaining
how to deploy Ironic as part of devstack.

Change-Id: I26a6f8faa882bfaa94dd6eb26e6bef197f12b25c
2014-03-21 13:22:25 -07:00
Roman Podoliaka
9f8748d1d8 Set the database.connection option default value
This was previously set right before ironic-api start, but the
default value must also be present for ironic-dbsync calls.

Note: the default value of database.connection is changed here - from
now on the sqlite database will be stored in ./ironic/ironic.sqlite
instead of ./ironic/openstack/common/db/ironic.sqlite.

Closes-Bug: #1290645

Change-Id: I2c2ab2f10a99ffd564611351e71c0b88adc20ba7
2014-03-12 19:32:17 +02:00
Jim Rollenhagen
70ba1493f9 Add libffi-dev(el) dependency to quickstart
This is required to build cryptography 0.2.1.

Change-Id: I397fe3c48ca65a3bed70bb5941c4bf9001aec717
2014-03-05 15:42:58 -08:00
Devananda van der Veen
dfa3501d78 Clarify and fix the dev-quickstart doc some more
Clarify and fix up the dev-quickstart doc some more
based on user feedback.

Testing examples now use tox rather than invoking the
testr command directly.

Simplified the section on building the documentation by
removing the need to install a web server.

Co-Authored-By: David Shrewsbury <shrewsbury.dave@gmail.com>

Change-Id: Ibdff4b44a26f11a5a0e92efb4c451105f6ab3245
2014-02-24 09:54:12 -08:00
Lucas Alvares Gomes
fdf19d393b Fix dev-quick-start.rst post landing for 9d81333fd0
Fixing:
* Add missing -r option to the pip install command
* Add a step to start rabbitmq-server on fedora/rhel after the
  installation
* Replace the systemctl command with service because RHEL <= 6 doesn't
  use systemd
* auth_strategy option can't be appended at the end of the file and
  should be edited under the [DEFAULT] section
* Remove the trailing space

Change-Id: Id9b8a3e2b8c0358ddfc6693fb0cda410a40a4186
2014-02-17 17:52:12 +00:00
Jenkins
b37844dacc Merge "Add testing and doc sections to docs/dev-quickstart" 2014-02-13 16:23:36 +00:00
Devananda van der Veen
9d81333fd0 Add testing and doc sections to docs/dev-quickstart
Add notes to dev/dev-quickstart to demonstrate how to
start up and interact with ironic-api and ironic-conductor
services locally, in a python virtualenv.

Also add some instrutions on building the documentation locally.

Change-Id: I01eb7ffb5ebe510cec9e4bc2f6ac0f0cc616493c
2014-02-12 22:17:00 -08:00
Jim Rollenhagen
7eb48adc82 Add git dependency to quickstart docs
Without git installed, `tox -evenv -- echo 'done'` fails with a
cryptic error message. This should keep newcomers from getting
stuck on this.

Change-Id: I7cd7faa3bda905c8cfb3cfb456e3279566edf613
2014-02-11 09:47:59 -08:00
Ruby Loo
76b81e1f26 Updates documentation for tox use
In order to create a virtualenv with tox, a postgresql package is needed
as a prerequisite. The dev-quickstart documentation has been updated to
reflect this.

In addition, the prerequisites for Fedora/RHEL were modified, because
mysql-devel is needed, not mysql-libs.

Fixes bug: #1227390

Change-Id: Ibfdb0a9a3d560fcc3fb7d95aaa1d765ed18215e2
2013-09-19 16:12:01 +00:00
Devananda van der Veen
676a157f42 More doc updates.
Create doc/source/dev/ directory, and add several files that got
accidentaly ignored because they were under doc/source/api/.

Also move some files from doc/source into doc/source/dev to clean up the
base doc dir.

Change-Id: Ief9777216db82ec3be32b7a73e2d268a3a973ef8
2013-05-29 16:20:58 -07:00