Wiki.pcbsd.org

Creating an Automated Installation with pc-sysinstall/10.0

2013-12-02

Created page with "<noinclude><translate>  {{NavHeader|back=Dual Booting|forward=Desktops}}</noinclude>  PC-BSD® provides a set of Bourne shell scripts that allow advanced..."

New page

<noinclude><translate>



{{NavHeader|back=Dual Booting|forward=Desktops}}</noinclude>



PC-BSD® provides a set of Bourne shell scripts that allow advanced users to create automatic or customized PC-BSD® installations. '''pc-sysinstall''' is the name of the master script; it reads a customizable configuration file and uses dozens of backend scripts to perform the installation. You can read more about this utility by typing '''man pc-sysinstall'''.



Here is a quick overview of the components used by '''pc-sysinstall''':



* '''/usr/share/pc-sysinstall/backend/''' contains the scripts used by the PC-BSD® installer. Scripts have been divided by function, such as ''functions-bsdlabel.sh'' and ''functions-installcomponents.sh''. If you have ever wondered how the PC-BSD® installer works, read through these scripts. This directory also contains the ''parseconfig.sh'' and ''startautoinstall.sh'' scripts which '''pc-sysinstall''' uses to parse the configuration file and begin the installation.



* '''/usr/share/pc-sysinstall/backend-partmanager/''' contains the scripts which are used by the installer to create and delete partitions.



* '''/usr/share/pc-sysinstall/backend-query/''' contains the scripts which are used by the installer to detect (e.g. ''detect-nics.sh'') and configure (e.g. ''enable-net.sh'') hardware.



* '''/usr/share/pc-sysinstall/conf/''' contains the configuration file ''pc-sysinstall.conf''. It also contains a file indicating which localizations are available (''avail-langs''), and a ''license/'' subdirectory containing text files of applicable licenses (e.g. ''bsd-en.txt'' and ''nvidia-en.txt'').



* '''/usr/share/pc-sysinstall/doc/''' contains the help text that is seen if you run '''pc-sysinstall''' without any arguments.



* '''/usr/share/examples/pc-sysinstall/''' contains several example configuration files for different scenarios (e.g. ''upgrade'', ''fbsd-netinstall''). The ''README'' file in this directory should be considered as mandatory reading before using '''pc-sysinstall'''.



* '''/usr/sbin/pc-sysinstall''' this is the script that is used to perform a customized installation.



To create a custom installation, perform the following steps:



# {{local|link=Creating_an_Automated_Installation_with_pc-sysinstall|anchor=Determine which variables you wish to customize|Determine which variables you wish to customize}}. 

# {{local|link=Creating_an_Automated_Installation_with_pc-sysinstall|anchor=Create a customized configuration|Create a customized configuration}}. 

# {{local|link=Creating_an_Automated_Installation_with_pc-sysinstall|anchor=Create a custom installation media|Create a custom installation media}}. 



These steps are discussed in more detail below.

== Determine Which Variables you Wish to Customize == 



A list of possible variables can be found in ''/usr/share/examples/pc-sysinstall/README'' and in Table 5.5a. Note that the Table is meant as a quick reference to determine which variables are available. The ''README'' file contains more complete descriptions for each variable.



{{tbl-init|caption=5.5a: Available Variables for Customizing a PC-BSD® Installation}}

!width=20%|Variable

!Options

!Description

|-

|hostname=||should be unique for the network||optional as installer will auto-generate a hostname if empty

|-

|installMode=||fresh, upgrade, extract, or zfsrestore||sets the installation type

|-

|installLocation=||/path/to/location||used only when ''installMode'' is extract and should point to an already mounted location

|-

|installInteractive=||yes or no||set to no for automated installs without user input

|-

|netDev=||AUTO-DHCP or FreeBSD interface name||type of network connection to use during the installation

|-

|netIP=||IP address of interface used during installation||only use if ''netDev'' is set to an interface name

|-

|netMask=||subnet mask of interface||only use if ''netDev'' is set to an interface name

|-

