HowTo Build NST 2.13.0 - Revision history

Paul Blankenbaker: /* /root/.nst/custom.ks */

2012-09-10T21:46:14Z

/root/.nst/custom.ks

← Older revision		Revision as of 17:46, 10 September 2012
Line 249:		Line 249:

	# This code runs non-chrooted. This allows us to transfer files from		# This code runs non-chrooted. This allows us to transfer files from
	# the host development system into the build image under $~~LIVE_ROOT~~		# the host development system into the build image under $INSTALL_ROOT
	#		#
	# Useful variables:		# Useful variables:
	#		#
	# ~~INSTALL_ROOT~~ - Top level directory that ~~build is under (you can reach~~		# LIVE_ROOT - Top level directory of all the file that will appear in the
	# ~~the isolinux directory from this variable~~.		# ISO image.
	#		#
	# ~~LIVE_ROOT~~ - ~~Root~~ (/) ~~view of file system for live build~~		# INSTALL_ROOT - The directory that is used to make the compressed file system
			# image (/) that you see after booting (you'll find: /etc, /var, /usr, ... under here).

	%post --nochroot		%post --nochroot
Line 262:		Line 263:
	# Install our ssh keys		# Install our ssh keys
	if [ -d /root/.ssh ]; then		if [ -d /root/.ssh ]; then
	[ -d ${~~LIVE_ROOT~~}/root/.ssh ] && /bin/rm -fr ${~~LIVE_ROOT~~}/root/.ssh;		[ -d ${INSTALL_ROOT}/root/.ssh ] && /bin/rm -fr ${INSTALL_ROOT}/root/.ssh;
	cp -rp /root/.ssh ${~~LIVE_ROOT~~}/root/.ssh;		cp -rp /root/.ssh ${INSTALL_ROOT}/root/.ssh;
	fi		fi

Paul Blankenbaker: /* Customizing The NST WUI CSS */

2011-01-14T14:15:31Z

Customizing The NST WUI CSS

← Older revision		Revision as of 10:15, 14 January 2011
Line 299:		Line 299:
	div.niceTitle .ttSite,		div.niceTitle .ttSite,
	div.niceTitle .ttNav,		div.niceTitle .ttNav,
			div.niceTitle .ttValue,
	div.niceTitle .ttAction,		div.niceTitle .ttAction,
	div.niceTitle .ttAcronym,		div.niceTitle .ttAcronym,

Paul Blankenbaker: /* Customizing Your Build */

2011-01-14T14:12:07Z

Customizing Your Build

← Older revision		Revision as of 10:12, 14 January 2011
Line 286:		Line 286:

	'''NOTE''': The ''/root/.nst/custom.ks'' feature did not become available until version 2.13.0 of the NST.		'''NOTE''': The ''/root/.nst/custom.ks'' feature did not become available until version 2.13.0 of the NST.

			= Customizing The NST WUI CSS =

			If you would like to customize the look of the HTML produced by the ''nstweb'' and ''nstwui'' packages, you can do so by creating the file ''/root/.nst/site.css''. The CSS commands which you specify within this file will override the default CSS provided by the packages.

			For example, if you prefer to have less color in your tooltips, create the ''/root/.nst/site.css'' file and add the following:

			/* Reduce the number of colors used in the tooltips */

			div.niceTitle .ttCommand,
			div.niceTitle .ttDocument,
			div.niceTitle .ttSite,
			div.niceTitle .ttNav,
			div.niceTitle .ttAction,
			div.niceTitle .ttAcronym,
			div.niceTitle .ttEmphasis,
			div.niceTitle .ttEmphasisPFont,
			div.niceTitle .ttNote,
			div.niceTitle .ttNotePFont {
			color: white;
			}

			When the ''nstweb'' and ''nstwui'' packages are built, the contents of ''/root/.nst/site.css'' will be appended to ''/usr/share/nstweb/css/domtt.css'' and ''/usr/share/nstwui/domtt.css'' as these normally the last CSS files are included on most of the HTML pages.

Paul Blankenbaker: /* /root/.nst/configure.sh */

2010-11-12T11:56:28Z

/root/.nst/configure.sh

