ironic-python-agent/imagebuild/tinyipa
John L. Villalovos 785498867e Comment on when the TinyCore mirror list was generated
Add a comment on when the TinyCore mirror list was generated to make
it more obvious when it might need to be regenerated.

Change-Id: Ie3984b5c6b85c878212497f53eb3d3eabb352523
2016-12-14 09:14:54 -08:00
..
build_files Add bash scripts style checking for IPA 2016-11-09 14:14:40 -08:00
.gitignore Add tinyipa to IPA imagebuild directory 2016-01-29 12:07:19 +00:00
Makefile Add script to install missing tinyipa dependencies 2016-04-11 11:28:48 +01:00
README.rst [tinyipa] allow skipping python compileall 2016-10-04 12:23:31 +03:00
build-iso.sh Add script to install missing tinyipa dependencies 2016-04-11 11:28:48 +01:00
build-tinyipa.sh Probe for TC mirror during tinyipa build 2016-12-14 11:50:18 +02:00
finalise-tinyipa.sh Probe for TC mirror during tinyipa build 2016-12-14 11:50:18 +02:00
install-deps.sh Add script to install missing tinyipa dependencies 2016-04-11 11:28:48 +01:00
tc-mirror.sh Comment on when the TinyCore mirror list was generated 2016-12-14 09:14:54 -08:00

README.rst

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_tinyipa

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 SSH access to the ramdisk

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

export ENABLE_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>