|netNameServer=||IP address of DNS server||only use if ''netDev'' is set to an interface name

|-

|netDefaultRouter=||IP address of default gateway||only use if ''netDev'' is set to an interface name

|-

|netSaveDev=||AUTO-DHCP or FreeBSD interface name(s) (multiple allowed separated by spaces)||type of network configuration to enable on the installed system; can set multiple interfaces

|-

|netSaveIP=||IP address of interface ''<interface_name>'' or DHCP||only use if ''netSaveDev'' is set to an interface name or a list of interface names (repeat for each interface)

|-

|netSaveMask=||subnet mask of interface ''<interface_name>''||only use if ''netSaveDev'' is set to an interface name or a list of interface names (repeat for each interface)

|-

|netSaveNameServer=||IP address of DNS server (multiple allowed separated by spaces)||only use if ''netSaveDev'' is set to an interface name or a list of interface names (do not repeat for each interface)

|-

|netSaveDefaultRouter=||IP address of default gateway||only use if ''netSaveDev'' is set to an interface name or a list of interface names (do not repeat for each interface)

|-

|disk0=||FreeBSD disk device Name, (e.g. ''ad0'')||see ''README'' for examples

|-

|partition=||all, free, s1, s2, s3, s4, image||see ''README'' for examples

|-

|partscheme=||MBR or GPT||partition scheme type

|-

|mirror=||FreeBSD disk device name (e.g. ''ad1'')||sets the target disk for the mirror (i.e. the second disk)

|-

|mirrorbal=||load, prefer, round-robin, split||defaults to round-robin if the ''mirrorbal'' method is not specified

|-

|bootManager=||none, bsd||whether or not to install the FreeBSD boot manager

|-

|image=||/path/to/image||will write specified image file

|-

|commitDiskPart|| ||this variable is mandatory and must be placed at the end of each ''diskX'' section; create a ''diskX'' section for each disk you wish to configure.

|-

|encpass=||password value||at boot time, system will prompt for this password in order to mount the associated GELI encrypted partition

|-

|commitDiskLabel|| ||this variable is mandatory and must be placed at the end of disk's partitioning settings; see the ''README'' for examples on how to set the <File System Type> <Size> <Mountpoint> entries for each disk

|-

|installMedium=||dvd, usb, ftp, rsync, image||source to be used for installation

|-

|installType=||PCBSD, FreeBSD||determines whether this is a desktop or a server install

|-

|installFile=||e.g. fbsd-release.tbz||only set if using a customized installer archive

|-

|packageType=||tar, uzip, split||the archive type on the installation media

|-

|ftpPath=||e.g. {{ftp}}iso.cdn.pcbsd.org/9.1/amd64/netinstall/||location of the installer archive when using ''installMedium=ftp''

|-

|rsyncPath=||e.g. life-preserver/back-2011-09-12T14_53_14||location of the rsync data on the remote server when using ''installMedium=rsync''

|-

|rsyncUser=||username||set when using ''installMedium=rsync''

|-

|rsyncHost=||IP address of rsync server||set when using ''installMedium=rsync''

|-

|rsyncPort=||port number||set when using ''installMedium=rsync''

|-

|installComponents=||e.g. amarok,firefox,ports||components must exist in ''/PCBSD/pc-sysinstall/components/''

|-

|upgradeKeepDesktopProfile=||yes or no||specify if you wish to keep your existing user's desktop profile data during an upgrade

|-

|rootPass=||password||set the root password of the installed system to the specified string

|-

||rootEncPass=||encrypted string||set root password to specified encrypted string

|-

||userName=||case sensitive value||create a separate block of user values for each user you wish to create

|-

||userComment=||description||description text can include spaces

|-

|userPass=||case sensitive value|password of user

|-

|userEncPass||encrypted string||set user password to specified encrypted string

|-

|userShell=||e.g. ''/bin/csh''||path to default shell

|-

|userHome=||e.g. ''/home/username''||path to home directory

|-

|userGroups=||e.g. wheel,operator||comma separated (no spaces) list of groups

|-

