openSolaris 2008 - Creating a Profile - Solaris Express Installation Guide: Custom JumpStart and Advanced Installations

Creating a Profile

A profile is a text file that defines how to install the Solaris software on a system. A profile defines elements of the installation, for example, the software group to install. Every rule specifies a profile that defines how a system is to be installed. You can create different profiles for every rule or the same profile can be used in more than one rule.

A profile consists of one or more profile keywords and their values. Each profile keyword is a command that controls one aspect of how the JumpStart program is to install the Solaris software on a system. For example, the following profile keyword and value specify that the JumpStart program install the system as a server:

system_type  server

Note - Sample profiles are already located in the JumpStart directory if you created the JumpStart directory by using either of these procedures:

Syntax of Profiles

A profile must contain the following:

The install_type profile keyword as the first entry
One keyword per line
The root_device keyword if the systems that are being upgraded by the profile contain more than one root (/) file system that can be upgraded

A profile can contain the following:

Commented text
Any text that is included after the # symbol on a line is treated by the JumpStart program as commented text. If a line begins with the # symbol, the entire line is treated as a comment.
One or more blank lines

To Create a Profile

Use a text editor to create a text file. Name the file descriptively. Or, open a sample profile in the JumpStart directory that you created.
Note - Ensure that the name of the profile reflects how you intend to use the profile to install the Solaris software on a system. For example, you might name the profiles basic_install, eng_profile, or user_profile.
Add profile keywords and values to the profile.
For a list of profile keywords and values, see Profile Keywords and Values.

Note - Profile keywords and their values are case sensitive.
Save the profile in the JumpStart directory.
Ensure that root owns the profile and that the permissions are set to 644.
Test the profile (optional).
Testing a Profile contains information about testing profiles.

Profile Examples

The following examples of profiles show how to use different profile keywords and profile values to control how the Solaris software is installed on a system. Profile Keywords and Values contains a description of profile keywords and values.

Example 3-2 Mounting Remote File Systems and Adding and Deleting Packages

 
# profile keywords        profile values
# -----------------       -----------------
  install_type            initial_install
  system_type             standalone
  partitioning            default
  filesys                 any 512 swap   # specify size of /swap
  cluster                 SUNWCprog
  package                 SUNWman delete
  cluster                 SUNWCacc

The following list describes some of the keywords and values from this example.

install_type: The install_type keyword is required in every profile.
system_type: The system_type keyword defines that the system is to be installed as a standalone system.
partitioning: The file system slices are determined by the software to be installed with the value default. The size of swap is set to 512 Mbytes and is installed on any disk, value any.
cluster: The Developer Solaris Software Group, SUNWCprog, is installed on the system.
package: If the standard man pages are mounted from the file server, s_ref, on the network, the man page packages are not to be installed on the system. The packages that contain the System Accounting utilities are selected to be installed on the system.

Example 3-3 Mounting Remote File Systems and Adding a Third-Party Package

 
# profile keywords        profile values
# -----------------       -----------------
  install_type            initial_install
  system_type             standalone
  partitioning            default
  filesys                 any 512 swap   # specify size of /swap
  cluster                 SUNWCprog
  cluster                 SUNWCacc
  package                 apache_server  \
                           https://package.central/packages/apache timeout 5

The following list describes some of the keywords and values from this example.

install_type: The install_type keyword is required in every profile.
system_type: The system_type keyword defines that the system is to be installed as a standalone system.
partitioning: The file system slices are determined by the software to be installed with the value default. The size of swap is set to 512 Mbytes and is installed on any disk, value any.
cluster: The Developer Solaris Software Group, SUNWCprog, is installed on the system.
package: A third-party package is installed on the system located on an HTTP server.

Example 3-4 Specifying Where to Install File Systems

# profile keywords        profile values
# ----------------        -------------------
  install_type            initial_install
  system_type             standalone 
  partitioning            explicit
  filesys                 c0t0d0s0 auto /
  filesys                 c0t3d0s1 auto swap
  filesys                 any auto usr
  cluster                 SUNWCall

The following list describes some of the keywords and values from this example.

partitioning: The file system slices are determined by the filesys keywords, value explicit. The size of root (/) is based on the selected software, value auto, and is installed on c0t0d0s0. The size of swap is set to the necessary size and is installed on c0t3d0s1. usr is based on the selected software and the installation program determines where usr is installed, based on the value any.
cluster: The Entire Solaris Software Group, SUNWCall, is installed on the system.

