Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

AIF is the Arch linux Installation Framework.

Fetching latest commit…

Cannot retrieve the latest commit at this time

README
AIF is the Arch Linux Installation Framework.

License:     GPL3. See COPYING.
Authors:     Dieter Plaetinck
             Patches from Gerhard Brauer, Matthias Dienstbier, Jud Film, Laszlo Papp and 'tuxce'
             Quite some code has been taken from the installer project @ http://projects.archlinux.org/?p=installer.git;a=summary
             The main authors/contributors of that project are Judd Vinet, Tobias Powalowski, Simo Leone, Aaron Griffin and Dan McGee
Homepage:    http://github.com/Dieterbe/aif


** Dependencies **
 - util-linux-ng
 - bash >=4
 - pacman >=3.4
 - coreutils
 - grub
 - grep
 - awk
 - sed
 - libui-sh
Optionally:
 - markdown: to generate the html installation guide
 - cryptsetup: for encryption support
 - lvm2: for LVM support
 - dhcpd: for dhcp networking support
 - e2fsprogs: Ext support
 - jfsutils: JFS support
 - reiserfsprogs: ReiserFS support
 - nilfs-utils: Nilfs2 support
 - xfsprogs: XFS support
 - ntp: setting date with NTP
 - dialog: for ncurses support
 - curl: for the aif-report-issues.sh script

** Goals **

The goal of this project is to:
1) provide reasonable clean, DRY, modular and maintainable code for the Arch Linux installer
2) provide complete, easily-reusable libraries for disk partitioning, UI, package management, etc
3) provide some sensible default installation methods (eg interative, automatic (prescripted), ..)
4) allow power users to easily override certain aspects of the installation procedures
   or creating customized procedures, leveraging the available code.

The goal of AIF is not (yet) to:
1) provide an installer who detects your stuff and tries to be smart and configures all your stuff.
   If you're interested in this, feel free to build it and I may incorporate it someday.
2) be more fancy then needed


** Branches **
-> master: "stable" tree, infrequent updates
-> develop: unstable development tree, which may get rewritten at some points,
   only when things have settled down (every x weeks/months), gets pushed to master
-> optionally: more topic branches which are rewriteable and which come and go

** A bit of history **

AIF is based on the old archlinux-installer, but the code has been madly refactored, reorganized, cleaned
up, improved and in some places replaced.
The initial goal was to build an automated installer with a reusable
backend, but the porting of the userfriendly, interactive installer from /arch/setup quickly became a proof of concept
and even main focus point.  See http://www.nabble.com/Fifa:-Flexible-Installer-Framework-for-Arch-linux-td20256427.html

arch-installer used to be installed as /arch/setup and /arch/quickinst; wheres AIF adheres to the FHS spec,
but archiso images come with an /arch/setup 1-line script which now just calls aif with the interactive procedure and dialog (ncurses) frontend.

** Bug/feature request tracking.  Getting in touch ** 

AIF developement happens under the umbrella of the release engineering project of Arch Linux.

- bug tracker:  the Arch Linux bugtracker, "Release Engineering" project, category 'AIF'.
                http://bugs.archlinux.org/toplevel/proj6
- mailing list: http://www.archlinux.org/mailman/listinfo/arch-releng

