dc_manifest(5) 맨 페이지 - 윈디하나의 솔라나라

개요

섹션
맨 페이지 이름
검색(S)

dc_manifest(5)

dc_manifest(5)                   File Formats                   dc_manifest(5)

NAME
       dc_manifest - Distribution constructor manifest file format

SYNOPSIS
       /usr/share/install/dc.dtd.1

DESCRIPTION
       The  distribution  constructor (DC) can be used to build Oracle Solaris
       installation images.


       DC XML manifest files are used as input to the  distribution  construc‐
       tor. These manifests define the image that the distribution constructor
       builds. You can use different manifests to build different kinds of im‐
       ages. See the "Files" section for a list of template manifests that are
       available.


       Use  the  distro_const  command to build images, referencing a manifest
       file in the command. If you want to customize the image specifications,
       copy a manifest file, customize the copy, and use the copy as input for
       the distro_const command when you build the image.


       At a minimum, you need to edit the target element in  the  manifest  to
       specify  the  location  of  the  build area where the image can be con‐
       structed. And, you need to edit the software name  element  to  specify
       the  publisher and repository location that contain the packages needed
       to build the image.

MANIFEST SECTIONS
       The manifests include the following primary elements.

       Note -



         The default elements and attributes provided below vary depending  on
         which manifest is used.


   Image Name and Proxy Section
       This  element  provides  the default name, Oracle_Solaris_Text_X86, for
       the image that you plan to build. You can use this name, or  provide  a
       unique name for your image.


       If  you intend to perform a series of builds of an image and retain the
       incremental images, change the add_timestamp attribute value to true to
       automatically append a time stamp to the name for each image.


       If you need to specify an HTTP proxy, use the version of the distro el‐
       ement that includes the http_proxy attribute, and enter the proxy loca‐
       tion as shown in the following example:

         <distro name="Oracle_Solaris_Text_SPARC" add_timestamp="false"
             http_proxy="http://example.com">


   Boot Menu Modifications Section
       This element specifies boot menu modifications to be applied to the im‐
       age.


       In the following example, a specialized boot menu with the title  myen‐
       try  will be applied to the image. The timeout attribute specifies time
       before the default boot entry is automatically activated.

         <boot_mods title="myentry" timeout="5">



       You can add individual boot menu entries by adding a new boot_entry el‐
       ement for each new entry. Entries are added sequentially  to  the  boot
       menu  in  the  order based on the insert_at attribute value of start or
       end for each boot entry.

       Note -



         Add new entries before any assistive_tech=magnifier entry.



       Since a title sub-element is not included in this example, the  default
       is used. The default title is the first line of /etc/release.


       The  title_suffix  is  a  required sub-element, a text string to be ap‐
       pended to the entry title. An optional kernel_args  sub-element  passes
       kernel arguments to the boot loader.


       Optional attributes for the boot_entry element include:

       default_entry    Set  this  attribute to "true" to make this boot entry
                        the default. If more than one entry is set to  "true",
                        the last entry defined as such will override preceding
                        entries.


       insert_at        Set  value  to  "start" or "end" to indicate insertion
                        point relative to other boot entries.


   Installation Target Section
       This element defines the ZFS build dataset to be used  for  the  build.
       This  dataset is the area where the image will be created. The filesys‐
       tem name should not include the zpool name.

         <target>
           <logical>
             <zpool name="rpool" action="use_existing">
               <filesystem name="dc/text" action="preserve"/>
             </zpool>
           </logical>
         </target>


   Software Destination Section: IPS Package Image
       This section specifies information about the IPS package image that the
       distribution constructor will create. Image  properties,  optional  and
       mutually exclusive components of software packages might be specified.


       In  the  image  element in this section, the facet sub-element might be
       used to specify optional software components to install. The facet ele‐
       ment has a boolean set attribute and a value that is the  name  of  the
       IPS  facet.  The  variant sub-element might be used to specify which of
       one or more mutually exclusive  software  components  to  install.  The
       variant  element  has  a  name attribute to specify the name of the IPS
       variant and a value attribute to specify its value. Lastly,  the  prop‐
       erty  sub-element  might be used to specify IPS image properties on the
       image being built. For more information about IPS facets, variants, and
       image properties, see the pkg(7) man page. Note that the arch and open‐
       solaris.zone variants are set implicitly by the distribution  construc‐
       tor and will cause an error if they are specified in the manifest.

         <destination>
           <image img_root="{PKG_IMAGE_PATH}" action="create">
             <facet set="false">facet.locale.*</facet>
             <facet set="true">facet.locale.en</facet>
             <facet set="true">facet.locale.en_US</facet>
             <variant name="variant.debug.osnet" value="true"/>
             <img_type completeness="full"/>
             <property val="true">flush-content-cache-on-success</property>
             <property val="when-required">be-policy</property>
           </image>
         </destination>


       Note -



         The  image  element  also  includes  an  image_root  attribute and an
         img_type sub-element which specify the data mount point  to  be  used
         during the build of the image and the image type. Changing these val‐
         ues are not recommended.


   Software Source Section: Transfer IPS Packages
       This section specifies where the distribution constructor can get pack‐
       ages to download and use to build the image.


       Image Packaging System (IPS) publishers provide packages in one or more
       package repositories.


       In the source element in this section, edit the publisher name and ori‐
       gin name to specify which publisher to use and where the package repos‐
       itory is located. Multiple publishers can be listed. When the distribu‐
       tion constructor attempts to locate packages to install, publishers are
       searched  in  the order in which they are listed in the source element.
       Use the mirror sub-element to specify a mirror repository location.


       The cmd_options sub-element of the publisher element specifies  an  op‐
       tions  string.  This  options  string is added to the pkg set-publisher
       command run on the publisher. This element can be used to  set  proper‐
       ties, attributes, or other options on the publisher. See the pkg(1) man
       page for more information about the set-publisher subcommand. Note that
       not  all  options are applicable to be set on publishers in the context
       of distribution construction.


       See the pkg(7) man page for information about IPS publishers and repos‐
       itories.

         <source>
           <publisher name="solaris">
             <origin name="http://pkg.oracle.com/solaris/release"/>
           </publisher>
           <publisher name="internal">
             <origin name="http://example.com/"></origin>
             <mirror name="mirror1.example.com"></mirror>
             <mirror name="mirror2.example.com"></mirror>
             <cmd_options>--non-sticky</cmd_options>
             <cmd_options>--set-property signature-policy=ignore</cmd_options>
           </publisher>
         </source>


   Software Packages Section: Install
       This software_data element with the install attribute lists the set  of
       packages  to be installed in order to build a particular type of image,
       depending  on  which  manifest  you  are  using.   For   example,   the
       dc_text_x86.xml  manifest lists the packages needed to build a text in‐
       stall image.


       Each name element lists one package name.

         <software_data action="install">
           <name>pkg:/entire@latest</name>
           <name>pkg:/group/system/solaris-large-server</name>
           <name>pkg:/system/install/text-install</name>
           <name>pkg:/system/install/media/internal</name>
         </software_data>



       If you have packages that you want to add  to  the  image,  append  the
       package names by adding a name element for each package.


       By default, the most current package version available in the specified
       repository  is  installed.  If another version is required, include the
       version portion of the package FMRI as shown in the following example:

         <name>pkg:/entire@0.5.11-0.165</name>



       Use the following command to check which versions are available.

         $ pkg list -af entire


       Note -



         Do not remove or prevent the installation of the  package  named  en‐
         tire.  The  package  named  entire is an incorporation used to manage
         multiple packages that form the Oracle Solaris  OS.  Systems  without
         entire installed are unsupported.


   Software Packages Section: Uninstall
       The  software_data  element with the uninstall attribute can be used to
       uninstall an individual package.

         <software_data action="uninstall">
           <name>pkg:/editor/nano</name>
         </software_data>


   Software Source Section: Set IPS Attributes
       This element affects a system after that system has been installed with
       the image created using the distribution constructor.


       In the source element, use the publisher name and optional mirror  name
       to specify where the installed system can access additional packages to
       download and install. Use the optional cmd_options sub-element to spec‐
       ify options strings to be passed to the pkg set-publisher command to be
       run on the publisher.

         <source>
           <publisher name="solaris">
             <origin name="http://pkg.oracle.com/solaris/release/"/>
           </publisher>
         </source>


   Software Section: Boot Archive
       The  software  element  with name attribute ba-init lists the files and
       directories to be installed or uninstalled in the boot archive for  the
       image that is built. See the comments in the manifest file for informa‐
       tion.

       Caution -



         Modifying  the  boot  archive  contents  could  render the system un‐
         bootable.


   Execution and Checkpoint Section
       The execution element in the manifest lists  a  series  of  checkpoints
       that  are  executed  during the image construction process. Checkpoints
       are executed in the order in which they are listed in this section. The
       default checkpoints needed to build the default installation image  are
       included in each manifest.


       Each  checkpoint  element includes the mod-path attribute, which speci‐
       fies where the checkpoint script is located.


       Use the distro_const command options to control pausing and  restarting
       the build process at particular checkpoints.


       Some of the checkpoint sub-elements include arguments with default val‐
       ues provided. See the manifest comments for details.


       If  you create a custom script to be used during the building of an im‐
       age, you must add a checkpoint element pointing to the script location.
       See the following example about how to add a new checkpoint element  to
       point   to   a   custom   script.  A  user  creates  a  custom  script,
       /tmp/myscript.sh, to run in the build process after the default  trans‐
       fer-ips-checkpoint.  To point to the new script, add the following ele‐
       ment to the manifest after the transfer-ips-install checkpoint.

         <checkpoint name="custom1"
           desc="my new script"
           mod_path="solaris_install/distro_const/checkpoints/custom_script"
           checkpoint_class="CustomScript">
           <args>/tmp/myscript.sh {PKG_IMAGE_PATH}filearg arg2</args>
         </checkpoint>



       Where filearg and arg2 are arguments the script takes, and  filearg  is
       the  name of a file in $PKG_IMAGE_PATH. See the "Environment Variables"
       section below for a description of PKG_IMAGE_PATH.

       Note -



         Multiple custom checkpoints can be specified in a DC  manifest.  Each
         checkpoint must have a unique name.


   Configuration Section
       The  configuration  element  in the manifest lists SMF service profiles
       that are applied to the media during the  image  construction  process.
       These  SMF services specify which services will be running, or not run‐
       ning, on the booted media. The profiles are applied  in  the  order  in
       which they are specified in this element.


       This element would rarely be modified.

