puppet-masterless 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 682169b63eab3d891e86b9fc6132e9825b20d9f5
4
- data.tar.gz: 3279bdb87fa815b546a23090248781c05c0f4dc2
3
+ metadata.gz: 7a17d62d001e6f74d9c4aede2a2007e342c63d10
4
+ data.tar.gz: 678a49091781147b49262a8626b3a7ccb893a7a4
5
5
  SHA512:
6
- metadata.gz: cbd29e8b824afa0448cfb7574340be0ba30b8aa5ec95692686cdc1fe23f96f4a1f937bac8361af327298080230ffb0596270bd69112f09025ab41457a0726a55
7
- data.tar.gz: f9cfa98d18f4127270ed7eebb8c8f033eeea74be08f95404751884a406347f47cfdb656675c080dfdb768a66eb5954ef01f4bd5eec38cd60f1ef694fb9e94331
6
+ metadata.gz: 3c6c5c2851a6e2b168bc7be6055836785c49fe5d3a3745e1e98d765b94068203309411418418d2362a79591c9581f52e2304614b140c551f5a265e5fc2922245
7
+ data.tar.gz: 7d0ebcd084a6c8c0ffe3eb1552c973f2088618a9a7360cff5d9279ab2e33071f98fd0dcfa4b9d2b7f45c3f746cb59fa2ccd7cfbb7c8563e597ea1f52387c0a59
data/LICENSE.md ADDED
@@ -0,0 +1,675 @@
1
+ ### GNU GENERAL PUBLIC LICENSE
2
+
3
+ Version 3, 29 June 2007
4
+
5
+ Copyright (C) 2007 Free Software Foundation, Inc.
6
+ <http://fsf.org/>
7
+
8
+ Everyone is permitted to copy and distribute verbatim copies of this
9
+ license document, but changing it is not allowed.
10
+
11
+ ### Preamble
12
+
13
+ The GNU General Public License is a free, copyleft license for
14
+ software and other kinds of works.
15
+
16
+ The licenses for most software and other practical works are designed
17
+ to take away your freedom to share and change the works. By contrast,
18
+ the GNU General Public License is intended to guarantee your freedom
19
+ to share and change all versions of a program--to make sure it remains
20
+ free software for all its users. We, the Free Software Foundation, use
21
+ the GNU General Public License for most of our software; it applies
22
+ also to any other work released this way by its authors. You can apply
23
+ it to your programs, too.
24
+
25
+ When we speak of free software, we are referring to freedom, not
26
+ price. Our General Public Licenses are designed to make sure that you
27
+ have the freedom to distribute copies of free software (and charge for
28
+ them if you wish), that you receive source code or can get it if you
29
+ want it, that you can change the software or use pieces of it in new
30
+ free programs, and that you know you can do these things.
31
+
32
+ To protect your rights, we need to prevent others from denying you
33
+ these rights or asking you to surrender the rights. Therefore, you
34
+ have certain responsibilities if you distribute copies of the
35
+ software, or if you modify it: responsibilities to respect the freedom
36
+ of others.
37
+
38
+ For example, if you distribute copies of such a program, whether
39
+ gratis or for a fee, you must pass on to the recipients the same
40
+ freedoms that you received. You must make sure that they, too, receive
41
+ or can get the source code. And you must show them these terms so they
42
+ know their rights.
43
+
44
+ Developers that use the GNU GPL protect your rights with two steps:
45
+ (1) assert copyright on the software, and (2) offer you this License
46
+ giving you legal permission to copy, distribute and/or modify it.
47
+
48
+ For the developers' and authors' protection, the GPL clearly explains
49
+ that there is no warranty for this free software. For both users' and
50
+ authors' sake, the GPL requires that modified versions be marked as
51
+ changed, so that their problems will not be attributed erroneously to
52
+ authors of previous versions.
53
+
54
+ Some devices are designed to deny users access to install or run
55
+ modified versions of the software inside them, although the
56
+ manufacturer can do so. This is fundamentally incompatible with the
57
+ aim of protecting users' freedom to change the software. The
58
+ systematic pattern of such abuse occurs in the area of products for
59
+ individuals to use, which is precisely where it is most unacceptable.
60
+ Therefore, we have designed this version of the GPL to prohibit the
61
+ practice for those products. If such problems arise substantially in
62
+ other domains, we stand ready to extend this provision to those
63
+ domains in future versions of the GPL, as needed to protect the
64
+ freedom of users.
65
+
66
+ Finally, every program is threatened constantly by software patents.
67
+ States should not allow patents to restrict development and use of
68
+ software on general-purpose computers, but in those that do, we wish
69
+ to avoid the special danger that patents applied to a free program
70
+ could make it effectively proprietary. To prevent this, the GPL
71
+ assures that patents cannot be used to render the program non-free.
72
+
73
+ The precise terms and conditions for copying, distribution and
74
+ modification follow.
75
+
76
+ ### TERMS AND CONDITIONS
77
+
78
+ #### 0. Definitions.
79
+
80
+ "This License" refers to version 3 of the GNU General Public License.
81
+
82
+ "Copyright" also means copyright-like laws that apply to other kinds
83
+ of works, such as semiconductor masks.
84
+
85
+ "The Program" refers to any copyrightable work licensed under this
86
+ License. Each licensee is addressed as "you". "Licensees" and
87
+ "recipients" may be individuals or organizations.
88
+
89
+ To "modify" a work means to copy from or adapt all or part of the work
90
+ in a fashion requiring copyright permission, other than the making of
91
+ an exact copy. The resulting work is called a "modified version" of
92
+ the earlier work or a work "based on" the earlier work.
93
+
94
+ A "covered work" means either the unmodified Program or a work based
95
+ on the Program.
96
+
97
+ To "propagate" a work means to do anything with it that, without
98
+ permission, would make you directly or secondarily liable for
99
+ infringement under applicable copyright law, except executing it on a
100
+ computer or modifying a private copy. Propagation includes copying,
101
+ distribution (with or without modification), making available to the
102
+ public, and in some countries other activities as well.
103
+
104
+ To "convey" a work means any kind of propagation that enables other
105
+ parties to make or receive copies. Mere interaction with a user
106
+ through a computer network, with no transfer of a copy, is not
107
+ conveying.
108
+
109
+ An interactive user interface displays "Appropriate Legal Notices" to
110
+ the extent that it includes a convenient and prominently visible
111
+ feature that (1) displays an appropriate copyright notice, and (2)
112
+ tells the user that there is no warranty for the work (except to the
113
+ extent that warranties are provided), that licensees may convey the
114
+ work under this License, and how to view a copy of this License. If
115
+ the interface presents a list of user commands or options, such as a
116
+ menu, a prominent item in the list meets this criterion.
117
+
118
+ #### 1. Source Code.
119
+
120
+ The "source code" for a work means the preferred form of the work for
121
+ making modifications to it. "Object code" means any non-source form of
122
+ a work.
123
+
124
+ A "Standard Interface" means an interface that either is an official
125
+ standard defined by a recognized standards body, or, in the case of
126
+ interfaces specified for a particular programming language, one that
127
+ is widely used among developers working in that language.
128
+
129
+ The "System Libraries" of an executable work include anything, other
130
+ than the work as a whole, that (a) is included in the normal form of
131
+ packaging a Major Component, but which is not part of that Major
132
+ Component, and (b) serves only to enable use of the work with that
133
+ Major Component, or to implement a Standard Interface for which an
134
+ implementation is available to the public in source code form. A
135
+ "Major Component", in this context, means a major essential component
136
+ (kernel, window system, and so on) of the specific operating system
137
+ (if any) on which the executable work runs, or a compiler used to
138
+ produce the work, or an object code interpreter used to run it.
139
+
140
+ The "Corresponding Source" for a work in object code form means all
141
+ the source code needed to generate, install, and (for an executable
142
+ work) run the object code and to modify the work, including scripts to
143
+ control those activities. However, it does not include the work's
144
+ System Libraries, or general-purpose tools or generally available free
145
+ programs which are used unmodified in performing those activities but
146
+ which are not part of the work. For example, Corresponding Source
147
+ includes interface definition files associated with source files for
148
+ the work, and the source code for shared libraries and dynamically
149
+ linked subprograms that the work is specifically designed to require,
150
+ such as by intimate data communication or control flow between those
151
+ subprograms and other parts of the work.
152
+
153
+ The Corresponding Source need not include anything that users can
154
+ regenerate automatically from other parts of the Corresponding Source.
155
+
156
+ The Corresponding Source for a work in source code form is that same
157
+ work.
158
+
159
+ #### 2. Basic Permissions.
160
+
161
+ All rights granted under this License are granted for the term of
162
+ copyright on the Program, and are irrevocable provided the stated
163
+ conditions are met. This License explicitly affirms your unlimited
164
+ permission to run the unmodified Program. The output from running a
165
+ covered work is covered by this License only if the output, given its
166
+ content, constitutes a covered work. This License acknowledges your
167
+ rights of fair use or other equivalent, as provided by copyright law.
168
+
169
+ You may make, run and propagate covered works that you do not convey,
170
+ without conditions so long as your license otherwise remains in force.
171
+ You may convey covered works to others for the sole purpose of having
172
+ them make modifications exclusively for you, or provide you with
173
+ facilities for running those works, provided that you comply with the
174
+ terms of this License in conveying all material for which you do not
175
+ control copyright. Those thus making or running the covered works for
176
+ you must do so exclusively on your behalf, under your direction and
177
+ control, on terms that prohibit them from making any copies of your
178
+ copyrighted material outside their relationship with you.
179
+
180
+ Conveying under any other circumstances is permitted solely under the
181
+ conditions stated below. Sublicensing is not allowed; section 10 makes
182
+ it unnecessary.
183
+
184
+ #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
185
+
186
+ No covered work shall be deemed part of an effective technological
187
+ measure under any applicable law fulfilling obligations under article
188
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
189
+ similar laws prohibiting or restricting circumvention of such
190
+ measures.
191
+
192
+ When you convey a covered work, you waive any legal power to forbid
193
+ circumvention of technological measures to the extent such
194
+ circumvention is effected by exercising rights under this License with
195
+ respect to the covered work, and you disclaim any intention to limit
196
+ operation or modification of the work as a means of enforcing, against
197
+ the work's users, your or third parties' legal rights to forbid
198
+ circumvention of technological measures.
199
+
200
+ #### 4. Conveying Verbatim Copies.
201
+
202
+ You may convey verbatim copies of the Program's source code as you
203
+ receive it, in any medium, provided that you conspicuously and
204
+ appropriately publish on each copy an appropriate copyright notice;
205
+ keep intact all notices stating that this License and any
206
+ non-permissive terms added in accord with section 7 apply to the code;
207
+ keep intact all notices of the absence of any warranty; and give all
208
+ recipients a copy of this License along with the Program.
209
+
210
+ You may charge any price or no price for each copy that you convey,
211
+ and you may offer support or warranty protection for a fee.
212
+
213
+ #### 5. Conveying Modified Source Versions.
214
+
215
+ You may convey a work based on the Program, or the modifications to
216
+ produce it from the Program, in the form of source code under the
217
+ terms of section 4, provided that you also meet all of these
218
+ conditions:
219
+
220
+ - a) The work must carry prominent notices stating that you modified
221
+ it, and giving a relevant date.
222
+ - b) The work must carry prominent notices stating that it is
223
+ released under this License and any conditions added under
224
+ section 7. This requirement modifies the requirement in section 4
225
+ to "keep intact all notices".
226
+ - c) You must license the entire work, as a whole, under this
227
+ License to anyone who comes into possession of a copy. This
228
+ License will therefore apply, along with any applicable section 7
229
+ additional terms, to the whole of the work, and all its parts,
230
+ regardless of how they are packaged. This License gives no
231
+ permission to license the work in any other way, but it does not
232
+ invalidate such permission if you have separately received it.
233
+ - d) If the work has interactive user interfaces, each must display
234
+ Appropriate Legal Notices; however, if the Program has interactive
235
+ interfaces that do not display Appropriate Legal Notices, your
236
+ work need not make them do so.
237
+
238
+ A compilation of a covered work with other separate and independent
239
+ works, which are not by their nature extensions of the covered work,
240
+ and which are not combined with it such as to form a larger program,
241
+ in or on a volume of a storage or distribution medium, is called an
242
+ "aggregate" if the compilation and its resulting copyright are not
243
+ used to limit the access or legal rights of the compilation's users
244
+ beyond what the individual works permit. Inclusion of a covered work
245
+ in an aggregate does not cause this License to apply to the other
246
+ parts of the aggregate.
247
+
248
+ #### 6. Conveying Non-Source Forms.
249
+
250
+ You may convey a covered work in object code form under the terms of
251
+ sections 4 and 5, provided that you also convey the machine-readable
252
+ Corresponding Source under the terms of this License, in one of these
253
+ ways:
254
+
255
+ - a) Convey the object code in, or embodied in, a physical product
256
+ (including a physical distribution medium), accompanied by the
257
+ Corresponding Source fixed on a durable physical medium
258
+ customarily used for software interchange.
259
+ - b) Convey the object code in, or embodied in, a physical product
260
+ (including a physical distribution medium), accompanied by a
261
+ written offer, valid for at least three years and valid for as
262
+ long as you offer spare parts or customer support for that product
263
+ model, to give anyone who possesses the object code either (1) a
264
+ copy of the Corresponding Source for all the software in the
265
+ product that is covered by this License, on a durable physical
266
+ medium customarily used for software interchange, for a price no
267
+ more than your reasonable cost of physically performing this
268
+ conveying of source, or (2) access to copy the Corresponding
269
+ Source from a network server at no charge.
270
+ - c) Convey individual copies of the object code with a copy of the
271
+ written offer to provide the Corresponding Source. This
272
+ alternative is allowed only occasionally and noncommercially, and
273
+ only if you received the object code with such an offer, in accord
274
+ with subsection 6b.
275
+ - d) Convey the object code by offering access from a designated
276
+ place (gratis or for a charge), and offer equivalent access to the
277
+ Corresponding Source in the same way through the same place at no
278
+ further charge. You need not require recipients to copy the
279
+ Corresponding Source along with the object code. If the place to
280
+ copy the object code is a network server, the Corresponding Source
281
+ may be on a different server (operated by you or a third party)
282
+ that supports equivalent copying facilities, provided you maintain
283
+ clear directions next to the object code saying where to find the
284
+ Corresponding Source. Regardless of what server hosts the
285
+ Corresponding Source, you remain obligated to ensure that it is
286
+ available for as long as needed to satisfy these requirements.
287
+ - e) Convey the object code using peer-to-peer transmission,
288
+ provided you inform other peers where the object code and
289
+ Corresponding Source of the work are being offered to the general
290
+ public at no charge under subsection 6d.
291
+
292
+ A separable portion of the object code, whose source code is excluded
293
+ from the Corresponding Source as a System Library, need not be
294
+ included in conveying the object code work.
295
+
296
+ A "User Product" is either (1) a "consumer product", which means any
297
+ tangible personal property which is normally used for personal,
298
+ family, or household purposes, or (2) anything designed or sold for
299
+ incorporation into a dwelling. In determining whether a product is a
300
+ consumer product, doubtful cases shall be resolved in favor of
301
+ coverage. For a particular product received by a particular user,
302
+ "normally used" refers to a typical or common use of that class of
303
+ product, regardless of the status of the particular user or of the way
304
+ in which the particular user actually uses, or expects or is expected
305
+ to use, the product. A product is a consumer product regardless of
306
+ whether the product has substantial commercial, industrial or
307
+ non-consumer uses, unless such uses represent the only significant
308
+ mode of use of the product.
309
+
310
+ "Installation Information" for a User Product means any methods,
311
+ procedures, authorization keys, or other information required to
312
+ install and execute modified versions of a covered work in that User
313
+ Product from a modified version of its Corresponding Source. The
314
+ information must suffice to ensure that the continued functioning of
315
+ the modified object code is in no case prevented or interfered with
316
+ solely because modification has been made.
317
+
318
+ If you convey an object code work under this section in, or with, or
319
+ specifically for use in, a User Product, and the conveying occurs as
320
+ part of a transaction in which the right of possession and use of the
321
+ User Product is transferred to the recipient in perpetuity or for a
322
+ fixed term (regardless of how the transaction is characterized), the
323
+ Corresponding Source conveyed under this section must be accompanied
324
+ by the Installation Information. But this requirement does not apply
325
+ if neither you nor any third party retains the ability to install
326
+ modified object code on the User Product (for example, the work has
327
+ been installed in ROM).
328
+
329
+ The requirement to provide Installation Information does not include a
330
+ requirement to continue to provide support service, warranty, or
331
+ updates for a work that has been modified or installed by the
332
+ recipient, or for the User Product in which it has been modified or
333
+ installed. Access to a network may be denied when the modification
334
+ itself materially and adversely affects the operation of the network
335
+ or violates the rules and protocols for communication across the
336
+ network.
337
+
338
+ Corresponding Source conveyed, and Installation Information provided,
339
+ in accord with this section must be in a format that is publicly
340
+ documented (and with an implementation available to the public in
341
+ source code form), and must require no special password or key for
342
+ unpacking, reading or copying.
343
+
344
+ #### 7. Additional Terms.
345
+
346
+ "Additional permissions" are terms that supplement the terms of this
347
+ License by making exceptions from one or more of its conditions.
348
+ Additional permissions that are applicable to the entire Program shall
349
+ be treated as though they were included in this License, to the extent
350
+ that they are valid under applicable law. If additional permissions
351
+ apply only to part of the Program, that part may be used separately
352
+ under those permissions, but the entire Program remains governed by
353
+ this License without regard to the additional permissions.
354
+
355
+ When you convey a copy of a covered work, you may at your option
356
+ remove any additional permissions from that copy, or from any part of
357
+ it. (Additional permissions may be written to require their own
358
+ removal in certain cases when you modify the work.) You may place
359
+ additional permissions on material, added by you to a covered work,
360
+ for which you have or can give appropriate copyright permission.
361
+
362
+ Notwithstanding any other provision of this License, for material you
363
+ add to a covered work, you may (if authorized by the copyright holders
364
+ of that material) supplement the terms of this License with terms:
365
+
366
+ - a) Disclaiming warranty or limiting liability differently from the
367
+ terms of sections 15 and 16 of this License; or
368
+ - b) Requiring preservation of specified reasonable legal notices or
369
+ author attributions in that material or in the Appropriate Legal
370
+ Notices displayed by works containing it; or
371
+ - c) Prohibiting misrepresentation of the origin of that material,
372
+ or requiring that modified versions of such material be marked in
373
+ reasonable ways as different from the original version; or
374
+ - d) Limiting the use for publicity purposes of names of licensors
375
+ or authors of the material; or
376
+ - e) Declining to grant rights under trademark law for use of some
377
+ trade names, trademarks, or service marks; or
378
+ - f) Requiring indemnification of licensors and authors of that
379
+ material by anyone who conveys the material (or modified versions
380
+ of it) with contractual assumptions of liability to the recipient,
381
+ for any liability that these contractual assumptions directly
382
+ impose on those licensors and authors.
383
+
384
+ All other non-permissive additional terms are considered "further
385
+ restrictions" within the meaning of section 10. If the Program as you
386
+ received it, or any part of it, contains a notice stating that it is
387
+ governed by this License along with a term that is a further
388
+ restriction, you may remove that term. If a license document contains
389
+ a further restriction but permits relicensing or conveying under this
390
+ License, you may add to a covered work material governed by the terms
391
+ of that license document, provided that the further restriction does
392
+ not survive such relicensing or conveying.
393
+
394
+ If you add terms to a covered work in accord with this section, you
395
+ must place, in the relevant source files, a statement of the
396
+ additional terms that apply to those files, or a notice indicating
397
+ where to find the applicable terms.
398
+
399
+ Additional terms, permissive or non-permissive, may be stated in the
400
+ form of a separately written license, or stated as exceptions; the
401
+ above requirements apply either way.
402
+
403
+ #### 8. Termination.
404
+
405
+ You may not propagate or modify a covered work except as expressly
406
+ provided under this License. Any attempt otherwise to propagate or
407
+ modify it is void, and will automatically terminate your rights under
408
+ this License (including any patent licenses granted under the third
409
+ paragraph of section 11).
410
+
411
+ However, if you cease all violation of this License, then your license
412
+ from a particular copyright holder is reinstated (a) provisionally,
413
+ unless and until the copyright holder explicitly and finally
414
+ terminates your license, and (b) permanently, if the copyright holder
415
+ fails to notify you of the violation by some reasonable means prior to
416
+ 60 days after the cessation.
417
+
418
+ Moreover, your license from a particular copyright holder is
419
+ reinstated permanently if the copyright holder notifies you of the
420
+ violation by some reasonable means, this is the first time you have
421
+ received notice of violation of this License (for any work) from that
422
+ copyright holder, and you cure the violation prior to 30 days after
423
+ your receipt of the notice.
424
+
425
+ Termination of your rights under this section does not terminate the
426
+ licenses of parties who have received copies or rights from you under
427
+ this License. If your rights have been terminated and not permanently
428
+ reinstated, you do not qualify to receive new licenses for the same
429
+ material under section 10.
430
+
431
+ #### 9. Acceptance Not Required for Having Copies.
432
+
433
+ You are not required to accept this License in order to receive or run
434
+ a copy of the Program. Ancillary propagation of a covered work
435
+ occurring solely as a consequence of using peer-to-peer transmission
436
+ to receive a copy likewise does not require acceptance. However,
437
+ nothing other than this License grants you permission to propagate or
438
+ modify any covered work. These actions infringe copyright if you do
439
+ not accept this License. Therefore, by modifying or propagating a
440
+ covered work, you indicate your acceptance of this License to do so.
441
+
442
+ #### 10. Automatic Licensing of Downstream Recipients.
443
+
444
+ Each time you convey a covered work, the recipient automatically
445
+ receives a license from the original licensors, to run, modify and
446
+ propagate that work, subject to this License. You are not responsible
447
+ for enforcing compliance by third parties with this License.
448
+
449
+ An "entity transaction" is a transaction transferring control of an
450
+ organization, or substantially all assets of one, or subdividing an
451
+ organization, or merging organizations. If propagation of a covered
452
+ work results from an entity transaction, each party to that
453
+ transaction who receives a copy of the work also receives whatever
454
+ licenses to the work the party's predecessor in interest had or could
455
+ give under the previous paragraph, plus a right to possession of the
456
+ Corresponding Source of the work from the predecessor in interest, if
457
+ the predecessor has it or can get it with reasonable efforts.
458
+
459
+ You may not impose any further restrictions on the exercise of the
460
+ rights granted or affirmed under this License. For example, you may
461
+ not impose a license fee, royalty, or other charge for exercise of
462
+ rights granted under this License, and you may not initiate litigation
463
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
464
+ any patent claim is infringed by making, using, selling, offering for
465
+ sale, or importing the Program or any portion of it.
466
+
467
+ #### 11. Patents.
468
+
469
+ A "contributor" is a copyright holder who authorizes use under this
470
+ License of the Program or a work on which the Program is based. The
471
+ work thus licensed is called the contributor's "contributor version".
472
+
473
+ A contributor's "essential patent claims" are all patent claims owned
474
+ or controlled by the contributor, whether already acquired or
475
+ hereafter acquired, that would be infringed by some manner, permitted
476
+ by this License, of making, using, or selling its contributor version,
477
+ but do not include claims that would be infringed only as a
478
+ consequence of further modification of the contributor version. For
479
+ purposes of this definition, "control" includes the right to grant
480
+ patent sublicenses in a manner consistent with the requirements of
481
+ this License.
482
+
483
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
484
+ patent license under the contributor's essential patent claims, to
485
+ make, use, sell, offer for sale, import and otherwise run, modify and
486
+ propagate the contents of its contributor version.
487
+
488
+ In the following three paragraphs, a "patent license" is any express
489
+ agreement or commitment, however denominated, not to enforce a patent
490
+ (such as an express permission to practice a patent or covenant not to
491
+ sue for patent infringement). To "grant" such a patent license to a
492
+ party means to make such an agreement or commitment not to enforce a
493
+ patent against the party.
494
+
495
+ If you convey a covered work, knowingly relying on a patent license,
496
+ and the Corresponding Source of the work is not available for anyone
497
+ to copy, free of charge and under the terms of this License, through a
498
+ publicly available network server or other readily accessible means,
499
+ then you must either (1) cause the Corresponding Source to be so
500
+ available, or (2) arrange to deprive yourself of the benefit of the
501
+ patent license for this particular work, or (3) arrange, in a manner
502
+ consistent with the requirements of this License, to extend the patent
503
+ license to downstream recipients. "Knowingly relying" means you have
504
+ actual knowledge that, but for the patent license, your conveying the
505
+ covered work in a country, or your recipient's use of the covered work
506
+ in a country, would infringe one or more identifiable patents in that
507
+ country that you have reason to believe are valid.
508
+
509
+ If, pursuant to or in connection with a single transaction or
510
+ arrangement, you convey, or propagate by procuring conveyance of, a
511
+ covered work, and grant a patent license to some of the parties
512
+ receiving the covered work authorizing them to use, propagate, modify
513
+ or convey a specific copy of the covered work, then the patent license
514
+ you grant is automatically extended to all recipients of the covered
515
+ work and works based on it.
516
+
517
+ A patent license is "discriminatory" if it does not include within the
518
+ scope of its coverage, prohibits the exercise of, or is conditioned on
519
+ the non-exercise of one or more of the rights that are specifically
520
+ granted under this License. You may not convey a covered work if you
521
+ are a party to an arrangement with a third party that is in the
522
+ business of distributing software, under which you make payment to the
523
+ third party based on the extent of your activity of conveying the
524
+ work, and under which the third party grants, to any of the parties
525
+ who would receive the covered work from you, a discriminatory patent
526
+ license (a) in connection with copies of the covered work conveyed by
527
+ you (or copies made from those copies), or (b) primarily for and in
528
+ connection with specific products or compilations that contain the
529
+ covered work, unless you entered into that arrangement, or that patent
530
+ license was granted, prior to 28 March 2007.
531
+
532
+ Nothing in this License shall be construed as excluding or limiting
533
+ any implied license or other defenses to infringement that may
534
+ otherwise be available to you under applicable patent law.
535
+
536
+ #### 12. No Surrender of Others' Freedom.
537
+
538
+ If conditions are imposed on you (whether by court order, agreement or
539
+ otherwise) that contradict the conditions of this License, they do not
540
+ excuse you from the conditions of this License. If you cannot convey a
541
+ covered work so as to satisfy simultaneously your obligations under
542
+ this License and any other pertinent obligations, then as a
543
+ consequence you may not convey it at all. For example, if you agree to
544
+ terms that obligate you to collect a royalty for further conveying
545
+ from those to whom you convey the Program, the only way you could
546
+ satisfy both those terms and this License would be to refrain entirely
547
+ from conveying the Program.
548
+
549
+ #### 13. Use with the GNU Affero General Public License.
550
+
551
+ Notwithstanding any other provision of this License, you have
552
+ permission to link or combine any covered work with a work licensed
553
+ under version 3 of the GNU Affero General Public License into a single
554
+ combined work, and to convey the resulting work. The terms of this
555
+ License will continue to apply to the part which is the covered work,
556
+ but the special requirements of the GNU Affero General Public License,
557
+ section 13, concerning interaction through a network will apply to the
558
+ combination as such.
559
+
560
+ #### 14. Revised Versions of this License.
561
+
562
+ The Free Software Foundation may publish revised and/or new versions
563
+ of the GNU General Public License from time to time. Such new versions
564
+ will be similar in spirit to the present version, but may differ in
565
+ detail to address new problems or concerns.
566
+
567
+ Each version is given a distinguishing version number. If the Program
568
+ specifies that a certain numbered version of the GNU General Public
569
+ License "or any later version" applies to it, you have the option of
570
+ following the terms and conditions either of that numbered version or
571
+ of any later version published by the Free Software Foundation. If the
572
+ Program does not specify a version number of the GNU General Public
573
+ License, you may choose any version ever published by the Free
574
+ Software Foundation.
575
+
576
+ If the Program specifies that a proxy can decide which future versions
577
+ of the GNU General Public License can be used, that proxy's public
578
+ statement of acceptance of a version permanently authorizes you to
579
+ choose that version for the Program.
580
+
581
+ Later license versions may give you additional or different
582
+ permissions. However, no additional obligations are imposed on any
583
+ author or copyright holder as a result of your choosing to follow a
584
+ later version.
585
+
586
+ #### 15. Disclaimer of Warranty.
587
+
588
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
589
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
590
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
591
+ WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
592
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
593
+ A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
594
+ PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
595
+ DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
596
+ CORRECTION.
597
+
598
+ #### 16. Limitation of Liability.
599
+
600
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
602
+ CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
603
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
604
+ ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
605
+ NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
606
+ LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
607
+ TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
608
+ PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
609
+
610
+ #### 17. Interpretation of Sections 15 and 16.
611
+
612
+ If the disclaimer of warranty and limitation of liability provided
613
+ above cannot be given local legal effect according to their terms,
614
+ reviewing courts shall apply local law that most closely approximates
615
+ an absolute waiver of all civil liability in connection with the
616
+ Program, unless a warranty or assumption of liability accompanies a
617
+ copy of the Program in return for a fee.
618
+
619
+ END OF TERMS AND CONDITIONS
620
+
621
+ ### How to Apply These Terms to Your New Programs
622
+
623
+ If you develop a new program, and you want it to be of the greatest
624
+ possible use to the public, the best way to achieve this is to make it
625
+ free software which everyone can redistribute and change under these
626
+ terms.
627
+
628
+ To do so, attach the following notices to the program. It is safest to
629
+ attach them to the start of each source file to most effectively state
630
+ the exclusion of warranty; and each file should have at least the
631
+ "copyright" line and a pointer to where the full notice is found.
632
+
633
+ <one line to give the program's name and a brief idea of what it does.>
634
+ Copyright (C) <year> <name of author>
635
+
636
+ This program is free software: you can redistribute it and/or modify
637
+ it under the terms of the GNU General Public License as published by
638
+ the Free Software Foundation, either version 3 of the License, or
639
+ (at your option) any later version.
640
+
641
+ This program is distributed in the hope that it will be useful,
642
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
643
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644
+ GNU General Public License for more details.
645
+
646
+ You should have received a copy of the GNU General Public License
647
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
648
+
649
+ Also add information on how to contact you by electronic and paper
650
+ mail.
651
+
652
+ If the program does terminal interaction, make it output a short
653
+ notice like this when it starts in an interactive mode:
654
+
655
+ <program> Copyright (C) <year> <name of author>
656
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
+ This is free software, and you are welcome to redistribute it
658
+ under certain conditions; type `show c' for details.
659
+
660
+ The hypothetical commands \`show w' and \`show c' should show the
661
+ appropriate parts of the General Public License. Of course, your
662
+ program's commands might be different; for a GUI interface, you would
663
+ use an "about box".
664
+
665
+ You should also get your employer (if you work as a programmer) or
666
+ school, if any, to sign a "copyright disclaimer" for the program, if
667
+ necessary. For more information on this, and how to apply and follow
668
+ the GNU GPL, see <http://www.gnu.org/licenses/>.
669
+
670
+ The GNU General Public License does not permit incorporating your
671
+ program into proprietary programs. If your program is a subroutine
672
+ library, you may consider it more useful to permit linking proprietary
673
+ applications with the library. If this is what you want to do, use the
674
+ GNU Lesser General Public License instead of this License. But first,
675
+ please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.
data/README.md ADDED
@@ -0,0 +1,102 @@
1
+ # puppet-masterless
2
+
3
+ This is a small tool designed to help you use Puppet *without* using a
4
+ Puppet Master. It packages a Puppet project as a self-contained shell
5
+ script and optionally executes it on a remote machine via SSH. You can
6
+ think of it like a remote version of the `puppet-apply` command[^1].
7
+
8
+ [^1]: In fact, running `puppet-apply` is exactly what it does in the end.
9
+
10
+ ## Installation
11
+
12
+ ### From RubyGems.org
13
+
14
+ To install from [RubyGems.org][] just run:
15
+
16
+ gem install puppet-masterless
17
+
18
+ [RubyGems.org]: https://rubygems.org/gems/puppet-masterless
19
+
20
+ ### From Source
21
+
22
+ The program is a single Ruby file. To install it from source, simply put
23
+ it somewhere on your PATH and make sure it's executable:
24
+
25
+ install -m 755 bin/puppet-masterless /usr/local/bin/puppet-masterless
26
+
27
+ You can also install its man page, if desired:
28
+
29
+ install -m 644 man/puppet-masterless.1 /usr/local/share/man/man1/puppet-masterless.1
30
+
31
+ Alternatively, you can use [Rake][] to build and install the program as a Gem:
32
+
33
+ rake install:local
34
+
35
+ [rake]: https://ruby.github.io/rake/
36
+
37
+ ## Usage
38
+
39
+ ### Quick Start
40
+
41
+ To package a project, use the `package` command:
42
+
43
+ puppet-masterless package confdir <confdir>
44
+
45
+ To apply a project to a remote host, use the `apply` command:
46
+
47
+ puppet-masterless apply confdir <confdir> to <hostname>
48
+
49
+ In both situations, `<confdir>` should be the base directory of your
50
+ Puppet project. Refer to [Puppet's documentation][confdir] for details
51
+ about how this directory should be organised.
52
+
53
+ [confdir]: https://puppet.com/docs/puppet/4.10/dirs_confdir.html
54
+
55
+ ### Options
56
+
57
+ The program accepts arguments according to a very simple command line
58
+ grammar. To see a summary of the available options and what they
59
+ control, run `puppet-masterless` without any arguments. For full
60
+ documentation, refer to its man page[^2].
61
+
62
+ [^2]: You can view a Gem's man page by installing the [gem-man][]
63
+ extension and running `gem man <gem>`.
64
+
65
+ [gem-man]: https://rubygems.org/gems/gem-man
66
+
67
+ ### Project Layout
68
+
69
+ It's assumed that your Puppet project is laid out something like this:
70
+
71
+ <confdir>
72
+ ├── puppet.conf
73
+ ├── hiera.yaml
74
+ ├── hieradata
75
+ │   └── ...
76
+ ├── manifests
77
+ │   └── ...
78
+ └── modules
79
+ └── ...
80
+
81
+ All of these paths can be overridden by command line arguments, but the
82
+ tool will work best if you use a project structure similar to this one.
83
+
84
+ Most importantly, all paths in your Hiera configuration should be
85
+ relative to the project's root. The following Hiera configuration
86
+ illustrates one way to do this, by explicitly setting `:datadir` to a
87
+ path in your project's `confdir`. This way, `puppet-apply` will only
88
+ consult Hiera data that's included in the package:
89
+
90
+ ---
91
+ :backends:
92
+ - yaml
93
+ :yaml:
94
+ :datadir: "%{settings::confdir}/hieradata"
95
+
96
+ ## Contributing
97
+
98
+ 1. Fork it from <https://gitlab.wgtn.cat-it.co.nz/devtools/puppet-masterless>
99
+ 2. Create a feature branch (`git checkout -b my-new-feature`)
100
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
101
+ 4. Push to the branch (`git push origin my-new-feature`)
102
+ 5. Create a Merge Request at <https://gitlab.wgtn.cat-it.co.nz/devtools/puppet-masterless/merge_requests>
@@ -31,6 +31,7 @@ require 'shellwords'
31
31
  #|
32
32
  #| apply - apply a project to a remote host
33
33
  #| package - package a project as a shell script
34
+ #| help - display manual page
34
35
  #|
35
36
  #| Available arguments:
36
37
  #|
@@ -126,12 +127,25 @@ module PuppetMasterless
126
127
  @hostname ? apply_remote : apply_local
127
128
  end
128
129
 
130
+ def help
131
+ display_manual
132
+ end
133
+
129
134
  private
130
135
 
131
136
  def banner
132
137
  File.read(__FILE__).lines.grep(/^#\|/).map { |s| s.gsub(/^#\| ?/, '') }
133
138
  end
134
139
 
140
+ def display_manual
141
+ manual = File.read(__FILE__).lines.grep(/^#1/).map { |s| s.gsub(/^#1 ?/, '') }
142
+ raise 'No manual entry' if manual.empty?
143
+ i, o = IO.pipe
144
+ o.puts(manual)
145
+ STDIN.reopen(i)
146
+ exec('man', '-l', '/dev/stdin')
147
+ end
148
+
135
149
  def collect_output(args)
136
150
  usage(1) unless args.shift == 'file'
137
151
  @output = args.shift
@@ -210,6 +224,8 @@ begin
210
224
  main.collect(ARGV)
211
225
  main.validate
212
226
  main.apply
227
+ when 'help'
228
+ main.help
213
229
  when '-h', '--help', nil
214
230
  main.usage(0)
215
231
  else
@@ -219,3 +235,212 @@ rescue => e
219
235
  STDERR.puts("Error: #{File.basename($0)}: #{e.message}")
220
236
  exit(1)
221
237
  end
238
+
239
+ #1 .Dd January 5, 2018
240
+ #1 .Dt PUPPET-MASTERLESS 1
241
+ #1 .Os
242
+ #1 .Sh NAME
243
+ #1 .Nm puppet-masterless
244
+ #1 .Nd apply a local puppet project to a remote host
245
+ #1 .Sh SYNOPSIS
246
+ #1 .Nm
247
+ #1 .Ar command
248
+ #1 .Ar [ argument ... ]
249
+ #1 .No [ --
250
+ #1 .Ar puppet-apply argument ...
251
+ #1 .No ]
252
+ #1 .Sh DESCRIPTION
253
+ #1 The
254
+ #1 .Nm
255
+ #1 .No program packages a Puppet project as a self-contained shell script
256
+ #1 .No and optionally executes it on a remote machine via SSH.
257
+ #1 .Pp
258
+ #1 .No Some simple conventions are used to decide what files to include
259
+ #1 .No in the package. For a list of files that will be automatically
260
+ #1 .No included, refer to Sx FILES .
261
+ #1 .Sh COMMANDS
262
+ #1 .Bl -tag -width " "
263
+ #1 .It Cm package
264
+ #1 .No Package a project as a self-contained shell script.
265
+ #1 .It Cm apply
266
+ #1 .No Apply a project to a remote host, or to the local machine if no
267
+ #1 .No hostname is specified with the
268
+ #1 .Cm to No argument.
269
+ #1 .Sh ARGUMENTS
270
+ #1 .Bl -tag -width " "
271
+ #1 .It Cm confdir Aq pathname
272
+ #1 .No Set the root directory of the Puppet project. This value is passed to
273
+ #1 .Fl -confdir
274
+ #1 .No when running
275
+ #1 .Xr puppet-apply 8 .
276
+ #1 .Pp
277
+ #1 .No This argument is required.
278
+ #1 .It Cm manifest Aq filename
279
+ #1 .No Specify the main Puppet manifest to apply. This may be a file or
280
+ #1 .No directory.
281
+ #1 .Pp
282
+ #1 .No Defaults to
283
+ #1 .Dq Ao confdir Ac Ns /manifests
284
+ #1 .No (if that file is present).
285
+ #1 .It Cm hiera_config Aq filename
286
+ #1 .No Specify the Hiera configuration file to use. This value is passed to
287
+ #1 .Fl -hiera_config
288
+ #1 .No when running
289
+ #1 .Xr puppet-apply 8 .
290
+ #1 .Pp
291
+ #1 .No Defaults to
292
+ #1 .Dq Ao confdir Ac Ns /hiera.yaml
293
+ #1 .No (if that file is present).
294
+ #1 .It Cm modulepath Aq pathname
295
+ #1 .No Set the Puppet modules directory. This value is passed to
296
+ #1 .No Fl -modulepath No when running Xr puppet-apply 8 .
297
+ #1 .Pp
298
+ #1 .No Defaults to
299
+ #1 .Dq Ao confdir Ac Ns /modules
300
+ #1 .No (if that file is present).
301
+ #1 .It Cm file Aq filename
302
+ #1 .No Add an arbitrary file or directory to the generated package. This
303
+ #1 .No can be used to include files in non-standard locations.
304
+ #1 .Pp
305
+ #1 .No Directories are added recursively, and this option can be repeated
306
+ #1 .No to include multiple files.
307
+ #1 .It Cm puppet Aq executable
308
+ #1 .No Specify the location of the Xr puppet 8 executable on the remote host.
309
+ #1 .No This is useful when the puppet binary is installed in a directory
310
+ #1 .No that is not on the active user's Ev PATH (for example under
311
+ #1 .Pa /opt/puppetlabs/bin Ns ).
312
+ #1 .Pp
313
+ #1 .No Defaults to
314
+ #1 .Dq puppet .
315
+ #1 .It Cm output file Aq filename
316
+ #1 .No Set the output filename. If not given, a randomly-generated filename in
317
+ #1 .No the current directory is used.
318
+ #1 .Pp
319
+ #1 .No Applies only to the Cm package No command.
320
+ #1 .It Cm sudo Aq executable
321
+ #1 .No Specify the location of the Xr sudo 1 executable on the remote host.
322
+ #1 .No This can also be used to specify an alternative command for
323
+ #1 .No privilege elevation, for example Xr doas 1 .
324
+ #1 .Pp
325
+ #1 .No Applies only to the Cm apply No command.
326
+ #1 .Pp
327
+ #1 .No Defaults to
328
+ #1 .Dq sudo .
329
+ #1 .It Cm as Aq username
330
+ #1 .No Set the name of the user that will run
331
+ #1 .Xr puppet-apply 8 on the remote host.
332
+ #1 .Xr sudo 1 is used to become this user before execution.
333
+ #1 .Pp
334
+ #1 .No Applies only to the Cm apply No command.
335
+ #1 .Pp
336
+ #1 .No Defaults to
337
+ #1 .Dq root .
338
+ #1 .It Cm to Aq hostname
339
+ #1 .No Specify the remote host to provision. If not given, the project will
340
+ #1 .No be applied directly to the local machine (without packaging or SSH).
341
+ #1 .Pp
342
+ #1 .No Applies only to the Cm apply No command.
343
+ #1 .It Cm and , with
344
+ #1 .No These words are ignored. They can be used to make an invocation of
345
+ #1 .No the program read sensibly (or insensibly, as desired).
346
+ #1 .It Cm -- [ Ar argument ... ]
347
+ #1 .No Two dashes indicate the end of program arguments. Any remaining
348
+ #1 .No arguments are passed to
349
+ #1 .Xr puppet-apply 8 verbatim.
350
+ #1 .El
351
+ #1 .Pp
352
+ #1 .No For more information about the
353
+ #1 .Cm confdir ,
354
+ #1 .Cm hiera_config ,
355
+ #1 .Cm manifest , No and
356
+ #1 .Cm modulepath No settings, refer to the following Puppet documentation:
357
+ #1 .Pp
358
+ #1 .Bl -dash -compact -width Ns
359
+ #1 .It
360
+ #1 .Lk https://puppet.com/docs/puppet/4.10/dirs_confdir.html confdir
361
+ #1 .It
362
+ #1 .Lk https://puppet.com/docs/puppet/4.10/hiera_config_yaml_3.html hiera_config
363
+ #1 .It
364
+ #1 .Lk https://puppet.com/docs/puppet/4.10/dirs_manifest.html manifest
365
+ #1 .It
366
+ #1 .Lk https://puppet.com/docs/puppet/4.10/dirs_modulepath.html modulepath
367
+ #1 .El
368
+ #1 .Sh FILES
369
+ #1 .No The following files are automatically included in the package, when
370
+ #1 .No present:
371
+ #1 .Bl -column " "
372
+ #1 .It Ao confdir Ac Ns /puppet.conf Ta - Default Puppet configuration file.
373
+ #1 .It Ao confdir Ac Ns /hiera.yaml Ta - Default hiera configuration file.
374
+ #1 .It Ao confdir Ac Ns /hieradata Ta - Default hiera data directory.
375
+ #1 .It Ao confdir Ac Ns /manifests Ta - Default manifest path.
376
+ #1 .It Ao confdir Ac Ns /modules Ta - Default module path.
377
+ #1 .El
378
+ #1 .Pp
379
+ #1 .No Directories are included recursively.
380
+ #1 .Sh EXIT STATUS
381
+ #1 .Ex -std
382
+ #1 .Sh EXAMPLES
383
+ #1 Apply the Puppet project in
384
+ #1 .Pa ./puppet
385
+ #1 directly to the local machine:
386
+ #1 .Bd -literal -offset indent
387
+ #1 puppet-masterless apply confdir puppet
388
+ #1 .Ed
389
+ #1 .Pp
390
+ #1 .No Apply the
391
+ #1 .Pa site.pp
392
+ #1 .No manifest from the project in
393
+ #1 .Pa ./config
394
+ #1 .No to host 10.0.8.1 as user
395
+ #1 .Dq charlize :
396
+ #1 .Bd -literal -offset indent
397
+ #1 puppet-masterless apply confdir config \\
398
+ #1 with manifest config/manifests/site.pp \\
399
+ #1 to 10.0.8.1 as charlize
400
+ #1 .Ed
401
+ #1 .Pp
402
+ #1 .No Bundle the
403
+ #1 .Pa test
404
+ #1 .No project as a shell script, including a non-standard Hiera configuration
405
+ #1 .No file location and data directory:
406
+ #1 .Bd -literal -offset indent
407
+ #1 puppet-masterless package confdir test \\
408
+ #1 with file hiera and hiera_config hiera/test.yaml
409
+ #1 .Ed
410
+ #1 .Sh CAVEATS
411
+ #1 .No For this program to be useful, Puppet must be installed on the remote host.
412
+ #1 .Pp
413
+ #1 .No This program is only intended to work with Puppet 4.10. \&It may work
414
+ #1 .No with other versions of Puppet, or it may not.
415
+ #1 .Pp
416
+ #1 .No The SSH functionality of this program is intentionally simplistic.
417
+ #1 .No If you need more complex behaviour when connecting to remote machines,
418
+ #1 .No use the
419
+ #1 .Ql package
420
+ #1 .No command in combination with a tool like
421
+ #1 .Xr ansible 1 ,
422
+ #1 .Xr cap 1 or
423
+ #1 .Xr fab 1 .
424
+ #1 .Pp
425
+ #1 .No Very little information is displayed when an error occurs.
426
+ #1 .Sh SECURITY CONSIDERATIONS
427
+ #1 .No The
428
+ #1 .Ql apply
429
+ #1 .No command uses
430
+ #1 .Xr sudo 1
431
+ #1 .No to assume a given user's identity on the remote host, with all of the
432
+ #1 .No security issues that implies.
433
+ #1 .Pp
434
+ #1 .No When applying manifests to a remote machine, any secrets included in the
435
+ #1 .No project will be present on the filesystem for as long as it takes to run
436
+ #1 .Xr puppet-apply 8 .
437
+ #1 .Sh IMPLEMENTATION NOTES
438
+ #1 .Nm
439
+ #1 .No is a Ruby script with no Gem dependencies. \&It should be possible to copy
440
+ #1 .No and run it on any machine with Ruby 1.9 or newer.
441
+ #1 .Sh SEE ALSO
442
+ #1 .Xr puppet 8 ,
443
+ #1 .Xr puppet-apply 8 ,
444
+ #1 .Xr puppet-master 8
445
+ #1 .Sh AUTHORS
446
+ #1 .An Evan Hanson Aq Mt evanh@catalyst.net.nz
@@ -0,0 +1,208 @@
1
+ .Dd January 5, 2018
2
+ .Dt PUPPET-MASTERLESS 1
3
+ .Os
4
+ .Sh NAME
5
+ .Nm puppet-masterless
6
+ .Nd apply a local puppet project to a remote host
7
+ .Sh SYNOPSIS
8
+ .Nm
9
+ .Ar command
10
+ .Ar [ argument ... ]
11
+ .No [ --
12
+ .Ar puppet-apply argument ...
13
+ .No ]
14
+ .Sh DESCRIPTION
15
+ The
16
+ .Nm
17
+ .No program packages a Puppet project as a self-contained shell script
18
+ .No and optionally executes it on a remote machine via SSH.
19
+ .Pp
20
+ .No Some simple conventions are used to decide what files to include
21
+ .No in the package. For a list of files that will be automatically
22
+ .No included, refer to Sx FILES .
23
+ .Sh COMMANDS
24
+ .Bl -tag -width " "
25
+ .It Cm package
26
+ .No Package a project as a self-contained shell script.
27
+ .It Cm apply
28
+ .No Apply a project to a remote host, or to the local machine if no
29
+ .No hostname is specified with the
30
+ .Cm to No argument.
31
+ .Sh ARGUMENTS
32
+ .Bl -tag -width " "
33
+ .It Cm confdir Aq pathname
34
+ .No Set the root directory of the Puppet project. This value is passed to
35
+ .Fl -confdir
36
+ .No when running
37
+ .Xr puppet-apply 8 .
38
+ .Pp
39
+ .No This argument is required.
40
+ .It Cm manifest Aq filename
41
+ .No Specify the main Puppet manifest to apply. This may be a file or
42
+ .No directory.
43
+ .Pp
44
+ .No Defaults to
45
+ .Dq Ao confdir Ac Ns /manifests
46
+ .No (if that file is present).
47
+ .It Cm hiera_config Aq filename
48
+ .No Specify the Hiera configuration file to use. This value is passed to
49
+ .Fl -hiera_config
50
+ .No when running
51
+ .Xr puppet-apply 8 .
52
+ .Pp
53
+ .No Defaults to
54
+ .Dq Ao confdir Ac Ns /hiera.yaml
55
+ .No (if that file is present).
56
+ .It Cm modulepath Aq pathname
57
+ .No Set the Puppet modules directory. This value is passed to
58
+ .No Fl -modulepath No when running Xr puppet-apply 8 .
59
+ .Pp
60
+ .No Defaults to
61
+ .Dq Ao confdir Ac Ns /modules
62
+ .No (if that file is present).
63
+ .It Cm file Aq filename
64
+ .No Add an arbitrary file or directory to the generated package. This
65
+ .No can be used to include files in non-standard locations.
66
+ .Pp
67
+ .No Directories are added recursively, and this option can be repeated
68
+ .No to include multiple files.
69
+ .It Cm puppet Aq executable
70
+ .No Specify the location of the Xr puppet 8 executable on the remote host.
71
+ .No This is useful when the puppet binary is installed in a directory
72
+ .No that is not on the active user's Ev PATH (for example under
73
+ .Pa /opt/puppetlabs/bin Ns ).
74
+ .Pp
75
+ .No Defaults to
76
+ .Dq puppet .
77
+ .It Cm output file Aq filename
78
+ .No Set the output filename. If not given, a randomly-generated filename in
79
+ .No the current directory is used.
80
+ .Pp
81
+ .No Applies only to the Cm package No command.
82
+ .It Cm sudo Aq executable
83
+ .No Specify the location of the Xr sudo 1 executable on the remote host.
84
+ .No This can also be used to specify an alternative command for
85
+ .No privilege elevation, for example Xr doas 1 .
86
+ .Pp
87
+ .No Applies only to the Cm apply No command.
88
+ .Pp
89
+ .No Defaults to
90
+ .Dq sudo .
91
+ .It Cm as Aq username
92
+ .No Set the name of the user that will run
93
+ .Xr puppet-apply 8 on the remote host.
94
+ .Xr sudo 1 is used to become this user before execution.
95
+ .Pp
96
+ .No Applies only to the Cm apply No command.
97
+ .Pp
98
+ .No Defaults to
99
+ .Dq root .
100
+ .It Cm to Aq hostname
101
+ .No Specify the remote host to provision. If not given, the project will
102
+ .No be applied directly to the local machine (without packaging or SSH).
103
+ .Pp
104
+ .No Applies only to the Cm apply No command.
105
+ .It Cm and , with
106
+ .No These words are ignored. They can be used to make an invocation of
107
+ .No the program read sensibly (or insensibly, as desired).
108
+ .It Cm -- [ Ar argument ... ]
109
+ .No Two dashes indicate the end of program arguments. Any remaining
110
+ .No arguments are passed to
111
+ .Xr puppet-apply 8 verbatim.
112
+ .El
113
+ .Pp
114
+ .No For more information about the
115
+ .Cm confdir ,
116
+ .Cm hiera_config ,
117
+ .Cm manifest , No and
118
+ .Cm modulepath No settings, refer to the following Puppet documentation:
119
+ .Pp
120
+ .Bl -dash -compact -width Ns
121
+ .It
122
+ .Lk https://puppet.com/docs/puppet/4.10/dirs_confdir.html confdir
123
+ .It
124
+ .Lk https://puppet.com/docs/puppet/4.10/hiera_config_yaml_3.html hiera_config
125
+ .It
126
+ .Lk https://puppet.com/docs/puppet/4.10/dirs_manifest.html manifest
127
+ .It
128
+ .Lk https://puppet.com/docs/puppet/4.10/dirs_modulepath.html modulepath
129
+ .El
130
+ .Sh FILES
131
+ .No The following files are automatically included in the package, when
132
+ .No present:
133
+ .Bl -column " "
134
+ .It Ao confdir Ac Ns /puppet.conf Ta - Default Puppet configuration file.
135
+ .It Ao confdir Ac Ns /hiera.yaml Ta - Default hiera configuration file.
136
+ .It Ao confdir Ac Ns /hieradata Ta - Default hiera data directory.
137
+ .It Ao confdir Ac Ns /manifests Ta - Default manifest path.
138
+ .It Ao confdir Ac Ns /modules Ta - Default module path.
139
+ .El
140
+ .Pp
141
+ .No Directories are included recursively.
142
+ .Sh EXIT STATUS
143
+ .Ex -std
144
+ .Sh EXAMPLES
145
+ Apply the Puppet project in
146
+ .Pa ./puppet
147
+ directly to the local machine:
148
+ .Bd -literal -offset indent
149
+ puppet-masterless apply confdir puppet
150
+ .Ed
151
+ .Pp
152
+ .No Apply the
153
+ .Pa site.pp
154
+ .No manifest from the project in
155
+ .Pa ./config
156
+ .No to host 10.0.8.1 as user
157
+ .Dq charlize :
158
+ .Bd -literal -offset indent
159
+ puppet-masterless apply confdir config \\
160
+ with manifest config/manifests/site.pp \\
161
+ to 10.0.8.1 as charlize
162
+ .Ed
163
+ .Pp
164
+ .No Bundle the
165
+ .Pa test
166
+ .No project as a shell script, including a non-standard Hiera configuration
167
+ .No file location and data directory:
168
+ .Bd -literal -offset indent
169
+ puppet-masterless package confdir test \\
170
+ with file hiera and hiera_config hiera/test.yaml
171
+ .Ed
172
+ .Sh CAVEATS
173
+ .No For this program to be useful, Puppet must be installed on the remote host.
174
+ .Pp
175
+ .No This program is only intended to work with Puppet 4.10. \&It may work
176
+ .No with other versions of Puppet, or it may not.
177
+ .Pp
178
+ .No The SSH functionality of this program is intentionally simplistic.
179
+ .No If you need more complex behaviour when connecting to remote machines,
180
+ .No use the
181
+ .Ql package
182
+ .No command in combination with a tool like
183
+ .Xr ansible 1 ,
184
+ .Xr cap 1 or
185
+ .Xr fab 1 .
186
+ .Pp
187
+ .No Very little information is displayed when an error occurs.
188
+ .Sh SECURITY CONSIDERATIONS
189
+ .No The
190
+ .Ql apply
191
+ .No command uses
192
+ .Xr sudo 1
193
+ .No to assume a given user's identity on the remote host, with all of the
194
+ .No security issues that implies.
195
+ .Pp
196
+ .No When applying manifests to a remote machine, any secrets included in the
197
+ .No project will be present on the filesystem for as long as it takes to run
198
+ .Xr puppet-apply 8 .
199
+ .Sh IMPLEMENTATION NOTES
200
+ .Nm
201
+ .No is a Ruby script with no Gem dependencies. \&It should be possible to copy
202
+ .No and run it on any machine with Ruby 1.9 or newer.
203
+ .Sh SEE ALSO
204
+ .Xr puppet 8 ,
205
+ .Xr puppet-apply 8 ,
206
+ .Xr puppet-master 8
207
+ .Sh AUTHORS
208
+ .An Evan Hanson Aq Mt evanh@catalyst.net.nz
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: puppet-masterless
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Evan Hanson
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-01-05 00:00:00.000000000 Z
11
+ date: 2018-09-03 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Packages and applies a Puppet project to a remote host.
14
14
  email: evanh@catalyst.net.nz
@@ -17,7 +17,10 @@ executables:
17
17
  extensions: []
18
18
  extra_rdoc_files: []
19
19
  files:
20
+ - LICENSE.md
21
+ - README.md
20
22
  - bin/puppet-masterless
23
+ - man/puppet-masterless.1
21
24
  homepage: https://gitlab.com/catalyst-it/puppet-masterless
22
25
  licenses:
23
26
  - GPLv3