97c01e48ed
Currently we have all our elements and library files in a top-level directory and install them into <root>/share/diskimage-builder/[elements|lib] (where root is either / or the root of a virtualenv). The problem with this is that editable/development installs (pip -e) do *not* install data_files. Thus we have no canonical location to look for elements -- leading to the various odd things we do such as a whole bunch of guessing at the top of disk-image-create and having a special test-loader in tests/test_elements.py so we can run python unit tests on those elements that have it. data_files is really the wrong thing to use for what are essentially assets of the program. data_files install works well for things like config-files, init.d files or dropping documentation files. By moving the elements under the diskimage_builder package, we always know where they are relative to where we import from. In fact, pkg_resources has an api for this which we wrap in the new diskimage_builder/paths.py helper [1]. We use this helper to find the correct path in the couple of places we need to find the base-elements dir, and for the paths to import the library shell functions. Elements such as svc-map and pkg-map include python unit-tests, which we do not need tests/test_elements.py to special-case load any more. They just get found automatically by the normal subunit loader. I have a follow-on change (I69ca3d26fede0506a6353c077c69f735c8d84d28) to move disk-image-create to a regular python entry-point. Unfortunately, this has to move to work with setuptools. You'd think a symlink under diskimage_builder/[elements|lib] would work, but it doesn't. [1] this API handles stuff like getting files out of .zip archive modules, which we don't do. Essentially for us it's returning __file__. Change-Id: I5e3e3c97f385b1a4ff2031a161a55b231895df5b
38 lines
1.7 KiB
ReStructuredText
38 lines
1.7 KiB
ReStructuredText
============
|
|
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
|