← Back to branch summary

~ubuntu-branches/ubuntu/vivid/ironic/vivid-updates

« back to all changes in this revision

Viewing changes to doc/source/dev/dev-quickstart.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2015-01-05 12:21:37 UTC
  • mfrom: (1.2.4)
  • Revision ID: package-import@ubuntu.com-20150105122137-171bqrdpcxqipunk
Tags: 2015.1~b1-0ubuntu1
* New upstream beta release:
  - d/control: Align version requirements with upstream release.
* d/watch: Update uversionmangle to deal with kilo beta versioning
  changes.
* d/control: Bumped Standards-Version to 3.9.6, no changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/dev/dev-quickstart.rst
10
10
 
11
11
.. seealso::
12
12
 
13
 
    https://wiki.openstack.org/wiki/GerritWorkflow
 
13
    http://docs.openstack.org/infra/manual/developers.html#development-workflow
14
14
 
15
15
Install prerequisites::
16
16
 
17
17
    # Ubuntu/Debian:
18
 
    sudo apt-get install python-dev libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev libpq-dev git git-review libffi-dev
 
18
    sudo apt-get install python-dev libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev libpq-dev git git-review libffi-dev gettext
19
19
 
20
20
    # Fedora/RHEL:
21
 
    sudo yum install python-devel openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel git git-review libffi-devel
22
 
 
 
21
    sudo yum install python-devel openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel git git-review libffi-devel gettext ipmitool
 
22
 
 
23
    # openSUSE/SLE 12:
 
24
    sudo zypper install git git-review libffi-devel libmysqlclient-devel libopenssl-devel libxml2-devel libxslt-devel postgresql-devel python-devel python-nose python-pip gettext-runtime
 
25
 
 
26
    # All distros:
23
27
    sudo easy_install nose
24
28
    sudo pip install virtualenv setuptools-git flake8 tox testrepository
25
29
 
26
 
    # openSUSE/SLE 12:
27
 
    sudo zypper install git git-review libffi-devel libmysqlclient-devel libopenssl-devel libxml2-devel libxslt-devel postgresql-devel python-devel python-flake8 python-nose python-pip python-setuptools-git python-testrepository python-tox python-virtualenv
 
30
If using RHEL and yum reports “No package python-pip available” and “No
 
31
package git-review available”, use the EPEL software repository. Instructions
 
32
can be found at `<http://fedoraproject.org/wiki/EPEL/FAQ#howtouse>`_.
28
33
 
29
34
You may need to explicitly upgrade virtualenv if you've installed the one
30
35
from your OS distribution and it is too old (tox will complain). You can
56
61
 
57
62
To run a specific test, use a positional argument for the unit tests::
58
63
 
59
 
    # run a specific test for both Python 2.6 and 2.7
60
 
    tox -epy26,py27 -- test_conductor
 
64
    # run a specific test for Python 2.7
 
65
    tox -epy27 -- test_conductor
61
66
 
62
67
You may pass options to the test programs using positional arguments::
63
68
 
235
240
 
236
241
.. seealso::
237
242
 
238
 
    https://devstack.org
 
243
    http://docs.openstack.org/developer/devstack/
239
244
 
240
245
Devstack will no longer create the user 'stack' with the desired
241
246
permissions, but does provide a script to perform the task::
251
256
 
252
257
Create devstack/localrc with minimal settings required to enable Ironic.
253
258
Note that Ironic under devstack can only support running *either* the PXE
254
 
or the agent driver, not both.::
 
259
or the agent driver, not both. The default is the PXE driver.::
255
260
 
256
261
    cd devstack
257
262
    cat >localrc <<END
305
310
 
306
311
    END
307
312
 
308
 
If running with the agent driver::
 
313
If running with the agent driver (instead of PXE driver), add these additional
 
314
settings to localrc::
309
315
 
310
316
    cat >>localrc <<END
311
 
    enable_service s-proxy s-object s-container s-account
 
317
    # Agent driver requires swift with tempurls
 
318
    # Enable swift services
 
319
    enable_service s-proxy
 
320
    enable_service s-object
 
321
    enable_service s-container
 
322
    enable_service s-account
 
323
 
 
324
    # Enable tempurls and set credentials
 
325
    SWIFT_HASH=password
 
326
    SWIFT_TEMPURL_KEY=password
312
327
    SWIFT_ENABLE_TEMPURLS=True
 
328
 
 
329
    # Enable agent driver
313
330
    IRONIC_ENABLED_DRIVERS=fake,agent_ssh,agent_ipmitool
 
331
    IRONIC_DEPLOY_DRIVER=agent_ssh
 
332
 
 
333
    # To build your own IPA ramdisk from source, set this to True
314
334
    IRONIC_BUILD_DEPLOY_RAMDISK=False
315
 
    IRONIC_DEPLOY_DRIVER=agent_ssh
316
335
 
317
336
    END
318
337
 
412
431
    source .tox/venv/bin/activate
413
432
 
414
433
    # build the docs
415
 
    python setup.py build_sphinx
 
434
    tox -egendocs
416
435
 
417
436
Now use your browser to open the top-level index.html located at::
418
437