← Older revision		Revision as of 07:56, 12 November 2010
Line 210:		Line 210:
	# from the top level directory		# from the top level directory
	#		#

			# Set the TEST_EXTENDED variable to "true" to enable test that take a long time to complete
			TEST_EXTENDED="false";

			# Following are related to tests requiring SMTP server access (tests that generate email)
	TEST_SMTP_SERVER="smtp.linux.bogus";		TEST_SMTP_SERVER="smtp.linux.bogus";
	TEST_SMTP_DOMAIN="linux.bogus";		TEST_SMTP_DOMAIN="linux.bogus";
Line 216:		Line 221:

	There used to be a lot more variables that could be "tweaked" in this file, but most of them have become deprecated since version 2.11.0 of the NST. You can review the file ''include/data/configure.in'' for a list of some of the other variables that can be overridden.		There used to be a lot more variables that could be "tweaked" in this file, but most of them have become deprecated since version 2.11.0 of the NST. You can review the file ''include/data/configure.in'' for a list of some of the other variables that can be overridden.


	== /root/.nst/custom.ks ==		== /root/.nst/custom.ks ==

Paul Blankenbaker: /* Check SELINUX Setting */

2010-11-03T22:19:01Z

Check SELINUX Setting

← Older revision		Revision as of 18:19, 3 November 2010
Line 54:		Line 54:
	You will need to restart the '''gdm''' process (or reboot your system) for the change to take affect.		You will need to restart the '''gdm''' process (or reboot your system) for the change to take affect.

	== Check SELINUX Setting ==		=== Check SELINUX Setting ===

	By default, Fedora will enable ''~~selinux~~'' in ''Enforcing'' mode. ~~In order~~ to build the ~~NST~~, you ~~must~~ either disable ''~~selinux~~'' or change it to ''Permissive'' mode. The following shows how the '''getenforce''' and '''setenforce''' commands can be used to change the ''selinux'' mode from ''Enforcing'' to ''Permissive'':		By default, Fedora will enable ''SELinux'' in ''Enforcing'' mode. Most likely, everything will build when in ''Enforcing'' mode. However, we have seen some circumstances (involving multiple disk partitions) when having ''SELinux'' set to ''Enforcing'' mode causes a failure in the build process.

			Using the ''SELinux Troubleshooter'' utility can help determine whether a build failure is due to a ''SELinux'' issue.

			If you want to avoid ''SELinux'' issues on your development machine, you can either disable ''SELinux'' or change it to ''Permissive'' mode. The following shows how the '''getenforce''' and '''setenforce''' commands can be used to change the ''selinux'' mode from ''Enforcing'' to ''Permissive'':

	[root@cirrus ~]# getenforce		[root@cirrus ~]# getenforce

Paul Blankenbaker: /* Install OS */

2010-10-30T19:13:17Z

Install OS

← Older revision		Revision as of 15:13, 30 October 2010
Line 53:		Line 53:

	You will need to restart the '''gdm''' process (or reboot your system) for the change to take affect.		You will need to restart the '''gdm''' process (or reboot your system) for the change to take affect.

			== Check SELINUX Setting ==

			By default, Fedora will enable ''selinux'' in ''Enforcing'' mode. In order to build the NST, you must either disable ''selinux'' or change it to ''Permissive'' mode. The following shows how the '''getenforce''' and '''setenforce''' commands can be used to change the ''selinux'' mode from ''Enforcing'' to ''Permissive'':

			[root@cirrus ~]# getenforce
			Enforcing
			[root@cirrus ~]# setenforce Permissive
			[root@cirrus ~]# getenforce
			Permissive
			[root@cirrus ~]#

			However, the above change only lasts until you reboot your machine. To make the change permanent, you need to edit the file: "''/etc/sysconfig/selinux''".

	=== Update OS ===		=== Update OS ===

Paul Blankenbaker at 19:07, 13 September 2010

2010-09-13T19:07:08Z

← Older revision		Revision as of 15:07, 13 September 2010
Line 1:		Line 1:
	= General =		= General =

	This document describes the steps involved in building the NST distribution from the source. This document is written against the state of the NST v2.12.0 source code repository as of ~~2009~~-12-09. Things will undoubtedly change in the future - but the basic principles should still hold.		This document describes the steps involved in building the NST distribution from the source. This document is written against the state of the NST v2.13.0 source code repository as of 2010-09-13. Things will undoubtedly change in the future - but the basic principles should still hold.

	Building a NST system from the source is not a trivial process (expect to invest time and resources). However, building your own NST system from the ground allows you to produce a customized build.		Building a NST system from the source is not a trivial process (expect to invest time and resources). However, building your own NST system from the ground allows you to produce a customized build.
