Print this page 
OS-4915 want FX high priority zone configuration option
OS-4925 ps pri shows misleading value for zone in RT scheduling class
Reviewed by: Patrick Mooney <patrick.mooney@joyent.com>
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man1m/zonecfg.1m
          +++ new/usr/src/man/man1m/zonecfg.1m
   1    1  '\" te
   2    2  .\" Copyright (c) 2004, 2009 Sun Microsystems, Inc. All Rights Reserved.
   3      -.\" Copyright 2013 Joyent, Inc. All Rights Reserved.
        3 +.\" Copyright 2015 Joyent, Inc.
   4    4  .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   5    5  .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
   6    6  .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7      -.TH ZONECFG 1M "Feb 28, 2014"
        7 +.TH ZONECFG 1M "Nov 4, 2015"
   8    8  .SH NAME
   9    9  zonecfg \- set up zone configuration
  10   10  .SH SYNOPSIS
  11   11  .LP
  12   12  .nf
  13   13  \fBzonecfg\fR \fB-z\fR \fIzonename\fR
  14   14  .fi
  15   15  
  16   16  .LP
  17   17  .nf
↓ open down ↓ 4 lines elided ↑ open up ↑ 
  22   22  .nf
  23   23  \fBzonecfg\fR \fB-z\fR \fIzonename\fR \fB-f\fR \fIcommand_file\fR
  24   24  .fi
  25   25  
  26   26  .LP
  27   27  .nf
  28   28  \fBzonecfg\fR help
  29   29  .fi
  30   30  
  31   31  .SH DESCRIPTION
  32      -.sp
  33   32  .LP
  34   33  The \fBzonecfg\fR utility creates and modifies the configuration of a zone.
  35   34  Zone configuration consists of a number of resources and properties.
  36   35  .sp
  37   36  .LP
  38   37  To simplify the user interface, \fBzonecfg\fR uses the concept of a scope. The
  39   38  default scope is global.
  40   39  .sp
  41   40  .LP
  42   41  The following synopsis of the \fBzonecfg\fR command is for interactive usage:
↓ open down ↓ 22 lines elided ↑ open up ↑ 
  65   64  .LP
  66   65  Every zone is configured with an associated brand. The brand determines the
  67   66  user-level environment used within the zone, as well as various behaviors for
  68   67  the zone when it is installed, boots, or is shutdown. Once a zone has been
  69   68  installed the brand cannot be changed. The default brand is determined by the
  70   69  installed distribution in the global zone. Some brands do not support all of
  71   70  the \fBzonecfg\fR properties and resources. See the brand-specific man page for
  72   71  more details on each brand. For an overview of brands, see the \fBbrands\fR(5)
  73   72  man page.
  74   73  .SS "Resources"
  75      -.sp
  76   74  .LP
  77   75  The following resource types are supported:
  78   76  .sp
  79   77  .ne 2
  80   78  .na
  81   79  \fB\fBattr\fR\fR
  82   80  .ad
  83   81  .sp .6
  84   82  .RS 4n
  85   83  Generic attribute.
↓ open down ↓ 73 lines elided ↑ open up ↑ 
 159  157  .ne 2
 160  158  .na
 161  159  \fB\fBrctl\fR\fR
 162  160  .ad
 163  161  .sp .6
 164  162  .RS 4n
 165  163  Resource control.
 166  164  .RE
 167  165  
 168  166  .SS "Properties"
 169      -.sp
 170  167  .LP
 171  168  Each resource type has one or more properties. There are also some global
 172  169  properties, that is, properties of the configuration as a whole, rather than of
 173  170  some particular resource.
 174  171  .sp
 175  172  .LP
 176  173  The following properties are supported:
 177  174  .sp
 178  175  .ne 2
 179  176  .na
