Installation guide needs updating

Bug #1323589 reported by Dmitry Tantsur
42
This bug affects 7 people
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Wishlist
Unassigned

Bug Description

There are upcoming requests on IRC for instructions on how to install Ironic without using devstack or devtest, i.e. manually from scratch. We have a page for it, but it can be outdated: http://docs.openstack.org/developer/ironic/deploy/install-guide.html

We need to verify it and add at least the following chapters:
- Nova flavor creating
- Building deploy kernel and ramdisk
- Enrolling nodes
- Enhance TFTP section: how to set up TFTP daemon, mention that "flags = IPv4" is required in /etc/xinet.d/tftp on Fedora to work properly
- How to set up IPMI
- Relationship between ironic and nova scheduler (flavors, capabilities, etc)
- Example/suggested neutron configuration for provisioning physical machines
- Recommended deployment topology and rationale (service co-location or isolation)
- How to run the nova.virt.ironic driver alongside a traditional hypervisor driver

If possible:
- Instructions for other platforms (e.g. Fedora)
- Migration from Nova Baremetal (will probably be done separately)

Related DevStack source code, which can be used as a source of information:
* https://github.com/openstack-dev/devstack/blob/master/lib/ironic
* https://github.com/openstack-dev/devstack/blob/master/lib/nova_plugins/hypervisor-ironic
* https://github.com/openstack-dev/devstack/blob/master/tools/ironic/templates/tftpd-xinetd.template

Revision history for this message
Dmitry Tantsur (divius) wrote :

On of the efforts to collect information for this manual: https://etherpad.openstack.org/p/Using_Ironic_to_launch_instances_on_real_hardware

description: updated
Dmitry Tantsur (divius)
description: updated
Changed in ironic:
status: New → Triaged
importance: Undecided → Low
Revision history for this message
Alexander Gordeev (a-gordeev) wrote :

Since https://bugs.launchpad.net/diskimage-builder/+bug/1291533 was fixed, there is no need of placing `tftpboot` directory in the root directory of TFTP

Also https://github.com/openstack-dev/devstack/blob/master/lib/ironic#L426 that line with could be removed entirely.

Dmitry Tantsur (divius)
description: updated
summary: - We need a documentation on manually installing Ironic
+ Installation guide needs updating
description: updated
description: updated
Vinay B S (vinbs)
Changed in ironic:
assignee: nobody → Vinay B S (vinbs)
Dmitry Tantsur (divius)
tags: added: documentation
description: updated
Revision history for this message
Dmitry Tantsur (divius) wrote :

Vinay B S, hi! Youre assigned to the issue, could you give some status update on it? Our policy is to not have an issue assigned w/o patch for >7 days.

Revision history for this message
Vinay B S (vinbs) wrote :

Hi Dmitry, I have been writing the instructions here: https://etherpad.openstack.org/p/Using_Ironic_to_launch_instances_on_real_hardware

It's almost in completion stage. Please review it and let me know if I need to make any changes.

Revision history for this message
Dmitry Tantsur (divius) wrote :

Left a couple of comments, but it's much easier to comment in Gerrit, so I propose moving it there :) thank you for update.

aeva black (tenbrae)
Changed in ironic:
importance: Low → Medium
milestone: none → next
Revision history for this message
aeva black (tenbrae) wrote :

Hi Vinay!

I wasn't aware you were working on this. In fact, I just sent an email to the mailing list calling for much the same thing (there's some overlap, but some things not covered by your etherpad).

As Dmitry suggested, please propose these changes via Gerrit -- even if it is not complete, in which case, you should mark it as a WIP (work in progress).

Also, in the future, a series of small changes that show the ongoing work you are doing is far preferrable to a single large "do it all at once" patch. This helps raise awareness from core reviewers of what you are doing, and shortens the feedback cycle in case there are course-corrections that need to be made early on.

Thanks for you work! I look forward to seeing the review soon :)

Changed in ironic:
milestone: next → juno-3
Revision history for this message
Vinay B S (vinbs) wrote :

Hi Devananda,

This is my first bug fix and I was not completely aware of the procedure. It does make sense to commit a series of small changes instead of committing a big patch at the end. I'll add the patch of whatever changes I have done till now.
And I would like to document the other things you mentioned in the mail too, which I have not covered yet in the etherpad.

Thanks!

Vinay B S (vinbs)
description: updated
Vinay B S (vinbs)
Changed in ironic:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.openstack.org/114886

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/114888

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/114889

Revision history for this message
Eric Xie (mark-xiett) wrote :

Hi Vinay,
I have not found the configuration for tftp-server. Will it be added soon?

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on ironic (master)

Change abandoned by Vinay B S (<email address hidden>) on branch: master
Review: https://review.openstack.org/114887
Reason: Dependency issue. Will commit a new patch to replace this.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Change abandoned by Vinay B S (<email address hidden>) on branch: master
Review: https://review.openstack.org/114888
Reason: Dependency issue. Will commit a new patch

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Change abandoned by Vinay B S (<email address hidden>) on branch: master
Review: https://review.openstack.org/114889
Reason: Dependency issue. Will commit a new patch

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Change abandoned by Vinay B S (<email address hidden>) on branch: master
Review: https://review.openstack.org/114886
Reason: committing a new patch to resolve few dependency issues

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.openstack.org/118614

Thierry Carrez (ttx)
Changed in ironic:
milestone: juno-3 → juno-rc1
aeva black (tenbrae)
Changed in ironic:
milestone: juno-rc1 → none
Changed in ironic:
assignee: Vinay B S (vinbs) → Ruby Loo (rloo)
Ruby Loo (rloo)
Changed in ironic:
assignee: Ruby Loo (rloo) → Vinay B S (vinbs)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/118614
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=befe332e28a18a842777facc8f17fb7dc3fd68d6
Submitter: Jenkins
Branch: master

commit befe332e28a18a842777facc8f17fb7dc3fd68d6
Author: Vinay B S <email address hidden>
Date: Wed Sep 3 04:58:04 2014 -0700

    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

Changed in ironic:
assignee: Vinay B S (vinbs) → Chris Krelle (nobodycam)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/138864
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=4610c25c40cf0d45a0c9f890afd8f245d047f822
Submitter: Jenkins
Branch: master

commit 4610c25c40cf0d45a0c9f890afd8f245d047f822
Author: Chris Krelle <email address hidden>
Date: Wed Dec 3 13:11:16 2014 -0800

    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

aeva black (tenbrae)
Changed in ironic:
milestone: none → kilo-rc1
Revision history for this message
aeva black (tenbrae) wrote :

Closing this bug now. Based on the initial title, it is simply too broad, and based on the initial description, much of that has been done already.

We should revisit this and file bugs for specific items which lack documentation, rather than a single catch-all that we'll never complete (good aspiration as it is).

Changed in ironic:
assignee: Chris Krelle (nobodycam) → nobody
milestone: kilo-rc1 → none
importance: Medium → Wishlist
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
milestone: none → kilo-rc1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ironic:
milestone: kilo-rc1 → 2015.1.0
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.