|commitUser|| ||mandatory, must be last line in each user block

|-

|runCommand=||path to command||run the specified command within chroot of the installed system, after the installation is complete

|-

|runScript=||path to script||runs specified script within chroot of the installed system, after the installation is complete

|-

|runExtCommand=||path to command||runs a command outside the chroot

|-

|timeZone=||e.g. America/New_York||location must exist in ''/usr/share/zoneinfo/''

|-

|enableNTP=||yes or no||enable/disable NTP

|-

|localizeLang=||e.g. en||sets the system console and Desktop to the target language

|-

|localizeKeyLayout=||e.g. en||updates the system's Xorg config to set the keyboard layout

|-

|localizeKeyModel=||e.g. pc104||updates the system's Xorg config to set the keyboard model

|-

|localizeKeyVariant=||e.g. intl||updates the Xorg config to set the keyboard variant

|-

|autoLoginUser=||username||user will be logged in automatically without entering a password

|}

== Create a Customized Configuration == 



One way to create this file is to read through the configuration examples in ''/usr/share/examples/pc-sysinstall/'' to find the one that most closely matches your needs. Copy that file (to any location) and customize it so that it includes the variables and values you would like to use in your installation.



An alternate way to create this file is to perform an installation of the version that you wish to customize. The installer will automatically create a file containing the settings you selected during the installation to ''/root/pc-sysinstall.cfg.'' You can use that configuration file as-is, or customize it to meet an installation's needs. This method may prove easier to use if you are performing complex disk layouts.



Here is a sample configuration:



{{txtbox|box={{pound}} Sample configuration file for an installation using pc-sysinstall



installMode=fresh

installInteractive=no

hostname=myhost.mydomain.com



{{pound}} Set the disk parameters - 1st disk

disk0=da0

partition=all

bootManager=none

commitDiskPart



{{pound}} Set the disk parameters - 2nd disk

disk1=da1

partition=all

bootManager=none

commitDiskPart



{{pound}} Setup the disk label - 1st disk

{{pound}} All sizes are expressed in MB

{{pound}} Avail FS Types, UFS, UFS+S, UFS+J, ZFS, SWAP

disk0-part=UFS+S 1024 /

disk0-part=SWAP.eli 2048 none

disk0-part=UFS+S 1024 /tmp

disk0-part=UFS+S 1024 /var

disk0-part=UFS+S 0 /usr

{{pound}} Size 0 means use the rest of the slice size

{{pound}} Do it now!

commitDiskLabel



{{pound}} Setup the disk label - 2nd disk

{{pound}} All sizes are expressed in MB

{{pound}} Avail FS Types, UFS, UFS+S, UFS+J, ZFS, SWAP

disk1-part=UFS+S 1024 /usr/src

disk1-part=UFS+S 4096 /usr/local

disk1-part=UFS+S 0 /usr/ports

{{pound}} Size 0 means use the rest of the slice size

{{pound}} Do it now!

commitDiskLabel



netDev=em1

netIP=172.16.80.250

netMask=255.255.240.0

netNameServer=172.16.80.1

netDefaultRouter=172.16.80.1

netSaveDev=em0 em1

netSaveIP_em0=192.168.101.42

netSaveIP_em1=172.16.80.156

netSaveMask_em0=255.255.252.0

netSaveMask_em1=255.255.240.0

netSaveNameServer=172.16.80.1

netSaveDefaultRouter=192.168.100.1



{{pound}} Set if we are installing via optical, USB, or FTP

installType=FreeBSD

installMedium=ftp

ftpPath={{http}}pkgbuilder.mydomain.com/images/freebsd/8.2/

packageType=tar



{{pound}} List our components to install

{{pound}}installComponents=ports,src



{{pound}} Set the root pass

rootPass=root



{{pound}} Setup our users

userName=demo

userComment=Demo User

userPass=demo

userShell=/bin/sh

userHome=/home/demo

commitUser



{{pound}} Set up date/time

runCommand=cp /usr/share/zoneinfo/EST5EDT /etc/localtime

runCommand=touch /etc/wall_cmos_clock

runCommand=adjkerntz -a



{{pound}} Install packages required for VMware Tools installation/configuration

runCommand=pkg_add -r compat6x-amd64

runCommand=pkg_add -r perl

runCommand=pkg_add -r pcre

runCommand=pkg_add -r puppet

runCommand=pkg_add -r sysrc



{{pound}} Fetch/install VMware Tools

runCommand=fetch -o /tmp/vmtools.tar.gz {{http}}pkgbuilder.mydomain.com/images/freebsd/vmware-freebsd-tools.tar.gz

runCommand=zcat /tmp/vmtools.tar.gz | tar -C /tmp -xvf -

runCommand=/tmp/vmware-tools-distrib/vmware-install.pl -d

runCommand=rm -rf /tmp/vmware-tools-distrib

runCommand=/usr/local/sbin/sysrc puppet_enable=YES

{{pound}} Generate the certificate to be signed by the master

runCommand=/usr/local/bin/puppet agent -t}}