↓ open down ↓ 597 lines elided ↑ open up ↑ 
 777  774  .ad
 778  775  .sp .6
 779  776  .RS 4n
 780  777  Specifies the scheduling class used for processes running in a zone. When this
 781  778  property is not specified, the scheduling class is established as follows:
 782  779  .RS +4
 783  780  .TP
 784  781  .ie t \(bu
 785  782  .el o
 786  783  If the \fBcpu-shares\fR property or equivalent rctl is set, the scheduling
 787      -class FSS is used.
      784 +class \fBFSS\fR is used.
 788  785  .RE
 789  786  .RS +4
 790  787  .TP
 791  788  .ie t \(bu
 792  789  .el o
 793  790  If neither \fBcpu-shares\fR nor the equivalent rctl is set and the zone's pool
 794  791  property references a pool that has a default scheduling class, that class is
 795  792  used.
 796  793  .RE
 797  794  .RS +4
 798  795  .TP
 799  796  .ie t \(bu
 800  797  .el o
 801  798  Under any other conditions, the system default scheduling class is used.
 802  799  .RE
      800 +.sp
      801 +If the \fBFX\fR scheduling class is specified, then the optional
      802 +\fBfixed-hi-pri\fR attribute can be set to \fBtrue\fR. This causes all of the
      803 +processes in the zone to run at the highest \fBFX\fR priority. By default
      804 +processes under \fBFX\fR run at the lowest priority. See \fBpriocntl\fR(2)
      805 +for details on each scheduling class.
 803  806  .RE
 804  807  
 805  808  
 806      -
 807  809  .sp
 808  810  .ne 2
 809  811  .na
 810  812  \fB\fBdedicated-cpu\fR: ncpus, importance\fR
 811  813  .ad
 812  814  .sp .6
 813  815  .RS 4n
 814  816  The number of CPUs that should be assigned for this zone's exclusive use. The
 815  817  zone will create a pool and processor set when it boots. See \fBpooladm\fR(1M)
 816  818  and \fBpoolcfg\fR(1M) for more information on resource pools. The \fBncpu\fR
↓ open down ↓ 120 lines elided ↑ open up ↑ 
 937  939  To further specify things, the breakdown of the complex property "value" of the
 938  940  "rctl" resource type, it consists of three name/value pairs, the names being
 939  941  "priv", "limit" and "action", each of which takes a simple value. The "name"
 940  942  property of an "attr" resource is syntactically restricted in a fashion similar
 941  943  but not identical to zone names: it must begin with an alphanumeric, and can
 942  944  contain alphanumerics plus the hyphen (\fB-\fR), underscore (\fB_\fR), and dot
 943  945  (\fB\&.\fR) characters. Attribute names beginning with "zone" are reserved for
 944  946  use by the system. Finally, the "autoboot" global property must have a value of
 945  947  "true" or "false".
 946  948  .SS "Using Kernel Statistics to Monitor CPU Caps"
 947      -.sp
 948  949  .LP
 949  950  Using the kernel statistics (\fBkstat\fR(3KSTAT)) module \fBcaps\fR, the system
 950  951  maintains information for all capped projects and zones. You can access this
 951  952  information by reading kernel statistics (\fBkstat\fR(3KSTAT)), specifying
 952  953  \fBcaps\fR as the \fBkstat\fR module name. The following command displays
 953  954  kernel statistics for all active CPU caps:
 954  955  .sp
 955  956  .in +2
 956  957  .nf
 957  958  # \fBkstat caps::'/cpucaps/'\fR
↓ open down ↓ 132 lines elided ↑ open up ↑ 
1090 1091  .ad
1091 1092  .sp .6
1092 1093  .RS 4n
1093 1094  Name of the zone for which statistics are displayed.
1094 1095  .RE
1095 1096  
1096 1097  .sp
1097 1098  .LP
1098 1099  See \fBEXAMPLES\fR for sample output from a \fBkstat\fR command.
1099 1100  .SH OPTIONS
1100      -.sp
1101 1101  .LP
1102 1102  The following options are supported:
1103 1103  .sp
1104 1104  .ne 2
1105 1105  .na
1106 1106  \fB\fB-f\fR \fIcommand_file\fR\fR
1107 1107  .ad
1108 1108  .sp .6
1109 1109  .RS 4n
1110 1110  Specify the name of \fBzonecfg\fR command file. \fIcommand_file\fR is a text
↓ open down ↓ 8 lines elided ↑ open up ↑ 
1119 1119  .sp .6
1120 1120  .RS 4n
1121 1121  Specify the name of a zone. Zone names are case sensitive. Zone names must
1122 1122  begin with an alphanumeric character and can contain alphanumeric characters,
1123 1123  the underscore (\fB_\fR) the hyphen (\fB-\fR), and the dot (\fB\&.\fR). The
1124 1124  name \fBglobal\fR and all names beginning with \fBSUNW\fR are reserved and
1125 1125  cannot be used.
1126 1126  .RE
1127 1127  
1128 1128  .SH SUBCOMMANDS
1129      -.sp
1130 1129  .LP
1131 1130  You can use the \fBadd\fR and \fBselect\fR subcommands to select a specific
1132 1131  resource, at which point the scope changes to that resource. The \fBend\fR and
1133 1132  \fBcancel\fR subcommands are used to complete the resource specification, at
1134 1133  which time the scope is reverted back to global. Certain subcommands, such as
1135 1134  \fBadd\fR, \fBremove\fR and \fBset\fR, have different semantics in each scope.
1136 1135  .sp
1137 1136  .LP
1138 1137  \fBzonecfg\fR supports a semicolon-separated list of subcommands. For example:
1139 1138  .sp
↓ open down ↓ 656 lines elided ↑ open up ↑ 
1796 1795  .in +2
1797 1796  .nf
1798 1797  # \fBkstat -c project_caps\fR
1799 1798  
1800 1799  # \fBkstat -c project_caps -i 1\fR
1801 1800  .fi
1802 1801  .in -2
1803 1802  .sp
1804 1803  
1805 1804  .SH EXIT STATUS
1806      -.sp
1807 1805  .LP
1808 1806  The following exit values are returned:
1809 1807  .sp
1810 1808  .ne 2
1811 1809  .na
1812 1810  \fB\fB0\fR\fR
1813 1811  .ad
1814 1812  .sp .6
1815 1813  .RS 4n
1816 1814  Successful completion.
↓ open down ↓ 13 lines elided ↑ open up ↑ 
1830 1828  .ne 2
1831 1829  .na
1832 1830  \fB\fB2\fR\fR
1833 1831  .ad
1834 1832  .sp .6
1835 1833  .RS 4n
1836 1834  Invalid usage.
1837 1835  .RE
1838 1836  
1839 1837  .SH ATTRIBUTES
1840      -.sp
1841 1838  .LP
1842 1839  See \fBattributes\fR(5) for descriptions of the following attributes:
1843 1840  .sp
1844 1841  
1845 1842  .sp
1846 1843  .TS
1847 1844  box;
1848 1845  c | c
1849 1846  l | l .
1850 1847  ATTRIBUTE TYPE  ATTRIBUTE VALUE
1851 1848  _
1852 1849  Interface Stability     Volatile
1853 1850  .TE
1854 1851  
1855 1852  .SH SEE ALSO
1856      -.sp
1857 1853  .LP
1858 1854  \fBppriv\fR(1), \fBprctl\fR(1), \fBzlogin\fR(1), \fBkstat\fR(1M),
1859 1855  \fBmount\fR(1M), \fBpooladm\fR(1M), \fBpoolcfg\fR(1M), \fBpoold\fR(1M),
1860 1856  \fBrcapd\fR(1M), \fBrctladm\fR(1M), \fBsvcadm\fR(1M), \fBsysidtool\fR(1M),
1861      -\fBzfs\fR(1M), \fBzoneadm\fR(1M), \fBpriv_str_to_set\fR(3C),
     1857 +\fBzfs\fR(1M), \fBzoneadm\fR(1M), \fBpriocntl\fR(2), \fBpriv_str_to_set\fR(3C),
1862 1858  \fBkstat\fR(3KSTAT), \fBvfstab\fR(4), \fBattributes\fR(5), \fBbrands\fR(5),
1863 1859  \fBfnmatch\fR(5), \fBlx\fR(5), \fBprivileges\fR(5), \fBresource_controls\fR(5),
1864 1860  \fBzones\fR(5)
1865 1861  .sp
1866 1862  .LP
1867 1863  \fISystem Administration Guide: Solaris Containers-Resource Management, and
1868 1864  Solaris Zones\fR
1869 1865  .SH NOTES
1870      -.sp
1871 1866  .LP
1872 1867  All character data used by \fBzonecfg\fR must be in US-ASCII encoding.
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX