92 Commits

Author SHA1 Message Date
John L. Villalovos
6cbea412cc Docs: Run py34 tox test before py27
Since running the py27 tox test before the py34 tox test can cause
errors about 'db type could not be determined'. Change the docs to
show the py34 test first, so hopefully people will run that test
first.

Change-Id: I59409edc5cab7f58112ebe28e280f0eeda3becd0
2016-08-05 09:09:21 -07:00
Jenkins
761dadba73 Merge "Fix for "db type could not be determined" error message" 2016-08-04 01:17:12 +00:00
Varun Gadiraju
288f4e617b Fix for "db type could not be determined" error message
If tests are run under py27 then run under py34 or py35, user may get
`db type could not be determined` error.

This patch adds a note to the dev-quickstart guide telling user to
remove the file `.testrepository/times.dbm` and then run the py34 or
py35 test to work around this error.

Change-Id: I57b583eaa8586d14cee730eefc515ad064ac8b32
Closes-Bug: #1229445 (regarding Ironic)
2016-08-03 19:23:34 +00:00
Akilan Pughazhendi
be8577b32c Updating dev quickstart to include compatiblity for newest distros
Updates ironic dev quickstart to include compatability with the
latest versions of python, ubuntu and fedora

Change-Id: I14b0668e228c47db36970df14a774469f6d966d1
Closes-bug: 1603575
2016-08-03 15:56:16 +00:00
Jenkins
2d2a18cd97 Merge "Added note to local.conf addressing firewall/proxy blocking Git protocol" 2016-07-21 20:25:38 +00:00
Varun Gadiraju
7a0d22c0fd Added note to local.conf addressing firewall/proxy blocking Git protocol
local.conf file for deploying ironic with devstack uses Git protocol to
enable ironic plugin. Git protocol requires access to port 9418 which
corporate firewalls commonly block.

Added a note to the local.conf file informing users who face this
problem how to modify the local.conf file to use https:// instead of
git:// so ironic plugin will be enabled.

Change-Id: Ia0ab1c23cf1e6979eb7e03bb9746aa94dd3f0257
Closes-Bug: #1604243
2016-07-21 18:23:51 +00:00
Jim Rollenhagen
a9e48a3378 Add build-essential to required packages for development
I ran into gcc not being available recently on a fresh Ubuntu image.
Adding it allowed tox to run fine and install ironic's dependencies. Add
it to the dev quickstart to make sure nobody else gets tripped up.

Change-Id: Ibd6e3bc4772af382c8df92d54050af4934e49ab4
2016-07-20 14:45:30 -07:00
Chris Krelle
8b2a7bd2aa Update devstack section of quickstart to use agent_ipmitool
This patch updates the sample local.conf to use the agent_ipmitool
driver instead of the pxe_ssh driver. It also adds a note about *_ssh
drivers being phased out in favor of ipmitool + vbmc.

Change-Id: I1bc58b6b97f2aa0c864ebe112ca3c5a88b9ca561
2016-07-14 16:53:52 -07:00
Vasyl Saienko
f30f48e743 Drop IRONIC_DEPLOY_DRIVER_ISCSI_WITH_IPA from documentation
Support of old ramdisk has been deprecated at [0].
This patch removes IRONIC_DEPLOY_DRIVER_ISCSI_WITH_IPA variable
from documentation.

Reference:
[0] https://review.openstack.org/327083/

Change-Id: I37448131b71d8e1580a765096e9d3698bd4b1c6c
2016-07-05 09:52:29 +03:00
Miles Gould
9e99a8f100 Document testing an in-review patch with devstack
The method documented at
http://docs.openstack.org/developer/devstack/configuration.html#service-repos
doesn't work for services (like Ironic) that use a devstack plugin.
Documenting the right process to use should help new developers (who may
not be familiar with OpenStack infrastructure) become productive
quickly.

Change-Id: I40538306ea81dd356e47e063208ea1b84e6e9b24
2016-06-15 17:04:50 +01:00
Ruby Loo
d24e6b725e fix sed strings in developer doc
The sample configuration file was changed so that the configuration
options are of the form 'name = value' instead of 'name=value'.

This patch updates the developer documentation [1] so that the 'sed'
instructions work properly with the new format.

[1] http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#option-1-manual-install

Change-Id: I8e36ec40c83c6d914dcd6b3d426f58415e1d3e23
2016-06-09 17:22:28 -04:00
Jenkins
faa43c9564 Merge "Fix markup in documentation" 2016-06-06 18:25:31 +00:00
Vladyslav Drok
d3c7e6fad4 Fix markup in documentation
This change fixes all the markup issues in our docs, such as:

* Title length must match an underline (some titles are only 3
  characters long, make them longer, otherwise they are not
  considered a title);
* Blank line required after literal block;
* Duplicate explicit target name.

It also makes section names consistent in drivers.rst.

Change-Id: I058224589f4ca63a4acfb8e2c4fcdbb51c730542
2016-06-06 11:00:24 +00:00
Lucas Alvares Gomes
7abfe28618 Add debug environment to tox
The oslo_debug_helper enables developers to use pdb for debugging the
unittests.

Ref: http://docs.openstack.org/developer/oslotest/features.html

Change-Id: I08d4c0fcb2e8015c02f5e9b9d4e9dff7f58d21ea
2016-06-03 17:09:22 +01:00
Jim Rollenhagen
abc77b1567 Remove links to github for OpenStack things
Github is not the official reference for OpenStack code repositories,
and as such should not be used in documentation.

Update links that are meant to be links to a project as a whole with
links to the project's documentation.

Update links directly to code to git.openstack.org.