If you wish to perform a fully-automated installation that does not prompt for any user input, you will also need to review ''/usr/share/examples/pc-sysinstall/pc-autoinstall.conf'' and place a customized copy of that file into ''/boot/pc-autoinstall.conf'' on your installation media.



Table 5.5b summarizes the additional variables that are available for fully automatic installations. More detailed descriptions can be found in the ''/usr/share/examples/pc-sysinstall/pc-autoinstall.conf'' file. Note that the variables in this file use a different syntax than those in Table 5.5a, in that the values follow a colon and a space rather than an equal sign.



{{tbl-init|caption=5.5b: Additional Variables for Automated Installations}}

!Variable

!Options

!Description

|-

|pc_config||URL or /path/to/file||location of customized ''pc-sysinstall.conf''

|-

|confirm_install||yes or no||should be set to yes, otherwise booting the wrong disk will result in a system wipe

|-

|shutdown_cmd||e.g. '''shutdown -p now'''||good idea to run a shutdown, but can be any command/script you wish to execute post-install

|-

|nic_config||dhcp-all or <interface name> <IP address> <subnet mask>||will attempt dhcp on all found NICs until the installation file can be fetched or will setup specified interface

|-

|nic_dns||IP address|DNS server to use

|-

|nic_gateway||IP address||default gateway to use

|}



Here is a sample ''pc-autoinstall.conf'' file:



{{txtbox|box={{pound}} pc-autoinstall.conf example{{nbsp|51}}

{{pound}}

{{pound}} Usage: Modify these variables, and copy the file to

{{pound}} /boot/pc-autoinstall.conf on your PC-BSD installation medium

{{pound}}

{{pound}} The conf will then be read at bootup, and your automated

{{pound}} install will take place

<nowiki>##################################################################</nowiki>



{{pound}} Where the pc-sysinstall main config is located

{{pound}} Can be either a file on the booted CD / DVD / USB media,

{{pound}} or a remote file on http / ftp

{{pound}}

{{pound}} The value %%NIC_MAC%% is special, and will be substituted with

{{pound}} the macaddress of the enabled NIC from DHCP or manually set

{{pound}} with 'nic_config:'

<nowiki>##################################################################</nowiki>



{{pound}} Examples:

{{pound}} pc_config: {{ftp}}192.168.0.2/cust-install.cfg

{{pound}} pc_config: {{http}}192.168.0.2/cust-install.cfg

{{pound}} pc_config: {{http}}192.168.0.2/%%NIC_MAC%%.cfg

{{pound}} pc_config: /boot/cust-install.cfg

pc_config:

{{http}}pkgbuilder.mydomain.com/images/freebsd/pc-sysinstall.cfg>



{{pound}} Set this to yes if we should confirm before doing an install

{{pound}} This should normally be set to yes, otherwise booting the wrong

{{pound}} disk will result in a system wipe

confirm_install: no



{{pound}} Set the command to run post-install, usually best to run shutdown

{{pound}} but this can be replaced with any other command / script you wish

{{pound}} to execute post-install 

shutdown_cmd: shutdown -r now 



{{pound}} Options for the network setup, should the cfg need to be fetched

{{pound}} from a remote location, only necessary when using ftp or http

<nowiki>##################################################################</nowiki>



{{pound}} Special option, will attempt dhcp on all found NICs

{{pound}} until the file can be fetched, or we run out of interfaces

{{pound}} nic_config: dhcp-all



{{pound}} Line to be passed to the "ifconfig" command to bring up an interface

nic_config: em1 172.16.80.250 255.255.240.0



{{pound}} DNS server to use

nic_dns: 172.16.80.1



{{pound}} Default router / gateway

nic_gateway: 172.16.80.1}}