Example 3-5 Upgrading and Installing Patches

# profile keywords         profile values
# ----------------         -------------------
  install_type             upgrade 
  root_device              c0t3d0s2 
  backup_media             remote_filesystem timber:/export/scratch
  package                  SUNWbcp delete
  package                  SUNWxwman add
  cluster                  SUNWCacc add   
  patch                    patch_list nfs://patch_master/Solaris_11/patches \
                           retry 5
  locale                   de

The following list describes some of the keywords and values from this example.

install_type: The profile upgrades a system by reallocating disk space. In this example, disk space must be reallocated because some file systems on the system did not have enough space for the upgrade.
root_device: The root file system on c0t3d0s2 is upgraded.
backup_media: A remote system that is named timber is to be used to back up data during the disk space reallocation. For more backup-media keyword values, see backup_media Profile Keyword.
package: The binary compatibility package, SUNWbcp, is not installed on the system after the upgrade.
package: The code ensures that the X Window System man pages and the System Accounting Utilities are to be installed if they are not already installed on the system. All packages already on the system are automatically upgraded.
patch: A list of patches that are installed with the upgrade. The patch list is located on an NFS server named patch_master under the directories Solaris_11/patches. In case of a mount failure, the NFS mount is tried five times.
locale: The German localization packages are to be installed on the system.

Example 3-6 Reallocating Disk Space for an Upgrade

# profile keywords         profile values
# ----------------         -------------------
  install_type             upgrade 
  root_device              c0t3d0s2 
  backup_media             remote_filesystem timber:/export/scratch
  layout_constraint        c0t3d0s2 changeable 100
  layout_constraint        c0t3d0s4 changeable
  layout_constraint        c0t3d0s5 movable 
  package                  SUNWbcp delete
  package                  SUNWxwman add
  cluster                  SUNWCacc add   
  locale                   de

The following list describes some of the keywords and values from this example.

install_type

The profile upgrades a system by reallocating disk space. In this example, disk space must be reallocated because some file systems on the system did not have enough space for the upgrade.

root_device

The root file system on c0t3d0s2 is upgraded.

backup_media

A remote system that is named timber is to be used to back up data during the disk space reallocation. For more backup-media keyword values, see backup_media Profile Keyword.

layout_constraint

The layout_constraint keywords designate that auto-layout can perform the following when auto-layout attempts to reallocate disk space for the upgrade.

Change slices 2 and 4. The slices can be moved to another location and the size can be changed.
Move slice 5. The slice can be moved to another location but its size cannot change.

package

The binary compatibility package, SUNWbcp, is not installed on the system after the upgrade.

package

The code ensures that the X Window System man pages and the System Accounting Utilities are to be installed if they are not already installed on the system. All packages already on the system are automatically upgraded.

locale

The German localization packages are to be installed on the system.

Example 3-7 Retrieving a Solaris Flash Archive From an HTTP Server

In the following example, the profile indicates that the custom JumpStart program retrieves the Solaris Flash archive from an HTTP server.

# profile keywords         profile values
# ----------------         -------------------
install_type               flash_install
archive_location           https://192.168.255.255/flasharchive/solarisarchive
partitioning               explicit
filesys                    c0t1d0s0 4000 /
filesys                    c0t1d0s1 512 swap
filesys                    c0t1d0s7 free /export/home

The following list describes some of the keywords and values from this example.

install_type: The profile installs a Solaris Flash archive on the clone system. All files are overwritten as in an initial installation.
archive_location: The Solaris Flash archive is retrieved from an HTTP server.
partitioning: The file system slices are determined by the filesys keywords, value explicit. The size of root (/) is based on the size of the Solaris Flash archive. The root file system is installed on c0t1d0s0. The size of swap is set to the necessary size and is installed on c0t1d0s1. /export/home is based on the remaining disk space. /export/home is installed on c0t1d0s7.

Example 3-8 Retrieving a Solaris Flash Archive From a Secure HTTP Server

In the following example, the profile indicates that the custom JumpStart program retrieves the Solaris Flash archive from a secure HTTP server.

