diskimage-builder/diskimage_builder/elements/ironic-agent
melissaml a6322c6ed0 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I03e9162d5a59a2aa1631a9ecf6f6833bb7ac6050
2019-05-16 14:45:52 +08:00
..
cleanup.d Release 1.27.0 2017-02-03 11:49:45 +11:00
environment.d Trivial fix typos 2017-05-31 11:17:05 +07:00
extra-data.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
finalise.d ironic-agent: don't remove make 2017-12-07 13:59:51 +11:00
install.d upgrade pip before using -c option 2018-01-19 16:46:59 -06:00
post-install.d Keep git after ironic-agent post 2019-02-19 16:32:22 +11:00
static Create rescue user on ironic agent 2017-10-23 12:50:32 +00:00
test-elements/build-succeeds-fedora Move ironic-agent test to fedora-minimal 2017-06-21 15:05:36 +10:00
element-deps Add an element to configure iBFT network interfaces 2018-11-20 14:11:11 +01:00
element-provides Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
package-installs.yaml IPA requires iptables 2018-05-17 11:14:44 -05:00
pkg-map Remove centos and rhel elements 2017-06-28 12:26:24 +10:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-29 20:15:25 +10:00
source-repository-ironic-agent Replace git.openstack.org URLs with opendev.org URLs 2019-05-16 14:45:52 +08:00
svc-map Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00

============
ironic-agent
============
Builds a ramdisk with ironic-python-agent.  More information can be found at:
    https://opendev.org/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.
* Compresses initramfs with command specified in environment variable
  ``DIB_IPA_COMPRESS_CMD``, which is 'gzip' by default. This command should listen
  for raw data from stdin and write compressed data to stdout. Command can be
  with arguments.

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