summaryrefslogtreecommitdiffstats
path: root/schemas/bundle.xsd
blob: 4a11a1d1b6b453bae0f11407b0af607a3b6a7d1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:py="http://genshi.edgewall.org/" xml:lang="en">

  <xsd:annotation>
    <xsd:documentation>
      bundle schema for bcfg2
      Narayan Desai, Argonne National Laboratory
    </xsd:documentation>
  </xsd:annotation>

  <xsd:import namespace="http://www.w3.org/XML/1998/namespace"
              schemaLocation="xml.xsd"/>
  <xsd:import namespace="http://genshi.edgewall.org/"
              schemaLocation="genshi.xsd"/>

  <xsd:include schemaLocation="atom.xsd"/>
  <xsd:include schemaLocation="pathentry.xsd"/>
  <xsd:include schemaLocation="rules.xsd"/>
  <xsd:include schemaLocation="types.xsd"/>
  <xsd:include schemaLocation="servicetype.xsd"/>

  <xsd:group name="bundleElements">
    <xsd:choice>
      <xsd:group ref="py:genshiElements"/>
      <xsd:element name='Package' type='PackageStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract implementation of a Package entry.  The full
            specification will be generated by a plugin such as
            Packages.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='Path' type='PathEntry'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract implementation of a Path entry.  The entry will
            be handled by a Generator plugin, like Cfg or Rules.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='Service' type='StructureEntry'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract implementation of a Service entry.  The full
            specification will be included in Rules.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='Action' type='StructureEntry'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract implementation of an Action entry.  The full
            specification will be included in Rules.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='POSIXUser' type='StructureEntry'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract description of a POSIXUser entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='POSIXGroup' type='StructureEntry'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract description of a POSIXGroup entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SEBoolean' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux boolean entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SEPort' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux port entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SEFcontext' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux file context ("fcontext") entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SENode' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux node entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SELogin' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux login entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SEUser' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux user entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SEInterface' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux interface entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SEPermissive' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux permissive domain entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='SEModule' type='SELinuxStructure'>
        <xsd:annotation>
          <xsd:documentation>
            Abstract SELinux module entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundPackage' type='PackageType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of a software package to be managed.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundPath' type='PathType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of a filesystem path to be handled
            by the POSIX driver.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundService' type='ServiceType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of a system service to be managed.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundAction' type='ActionType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of a command to be run.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSEBoolean' type='SEBooleanType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux boolean entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSEPort' type='SEPortType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux port entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSEFcontext' type='SEFcontextType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux file context entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSENode' type='SENodeType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux node entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSELogin' type='SELoginType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux login entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSEUser' type='SEUserType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux user entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSEInterface' type='SEInterfaceType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux interface entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSEPermissive' type='SEPermissiveType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux permissive domain entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundSEModule' type='SEModuleType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of an SELinux module entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundPOSIXUser' type='POSIXUserType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of a POSIXUser entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='BoundPOSIXGroup' type='POSIXGroupType'>
        <xsd:annotation>
          <xsd:documentation>
            Fully bound description of a POSIXGroup entry.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='Group' type='BundlerGroupType'>
        <xsd:annotation>
          <xsd:documentation>
            Elements within Group tags only apply to clients that are
            members of that group (or vice-versa; see #element_negate
            below)
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='Client' type='BundlerGroupType'>
        <xsd:annotation>
          <xsd:documentation>
            Elements within Client tags only apply to the named client
            (or vice-versa; see #element_negate below)
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='Bundle' type='BundleType'>
        <xsd:annotation>
          <xsd:documentation>
            Nesting Bundle tags is allowed in order to support
            XInclude within Bundles.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name='RequiredBundle' type='RequiredBundleType'>
        <xsd:annotation>
          <xsd:documentation>
            Nesting Bundle tags to specify dependencies to other bundles.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
    </xsd:choice>
  </xsd:group>

  <xsd:complexType name='BundlerGroupType'>
    <xsd:annotation>
      <xsd:documentation>
        A **BundlerGroupType** is a tag used to provide logic.  Child
        entries of a BundlerGroupType tag only apply to machines that
        match the condition specified -- either membership in a group,
        or a matching client name.
        :xml:attribute:`BundlerGroupType:negate` can be set to negate
        the sense of the match.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:choice minOccurs='0' maxOccurs='unbounded'>
      <xsd:group ref="bundleElements"/>
    </xsd:choice>
    <xsd:attribute type='xsd:string' name='name' use='required'>
      <xsd:annotation>
        <xsd:documentation>
          The group name
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='negate'>
      <xsd:annotation>
        <xsd:documentation>
          Negate the sense of this group or client; i.e., entries
          within this tag are only used on clients that are not
          members of the group, or that have hostnames that do not
          match.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attributeGroup ref="py:genshiAttrs"/>
  </xsd:complexType>

  <xsd:complexType name='RequiredBundleType'>
    <xsd:attribute type='xsd:string' name='name' use='required'>
      <xsd:annotation>
        <xsd:documentation>
          The name of the required bundle.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:boolean' name='inherit_modification'>
      <xsd:annotation>
        <xsd:documentation>
          Specify how to handle modifications in the required
          bundle. You can either ignore the modifications (this
          is the default) or you can inherit the modifications
          so that Services in the current Bundle are restarted
          if the required Bundle is modified.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attributeGroup ref="py:genshiAttrs"/>
  </xsd:complexType>

  <xsd:complexType name='BundleType'>
    <xsd:choice minOccurs='0' maxOccurs='unbounded'>
      <xsd:group ref="bundleElements"/>
    </xsd:choice>
    <xsd:attribute type='xsd:string' name='description'>
      <xsd:annotation>
        <xsd:documentation>
          Freeform description of the bundle.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:boolean' name='independent'>
      <xsd:annotation>
        <xsd:documentation>
          If set to ``true``, indicates that the bundle is a
          collection of independent entries, and that service restarts
          and modified actions should not be performed.  See
          :ref:`server-plugins-structures-bundler-magic` for more.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='name'>
      <xsd:annotation>
        <xsd:documentation>
          **Deprecated.** The name of the bundle.  If present, this
          must match the bundle filename, minus the extension.
          Specifying the name explicitly is deprecated.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='version'>
      <xsd:annotation>
        <xsd:documentation>
          Bundle schema version.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:anyURI' name='origin'>
      <xsd:annotation>
        <xsd:documentation>
          URL of master version (for common repo)
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='revision'>
      <xsd:annotation>
        <xsd:documentation>
          Master version control revision.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="lax_decryption" type="xsd:boolean">
      <xsd:annotation>
        <xsd:documentation>
          Override the global lax_decryption setting in
          ``bcfg2.conf``.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attributeGroup ref="py:genshiAttrs"/>
    <xsd:attribute ref="xml:base"/>
  </xsd:complexType>

  <xsd:element name='Bundle' type='BundleType'>
    <xsd:annotation>
      <xsd:documentation>
        A bundle describes a group of inter-dependent configuration
        entries, such as the combination of packages, configuration
        files, and service activations that comprise typical Unix
        daemons. Bundles are used to add groups of configuration
        entries to the inventory of client configurations, as opposed
        to describing particular versions of those entries. For
        example, a bundle could say that the configuration file
        ``/etc/passwd`` should be included in a configuration, but
        will not describe the particular version of ``/etc/passwd``
        that a given client will receive.
      </xsd:documentation>
    </xsd:annotation>
  </xsd:element>
</xsd:schema>