ironic-python-agent/imagebuild/tinyipa
Pavlo Shchelokovskyy 2136ded582 Enable SSH access to tinyipa
might be useful sometimes,
for example debugging in normal terminal is usually more pleasant
than in QEMU console.

Add env variables `ENABLE_SSH` and `SSH_PUBLIC_KEY`,
documentation is amended accordingly.

Change-Id: I71352c2087e1fb9a7174affb78fe695932a924d7
2016-09-19 19:02:55 +03:00
..
build_files Enable SSH access to tinyipa 2016-09-19 19:02:55 +03: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 Enable SSH access to tinyipa 2016-09-19 19:02:55 +03:00
build-iso.sh Add script to install missing tinyipa dependencies 2016-04-11 11:28:48 +01:00
build-tinyipa.sh Fix TINYCORE_MIRROR_URL option defaults 2016-09-16 10:54:18 +03:00
finalise-tinyipa.sh Enable SSH access to tinyipa 2016-09-19 19:02:55 +03:00
install-deps.sh Add script to install missing tinyipa dependencies 2016-04-11 11:28:48 +01: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

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

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>