# profile keywords         profile values
# ----------------         -------------------
install_type               flash_install
archive_location           https://192.168.255.255/solarisupdate.flar
partitioning               explicit
filesys                    c0t1d0s0 4000 /
filesys                    c0t1d0s1 512 swap
filesys                    c0t1d0s7 free /export/home

The following list describes some of the keywords and values from this example.

install_type: The profile installs a Solaris Flash archive on the clone system. All files are overwritten as in an initial installation.
archive_location: The compressed Solaris Flash archive is retrieved from a secure HTTP server.
partitioning: The file system slices are determined by the filesys keywords, value explicit. The size of root (/) is based on the size of the Solaris Flash archive. The size of swap is set to the necessary size and is installed on c0t1d0s1. /export/home is based on the remaining disk space. /export/home is installed on c0t1d0s7.

Example 3-9 Retrieving a Solaris Flash Archive and Installing a Third-Party Package

In the following example, the profile indicates that the custom JumpStart program retrieves the Solaris Flash archive from an HTTP server.

# profile keywords         profile values
# ----------------         -------------------
install_type               flash_install
archive_location           https://192.168.255.255/flasharchive/solarisarchive
partitioning               explicit
filesys                    c0t1d0s0 4000 /
filesys                    c0t1d0s1 512 swap
filesys                    c0t1d0s7 free /export/home
package                    SUNWnew https://192.168.254.255/Solaris_11 timeout 5

The following list describes some of the keywords and values from this example.

install_type: The profile installs a Solaris Flash archive on the clone system. All files are overwritten as in an initial installation.
archive_location: The Solaris Flash archive is retrieved from an HTTP server.
partitioning: The file system slices are determined by the filesys keywords, value explicit. The size of root (/) is based on the size of the Solaris Flash archive. The root file system is installed on c0t1d0s0. The size of swap is set to the necessary size and is installed on c0t1d0s1. /export/home is based on the remaining disk space. /export/home is installed on c0t1d0s7.
package: The SUNWnew package is added from the Solaris_11 directory from the HTTP server 192.168.254.255.

Example 3-10 Retrieving a Solaris Flash Differential Archive From an NFS Server

In the following example, the profile indicates that the custom JumpStart program retrieves the Solaris Flash archive from an NFS server. The flash_update keyword indicates that this is a differential archive. A differential archive installs only the differences between two system images.

# profile keywords         profile values
# ----------------         -------------------
install_type               flash_update
archive_location           nfs installserver:/export/solaris/flasharchive \
                           /solarisdiffarchive
no_master_check

The following list describes some of the keywords and values from this example.

install_type: The profile installs a Solaris Flash differential archive on the clone system. Only files that are specified by the archive are installed.
archive_location: The Solaris Flash archive is retrieved from an NFS server.
no_master_check: The clone system is not checked for a valid system image. A valid system image would have been built from the original master system.

Example 3-11 Creating an Empty Boot Environment

In the following example, the profile indicates that the custom JumpStart program creates an empty boot environment. An empty boot environment contains no file systems and no copy from the current boot environment occurs. The boot environment can be populated later with a Solaris Flash archive and then activated.

# profile keywords        profile values
# ----------------        -------------------
  install_type            initial_install
  system_type             standalone 
  partitioning            explicit
  filesys                 c0t0d0s0 auto /
  filesys                 c0t3d0s1 auto swap
  filesys                 any auto usr
  cluster                 SUNWCall
  bootenv createbe bename second_BE \
  filesystem /:/dev/dsk/c0t1d0s0:ufs \
  filesystem -:/dev/dsk/c0t1d0s0:swap \
  filesystem /export:shared:ufs

The following list describes some of the keywords and values from this example.

partitioning

The file system slices are determined by the filesys keywords, value explicit. The size of root (/) is based on the selected software, value auto, and is installed on c0t0d0s0. The size of swap is set to the necessary size and is installed on c0t3d0s1. usr is based on the selected software and the installation program determines where usr is installed, based on the value any.

cluster

The Entire Solaris Software Group, SUNWCall, is installed on the system.

bootenv createbe

An empty, inactive boot environment is set up on disk c0t1d0. File systems for root (/), swap, and /export are created, but left empty. This second boot environment can be installed with a Solaris Flash archive at a later time. The new boot environment can then be activated to become the current boot environment.

For keyword values and background about using this keyword, see the following references:

