Environment variables

[marcastel]

AIT environment

The environment variables available to AIT commands (cf. aitenv(1)).

AIT host/system information

Property	Label
rc.host.kind	Kind of server (n-tier, workstation, ...)
rc.host.mode	Host mode mode (operational, standby, legacy, ...)
rc.host.role	Role of server (production, test, ...)
rc.host.site	Site or organisation to which the system is bound
rc.host.zone	Cloud platform and/or geographic location of server
rc.host.tags	Tags intended for automation and reporting purposes
rc.host.apps	Tags describing the business purpose of this system
rc.host.risk	Risk level and associated SLA handling level

UNIX version and hardware

Property	Label
rc.unix.brief	UNIX or Linux summarised identity
rc.unix.name	Standardised UNIX or Linux name
rc.unix.version	Operating system version
rc.unix.distrib	Linux distribution or macOS major version name
rc.unix.cputype	Underlying CPU type or family
rc.unix.machine	Underlying hardware architectural type

AIT system-wide directories

Property	Default	Label
rc.host.prefix	/opt/ait	Home of the AIT framework
rc.host.execprefix	/opt/ait	Prefix for machine-specific files
rc.host.bindir	/opt/ait/bin	Executable programs that users can run
rc.host.countdir	/opt/ait/run/counters	Serialised counters and statistical data.]
rc.host.datadir	/opt/ait/share	Read-only arch-independent data files
rc.host.datarootdir	/opt/ait/share	Read-only arch-independent data files
rc.host.docdir	/opt/ait/man/doc	Documentation files
rc.host.htmldir	/opt/ait/man/html	HTML documentation files
rc.host.includedir	/opt/ait/include	Header files primarily for C/C++
rc.host.infodir	/opt/ait/man/info	GNU Info documentation files
rc.host.kornlibdir	/opt/ait/lib/ksh	KornShell functions library
rc.host.libdir	/opt/ait/lib	Object files and libraries of object code
rc.host.libexecdir	/opt/ait/libexec	Executable librarys of object code
rc.host.localedir	/opt/ait/locale	Locale-specific message catalogs
rc.host.localstatedir	/opt/ait/var	Machine-specific variable data (logs, spools, ...)
rc.host.lockdir	/opt/ait/run/lock	Lock files that pertain to devices and other resources
rc.host.logdir	/opt/ait/var/log	Logging-related files output by AIT executables and utilities
rc.host.mandir	/opt/ait/man	Top-level directory for AIT man pages
rc.host.menudir	/opt/ait/etc/menu.d	Top-level directory for AIT menu(1) definition files
rc.host.mddir	/opt/ait/man/md	Markdown documentation files
rc.host.mdlibdir	/opt/ait/lib/md	Markdown resources and assets
rc.host.pdfdir	/opt/ait/man/pdf	PDF documentation files
rc.host.pkgconfigdirr	/opt/ait/lib/pkgconfig	Repository of pkgconfig(1) definition files
rc.host.profiledir	/opt/ait/etc/profile.d	Site, machine and user profiles
rc.host.runstatedir	/opt/ait/run	Machine-specific process identification files (PIDs)
rc.host.sbindir	/opt/ait/sbin	Executable programs primarily intended for system administrators
rc.host.stopdir	/opt/ait/run/stop	Stop files and program execution control
rc.host.sharedstatedir	/opt/ait/com	Shared process state and variable data
rc.host.sysconfdir	/opt/ait/etc	Machine-specific read-only data files
rc.host.sysincludedir	/opt/ait/com	POSIX system master include directory
rc.host.syslibdir	/usr/lib	POSIX system master library
rc.host.tmpdir	$TMPDIR	Spooler for temporary files

AIT user directories

Property	Default	Label
rc.user.briefcase	~/Briefcase	Private/professional files (cloud/shared)
rc.user.sandbox	~/Sandbox	Software engineering sandbox
rc.user.prefix	~/.ait	Home of the user's AIT framework
rc.user.bindir	~/.ait/bin	Executable programs that users can run
rc.user.confdir	~/.ait/etc	User-specific read-only data files
rc.user.lockdir	~/.ait/run/lock	Lock files that pertain to devices and other resources
rc.user.menudir	~/.ait/etc/menu.d	User specific AIT menu(1) definition files
rc.user.profiledir	~/.ait/etc/profile.d	User's profile customisations
rc.user.runstatedir	~/.ait/run	Process identification files (PIDs)
rc.user.statedir	~/.ait/var	Process state and variable data (shareable)
rc.user.stopdir	~/.ait/run/stop	Stop files and program execution control
rc.user.tmpdir	~/.ait/tmp	Spooler for temporary files