From 746faceeaba71138252f58515963bdf4f12ee7b2 Mon Sep 17 00:00:00 2001 From: Mathieu Mitchell Date: Tue, 13 Sep 2016 22:39:16 -0400 Subject: [PATCH] [install-guide] Import "Building or downloading a deploy ramdisk image" Change-Id: I11cd67602b04c23cfe966cd2c2176ba01807c672 Partial-bug: #1612278 (cherry picked from commit f4a6dc72d579b0c450c84661db7eea9ec6bbffa1) --- doc/source/deploy/install-guide.rst | 95 +----------------- install-guide/source/deploy-ramdisk.rst | 98 +++++++++++++++++++ .../include/configure-glance-images.rst | 6 +- install-guide/source/index.rst | 1 + 4 files changed, 104 insertions(+), 96 deletions(-) create mode 100644 install-guide/source/deploy-ramdisk.rst diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst index 6c8614dc68..c3f67f2d34 100644 --- a/doc/source/deploy/install-guide.rst +++ b/doc/source/deploy/install-guide.rst @@ -711,99 +711,10 @@ to the Bare Metal service Install Guide. Building or downloading a deploy ramdisk image ============================================== -Ironic depends on having an image with the ironic-python-agent_ (IPA) -service running on it for controlling and deploying bare metal nodes. +The `Building or downloading a deploy ramdisk image`_ section has been moved to +the Bare Metal service Install Guide. -You can download a pre-built version of the deploy ramdisk built with -the `CoreOS tools`_ at: - -* `CoreOS deploy kernel `_ -* `CoreOS deploy ramdisk `_ - -.. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ - -Building from source --------------------- - -There are two known methods for creating the deployment image with the -IPA service: - -.. _BuildingCoreOSDeployRamdisk: - -CoreOS tools -~~~~~~~~~~~~ - -#. Clone the ironic-python-agent_ project:: - - git clone https://git.openstack.org/openstack/ironic-python-agent - -#. Install the requirements:: - - Fedora 21/RHEL7/CentOS7: - sudo yum install docker gzip util-linux cpio findutils grep gpg - - Fedora 22 or higher: - sudo dnf install docker gzip util-linux cpio findutils grep gpg - - Ubuntu 14.04 (trusty) or higher: - sudo apt-get install docker.io gzip uuid-runtime cpio findutils grep gnupg - -#. Change directory to ``imagebuild/coreos``:: - - cd ironic-python-agent/imagebuild/coreos - -#. Start the docker daemon:: - - Fedora/RHEL7/CentOS7: - sudo systemctl start docker - - Ubuntu: - sudo service docker start - -#. Create the image:: - - sudo make - -#. Or, create an ISO image to boot with virtual media:: - - sudo make iso - - -.. note:: - Once built the deploy ramdisk and kernel will appear inside of a - directory called ``UPLOAD``. - - -.. _BuildingDibBasedDeployRamdisk: - -disk-image-builder -~~~~~~~~~~~~~~~~~~ - -#. Install disk-image-builder_ from pip or from your distro's packages:: - - sudo pip install diskimage-builder - -#. Create the image:: - - disk-image-create ironic-agent fedora -o ironic-deploy - - The above command creates the deploy ramdisk and kernel named - ``ironic-deploy.vmlinuz`` and ``ironic-deploy.initramfs`` in your - current directory. - -#. Or, create an ISO image to boot with virtual media:: - - disk-image-create ironic-agent fedora iso -o ironic-deploy - - The above command creates the deploy ISO named ``ironic-deploy.iso`` - in your current directory. - -.. note:: - Fedora was used as an example for the base operational system. Please - check the `diskimage-builder documentation`_ for other supported - operational systems. - -.. _`diskimage-builder documentation`: http://docs.openstack.org/developer/diskimage-builder +.. _`Building or downloading a deploy ramdisk image`: http://docs.openstack.org/project-install-guide/baremetal/draft/deploy-ramdisk.html Trusted boot with partition image diff --git a/install-guide/source/deploy-ramdisk.rst b/install-guide/source/deploy-ramdisk.rst new file mode 100644 index 0000000000..c0e76b1a2f --- /dev/null +++ b/install-guide/source/deploy-ramdisk.rst @@ -0,0 +1,98 @@ +.. _deploy-ramdisk: + +Building or downloading a deploy ramdisk image +============================================== + +Ironic depends on having an image with the ironic-python-agent_ (IPA) +service running on it for controlling and deploying bare metal nodes. + +You can download a pre-built version of the deploy ramdisk built with +the `CoreOS tools`_ at: + +* `CoreOS deploy kernel `_ +* `CoreOS deploy ramdisk `_ + +.. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ + +Building from source +-------------------- + +There are two known methods for creating the deployment image with the +IPA service: + +.. _BuildingCoreOSDeployRamdisk: + +CoreOS tools +~~~~~~~~~~~~ + +#. Clone the ironic-python-agent_ project:: + + git clone https://git.openstack.org/openstack/ironic-python-agent + +#. Install the requirements:: + + Fedora 21/RHEL7/CentOS7: + sudo yum install docker gzip util-linux cpio findutils grep gpg + + Fedora 22 or higher: + sudo dnf install docker gzip util-linux cpio findutils grep gpg + + Ubuntu 14.04 (trusty) or higher: + sudo apt-get install docker.io gzip uuid-runtime cpio findutils grep gnupg + +#. Change directory to ``imagebuild/coreos``:: + + cd ironic-python-agent/imagebuild/coreos + +#. Start the docker daemon:: + + Fedora/RHEL7/CentOS7: + sudo systemctl start docker + + Ubuntu: + sudo service docker start + +#. Create the image:: + + sudo make + +#. Or, create an ISO image to boot with virtual media:: + + sudo make iso + + +.. note:: + Once built the deploy ramdisk and kernel will appear inside of a + directory called ``UPLOAD``. + + +.. _BuildingDibBasedDeployRamdisk: + +disk-image-builder +~~~~~~~~~~~~~~~~~~ + +#. Follow `diskimage-builder installation documentation`_ to install + diskimage-builder. + +#. Create the image:: + + disk-image-create ironic-agent fedora -o ironic-deploy + + The above command creates the deploy ramdisk and kernel named + ``ironic-deploy.vmlinuz`` and ``ironic-deploy.initramfs`` in your + current directory. + +#. Or, create an ISO image to boot with virtual media:: + + disk-image-create ironic-agent fedora iso -o ironic-deploy + + The above command creates the deploy ISO named ``ironic-deploy.iso`` + in your current directory. + +.. note:: + Fedora was used as an example for the base operational system. Please + check the `diskimage-builder documentation`_ for other supported + operational systems. + +.. _`diskimage-builder documentation`: http://docs.openstack.org/developer/diskimage-builder +.. _`diskimage-builder installation documentation`: http://docs.openstack.org/developer/diskimage-builder/user_guide/installation.html diff --git a/install-guide/source/include/configure-glance-images.rst b/install-guide/source/include/configure-glance-images.rst index 343a076a40..9b62135595 100644 --- a/install-guide/source/include/configure-glance-images.rst +++ b/install-guide/source/include/configure-glance-images.rst @@ -48,10 +48,8 @@ them to the Image service: If you want to use Fedora image, replace ``ubuntu`` with ``fedora`` in the chosen command. - .. note:: To build the deploy image take a look at the `Building or - downloading a deploy ramdisk image`_ section. - - .. _`Building or downloading a deploy ramdisk image`: http://docs.openstack.org/developer/ironic/deploy/install-guide.html#building-or-downloading-a-deploy-ramdisk-image + .. note:: To build the deploy image take a look at the :ref:`deploy-ramdisk` + section. #. Add the user images to the Image service diff --git a/install-guide/source/index.rst b/install-guide/source/index.rst index 289c99e931..ba86563331 100644 --- a/install-guide/source/index.rst +++ b/install-guide/source/index.rst @@ -14,6 +14,7 @@ Bare Metal service enabling-https.rst standalone.rst configdrive.rst + deploy-ramdisk.rst advanced.rst troubleshooting.rst next-steps.rst