Print this page
    
12278 nfs-zone needs man page changes
Reviewed by: Peter Tribble <peter.tribble@gmail.com>
Reviewed by: Gordon Ross <gordon.w.ross@gmail.com>
    
      
        | Split | 
	Close | 
      
      | Expand all | 
      | Collapse all | 
    
    
          --- old/usr/src/man/man5/zones.5
          +++ new/usr/src/man/man5/zones.5
   1    1  '\" te
   2    2  .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
   3    3  .\" 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.
   4    4  .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5    5  .\" 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
        6 +.\"
        7 +.\" Copyright 2020 Joyent, Inc.
   6    8  .TH ZONES 5 "Jan 29, 2009"
   7    9  .SH NAME
   8   10  zones \- Solaris application containers
   9   11  .SH DESCRIPTION
  10      -.sp
  11      -.LP
  12   12  The zones facility in Solaris provides an isolated environment for running
  13   13  applications. Processes running in a zone are prevented from monitoring or
  14   14  interfering with other activity in the system. Access to other processes,
  15   15  network interfaces, file systems, devices, and inter-process communication
  16   16  facilities are restricted to prevent interaction between processes in different
  17   17  zones.
  18   18  .sp
  19   19  .LP
  20   20  The privileges available within a zone are restricted to prevent operations
  21   21  with system-wide impact. See \fBprivileges\fR(5).
  22   22  .sp
  23   23  .LP
  24   24  You can configure and administer zones with the \fBzoneadm\fR(1M) and
  25   25  \fBzonecfg\fR(1M) utilities. You can specify the configuration details a zone,
  26   26  install file system contents including software packages into the zone, and
  27   27  manage the runtime state of the zone. You can use the \fBzlogin\fR(1) to run
  28   28  commands within an active zone. You can do this without logging in through a
  29   29  network-based login server such as \fBin.rlogind\fR(1M) or \fBsshd\fR(1M).
  30   30  .sp
  31   31  .LP
  32   32  The autobooting of zones is enabled and disabled by the zones service,
  33   33  identified by the FMRI:
  34   34  .sp
  35   35  .LP
  36   36  svc:/system/zones:default
  37   37  .sp
  38   38  .LP
  39   39  See \fBzoneadm\fR(1M). Note that a zone has an \fBautoboot\fR property, which
  40   40  can be set to \fBtrue\fR (always autoboot). However, if the zones service is
  41   41  disabled, autoboot will not occur, regardless of the setting of the autoboot
  42   42  property for a given zone. See \fBzonecfg\fR(1M).
  43   43  .sp
  44   44  .LP
  45   45  An alphanumeric name and numeric ID identify each active zone. Alphanumeric
  46   46  names are configured using the \fBzonecfg\fR(1M) utility. Numeric IDs are
  47   47  automatically assigned when the zone is booted. The \fBzonename\fR(1) utility
  48   48  reports the current zone name, and the \fBzoneadm\fR(1M) utility can be used to
  49   49  report the names and IDs of configured zones.
  50   50  .sp
  51   51  .LP
  52   52  A zone can be in one of several states:
  53   53  .sp
  54   54  .ne 2
  55   55  .na
  56   56  \fB\fBCONFIGURED\fR\fR
  57   57  .ad
  58   58  .RS 17n
  59   59  Indicates that the configuration for the zone has been completely specified and
  60   60  committed to stable storage.
  61   61  .RE
  62   62  
  63   63  .sp
  64   64  .ne 2
  65   65  .na
  66   66  \fB\fBINCOMPLETE\fR\fR
  67   67  .ad
  68   68  .RS 17n
  69   69  Indicates that the zone is in the midst of being installed or uninstalled, or
  70   70  was interrupted in the midst of such a transition.
  71   71  .RE
  72   72  
  73   73  .sp
  74   74  .ne 2
  75   75  .na
  76   76  \fB\fBINSTALLED\fR\fR
  77   77  .ad
  78   78  .RS 17n
  79   79  Indicates that the zone's configuration has been instantiated on the system:
  80   80  packages have been installed under the zone's root path.
  81   81  .RE
  82   82  
  83   83  .sp
  84   84  .ne 2
  85   85  .na
  86   86  \fB\fBREADY\fR\fR
  87   87  .ad
  88   88  .RS 17n
  89   89  Indicates that the "virtual platform" for the zone has been established. For
  90   90  instance, file systems have been mounted, devices have been configured, but no
  91   91  processes associated with the zone have been started.
  92   92  .RE
  93   93  
  94   94  .sp
  95   95  .ne 2
  96   96  .na
  97   97  \fB\fBRUNNING\fR\fR
  98   98  .ad
  99   99  .RS 17n
 100  100  Indicates that user processes associated with the zone application environment
 101  101  are running.
 102  102  .RE
 103  103  
 104  104  .sp
 105  105  .ne 2
 106  106  .na
 107  107  \fB\fBSHUTTING_DOWN\fR\fR
 108  108  .ad
 109  109  .br
 110  110  .na
  
    | 
      ↓ open down ↓ | 
    89 lines elided | 
    
      ↑ open up ↑ | 
  
 111  111  \fB\fBDOWN\fR\fR
 112  112  .ad
 113  113  .RS 17n
 114  114  Indicates that the zone is being halted. The zone can become stuck in one of
 115  115  these states if it is unable to tear down the application environment state
 116  116  (such as mounted file systems) or if some portion of the virtual platform
 117  117  cannot be destroyed. Such cases require operator intervention.
 118  118  .RE
 119  119  
 120  120  .SS "Process Access Restrictions"
 121      -.sp
 122      -.LP
 123  121  Processes running inside a zone (aside from the global zone) have restricted
 124  122  access to other processes. Only processes in the same zone are visible through
 125  123  \fB/proc\fR (see \fBproc\fR(4) or through system call interfaces that take
 126  124  process IDs such as \fBkill\fR(2) and \fBpriocntl\fR(2). Attempts to access
 127  125  processes that exist in other zones (including the global zone) fail with the
 128  126  same error code that would be issued if the specified process did not exist.
 129  127  .SS "Privilege Restrictions"
 130      -.sp
 131      -.LP
 132  128  Processes running within a non-global zone are restricted to a subset of
 133  129  privileges, in order to prevent one zone from being able to perform operations
 134  130  that might affect other zones. The set of privileges limits the capabilities of
 135  131  privileged users (such as the super-user or root user) within the zone. The
 136  132  list of privileges available within a zone can be displayed using the
 137  133  \fBppriv\fR(1) utility. For more information about privileges, see
 138  134  \fBprivileges\fR(5).
 139  135  .SS "Device Restrictions"
 140      -.sp
 141      -.LP
 142  136  The set of devices available within a zone is restricted, to prevent a process
 143  137  in one zone from interfering with processes in other zones. For example, a
 144  138  process in a zone should not be able to modify kernel memory using
 145  139  \fB/dev/kmem\fR, or modify the contents of the root disk. Thus, by default,
 146  140  only a few pseudo devices considered safe for use within a zone are available.
 147  141  Additional devices can be made available within specific zones using the
 148  142  \fBzonecfg\fR(1M) utility.
 149  143  .sp
 150  144  .LP
 151  145  The device and privilege restrictions have a number of effects on the utilities
 152  146  that can run in a non-global zone. For example, the \fBeeprom\fR(1M),
 153  147  \fBprtdiag\fR(1M), and \fBprtconf\fR(1M) utilities do not work in a zone since
 154  148  they rely on devices that are not normally available.
 155  149  .SS "Brands"
 156      -.sp
 157      -.LP
 158  150  A zone may be assigned a brand when it is initially created. A branded zone is
 159  151  one whose software does not match that software found in the global zone. The
 160  152  software may include Solaris software configured or laid out differently, or it
 161  153  may include non-Solaris software. The particular collection of software is
 162  154  called a "brand" (see \fBbrands\fR(5)). Once installed, a zone's brand may not
 163  155  be changed unless the zone is first uninstalled.
 164  156  .SS "File Systems"
 165      -.sp
 166      -.LP
 167  157  Each zone has its own section of the file system hierarchy, rooted at a
 168  158  directory known as the zone root. Processes inside the zone can access only
 169  159  files within that part of the hierarchy, that is, files that are located
 170  160  beneath the zone root. This prevents processes in one zone from corrupting or
 171  161  examining file system data associated with another zone. The \fBchroot\fR(1M)
 172  162  utility can be used within a zone, but can only restrict the process to a root
 173  163  path accessible within the zone.
 174  164  .sp
 175  165  .LP
 176  166  In order to preserve file system space, sections of the file system can be
 177  167  mounted into one or more zones using the read-only option of the
 178  168  \fBlofs\fR(7FS) file system. This allows the same file system data to be shared
 179  169  in multiple zones, while preserving the security guarantees supplied by zones.
 180  170  .sp
 181  171  .LP
 182  172  NFS and autofs mounts established within a zone are local to that zone; they
 183  173  cannot be accessed from other zones, including the global zone. The mounts are
 184  174  removed when the zone is halted or rebooted.
 185      -.SS "Networking"
 186  175  .sp
 187  176  .LP
      177 +A zone can share filesystems using \fBnfs\fR(4) or \fBsmb\fR(4)
      178 +subject to the restrictions earlier in this section, plus the additional
      179 +restriction that file sharing can only be done from filesystems a zone
      180 +completely controls. Some \fBbrands\fR(5) do not have the zone root set to a
      181 +filesystem boundary.  \fBsharefs\fR(7FS) can instantiate per-zone subject to
      182 +the brand restrictions.
      183 +.SS "Networking"
 188  184  A zone has its own port number space for \fBTCP\fR, \fBUDP\fR, and \fBSCTP\fR
 189  185  applications and typically one or more separate \fBIP\fR addresses (but some
 190  186  configurations of Trusted Extensions share IP address(es) between zones).
 191  187  .sp
 192  188  .LP
 193  189  For the \fBIP\fR layer (\fBIP\fR routing, \fBARP\fR, \fBIPsec\fR, \fBIP\fR
 194  190  Filter, and so on) a zone can either share the configuration and state with the
 195  191  global zone (a shared-\fBIP\fR zone), or have its distinct \fBIP\fR layer
 196  192  configuration and state (an exclusive-\fBIP\fR zone).
 197  193  .sp
 198  194  .LP
 199  195  If a zone is to be connected to the same datalink, that is, be on the same
 200  196  \fBIP\fR subnet or subnets as the global zone, then it is appropriate for the
 201  197  zone to use the shared \fBIP\fR instance.
 202  198  .sp
 203  199  .LP
 204  200  If a zone needs to be isolated at the \fBIP\fR layer on the network, for
 205  201  instance being connected to different \fBVLAN\fRs or different \fBLAN\fRs than
 206  202  the global zone and other non-global zones, then for isolation reasons the zone
 207  203  should have its exclusive \fBIP\fR.
 208  204  .sp
 209  205  .LP
 210  206  A shared-\fBIP\fR zone is prevented from doing certain things towards the
 211  207  network (such as changing its \fBIP\fR address or sending spoofed \fBIP\fR or
 212  208  Ethernet packets), but an exclusive-\fBIP\fR zone has more or less the same
 213  209  capabilities towards the network as a separate host that is connected to the
 214  210  same network interface. In particular, the superuser in such a zone can change
 215  211  its \fBIP\fR address and spoof \fBARP\fR packets.
 216  212  .sp
 217  213  .LP
 218  214  The shared-\fBIP\fR zones are assigned one or more network interface names and
 219  215  \fBIP\fR addresses in \fBzonecfg\fR(1M). The network interface name(s) must
 220  216  also be configured in the global zone.
 221  217  .sp
 222  218  .LP
  
    | 
      ↓ open down ↓ | 
    25 lines elided | 
    
      ↑ open up ↑ | 
  
 223  219  The exclusive-\fBIP\fR zones are assigned one or more network interface names
 224  220  in \fBzonecfg\fR(1M). The network interface names must be exclusively assigned
 225  221  to that zone, that is, it (or they) can not be assigned to some other running
 226  222  zone, nor can they be used by the global zone.
 227  223  .sp
 228  224  .LP
 229  225  The full \fBIP\fR-level functionality in the form of \fBDHCP\fR client,
 230  226  \fBIPsec\fR and \fBIP\fR Filter, is available in exclusive-\fBIP\fR zones and
 231  227  not in shared-\fBIP\fR zones.
 232  228  .SS "Host Identifiers"
 233      -.sp
 234      -.LP
 235  229  A zone is capable of emulating a 32-bit host identifier, which can be
 236  230  configured via \fBzonecfg\fR(1M), for the purpose of system consolidation. If a
 237  231  zone emulates a host identifier, then commands such as \fBhostid\fR(1) and
 238  232  \fBsysdef\fR(1M) as well as C interfaces such as \fBsysinfo\fR(2) and
 239  233  \fBgethostid\fR(3C) that are executed within the context of the zone will
 240  234  display or return the zone's emulated host identifier rather than the host
 241  235  machine's identifier.
 242  236  .SH SEE ALSO
 243      -.sp
 244      -.LP
 245  237  \fBhostid\fR(1), \fBzlogin\fR(1), \fBzonename\fR(1), \fBin.rlogind\fR(1M),
 246  238  \fBsshd\fR(1M), \fBsysdef\fR(1M), \fBzoneadm\fR(1M), \fBzonecfg\fR(1M),
 247  239  \fBkill\fR(2), \fBpriocntl\fR(2), \fBsysinfo\fR(2), \fBgethostid\fR(3C),
 248      -\fBgetzoneid\fR(3C), \fBucred_get\fR(3C), \fBproc\fR(4), \fBattributes\fR(5),
 249      -\fBbrands\fR(5), \fBprivileges\fR(5), \fBcrgetzoneid\fR(9F)
      240 +\fBgetzoneid\fR(3C), \fBucred_get\fR(3C), \fBnfs\fR(4), \fBproc\fR(4),
      241 +\fBsmb\fR(4), \fBattributes\fR(5), \fBbrands\fR(5), \fBprivileges\fR(5),
      242 +\fBsharefs\fR(7FS), \fBcrgetzoneid\fR(9F)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX