openstack/tripleo-docs
Code Issues Proposed changes

Streamline the basic deployment flow

Browse Source 
There were a couple of non-basic steps that got included in the
mainline deployment docs.  Let's move those to the advanced
section and leave links in the basic flow so they're easy to find
for people who want them.

Co-Authored-By: Swapnil Kulkarni <me@coolsvap.net>
Change-Id: Id8c9a689060df85b5ee87390a5510a569236b553
This commit is contained in:
Ben Nemec 2015-12-17 22:06:45 +00:00 committed by Swapnil Kulkarni (coolsvap)
parent 5d098fabd0
commit 6c31de6bc2
6 changed files with 101 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/advanced_deployment/advanced_deployment.rst
View File

@ -7,6 +7,8 @@ In this chapter you will find advanced deployment of various |project| areas.
.. toctree::
root_device
build_single_image
introspect_single_node
profile_matching
introspection_data
node_config
@ -16,6 +18,10 @@ In this chapter you will find advanced deployment of various |project| areas.
deploy_manila
cinder_netapp
neutron_midonet
tripleo.sh
ssl
node_placement
# TODO(bnemec): Add a new developer section for the docs that aren't
# relevant to regular users.
tripleo.sh
in_progress_review

36
doc/source/advanced_deployment/build_single_image.rst Normal file
View File

@ -0,0 +1,36 @@
Building a Single Image
=======================
The ``openstack overcloud image build --all`` command builds all the images
needed for an overcloud deploy. However, you may need to rebuild a single
one of them. Use the following commands if you want to do it::
openstack overcloud image build --type {agent-ramdisk|deploy-ramdisk|fedora-user|overcloud-full}
If the target image exist, this commands ends silently. Make sure to delete a
previous version of the image to run the command as you expect.
Moreover, you can build the image with an extra element of your choice using the
``--builder-extra-args`` argument::
openstack overcloud image build --type overcloud-full \
--builder-extra-args overcloud-network-midonet
.. note::
Make sure the element is available in the ``$ELEMENTS_PATH`` environment
variable
Uploading the New Single Image
------------------------------
After the new image is built, it can be uploaded using the same command as
before, with the ``--update-existing`` flag added::
openstack overcloud image upload --update-existing
Note that if the new image is a ramdisk, the Ironic nodes need to be
re-configured to use it. This can be done by re-running::
openstack overcloud configure boot
Now the new image should be fully ready for use by new deployments.

19
doc/source/advanced_deployment/in_progress_review.rst Normal file
View File

@ -0,0 +1,19 @@
Using an In-Progress Review
===========================
To use a git checkout for only a specific module, export the following variable::
export DIB_INSTALLTYPE_puppet_tripleo=source
Replace ``puppet_tripleo`` with the name of the puppet module to be installed
from source, replacing any -'s with _'s.
To use a pending review for a module, set its installtype to source as
described above, then also export the following variables::
export DIB_REPOLOCATION_puppet_tripleo=https://review.openstack.org/openstack/puppet-tripleo
export DIB_REPOREF_puppet_tripleo=refs/changes/30/223330/1
This time replace the name of the module in the variable name and the review URL.
The correct value for the ``reporef`` can be found in the ``Download`` section
of the Gerrit UI. Look for a string that matches the format of the example above.

28
doc/source/advanced_deployment/introspect_single_node.rst Normal file
View File

@ -0,0 +1,28 @@
Introspecting a Single Node
===========================
In addition to bulk introspetion, you can also introspect nodes one by one.
When doing so, you must take care to set the correct node states manually.
Use ``ironic node-show UUID`` command to figure out whether nodes are in
``manageable`` or ``available`` state. For all nodes in ``available`` state,
start with putting a node to ``manageable`` state::
ironic node-set-provision-state UUID manage
Then you can run introspection::
openstack baremetal introspection start UUID
This command won't poll for the introspection result, use the following command
to check the current introspection state::
openstack baremetal introspection status UUID
Repeat it for every node until you see ``True`` in the ``finished`` field.
The ``error`` field will contain an error message if introspection failed,
or ``None`` if introspection succeeded for this node.
Do not forget to make nodes available for deployment afterwards::
ironic node-set-provision-state UUID provide

88
doc/source/basic_deployment/basic_deployment_cli.rst
View File

