Pre-installation guide is missing PXE boot steps for target nodes

Bug #1308279 reported by Dmitriy Novakovskiy
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Fix Released
High
Dmitry Ilyin

Bug Description

Doc: http://docs.mirantis.com/fuel/fuel-4.1/pdf/Mirantis-OpenStack-4.1-Pre-InstallationGuide.pdf

- Page 4 ends on "12 Install the Fuel server"

- Page 6 jumps straight to "Create new cloud" on Web interface, including adding nodes (which are not yet discovered).

- ! There are no mentions of need to do PXE boot -> bootstrap -> discovery for actual future OpenStack nodes after Fuel master is installed.

Also:
- The document contains some unnecessarily blank pages
- Screenshots on page 11-14 are unnecessary and too scaled - hard to see anything
- Having 3 separate sections is confusing:
-- "Configuring Fuel Using the ISO image", "Preparing the Mirantis OpenStack Deployment", "Post-installation Configuration Tasks"
-- I would suggest having one section covering "end-to-end" story, + a picture illustrating cloud creation workflow.

Tags: docs
description: updated
Mike Scherbakov (mihgen)
Changed in fuel:
milestone: none → 5.0
assignee: nobody → Meg McRoberts (dreidellhasa)
Changed in fuel:
status: New → Confirmed
Revision history for this message
Meg McRoberts (dreidellhasa) wrote :

I totally agree with this. We need to have an Installation Guide that is much more straight-forward -- it can point to other docs for deep background information. See https://blueprints.launchpad.net/fuel/+spec/fuel-docs-restructure.

Screen shots need to have some commentary with them as well. I am hoping to make some progress on this for 5.0.

Changed in fuel:
importance: Undecided → High
Mike Scherbakov (mihgen)
tags: added: docs
Revision history for this message
Meg McRoberts (dreidellhasa) wrote :

I need some clarification about the PXE -> boot -> bootstrap process. We do have this one piece about modifying the PXE settings http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#changing-network-parameters-after-installation -- it has been moved into the User's Guide (which is now "Using Fuel to deploy an OpenStack environment") but I think this LP is asking for more/different information.

Revision history for this message
Dmitriy Novakovskiy (dnovakovskiy) wrote : Re: [Bug 1308279] Re: Pre-installation guide is missing PXE boot steps for target nodes
Download full text (3.3 KiB)

Ok. CCing Mike just in case (plz double-check if you have time)

So, the way how usual deployment flow works is:

1) User wires all the networking and server gear, plans network addresses
spaces for all Fuel networks
2) User triggers installation of Fuel master node by booting the server
from USB drive w/ ISO imaged written to it
3) User waits for Fuel master node to get installed (watching console
output until it says - ok, i'm installed, open Fuel Web UI on IP
xx.xx.xx.xx)
4) User opens Fuel Web UI using info from step 3 (from his/her laptop, in
browser)

## Now it's user has Fuel master, but has no nodes to build cloud from

5) User boots/reboots the rest of the nodes in lab (which are obviously NOT
Fuel master :) ) in PXE boot mode
6) After reboot, nodes send out DHCP/PXE discovery requests and get the
response from Fuel master node (which runs DHCP/PXE server)
7) Each node that received response from Fuel Master node:
- fetches bootstrap image from Fuel master node (minimal CentOS + tooling
needed in order to bring this node under Fuel master control)
- self-installs installs bootstrap image (erasing any other OS installation
if there was such)
- reports it's readiness to Fuel master
8) User observes the count of "Discovered nodes" growing on top right
corner of Fuel Web UI (it takes some time for node to get into discovered
state after PXE boot is done)
9) User waits for all his nodes to be reflected on counter in top right
corner

## Now user has both Fuel master node AND discovered nodes ready to
participate in OpenStack cloud building

---
Regards,
Dmitriy

On Thu, May 15, 2014 at 12:01 PM, Meg McRoberts <email address hidden>wrote:

> I need some clarification about the PXE -> boot -> bootstrap process.
> We do have this one piece about modifying the PXE settings
> http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#changing-
> network-parameters-after-installation -- it has been moved into the
> User's Guide (which is now "Using Fuel to deploy an OpenStack
> environment") but I think this LP is asking for more/different
> information.
>
> --
> You received this bug notification because you are subscribed to the bug
> report.
> https://bugs.launchpad.net/bugs/1308279
>
> Title:
> Pre-installation guide is missing PXE boot steps for target nodes
>
> Status in Fuel: OpenStack installer that works:
> Confirmed
>
> Bug description:
> Doc: http://docs.mirantis.com/fuel/fuel-4.1/pdf/Mirantis-OpenStack-4.1
> -Pre-InstallationGuide.pdf
>
> - Page 4 ends on "12 Install the Fuel server"
>
> - Page 6 jumps straight to "Create new cloud" on Web interface,
> including adding nodes (which are not yet discovered).
>
> - ! There are no mentions of need to do PXE boot -> bootstrap ->
> discovery for actual future OpenStack nodes after Fuel master is
> installed.
>
> Also:
> - The document contains some unnecessarily blank pages
> - Screenshots on page 11-14 are unnecessary and too scaled - hard to see
> anything
> - Having 3 separate sections is confusing:
> -- "Configuring Fuel Using the ISO image", "Preparing the Mirantis
> OpenStack Deployment", "Post-installation Configuration Tasks"
> -- I would sugge...

Read more...

Revision history for this message
Meg McRoberts (dreidellhasa) wrote :
Download full text (3.7 KiB)

Thanks so much! I'll get this written up.

On Mon, May 19, 2014 at 6:42 AM, Dmitriy Novakovskiy <
<email address hidden>> wrote:

> Ok. CCing Mike just in case (plz double-check if you have time)
>
> So, the way how usual deployment flow works is:
>
> 1) User wires all the networking and server gear, plans network addresses
> spaces for all Fuel networks
> 2) User triggers installation of Fuel master node by booting the server
> from USB drive w/ ISO imaged written to it
> 3) User waits for Fuel master node to get installed (watching console
> output until it says - ok, i'm installed, open Fuel Web UI on IP
> xx.xx.xx.xx)
> 4) User opens Fuel Web UI using info from step 3 (from his/her laptop, in
> browser)
>
> ## Now it's user has Fuel master, but has no nodes to build cloud from
>
> 5) User boots/reboots the rest of the nodes in lab (which are obviously
> NOT Fuel master :) ) in PXE boot mode
> 6) After reboot, nodes send out DHCP/PXE discovery requests and get the
> response from Fuel master node (which runs DHCP/PXE server)
> 7) Each node that received response from Fuel Master node:
> - fetches bootstrap image from Fuel master node (minimal CentOS + tooling
> needed in order to bring this node under Fuel master control)
> - self-installs installs bootstrap image (erasing any other OS
> installation if there was such)
> - reports it's readiness to Fuel master
> 8) User observes the count of "Discovered nodes" growing on top right
> corner of Fuel Web UI (it takes some time for node to get into discovered
> state after PXE boot is done)
> 9) User waits for all his nodes to be reflected on counter in top right
> corner
>
> ## Now user has both Fuel master node AND discovered nodes ready to
> participate in OpenStack cloud building
>
>
>
> ---
> Regards,
> Dmitriy
>
>
> On Thu, May 15, 2014 at 12:01 PM, Meg McRoberts <email address hidden>wrote:
>
>> I need some clarification about the PXE -> boot -> bootstrap process.
>> We do have this one piece about modifying the PXE settings
>> http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#changing-
>> network-parameters-after-installation<http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#changing-network-parameters-after-installation>-- it has been moved into the
>> User's Guide (which is now "Using Fuel to deploy an OpenStack
>> environment") but I think this LP is asking for more/different
>> information.
>>
>> --
>> You received this bug notification because you are subscribed to the bug
>> report.
>>
>> https://bugs.launchpad.net/bugs/1308279
>>
>> Title:
>> Pre-installation guide is missing PXE boot steps for target nodes
>>
>> Status in Fuel: OpenStack installer that works:
>> Confirmed
>>
>> Bug description:
>> Doc: http://docs.mirantis.com/fuel/fuel-4.1/pdf/Mirantis-OpenStack-4.1
>> -Pre-InstallationGuide.pdf
>>
>> - Page 4 ends on "12 Install the Fuel server"
>>
>> - Page 6 jumps straight to "Create new cloud" on Web interface,
>> including adding nodes (which are not yet discovered).
>>
>> - ! There are no mentions of need to do PXE boot -> bootstrap ->
>> discovery for actual future OpenStack nodes after Fuel master is
>> installed.
>>
>> Als...