Remove link to tripleo-incubator script for DIB dependencies, as it does
way more than we need to, and the dependencies needed differ between DIB
elements. Instead we leave this as an exercise to the user (this is
documented in the DIB docs).

Change-Id: Iee09b6b86628e46dc5e9436bd0f98a40c50244b7
2016-05-31 11:51:17 -04:00
Lucas Alvares Gomes
084c9694e5 Doc: Replace nova image-list
The "nova image-list" command has been deprecated, this patch is replacing
it with the openstack client "image show" command in our docs.

Closes-Bug: #1582211
Change-Id: I857d105a7868a610a4d97516117840cc4309c51d
2016-05-16 14:11:10 +01:00
Xavier
0f58de9792 Updating dev-quickstart.rst file links
This patch updates most links in the dev-quickstart.rst file from http
to https. The link for Vagrant page is also updated because when open
it a custom 404 page was being displayed.

Change-Id: I781b785992598f89fcea897fa78853a4fb71c10c
2016-05-03 09:48:59 -03:00
Lucas Alvares Gomes
9f4f0a4447 Document how to run the tempest tests
This patch is extending the developer quick-start guide to include
information about how one can run the integration tests (tempest) against
a running devstack cloud (the setup for such a cloud is already part of
the documentation).

The patch also removes the information about how to run tests from the
ironic_tempest_plugin/README.rst file and add a link pointing to our
documentation.

Change-Id: I6aeb3a4fa735ff08cbb62b0b15cf95be57d1a308
2016-04-20 17:35:40 +01:00
vsaienko
a71ac5d493 Use 'baremetal' flavor in devstack
By default DEFAULT_INSTANCE_TYPE is not set. As result when tempest is
enabled default Nova flavors are used. To use 'baremetal' flavor
DEFAULT_INSTANCE_TYPE should be set to 'baremetal' as is done on gate job.
Otherwise running BaremetalBasicOps test locally will fail.

Change-Id: I1294b1dc7bf4fa32f9cdeb7a8c22667a76929ded
2016-03-07 16:17:00 +00:00
Jacek Tomasiak
959689e30d Document possible access problems with custom IRONIC_VM_LOG_DIR path
Example local.conf from Ironic docs uses $HOME/ironic-bm-logs as VM log dir.
On some systems (e.g. Fedora) user's home is accessible only to the owner by
default which causes "permission denied" errors when starting VMs because
QEMU domains are running as non-root user ("qemu" in Fedora).

Extend the documentation with note about possible problems with custom
log directory set using IRONIC_VM_LOG_DIR.

Change-Id: Ia1d7688fd71c4853538621ec32b2d4a024f52a76
Closes-Bug: #1532184
2016-02-11 15:03:39 +01:00
Zhenguo Niu
0c9915e4ab Remove unneeded enable_service in dev-quickstart.rst
We already added service enabled in devstack settings file
https://github.com/openstack/ironic/blob/master/devstack/settings

Change-Id: Ie43e8daf5b15f0c76e6f2095c0911c1ef640929d
2016-01-21 13:15:40 +08:00
Jenkins
56c4fe590c Merge "Enable ironic devstack plugin in local.conf sample" 2015-12-29 03:13:14 +00:00
Lucas Alvares Gomes
13cf3c1f68 Update "Developer Quick-Start" guide for Fedora 23+
This patch is updating the "Developer Quick-Start" guide to instruct
people using Fedora 23+ to install a package called "redhat-rpm-config".
This is needed to build a virtualenv for development successfully.

Closes-Bug: #1527614
Change-Id: I95c927330faea009b327492a3884e01b9c44606d
2015-12-25 13:48:49 +00:00
Vladyslav Drok
73ea7ce39b Enable ironic devstack plugin in local.conf sample
As ironic is installed as devstack plugin, add this to sample
local.conf file. Apart from that, some formatting issues in
dev-quickstart are fixed.

Depends-On: I5125fce295c79600781469c2f48bea80e7600081
Change-Id: I30683b2569e6ca1233f54d1529a74f6a63cd633e
2015-12-25 13:02:35 +00:00
Shuquan Huang
01f1fc095a Correct the db connection string in dev-quickstart
mysql login requires password by default. We should change the DB
creation and connection string as below.

1. mysql -u root -pMYSQL_ROOT_PWD -e "create schema ironic"
2. sed -i ... root:MYSQL_ROOT_PWD@localhost ... ironic.conf.local

Change-Id: I19696a470055823a3b2edc45a48889945c255dfd
Closes-bug: #1520420
2015-12-03 22:29:49 +08:00
Jenkins
2c6ed6bd8c Merge "change mysql url in dev-quickstart doc" 2015-12-03 11:40:15 +00:00
Dmitry Tantsur
9cfdc3f51d Only mention IPA in the quick start and user guides for DevStack
The old ramdisk is deprecated, so we should not really default to it.
Also this guide makes an assumption that agent_* and pxe_* drivers
can't be used together, which is no longer the case, as IPA handles both.

Consolidate the example local.conf into one enabling both pxe_* and agent_*
drivers with IPA and create a separate page for explaining difference between
these two.

Co-Authored-By: Lilia Sampaio <liliars@lsd.ufcg.edu.br>
Change-Id: Ifeed7bf9128281b79d425f7c5dbb3d8c39e7fb68
2015-12-01 10:23:40 +01:00
Haomeng, Wang
09e4407dcf change mysql url in dev-quickstart doc
we have switched from MySQL-python to PyMySQL[1], so the mysql url in
dev-quickstart doc should be changed also, this patch will change
\connection=mysql:@' to 'connection=mysql+pymysql:@'.

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

Closes-bug: #1520020

Change-Id: Ibd2e6170eba3fe64f6a79966e1384c3ffc64f05b
2015-11-30 14:07:48 +00:00
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