@ -150,66 +150,19 @@ non-root user that was used to install the undercloud.
export DIB_INSTALLTYPE_puppet_modules=source
.. admonition:: Source
:class: source
To use a git checkout for only a specific module, export the following variable::
export DIB_INSTALLTYPE_puppet_tripleo=source
Replace ``puppet_tripleo`` with the name of the puppet module to be installed
from source, replacing any -'s with _'s.
To use a pending review for a module, set its installtype to source as
described above, then also export the following variables::
export DIB_REPOLOCATION_puppet_tripleo=https://review.openstack.org/openstack/puppet-tripleo
export DIB_REPOREF_puppet_tripleo=refs/changes/30/223330/1
This time replace the name of the module in the variable name and the review URL.
The correct value for the ``reporef`` can be found in the ``Download`` section
of the Gerrit UI. Look for a string that matches the format of the example above.
It is also possible to use this functionality to use an in-progress review
as part of the overcloud image build. See
:doc:`../advanced_deployment/in_progress_review` for details.
::
openstack overcloud image build --all
.. note::
This script will build **overcloud-full** images (\*.qcow2, \*.initrd,
\*.vmlinuz), **deploy-ramdisk-ironic** images (\*.initramfs, \*.kernel),
**ironic-python-agent** images (\*.initramfs, \*.kernel) and **testing**
fedora-user.qcow2 (which is always Fedora based).
Build a single image
````````````````````
The previous command builds all the images needed for an overcloud deploy.
However, you may need to rebuild a single one of them. Use the following
commands if you want to do it:
::
openstack overcloud image build --type {agent-ramdisk, deploy-ramdisk, fedora-user, overcloud-full}
If the target image exist, this commands ends silently. Make sure to delete a
previous version of the image to run the command as you expect.
Moreover, you can build the image with an extra element of your choice using the
``--builder-extra-args`` argument:
::
openstack overcloud image build --type overcloud-full \
--builder-extra-args overcloud-network-midonet
.. note::
Make sure the element is available in the ``$ELEMENTS_PATH`` environment
variable
.. note::
remove any previous ``overcloud-full.qcow2`` in your ``$path`` before run
any rebuild command
This command will build **overcloud-full** images (\*.qcow2, \*.initrd,
\*.vmlinuz) and **ironic-python-agent** images (\*.initramfs, \*.kernel)
To rebuild only a single image, see :doc:`../advanced_deployment/build_single_image`.
Upload Images
-------------
@ -275,33 +228,8 @@ Introspect hardware attributes of nodes::
The process can take up to 5 minutes for VM / 15 minutes for baremetal. If
the process takes longer, see :ref:`introspection_problems`.
Introspecting a single node
^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can also introspect nodes one by one.
When doing so, you must take care to set the correct node states manually.
Use ``ironic node-show UUID`` command to figure out whether nodes are in
``manageable`` or ``available`` state. For all nodes in ``available`` state,
start with putting a node to ``manageable`` state::
ironic node-set-provision-state UUID manage
Then you can run introspection::
openstack baremetal introspection start UUID
This command won't poll for the introspection result, use the following command
to check the current introspection state::
openstack baremetal introspection status UUID
Repeat it for every node until you see ``True`` in the ``finished`` field.
The ``error`` field will contain an error message if introspection failed,
or ``None`` if introspection succeeded for this node.
Do not forget to make nodes available for deployment afterwards::
ironic node-set-provision-state UUID provide
.. note:: If you need to introspect just a single node, see
:doc:`../advanced_deployment/introspect_single_node`
Flavor Details
--------------

22
doc/source/installation/installing.rst
View File

@ -91,25 +91,9 @@ Installing the Undercloud
export DIB_INSTALLTYPE_puppet_modules=source
.. admonition:: Source
:class: source
To use a git checkout for only a specific module, export the following variable::
export DIB_INSTALLTYPE_puppet_tripleo=source
Replace ``puppet_tripleo`` with the name of the puppet module to be installed
from source, replacing any -'s with _'s.
To use a pending review for a module, set its installtype to source as
described above, then also export the following variables::
export DIB_REPOLOCATION_puppet_tripleo=https://review.openstack.org/openstack/puppet-tripleo
export DIB_REPOREF_puppet_tripleo=refs/changes/30/223330/1
This time replace the name of the module in the variable name and the review URL.
The correct value for the ``reporef`` can be found in the ``Download`` section
of the Gerrit UI. Look for a string that matches the format of the example above.
It is also possible to use this functionality to use an in-progress review
as part of the undercloud install. See
:doc:`../advanced_deployment/in_progress_review` for details.
.. admonition:: SSL
:class: ssl