For descriptions of keyword values, see Profile Keywords and Values.
For background about using Solaris Live Upgrade that creates, upgrades, and activates inactive boot environments, see Chapter 2, Solaris Live Upgrade (Overview), in Solaris Express Installation Guide: Solaris Live Upgrade and Upgrade Planning.
For background about using a Solaris Flash archive, see Chapter 1, Solaris Flash (Overview), in Solaris Express Installation Guide: Solaris Flash Archives (Creation and Installation).

Example 3-12 Creating RAID-1 Volumes When Installing a Solaris Flash Archive

In the following example, the profile indicates that the custom JumpStart program uses Solaris Volume Manager technology to create RAID-1 volumes (mirrors) for the root (/), swap, /usr and /export/home file systems. A Solaris Flash archive is installed on the boot environment.

# profile keywords        profile values
# ----------------        -------------------
  install_type            flash_install
  arhcive_location        nfs server:/export/home/export/flash.s10.SUNWCall
  partitioning            explicit
  filesys                 mirror:d10 c0t0d0s0 c0t1d0s0 4096 /
  filesys                 mirror c0t0d0s1 2048 swap
  filesys                 mirror:d30 c0t0d0s3 c0t1d0s3 4096 /usr
  filesys                 mirror:d40 c0t0d0s4 c0t1d0s4 4096 /usr
  filesys                 mirror:d50 c0t0d0s5 c0t1d0s5 free /export/home
  metadb                  c0t1d0s7 size 8192 count 3

The following list describes some of the keywords and values from this example.

install_type: The profile installs a Solaris Flash archive on the clone system. All files are overwritten as in an initial installation.
archive_location: The Solaris Flash archive is retrieved from an NFS server.
partitioning: The file system slices are determined by the filesys keywords, value explicit.
filesys: The root (/) file system is created and mirrored on the slices c0t0d0s0 and c0t1d0s0. The size of the root (/) file system is set to 4096 Mbytes. The RAID-1 volume that mirrors c0t0d0s0 and c0t1d0s0 is named d10.
filesys: The swap file system is created and mirrored on the slice c0t0d0s1, and is sized at 2048 Mbytes. The custom JumpStart program assigns a name to the mirror.
filesys: The /usr file system is created and mirrored on the slices c0t1d0s3 and c0t0d0s3. The size of the /usr file system is set to 4096 Mbytes. The RAID-1 volume is named d30.
filesys: The /usr file system is created and mirrored on the slices c0t1d0s4 and c0t0d0s4. The size of the /usr file system is set to 4096 Mbytes. The RAID-1 volume is named d40.
metadb: Three state database replicas (metadbs) are installed on slice c0t1d0s7, and are sized at 8192 blocks (4 Mbytes).

For overview information about how to create mirrored file systems during your installation, see Chapter 8, Creating RAID-1 Volumes (Mirrors) During Installation (Overview), in Solaris Express Installation Guide: Planning for Installation and Upgrade.
For guidelines and requirements of creating mirrored file systems, see Chapter 9, Creating RAID-1 Volumes (Mirrors) During Installation (Planning), in Solaris Express Installation Guide: Planning for Installation and Upgrade.
For descriptions of keyword values, see filesys Profile Keyword (Creating RAID-1 Volumes) and metadb Profile Keyword (Creating State Database Replicas).

Example 3-13 Creating a RAID-1 Volume to Mirror the Root File System

In the following example, the profile indicates that the custom JumpStart program uses Solaris Volume Manager technology to create a RAID-1 volume (mirror) for the root (/) file system.

# profile keywords        profile values
# ----------------        -------------------
  install_type            initial_install
  cluster                 SUNWCXall
  filesys                 mirror:d30 c0t1d0s0 c0t0d0s0  /
  filesys                 c0t0d0s3 512 swap
  metadb                  c0t0d0s4 size 8192 count 4
  metadb                  c0t1d0s4 size 8192 count 4

The following list describes some of the keywords and values from this example.

