64 Commits

Author SHA1 Message Date
Jenkins
4f62cd9719 Merge "Drop some outdated information from our quick start guide" 2015-11-24 14:28:37 +00:00
Dmitry Tantsur
3ce0401da0 Drop some outdated information from our quick start guide
* Only tox has to be installed via pip, everything else is in virtual
  environment. Nose is no longer used.
* One should NOT run other tox commands in an existing tox environment.
  This is not how tox is intended to be used, and it cause weird failures
  or seemingly random virtual environment rebuilds.
* Drop statement about running unit tests on a clear VM. Not sure where it
  comes from, only tox and setuptools are required to run unit tests,
  and they don't mess with system packages. Only leave note about devstack,
  as people seem to have problems with it.

Change-Id: Ie7d0172b66231cfd8f9c4f8f2d76604a187443b0
2015-11-23 12:10:02 +01:00
Vladyslav Drok
50fbf67bfe Add missing packages to dev-quickstart
Pillow now requires to have libjpeg installed, this change adds it
to the list of binary dependencies for unit tests in developer
quickstart guide.

Closes-bug: #1516782
Change-Id: Id779c97de4ec6830117120a3311500d1dc6fc7f6
2015-11-19 19:21:51 +02:00
Lucas Alvares Gomes
4cd7acc90c Fix an annoying detail in the developer quick-start
Instead of using two commands to go to the user home directory use only
one.

Change-Id: I905c1143d5072c3f6b3cae55e4c79e2dfbadb3cc
2015-10-14 14:24:44 +01:00
Ruby Loo
83adca9506 To run a specific unit test with ostestr use -r
To run a specific unit test using ostestr (instead of testr), the '-r'
argument needs to be specified. This updates the developer documention
to reflect this.

By default, ostestr runs the tests in parallel, so the (incorrect)
example for running them in parallel was removed.

Change-Id: I01be19d4419155b7bb5367a14a585a1016bc799f
2015-10-06 14:00:36 +00:00
Ruby Loo
a4d8fc6ce7 Fix documentation for installing mariaDB
This updates the documentation on installing mariaDB on
Fedora/RHEL/CentOS. The mariadb-server package is needed.

Change-Id: I1cc617f9311ad203d863c22de440f8bb103e7a1d
2015-09-29 16:24:51 +00:00
Jenkins
ecf6fc17f0 Merge "Unit test environment setup clarification" 2015-09-24 18:57:00 +00:00
Lucas Alvares Gomes
d0949562bc Update docs for Fedora 22
Fedora 22 doesn't ship "yum" anymore it now uses "dnf". So this patch
is updating the documentation examples to reflect that.

Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com>
Change-Id: I1b96ba29d4699cc59d686104e968e7d35c874f0d
2015-09-24 15:17:23 +01:00
Kurt Taylor
5ab297c7e4 Unit test environment setup clarification
Added a note to make it clear that the developer should set up the environment
on a clean install to avoid conflicting devstack dependency config problems.

Change-Id: I81bba0ff33b33a026a3effc0ad71d9019df17582
2015-09-23 11:02:05 -05:00
stephane
cd89166602 Developer quickstart documentation fixes
Fix markup so that directions for MySQL database setup
look right in HTML.

Also, remove the conductor step from the API section since
the command is missing and the conductor has its own step.

Change-Id: Ibddf50527b5cc76c2dd06323ac46ba78431671d1
2015-08-05 14:08:06 -07:00
Vladyslav Drok
9a4ee8c40a Use LOGDIR instead of SCREEN_LOGDIR in docs
SCREEN_LOGDIR was deprecated in favor of LOGDIR in kilo.

Change-Id: I434cb4ab63b8025d9b036218e883606a8a34a801
2015-06-23 15:44:26 +03:00
Jenkins
77ca428615 Merge "Doc: Use --notest for creating venv" 2015-06-10 18:42:21 +00:00
Jenkins
7158ed2972 Merge "Add additional required RPMs to dev instructions" 2015-06-10 04:14:35 +00:00
John L. Villalovos
286f72e359 Doc: Use --notest for creating venv
The docs were saying to use:
    tox -evenv -- echo 'done'

