diskimage-builder/elements/ironic-agent
Ben Nemec 4e5dcdd9cf Clean more from ironic-agent ramdisk image
While we already clean a number of things off the ironic-agent
ramdisk, there are a few more significant ones that we should add
to the list.

First is the kernel source.  If you're rebuilding your kernel on
the agent ramdisk after the initial image build, then you need to
re-examine your life choices. ;-)

Second is /var/cache.  On yum-based distros, this contains a large
number of yum cache files that take up significant space.  We don't
really want to be copying around caches when booting a ramdisk
anyway, so cleaning this is the right thing to do regardless.

Third is all *.pyc or *.pyo files.  There are a lot of these, so
they eat up significant space and bloat the number of files in the
ramdisk, which makes it take longer to build.  the only purpose for
the files is to slightly speed up Python app startup, and we
probably lose more time transferring the files over the network
than we would gain in quicker start times.  Note that we were
already trying to remove these, but for some reason I was still
seeing them show up in my final images.  It makes more sense to
put them in the same pruning command as all the others anyway.

Fourth is /usr/include.  These are files only needed for
compilation.  See above for my thoughts on compiling in a ramdisk.

These changes have reduced the agent ramdisk from 391 MB to 333 MB
in my local centos 7 builds, and have reduced the number of files
in the ramdisk by over 18000.

Change-Id: I550f9904b9afd12d48da9ba24559acb23133d076
2016-06-24 13:21:32 -05:00
..
cleanup.d Clean more from ironic-agent ramdisk image 2016-06-24 13:21:32 -05:00
environment.d Use ironic-agent for source-repositories 2015-11-22 15:03:31 -05:00
extra-data.d Support to add certificate in ironic-agent 2016-04-14 13:42:36 +00:00
finalise.d Do not remove sudo in ironic-agent 2016-05-16 10:39:04 +10:00
install.d Add dhcp-all-interfaces.target for syncing units 2016-05-16 10:15:53 +01:00
post-install.d Merge "ironic-agent postinst fails on systemd with no iptables" 2016-04-04 19:35:42 +00:00
test-elements/build-succeeds-fedora Remove zero length files 2016-01-20 19:08:54 -05:00
element-deps Install IPA in a virtual environment 2016-02-16 11:17:12 +00:00
element-provides Add element for building ramdisk with ironic-python-agent 2014-11-13 19:30:44 +02:00
package-installs.yaml Add psmisc to the packages for ironic-agent 2016-03-21 00:01:57 -07:00
pkg-map Install ironic-agent dependencies via package-installs 2015-09-21 13:10:30 +02:00
README.rst Support to add certificate in ironic-agent 2016-04-14 13:42:36 +00:00
source-repository-ironic-agent Install IPA in a virtual environment 2016-02-16 11:17:12 +00:00
svc-map [ironic-agent] Use svc-map for enabling agent 2015-09-01 07:12:52 -04:00

============
ironic-agent
============
Builds a ramdisk with ironic-python-agent.  More information can be found at:
    https://git.openstack.org/cgit/openstack/ironic-python-agent/

Beyond installing the ironic-python-agent, this element does the following:

* Installs the ``dhcp-all-interfaces`` so the node, upon booting, attempts to
  obtain an IP address on all available network interfaces.
* Disables the ``iptables`` service on SysV and systemd based systems.
* Disables the ``ufw`` service on Upstart based systems.
* Installs packages required for the operation of the ironic-python-agent::
    ``qemu-utils`` ``parted`` ``hdparm`` ``util-linux`` ``genisoimage``
* When installing from source, ``python-dev`` and ``gcc`` are also installed
  in order to support source based installation of ironic-python-agent and its
  dependencies.
* Install the certificate if any, which is set to the environment variable
  ``DIB_IPA_CERT`` for validating the authenticity by ironic-python-agent. The
  certificate can be self-signed certificate or CA certificate.

This element outputs three files:

- ``$IMAGE-NAME.initramfs``: The deploy ramdisk file containing the
  ironic-python-agent (IPA) service.
- ``$IMAGE-NAME.kernel``: The kernel binary file.
- ``$IMAGE-NAME.vmlinuz``: A hard link pointing to the ``$IMAGE-NAME.kernel``
  file; this is just a backward compatibility layer, please do not rely
  on this file.

.. note::
   The package based install currently only enables the service when using the
   systemd init system. This can easily be changed if there is an agent
   package which includes upstart or sysv packaging.

.. note::
   Using the ramdisk will require at least 1.5GB of ram