zone

Table of Contents

1. Description
2. Setup - The basics of getting started with zone
   • Setup requirements
   • Beginning with zone
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

The zone_core module is used to manage Solaris zone resources.

Setup

Setup Requirements

The zone_core module depends on the zfs_core module, as a zone may be associated in a zfs resource pool.

Beginning with zone

To create a zone resource with the name tstzone in the running state and the root of the zone filesystem in /tstzones/mnt:

zone { 'tstzone' :
  ensure => running,
  path   => '/tstzones/mnt'
}

Usage

For details on usage, please see the zone puppet docs.

Reference

Please see REFERENCE.md for the reference documentation.

This module is documented using Puppet Strings.

For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.

To generate documentation locally, run

bundle install
bundle exec puppet strings generate ./lib/**/*.rb

This command will create a browsable \_index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.

Limitations

This module is only available on Solaris platforms.

Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.

Reference

Resource types

• zone: Manages Solaris zones. Autorequires: If Puppet is managing the directory specified as the root of the zone's filesystem (with the path

Resource types

zone

Manages Solaris zones.

Autorequires: If Puppet is managing the directory specified as the root of the zone's filesystem (with the path attribute), the zone resource will autorequire that directory.

Properties

The following properties are available in the zone type.

ensure

The running state of the zone. The valid states directly reflect the states that zoneadm provides. The states are linear, in that a zone must be configured, then installed, and only then can be running. Note also that halt is currently used to stop zones.

Default value: running

ip

The IP address of the zone. IP addresses must be specified with an interface, and may optionally be specified with a default router (sometimes called a defrouter). The interface, IP address, and default router should be separated by colons to form a complete IP address string. For example: bge0:192.168.178.200 would be a valid IP address string without a default router, and bge0:192.168.178.200:192.168.178.1 adds a default router to it.

For zones with multiple interfaces, the value of this attribute should be an array of IP address strings (each of which must include an interface and may include a default router).

iptype

Valid values: shared, exclusive

The IP stack type of the zone.

Default value: shared

autoboot

Valid values: true, false

Whether the zone should automatically boot.

Default value: true

path

The root of the zone's filesystem. Must be a fully qualified file name. If you include %s in the path, then it will be replaced with the zone's name. Currently, you cannot use Puppet to move a zone. Consequently this is a readonly property.

pool

The resource pool for this zone.

shares

Number of FSS CPU shares allocated to the zone.

dataset

The list of datasets delegated to the non-global zone from the global zone. All datasets must be zfs filesystem names which are different from the mountpoint.

inherit

The list of directories that the zone inherits from the global zone. All directories must be fully qualified.

Parameters

The following parameters are available in the zone type.

name

namevar

The name of the zone.

id

The numerical ID of the zone. This number is autogenerated and cannot be changed.

clone

Instead of installing the zone, clone it from another zone. If the zone root resides on a zfs file system, a snapshot will be used to create the clone; if it resides on a ufs filesystem, a copy of the zone will be used. The zone from which you clone must not be running.

sysidcfg

%{The text to go into the sysidcfg file when the zone is first booted. The best way is to use a template:

# $confdir/modules/site/templates/sysidcfg.erb
system_locale=en_US
timezone=GMT
terminal=xterms
security_policy=NONE
root_password=<%= password %>
timeserver=localhost
name_service=DNS {domain_name=<%= domain %> name_server=<%= nameserver %>}
network_interface=primary {hostname=<%= realhostname %>
  ip_address=<%= ip %>
  netmask=<%= netmask %>
  protocol_ipv6=no
  default_route=<%= defaultroute %>}
nfs4_domain=dynamic

And then call that:

zone { 'myzone':
  ip           => 'bge0:192.168.0.23',
  sysidcfg     => template('site/sysidcfg.erb'),
  path         => '/opt/zones/myzone',
  realhostname => 'fully.qualified.domain.name',
}

The sysidcfg only matters on the first booting of the zone, so Puppet only checks for it at that time.}

create_args

Arguments to the zonecfg create command. This can be used to create branded zones.

install_args

Arguments to the zoneadm install command. This can be used to create branded zones.

realhostname

The actual hostname of the zone.

Changelog

All notable changes to this project will be documented in this file.

Release 0.1.0

Features

Bugfixes

Known Issues