README.config
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9# or http://www.opensolaris.org/os/licensing.
10# See the License for the specific language governing permissions
11# and limitations under the License.
12#
13# When distributing Covered Code, include this CDDL HEADER in each
14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21
22#
23# Copyright 2007 Sun Microsystems, Inc. All rights reserved.
24# Use is subject to license terms.
25# The configX.cfg files describe both the dataset hierarchy to
26# be created but also the initial source values for the datasets
27# properties, i.e. whether they should be left with their default values
28# or set locally.
29#
30# Format for this file is as follows:
31# <dataset name> <dataset type> <inital property setting>
32#
33# <dataset name> - must be the full dataset name
34#
35# <dataset type> - recognised types are POOL, CTR and FS
36#
37#
38# <initial property setting> - can have one of the following
39# values:
40#
41# default property values are left unchanged
42#
43# local property values are set locally
44#
45# - property values are left unchanged (has the
46# same effect as 'default' but is used to indicate
47# that the property 'source' field may be 'inherited
48# from..' depending on the actions further up the
49# dataset hierarchy.
50#
51#
52# The configuration below creates a three tier dataset layout, consisting
53# of a pool, container and filesystem.
54#
55# The top tier pool's properties being set locally, and the two
56# lower tier properties each inheriting their values from the next tier
57# up.
58#
59TESTPOOL POOL local
60TESTPOOL/TESTCTR CTR -
61TESTPOOL/TESTCTR/TESTFS1 FS -
62
README.state
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9# or http://www.opensolaris.org/os/licensing.
10# See the License for the specific language governing permissions
11# and limitations under the License.
12#
13# When distributing Covered Code, include this CDDL HEADER in each
14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21
22#
23# Copyright 2007 Sun Microsystems, Inc. All rights reserved.
24# Use is subject to license terms.
25# For every configX.cfg file there must be a corresponding stateX.cfg
26# file. The state file both drives the operations to be performed on the
27# dataset hierarchy which has been specified by the corresponding
28# configX.cfg file, and also specifies the expected state of the
29# properties after the operation has been completed.
30#
31# The format of the file is:
32# <target dataset>:<command>
33# <property source before command> <property src after command>
34# <property source before command> <property src after command>
35# .... ....
36# .... ....
37#
38# <target dataset> - dataset upon which the <command> is to be executed. Can
39# be any of the datasets specified in the corresponding
40# configX.cfg file. If no command is to be executed
41# then must be set to '-'
42#
43#
44# <command> - command to be executed upon the specified dataset.
45# Currently the only supported commands are 'inherit'
46# or 'inherit -r'. If no command is to be executed,
47# then must be set to '-'.
48#
49# <property src before command>
50# - the 'source' (as reported in 'zfs get') for the
51# the properties before <command> is executed. This
52# can be 'default', 'local' or the name of a dataset
53# from which the property is inherited. (The code
54# automatically adds in the 'inherited from..' part
55# of the string when doing the check.
56#
57# This field is for informational purposes only, to
58# aid the user in seeing how the changes trickle down
59# the data hierarchy.
60#
61# <property src after command>
62# - the expected value of the 'source' field after the
63# <command> has been executed on the <target dataset>.
64# As above can be 'default', 'local', or the dataset
65# from which the property is inherited.
66#
67# Two important things to note:
68# 1) there must be a <property src..> line corresponding to each dataset
69# line specified in the configX.cfg file.
70#
71#
72# 2) There can be as many <command>/<property src> blocks as desired, but
73# there must be at least one, and the effect of each block is cumulative
74# (i.e. the properties are not reset back to their default values between
75# each block. If that is desired then each block must be placed in its
76# own state file with its own corresponding configX.cfg file).
77#
78#
79# Below are two sample <command>/<property src> blocks.
80#
81# The first simply verifies that the properties on the top level dataset
82# were set locally, and that the middle and bottom datasets properties
83# were inherited from the top level pool (called TESTPOOL). Note the '-:-'
84# which means that no command is to be executed, but simply that the
85# properties settings are to be verified.
86#
87-:-
88#
89local local
90TESTPOOL TESTPOOL
91TESTPOOL TESTPOOL
92#
93#
94# The block below describes the expected state of the properties after
95# an 'inherit -r' command has been run on the top level pool (called
96# TESTPOOL).
97#
98TESTPOOL:inherit -r
99#
100local default
101TESTPOOL default
102TESTPOOL default
103