== Create a Custom Installation Media or Installation Server == 



'''pc-sysinstall''' supports the following installation methods:



* from a CD, DVD, or USB media



* from an installation directory on an HTTP, FTP, SSH+rsync, or a {{local|link=Thin_Client|anchor=Creating a PXE Boot Install Server|PXE Boot Install}} server



The easiest way to create a custom installation media is to modify an existing installation image. For example, if you have downloaded an ISO for the PC-BSD® version that you wish to customize, the superuser can access the contents of the ISO as follows:



{{txtbox|box='''mdconfig -a -t vnode -f PCBSD9.0-x86-DVD.iso -u 1'''{{nbsp|31}}

'''mount -t cd9660 /dev/md1 /mnt'''}}

Make sure you have changed into a directory (use '''cd''') where you would like to copy the contents of the ISO. In the following examples, ''/tmp/custominstall/'' was created as the directory for this purpose:



{{txtbox|box='''cd /tmp/custominstall'''{{nbsp|59}}

'''tar -C /mnt -cf - . {{!}} tar -xvf -'''

'''umount /mnt'''}}



Alternately, if you have inserted an installation CD or DVD, you can mount the media and copy its contents to your desired directory:



{{txtbox|box='''mount -t cd9660 /dev/cd0 /mnt'''{{nbsp|51}}

'''cp -R /mnt/* /tmp/custominstall/'''

'''umount /mnt'''}}



If you are creating an automated installation, copy your customized ''pc-autoinstall.conf'' to ''/tmp/custominstall/boot/''.



Copy your customized configuration file to ''/tmp/custominstall/''. Double-check that the "installMedium=" variable in your customized configuration file is set to the type of media that you will be installing from.



You may also need to add some extra files if you set the following variables in your custom configuration file:



* '''installComponents=''' make sure that any extra components you wish to install exist in ''extras/PBI/'' (if they end in the ''.pbi'' extension) or ''extras/components/'' (if they end in ''.tbz'')



* '''runCommand=''' make sure the command exists in the specified path



* '''runScript=''' make sure the script exists in the specified path



* '''runExtCommand=''' make sure the command exists in the specified path



If the installation media is a CD or DVD, you will need to create a bootable media that contains the files in your directory. To create a bootable ISO:



{{txtbox|box='''cd /tmp/custominstall'''{{nbsp|59}}

'''mkisofs -V mycustominstall -J -R -b boot/cdboot -no-emul-boot -o myinstall.iso'''}}



You can then use your favorite burning utility to burn the ISO to the media.



To begin an installation that requires user interaction:



'''pc-sysinstall -c /path_to_your_config_file'''



To begin a fully automated installation, insert the installation media and reboot.



If you are using an HTTP, FTP, or SSH server as the installation media, untar or copy the required files to a directory on the server that is accessible to users. Be sure to configure the server so that the installation files are accessible to the systems that you wish to install. If you are using a PXE Boot Install server, follow the instructions at {{local|link=Thin_Client|anchor=Connecting_to_and_Customizing_the_PXE_Boot_Install_Server|Connecting to and Customizing the PXE Boot Install Server}}.



<noinclude>



{{GroupListHeading|group=tables}}

[[category:Creating an Automated Installation with pc-sysinstall]]

[[category:Advanced Installation Topics]]

[[category:handbook]]

</translate>

<languages/>

</noinclude>