Line 7:		Line 7:
	== Requirements ==		== Requirements ==

	In order to build the NST v2.12.0 release, you will need:		In order to build the NST v2.13.0 release, you will need:

	* A Fedora 12 based OS installation matching the NST target build. For example, to build a 64 bit version of the NST, you will need to start with a 64 bit Fedora based OS installation.		* A Fedora 13 based OS installation matching the NST target build. For example, to build a 64 bit version of the NST, you will need to start with a 64 bit Fedora based OS installation.
	* Access to the ''root'' account on the build system.		* Access to the ''root'' account on the build system.
	* At least ~~10GB~~ of available free disk space.		* At least 12GB of available free disk space.
	* The understanding that the process of building the NST will modify the software and configuration of your build system.		* The understanding that the process of building the NST will modify the software and configuration of your build system.
	* Broadband Internet access as the initial build process will pull several gigabytes of information down from the Internet.		* Broadband Internet access as the initial build process will pull several gigabytes of information down from the Internet.
Line 21:		Line 21:
	* Dedicate a machine or virtual machine for the single purpose of building the NST ISO. Since the NST build runs as ''root'' and modifies the OS installation, you should NOT use a production machine as your NST build machine.		* Dedicate a machine or virtual machine for the single purpose of building the NST ISO. Since the NST build runs as ''root'' and modifies the OS installation, you should NOT use a production machine as your NST build machine.
	* We recommend allocating 40GB of storage and 1GB of RAM when creating a NST build machine.		* We recommend allocating 40GB of storage and 1GB of RAM when creating a NST build machine.
	* We have used both VMware and VirtualBox to create NST build machines. Using the virtual machine approach increases the build time, but makes life much more convenient in the long run (you can use one physical machine to ~~build both a 32~~		* We have used both VMware and VirtualBox to create NST build machines. Using the virtual machine approach increases the build time, but makes life much more convenient in the long run (you can use one physical machine to setup multiple development machines).

	= Starting From A Fedora 12 Live Boot =		= Starting From A Fedora 13 Live Boot =

	The following outlines the steps for bringing up a NST development system starting from a Fedora 12 Live ISO image.		The following outlines the steps for bringing up a NST development system starting from a Fedora 13 Live ISO image.

	== Install and Update Fedora 12 ==		== Install and Update Fedora 13 ==

	=== Download ISO ===		=== Download ISO ===

	Download the Fedora 12 ISO image from Fedora's web site (http://fedoraproject.org/). ''Important'': Make sure you download either the 32 bit (i686) or 64 bit (x86_64) version of the Fedora Desktop Live Media (match the version of the NST you plan to build).		Download the Fedora 13 ISO image from Fedora's web site (http://fedoraproject.org/). ''Important'': Make sure you download either the 32 bit (i686) or 64 bit (x86_64) version of the Fedora Desktop Live Media (match the version of the NST you plan to build).

	=== Install OS ===		=== Install OS ===

	* Boot the Fedora 12 ISO image.		* Boot the Fedora 13 ISO image.
	* If you simply wait, you should eventually see a desktop with a ''Install To Hard Drive'' icon.		* If you simply wait, you should eventually see a desktop with a ''Install To Hard Drive'' icon.
	* Double click on the ''Install To Hard Drive'' icon.		* Double click on the ''Install To Hard Drive'' icon.
Line 56:		Line 56:
	=== Update OS ===		=== Update OS ===

	When building the active (''trunk'') version of the NST (2.12.0 is the active version at the time of this writing), you will want to keep your system up to date with the latest packages. This can be done with the following command:		When building the active (''trunk'') version of the NST (2.13.0 is the active version at the time of this writing), you will want to keep your system up to date with the latest packages. This can be done with the following command:

	yum update all		yum update all

	You will need to reboot after this initial update as it is more than likely that your kernel ~~was~~ updated.		You will need to reboot after this initial update as it is more than likely that your kernel will be updated.

	=== Install Virtual Machine Guest Additions ===		=== Install Virtual Machine Guest Additions ===
Line 115:		Line 115:
	At this point, you should have a copy of the current development tree under ''/opt/nst/trunk'' (feel free to checkout the source code to the directory of your choosing).		At this point, you should have a copy of the current development tree under ''/opt/nst/trunk'' (feel free to checkout the source code to the directory of your choosing).

	NOTE: As time moves on, the source code under ''$SVNROOT/trunk'' will move to newer versions of Fedora releases. When this occurs, the 2.12.0 source tree will migrate to ''$SVNROOT/maintenance/2.12.0''. For example, to check out the current maintenance version of the 2.11.0 source code to the directory: ''/opt/nst/2.11.0'' you would perform the following steps:		NOTE: As time moves on, the source code under ''$SVNROOT/trunk'' will move to newer versions of Fedora releases. When this occurs, the 2.13.0 source tree will migrate to ''$SVNROOT/maintenance/2.13.0''. For example, to check out the current maintenance version of the 2.11.0 source code to the directory: ''/opt/nst/2.11.0'' you would perform the following steps:

	source ~/.bashrc		source ~/.bashrc
Line 154:		Line 154:
	Once the system is configured, building the NST ISO image is not difficult (it just takes a long time).		Once the system is configured, building the NST ISO image is not difficult (it just takes a long time).

	Assuming that you've ~~check~~ the source code out under the directory: ''/opt/nst/trunk'', you should be able to build the NST ISO image using the following commands:		Assuming that you've checked the source code out under the directory: ''/opt/nst/trunk'', you should be able to build the NST ISO image using the following commands:

	cd /opt/nst/trunk		cd /opt/nst/trunk
Line 208:		Line 208:

	* Include both the ''gcc'' and ''kernel-devel'' packages (as well as all the packages they depend on).		* Include both the ''gcc'' and ''kernel-devel'' packages (as well as all the packages they depend on).
	* Transfer ~~our~~ ''/root/.ssh'' configuration from the development system to the ISO image being built.		* Transfer the contents of your ''/root/.ssh'' configuration from the development system to the ISO image being built.
	* Set the default proxy configuration for your local area network.		* Set the default proxy configuration for your local area network.

Line 264:		Line 264:
	For more information about kickstart files, see: http://fedoraproject.org/wiki/Anaconda/Kickstart.		For more information about kickstart files, see: http://fedoraproject.org/wiki/Anaconda/Kickstart.

	'''NOTE''': The ''/root/.nst/custom.ks'' feature did not become available until version 2.12.0 of the NST.		'''NOTE''': The ''/root/.nst/custom.ks'' feature did not become available until version 2.13.0 of the NST.

Paul Blankenbaker: moved HowTo Build NST 2.12.0 to HowTo Build NST 2.13.0: Updating for the 2.13.0 release

2010-09-13T18:55:52Z

moved HowTo Build NST 2.12.0 to HowTo Build NST 2.13.0: Updating for the 2.13.0 release

← Older revision	Revision as of 14:55, 13 September 2010
(No difference)

Paul Blankenbaker: /* /root/.nst/custom.ks */

2009-12-12T21:12:32Z

/root/.nst/custom.ks

← Older revision		Revision as of 17:12, 12 December 2009
Line 208:		Line 208:

	* Include both the ''gcc'' and ''kernel-devel'' packages (as well as all the packages they depend on).		* Include both the ''gcc'' and ''kernel-devel'' packages (as well as all the packages they depend on).
			* Transfer our ''/root/.ssh'' configuration from the development system to the ISO image being built.
	* Set the default proxy configuration for your local area network.		* Set the default proxy configuration for your local area network.

	To accomplish this, you would create the file: ''/root/.nst/custom.ks'' with the following contents:		To accomplish this, you would create the file: ''/root/.nst/custom.ks'' with the following contents:

			# This %packages block is used to indicate what extra packages we
			# would like to include in the Live ISO image. The packages listed
			# here along with any required dependencies will be added to the ISO.

	%packages		%packages

	# Pre-install gcc and kernel-devel to simplify installing VirtualBox		# Pre-install gcc and kernel-devel to simplify installing VirtualBox
	# guest additions		# guest additions
	gcc		gcc
	kernel-devel		kernel-devel

	%end		%end


			# This code runs non-chrooted. This allows us to transfer files from
			# the host development system into the build image under $LIVE_ROOT
			#
			# Useful variables:
			#
			# INSTALL_ROOT - Top level directory that build is under (you can reach
			# the isolinux directory from this variable.
			#
			# LIVE_ROOT - Root (/) view of file system for live build

			%post --nochroot

			# Install our ssh keys
			if [ -d /root/.ssh ]; then
			[ -d ${LIVE_ROOT}/root/.ssh ] && /bin/rm -fr ${LIVE_ROOT}/root/.ssh;
			cp -rp /root/.ssh ${LIVE_ROOT}/root/.ssh;
			fi

			%end


			# This %post block does not include the --nochroot option. It
			# runs in a chroot environment under file system being created
			# for the live boot (its as if you are running inside the live boot
			# and unable to see the full development filesystem).

	%post		%post

	# Set default proxy configuration		# Set default proxy configuration
	nstsetproxy --http-host 192.168.1.2 --http-port 3128		nstsetproxy --http-host 192.168.1.2 --http-port 3128

	%end		%end

			This simple ''/root/.nst/custom.ks'' file provides the necessary hooks to allow you to extend, customize and tweak your NST ISO build as much as you want.

	For more information about kickstart files, see: http://fedoraproject.org/wiki/Anaconda/Kickstart.		For more information about kickstart files, see: http://fedoraproject.org/wiki/Anaconda/Kickstart.

	'''NOTE''': The ''/root/.nst/custom.ks'' feature did not become available until version 2.12.0 of the NST.		'''NOTE''': The ''/root/.nst/custom.ks'' feature did not become available until version 2.12.0 of the NST.

Paul Blankenbaker: /* Build ISO */

2009-12-12T00:25:53Z

Build ISO

← Older revision		Revision as of 20:25, 11 December 2009
Line 167:		Line 167:

	* The final ISO image produced will appear under the ''livecd'' directory.		* The final ISO image produced will appear under the ''livecd'' directory.

			= Customizing Your Build =

			There are many command line options you can specify to the top level ''./configure'' script. To see the various options that can be specified, run:

			./configure --help \| less

			Instead of specifying a long set of parameters each time when invoking the ''./configure'' command, it is recommended that you use standard configuration files to configure your build. The remaining sections will describe the files which can be used to customize your build.

			== Create the Configuration Directory (/root/.nst) ==

			By default, when your run the ''./configure'' script, it will assume the configuration directory is: ''/root/.nst''. You can create this directory with the following command:

			mkdir /root/.nst

			== /root/.nst/configure.sh ==

			This file will be sourced by the ''./configure'' script and allow you to override variables which change the build. The following shows a sample template of the most common variables you might want to adjust:

			# Set the default password
			NSTPASSWD="myNewPasswd";

			#
			# These are only used if your run "make test" or "make probe-check"
			# from the top level directory
			#
			TEST_SMTP_SERVER="smtp.linux.bogus";
			TEST_SMTP_DOMAIN="linux.bogus";
			TEST_SENDMAIL_FROM="first.last@linux.bogus";
			TEST_SENDMAIL_TO="first.last@destination.bogus";

			There used to be a lot more variables that could be "tweaked" in this file, but most of them have become deprecated since version 2.11.0 of the NST. You can review the file ''include/data/configure.in'' for a list of some of the other variables that can be overridden.


			== /root/.nst/custom.ks ==

			This file (if present) is "tacked" onto the kickstart file used to create the NST live ISO image. If you are familiar with kickstart files, you can use this to add other packages to your NST distribution.

			For example, lets assume that you wanted the following things to be done in your custom NST build:

			* Include both the ''gcc'' and ''kernel-devel'' packages (as well as all the packages they depend on).
			* Set the default proxy configuration for your local area network.

			To accomplish this, you would create the file: ''/root/.nst/custom.ks'' with the following contents:

			%packages
			# Pre-install gcc and kernel-devel to simplify installing VirtualBox
			# guest additions
			gcc
			kernel-devel
			%end


			%post
			# Set default proxy configuration
			nstsetproxy --http-host 192.168.1.2 --http-port 3128
			%end

			For more information about kickstart files, see: http://fedoraproject.org/wiki/Anaconda/Kickstart.

			'''NOTE''': The ''/root/.nst/custom.ks'' feature did not become available until version 2.12.0 of the NST.