Read more...

Changed in fuel:
importance: High → Medium
Changed in fuel:
status: Confirmed → In Progress
Mike Scherbakov (mihgen)
Changed in fuel:
milestone: 5.0 → 5.1
importance: Medium → High
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fuel-docs (master)

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

Changed in fuel:
assignee: Meg McRoberts (dreidellhasa) → Dmitry Ilyin (idv1985)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-docs (master)

Reviewed: https://review.openstack.org/94908
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=2bfc19b753211076a2893e89ee323dc4f426f463
Submitter: Jenkins
Branch: master

commit 2bfc19b753211076a2893e89ee323dc4f426f463
Author: Dmitry Ilyin <email address hidden>
Date: Thu May 22 19:37:03 2014 +0400

    Update PXE boot documentation

    Change-Id: Icd7f2cea8dcee68151878bbb3ef5008520ec2a13
    Closes-Bug: 1308279

Changed in fuel:
status: In Progress → Fix Committed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fuel-docs (stable/5.0)

Fix proposed to branch: stable/5.0
Review: https://review.openstack.org/95312

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-docs (stable/5.0)

Reviewed: https://review.openstack.org/95312
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=46db24712487a3c705db96347ec72870bfecd097
Submitter: Jenkins
Branch: stable/5.0

commit 46db24712487a3c705db96347ec72870bfecd097
Author: Dmitry Ilyin <email address hidden>
Date: Thu May 22 19:37:03 2014 +0400

    Update PXE boot documentation

    Change-Id: Icd7f2cea8dcee68151878bbb3ef5008520ec2a13
    Closes-Bug: 1308279

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-docs (master)

Reviewed: https://review.openstack.org/92075
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=8107f943cdf77e2f91ca01470d07956dcda8ebbc
Submitter: Jenkins
Branch: master

commit 8107f943cdf77e2f91ca01470d07956dcda8ebbc
Author: Meg McRoberts <email address hidden>
Date: Mon May 5 01:59:00 2014 -0700

    Set up User Guide

    This guide has been ordered to have sections that parallel
      what is in the introductory table, with screen shots, instructions,
      and appropriate xrefs in the same order as the table

    Moved info about mapping logical-to-physical NICS from pre-install
    Moved info about configuring the PXE network before deploying environment
      from install-guide
    Added information about booting node servers before deploying environment
    Deleted some superfluous and illegible screen shots that are now replaced
      by material in user-guide
    Added "Configure Hardware" from information that was in the pre-install
      "Prerequisites" table.

    TODO(Meg McRoberts):
      - Modularize the sections about each task/screen into separate
        files
      - Rewrite the intro (as well as the intros for Pre-Install and Install
      - A couple of screen shots are missing
      - Add xrefs to sections in other docs for supporting information.

    Closes-Bug: 1289668
    Closes-Bug: 1308279

    Change-Id: Ie717a0fafbf40272f603bab361046fa36457501a

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fuel-docs (stable/5.0)

Fix proposed to branch: stable/5.0
Review: https://review.openstack.org/95314

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-docs (stable/5.0)

Reviewed: https://review.openstack.org/95314
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=7acb4730388d9b90d038a7470b4b7409f08d9399
Submitter: Jenkins
Branch: stable/5.0

commit 7acb4730388d9b90d038a7470b4b7409f08d9399
Author: Meg McRoberts <email address hidden>
Date: Mon May 5 01:59:00 2014 -0700

    Set up User Guide

    This guide has been ordered to have sections that parallel
      what is in the introductory table, with screen shots, instructions,
      and appropriate xrefs in the same order as the table

    Moved info about mapping logical-to-physical NICS from pre-install
    Moved info about configuring the PXE network before deploying environment
      from install-guide
    Added information about booting node servers before deploying environment
    Deleted some superfluous and illegible screen shots that are now replaced
      by material in user-guide
    Added "Configure Hardware" from information that was in the pre-install
      "Prerequisites" table.

    TODO(Meg McRoberts):
      - Modularize the sections about each task/screen into separate
        files
      - Rewrite the intro (as well as the intros for Pre-Install and Install
      - A couple of screen shots are missing
      - Add xrefs to sections in other docs for supporting information.

    Closes-Bug: 1289668
    Closes-Bug: 1308279

    Change-Id: Ie717a0fafbf40272f603bab361046fa36457501a

Changed in fuel:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

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