=============================
Tiny Core Ironic Python Agent
=============================

Build script requirements
-------------------------
For the main build script:

* wget
* pip
* unzip
* sudo
* awk
* mksquashfs

For building an ISO you'll also need:

* genisoimage

Instructions:
-------------
To create a new ramdisk, run::

  make

or::

  ./build-tinyipa.sh && ./finalise-tinyipa.sh

This will create two new files once completed:

* tinyipa.vmlinuz
* tinyipa.gz

These are your two files to upload to glance for use with Ironic.

Building an ISO from a previous make run:
-----------------------------------------
Once you've built tinyipa it is possible to pack it into an ISO if required. To
create a bootable ISO, run::

  make iso

or::

./build-iso.sh

This will create one new file once completed:

* tinyipa.iso

To build a fresh ramdisk and build an iso from it:
--------------------------------------------------
Run::

  make all

To clean up the whole build environment run:
--------------------------------------------
Run::

  make clean

For cleaning up just the iso or just the ramdisk build::

  make clean_iso

or::

  make clean_build

Advanced options
----------------

(De)Optimizing the image
~~~~~~~~~~~~~~~~~~~~~~~~

If you want the build script to preinstall everything into the ramdisk,
instead of loading some things at runtime (this results in a slightly bigger
ramdisk), before running make or build-tinyipa.sh run::

  export BUILD_AND_INSTALL_TINYIPA=true

By default, building TinyIPA will compile most of the Python code to
optimized ``*.pyo`` files, completely remove most of ``*.py`` and ``*.pyc``
files, and run ironic-python-agent with ``PYTHONOPTIMIZE=1``
to save space on the ramdisk.
If instead you want a normal Python experience inside the image,
for example for debugging/hacking on IPA in a running ramdisk,
before running make or build-tinyipa.sh run::

    export PYOPTIMIZE_TINYIPA=false


Enabling/disabling SSH access to the ramdisk
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default tinyipa will be built with OpenSSH server installed but no
public SSH keys authorized to access it.

If you want to enable SSH access to the image, set ``AUTHORIZE_SSH`` variable
in your shell before building the tinyipa::

  export AUTHORIZE_SSH=true

By default it will use public RSA or DSA keys of the user running the build.
To provide other public SSH key, export path to it in your shell before
building tinyipa as follows::

  export SSH_PUBLIC_KEY=<full-path-to-public-key>

If you want to disable SSH altogether, set ``INSTALL_SSH`` variable in your
shell to ``false`` before building the tinyipa::

    export INSTALL_SSH=false

You can also rebuild an already built tinyipa image by using ``addssh`` make
tagret::

    make addssh

This will fetch the pre-built tinyipa image from "tarballs.openstack.org"
using the version specified as ``BRANCH_NAME`` shell variable as described
above, or it may use an already downloaded ramdisk image if path to it is set
as ``TINYIPA_RAMDISK_FILE`` shell variable before running this make target.
It will install and configure OpenSSH if needed and add public SSH keys for
``tc`` user using the same ``SSH_PUBLIC_KEY`` shell variable as described
above.

Enabling biosdevname in the ramdisk
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to collect BIOS given names of NICs in the inventory, set
``TINYIPA_REQUIRE_BIOSDEVNAME`` variable in your shell before building the
tinyipa::

  export TINYIPA_REQUIRE_BIOSDEVNAME=true

Using ironic-lib from source
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`ironic-lib <https://opendev.org/openstack/ironic-lib>`_ contains
important parts of the provisioning logic. If you need to build an IPA image
with your local checkout of `ironic-lib`, export the following variable::

  export IRONIC_LIB_SOURCE=/absolute/path/to/ironic-lib/checkout