cluster: The Entire Solaris Software Plus OEM Support software group, SUNWCXall, is installed on the system.
filesys: The root (/) file system is created and mirrored on the slices c0t1d0s0 and c0t0d0s0. The RAID-1 volume that mirrors c0t1d0s0 and c0t0d0s0 is named d30. The custom JumpStart program assigns names to the two submirrors.
filesys: The swap file system is created and mirrored on the slice c0t0d0s3, and is sized at 512 Mbytes.
metadb: Four state database replicas (metadbs) are installed on slice c0t0d0s4, and are sized at 8192 blocks (4 Mbytes).
metadb: Four state database replicas (metadbs) are installed on slice c0t1d0s4, and are sized at 8192 blocks (4 Mbytes).

For overview information about how to create RAID-1 volumes during your installation, see Chapter 8, Creating RAID-1 Volumes (Mirrors) During Installation (Overview), in Solaris Express Installation Guide: Planning for Installation and Upgrade.
For guidelines and requirements about creating RAID-1 volumes, see Chapter 9, Creating RAID-1 Volumes (Mirrors) During Installation (Planning), in Solaris Express Installation Guide: Planning for Installation and Upgrade.
For descriptions of keyword values, see filesys Profile Keyword (Creating RAID-1 Volumes) and metadb Profile Keyword (Creating State Database Replicas).

Example 3-14 Creating RAID-1 Volumes to Mirror Multiple File Systems

# profile keywords        profile values
# ----------------        -------------------
  install_type            initial_install
  cluster                 SUNWCXall
  filesys                 mirror:d100 c0t1d0s0 c0t0d0s0 200 /
  filesys                 c0t1d0s5 500 /var
  filesys                 c0t0d0s5 500
  filesys                 mirror c0t0d0s1 512 swap
  metadb                  c0t0d0s3 size 8192 count 5
  filesys                 mirror c0t1d0s4 c0t0d0s4 2000 /usr
  filesys                 c0t1d0s7 free /export/home
  filesys                 c0t0d0s7 free

The following list describes some of the keywords and values from this example.

cluster: The Entire Solaris Software Plus OEM Support software group, SUNWCXall, is installed on the system.
filesys: The root (/) file system is created and mirrored on the slices c0t1d0s0 and c0t0d0s0. The size of the root (/) file system is set to 200 Mbytes. The RAID-1 volume that mirrors c0t1d0s0 and c0t0d0s0 is named d100.
filesys: The /var file system is installed on the slice c0t1d0s5 and is sized at 500 Mbytes. The root (/) file system is created and mirrored on the slices c0t1d0s0 and c0t0d0s0. The size of the root (/) file system is set to 200 Mbytes. The RAID-1 volume that mirrors c0t1d0s0 and c0t0d0s0 is named d100.
filesys: The swap file system is created and mirrored on the slice c0t0d0s1, and is sized at 512 Mbytes. The custom JumpStart program assigns a name to the mirror.
metadb: Five state database replicas (metadbs) are installed on slice c0t0d0s3, and are sized at 8192 blocks (4 Mbytes).
filesys: The /usr file system is created and mirrored on the slices c0t1d0s4 and c0t0d0s4. The size of the /usr file system is set to 2000 Mbytes. The custom JumpStart program assigns a name to the mirror.

For overview information about how to create mirrored file systems during your installation, see Chapter 8, Creating RAID-1 Volumes (Mirrors) During Installation (Overview), in Solaris Express Installation Guide: Planning for Installation and Upgrade.
For guidelines and requirements of creating mirrored file systems, see Chapter 9, Creating RAID-1 Volumes (Mirrors) During Installation (Planning), in Solaris Express Installation Guide: Planning for Installation and Upgrade.
For descriptions of keyword values, see filesys Profile Keyword (Creating RAID-1 Volumes) and metadb Profile Keyword (Creating State Database Replicas).

Example 3-15 x86: Using the fdisk Keyword

# profile keywords      profile values
# ----------------      -------------------
  install_type          initial_install
  system_type           standalone

  fdisk                 c0t0d0 0x04 delete
  fdisk                 c0t0d0 solaris maxfree
  cluster               SUNWCall
  cluster               SUNWCacc delete

The following list describes some of the keywords and values from this example.

fdisk: All fdisk partitions of type DOSOS16 (04 hexadecimal) are deleted from the c0t0d0 disk.
fdisk: A Solaris fdisk partition is created on the largest contiguous free space on the c0t0d0 disk.
cluster: The Entire Distribution software group, SUNWCall, is installed on the system.
cluster: The system accounting utilities, SUNWCacc, are not to be installed on the system.