There are some known issues (see the bugtracker, TODO file and various TODO's in the source code) 
If you encounter issues, please report them on the bugtracker, after checking if they are not reported yet of course.
If you want to get in touch with us, to ask/discuss/.. things, please send to the mailing list.



** Lingo **

- procedure = a 'plugin' for aif that controls how the installation advances and how the interaction with the user happens
- lib       = a library for aif with some useful functions (eg lib-pacman handles all pacman related things)
- module    = a bundle that can contain zero or more procedures and libraries.
- profile   = a fancier name for a config file.  some procedures support the use of profiles (eg automatic), others don't (eg interactive)
- partial procedure = a 'mini' procedure that lets the user perform one or more smaller aspects of (or related to) an installation


** Basic workflow **

AIF comes by default with these procedures:
- base:        basic, little-interactivity installation with some common defaults. 
               This procedure is used by the others to inherit from, it is NOT meant to be used directly by end users
- interactive: An interactive installation procedure.
               Asks you some questions, guides you through an installation
               and even helps you a bit by updating configuration files on the target
               system with your usettings
- automatic:   An automated, deploy-tool-alike procedure.  designed for low-
               to zero interactivity.  uses profiles for configuration of the installation/target system.  
               See /usr/share/aif/examples/ for example profile files.
- partial-configure-network: exposes the network configuration step from the interactive procedure
- partial-disks: Process disk subsystem or do a rollback
- partial-keymap: change your keymap/console font settings.  The benefit of this method over a simple loadkeys is that the interactive procedure will
                  automatically update the rc.conf on the target system with your settings.

You would usually invoke aif like this:
aif -p interactive
aif -p automatic -c <profile file> [-l]
aif -p <custom module name>/<your procedure>
Type `aif -h` or just aif to see more details.



** Packages and file locations: **

The officially supported package is aif, in extra.  There are also
unsupported development git packages in AUR.  See HOWTO

File locations:
* aif.sh        -> /sbin/aif
* docs          -> /usr/share/aif/docs
* core module   -> /usr/lib/aif/core
* user modules  -> /usr/lib/aif/user/<module name> (put your own modules here)
* runtime files -> /tmp/aif
* logs          -> /var/log/aif



** (Internal) Workflow **
There is a very basic but powerful workflow defined by variables, phases and workers.
Depending on the procedure you choose (or write yourself), these will differ
In the code, they are very recognizable and are named like this:
 - variable -> var_<FOO>
 - phase    -> phase_<bar> (an array in which each element is a worker to be executed, with optionally arguments for that worker)
               There are 4 phases: preparation, basics, system, finish. (executed in that order)
 - worker   -> worker_<baz> ( a worker function, called by a phase. implements some specific logic.
               eg runtime_packages, prepare_disks, package_list etc)


You can depend on whatever procedure you like (like core/base), to save
yourself some work (you only need to override a few things)

Notes:
 - You don't need to use the concept of phases, for example the interactive procedure doesn't use them.
 - The phases are started by the start_process function.  You can also override this function to take flow control in your own hands (like interactive does) 
 - you _can_ override _all_ variables and functions in your modules, but you should be able to achieve your goals by
   overriding only the 3 basic things and the start_process function, and only in procedures.
 - you _must_ specify a procedure, to avoid errors. take 'interactive' if unsure
 - don't edit the base procedure (or any other core item), rather make your own. It's easy!
 - you're not supposed to define new phases. just override them. logic goes in workers/libariers
 - workers and phases are pretty regular functions, except that they are invoked through a wrapper (the `execute` function), which tracks the exitcodes
   this allows to get reports at the end of the install showing which steps completed successfully and where things failed.  Other then that, there is nothing
   special about them.  It is even possible to have your workers function as a callback by having library functions invoking them.


** Extending AIF **

*** Modules ***
 -> Modules are the building blocks in aif
 -> user modules are just directories with a 'libs' and 'procedures' subdirectory
    where you can put your customized.. guess what.  See 'file locations'
 -> The core module comes by default and contains everything 99% of the users will need. 
    Don't name your custom module 'core' (it will be ignored).
    Don't call it http either, because you can specify 'http://some/path/to/a/procedure',
    aif will download that procedure and execute it (and the module will be 'http')

*** Procedures ***
 -> You can take a procedure, copy it, modify it and call it. that's fine.
 -> You can also write a new one from scratch, inheriting some other procedure using
    the depend_procedure call and just overriding what you need.

 -> Commandline arguments are parsed by aif.sh but you can extend/override it's
    behaviour by overriding $var_OPTS_STRING and the process_vars variable.
    Also, you do not _have_ to use the variables they set (eg arg_ui_type).  You
    usually will set defaults in the configure worker and override with
    arguments passed by the user (eg to use cli mode unless user wants dia)

*** Libraries **
 -> If you have logic that may be reusable by several procedures, consider
    putting the functions in a library so you, and others can easily use it.

*** Profiles ***
 -> You can take a profile and modify it
 -> you can also use the depend_profile call and just override what you need.


Note that if you load a module and a library has the same function names as
the core module, it will override the functions from core.
This means you can 'inject' new backend code into core procedures, but you
can also write your own procedures that use your own, or the core libraries.
If you load a module, you actually load it's libraries, not it's procedures!
Procedures are only loaded when needed (because you request them because
of dependencies)

If you need a library from another user contributed module, execute
'depend_module <modulename>' for each module.  This way you load all the
libs of that module (not the procedures, use depend_procedure for that. 
keep in mind that the position of the depend_procedure statement defines
where your variables/functions might be overridden...)
(very basic dependencies, no version checking etc)

You can specify a core procedure on the command line by specifying
'<procedure_name>', to specify a user contriubuted procedure, specify
'<module_name>/<procedure_name>'



** Contributing **

Install a VM (I use virtualbox-ose, works fine), make a vm, boot the install cd and just follow the HOWTO.
It's probably easiest if you set up your own git clone that you can easily
acces from the VM (You can open a github account and fork my code).
You can edit on the cd itself, but given the low resolution of the VM, you'll probably edit on your pc, commit, push to github
and pull from the clone on the cd.
If you want to do debugging, just call the debug function and export DEBUG=1
before calling the scripts. (or pass -d)
Keep in mind there are 3 kinds of variables.  Those that affect/belong to
the runtime (install cd live environment), target (affects/belongs to the
target installation) and TMP (everything in between or extra). Variablenames
should have _TARGET or _TMP suffixes or none for runtime.  (That's the
theory, it isn't always the case like that now, I need to do more refactoring)

** Test suite **

AIF also has a (WIP) test-suited. the source is the documentation.

** Reporting issues / getting help **

Run the aif-report-issues.sh script, which will submit valuable (for debugging)
info to a public pastebin, you can then give the url to the people who need to help you
Something went wrong with that request. Please try again.