ENVIRONMENT VARIABLES
       The  following  environment  variables are used only with custom check‐
       point scripts. See the example in "Execution  and  Checkpoint  Section"
       above.

       PKG_IMAGE_PATH

           Replaced      by     distro_const     during     execution     with
           ZFS_dataset/build_data/pkg_image.


       BOOT_ARCHIVE

           Replaced     by     distro_const     during     execution      with
           ZFS_dataset/build_data/boot_archive.


FILES
       The  following  manifest  files can be used to build various Oracle So‐
       laris images. These manifests are  included  in  the  distribution-con‐
       structor package.

       /usr/share/distro_const/dc_ai_x86.xml

           To build x86 automated installation images.


       /usr/share/distro_const/dc_ai_sparc.xml

           To build SPARC automated installation images.


       /usr/share/distro_const/dc_text_x86.xml

           To build x86 text installation images.


       /usr/share/distro_const/dc_text_sparc.xml

           To build SPARC text installation images.


       /usr/share/distro_const/dc_diskimage_x86.xml

           To build x86 bootable disk images,


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:

       tab()  box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) ATTRIBUTE TYPEAT‐
       TRIBUTE VALUE _ Availabilityinstall/distribution-constructor  _  Inter‐
       face StabilityUncommitted


SEE ALSO
       pkg(1), pkg(7), distro_const(8)


       Creating a Custom Oracle Solaris 11.4 Image

Oracle Solaris 11.4               14 Dec 2023                   dc_manifest(5)
맨 페이지 내용의 저작권은 맨 페이지 작성자에게 있습니다.
RSS ATOM XHTML 5 CSS3