Which would create the virtualenv 'venv' but then error.

Update the docs to do:
    tox -evenv --notest

Change-Id: Ibe1dfd8748535c75040a8d8ef6d33d0791d022d1
2015-06-09 17:20:32 -07:00
Chris Dearborn
f9d76fd7c2 Add additional required RPMs to dev instructions
Changed dev quick start instructions to include installing gcc and
python3-devel as these are required to be present on (at least)
Fedora 21 server.

Change-Id: I576231cc3ecfda6407279b0326dbe54a408a64e0
2015-06-09 10:11:39 -04:00
John L. Villalovos
f2448a3788 Update docs for usage of python-ironicclient
The virtualenv in the python-ironicclient now installs the 'ironic'
program by default into the bin directory of the 'venv' environment.  It
is no longer needed to manually call setup.py

Remove that line from the instructions.

Change-Id: I25fffa41cb4e806d20484ce3423943c91d8ca38e
2015-06-08 14:18:27 -07:00
Jenkins
0b2ce80776 Merge "Rename gendocs tox environment" 2015-05-21 12:00:21 +00:00
Andreas Jaeger
6befe83d87 Rename gendocs tox environment
All other openstack projects use docs environment, use the same
name for ironic as well.

Change-Id: I46fd50da89c3247bffefc9c971f8eda309bbe9bd
2015-05-21 08:06:06 +02:00
Michael Krotscheck
ef237e0e5f Added vagrant VM for developer use
This patch adds a vagrantfile and ansible playbook that captures
the instructions from the ironic developer quickstart. By using
'vagrant up', and configuring your local dev instance to use
192.168.99.11, you should be able to exercise your services locally.
Documentation has also been updated.

Change-Id: Ic4f42e59cbda968d301c797ef77ff98030c55c41
2015-05-13 17:17:16 -07:00
Jenkins
77ee57c639 Merge "Fix and enhance "Exercising the Services Locally" docs" 2015-05-11 17:21:10 +00:00
Lucas Alvares Gomes
4b437a7473 Fix and enhance "Exercising the Services Locally" docs
Fix and enhance some parts of the "Exercising the Services Locally"
documentation. Also, this patch is updating the RHEL instructions to
support RHEL7 (not RHEL6).

Change-Id: I23618962d24856074e7b1b06e68e82e64f904ed4
2015-05-11 15:00:21 +01:00
Mitsuhiro SHIGEMATSU
acdec5b592 Fix typos in Ironic docs
Change-Id: I96dac53f9a23b24716313c88205ad0cbe6bbb9c8
2015-05-11 16:40:58 +09:00
Ruby Loo
8bff4bd0eb Include graphviz in install prerequisites
Graphviz is needed for generating the state machine diagram
(eg, via 'tox -egenstates'). It is added to the list of packages
to install.

The instructions for installing on openSUSE and SLE are a bit
more involved, so I've added a URL that describes how to do that.

Change-Id: I16380bc88fcecc6911f21b4554b04a9d72b2d66b
2015-05-05 00:55:41 +00:00
Jay Faulkner
bd1262a17d Fix bad quoting in quickstart guide
Before, the " and ' in the message was rendering into smart quotes,
making copy+paste impossible. This fix places the commands inside the
note into a blockquote, preventing sphinx from breaking copy+paste.

Change-Id: I7291f7cbdb9c7fa16d23376792012a7a70c7c16b
2015-04-07 13:45:50 -07:00
Lin Tan
b4c919abde Add a note to dev-quickstart
Devstack create multiple networks, a Network ID has to be specific
when boot a instance with admin account.

Change-Id: I2cc0835950a57560493ee11089d89cd3a471125c
2015-03-04 11:46:12 +08:00
Lucas Alvares Gomes
956237a171 Disable n-novnc, heat, cinder and horizon on devstack
Ironic doesn't integrate with those projects (at present) so no reason
to leave them enabled.

Change-Id: I0e27fdd01715ba9daebbdbbe5e45a772dd6abc1f
2015-02-23 15:04:52 +00: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
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
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
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
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