File: REFERENCE.md

package info (click to toggle)
puppet-module-cirrax-gitolite 1.3.3-2
  • links: PTS
  • area: main
  • in suites: bullseye, sid
  • size: 192 kB
  • sloc: ruby: 69; sh: 10; makefile: 2
file content (650 lines) | stat: -rw-r--r-- 11,500 bytes parent folder | download
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

**Classes**

* [`gitolite`](#gitolite): This class is inherited by setup.pp and admin.pp  It's intention is to have alle the config parameters.  If you only use this class (and the 
* [`gitolite::admin`](#gitoliteadmin): This class manages the gitolite.conf file and prepares to manage the ssh keys with puppet.  do not use this class if you want to use the gito
* [`gitolite::client`](#gitoliteclient): Class to install git
* [`gitolite::ssh_key`](#gitolitessh_key): Generate an SSH authentication key  Key generation for (passwordless) authentication to a remote system.

**Defined types**

* [`gitolite::repo`](#gitoliterepo): this resources defines a git repository you also can use it to define values for a group of repositories (by using an @ in front of the group
* [`gitolite::repos`](#gitoliterepos): this resource defines a group of repos with defaults
* [`gitolite::user`](#gitoliteuser): this resources defines a git user you also can use it to define values for a group of repositories (by using an @ in front of the group name)
* [`gitolite::users`](#gitoliteusers): this resource defines a group of users with defaults

**Resource types**

* [`gitremote`](#gitremote): add a remote to a git repository

## Classes

### gitolite

This class is inherited by setup.pp and admin.pp

It's intention is to have alle the config parameters.

If you only use this class (and the setup), you can still do all admin work
(manage users, permissions etc. throug the git repository
gitolite-admin.git.)

#### Parameters

The following parameters are available in the `gitolite` class.

##### `reporoot`

Data type: `String`

path to the directory where you will store the repositories.
This does not have to be equal to the $users home directory.
defaults to $userhome

Default value: "${userhome}/repositories"

##### `user`

Data type: `String`

the user to host the git repositories
this user needs a home directory to work with gitolite.

##### `userhome`

Data type: `String`

the home directory of the user

##### `user_ensure`

Data type: `Boolean`

if true, $user will be created, if false, you have
to create the user with the homedirectory elsewhere.
defaults to true

Default value: `true`

##### `umask`

Data type: `String`

see the rc file docs for how/why you might change this
defaults to '0077' which gives perms of '0700'

Default value: '0077'

##### `git_config_keys`

Data type: `String`

look for "git-config" in the documentation
default: '.*'

Default value: '.*'

##### `log_extra`

Data type: `Boolean`

set to true for extra log details
default: false

Default value: `false`

##### `log_dest`

Data type: `Array`

array of log destinations.
available values are:
  normal: normal gitolite logs
  syslog: log to syslog
  repo-log: log just the update records to
            gl-log in the bare repo directory
defaults to ['normal']

Default value: ['normal']

##### `roles`

Data type: `Array`

Array of roles to add.
default: ['READERS', 'WRITERS']

Default value: ['READERS', 'WRITERS']

##### `site_info`

Data type: `Boolean`

the 'info' command prints this as additional info
default to false

Default value: `false`

##### `gitolite_hostname`

Data type: `String`

the hostname, to unset, set to false
defaults to $::hostname

Default value: $::hostname

##### `local_code`

Data type: `String`

suggested locations for site-local gitolite code
defaults to '', no site-local code

Default value: ''

##### `additional_gitoliterc`

Data type: `Hash`

hash of additional lines to add on gitolite.rc file
defaults to empty (beware of "' etc ...)
example:
{ 'CACHE' => '"Redis"' }

Default value: {}

##### `commands`

Data type: `Array`

Array of commands and features to enable
defaults to ['help', 'desc', 'info', 'perms' ]

Default value: [
    'help',
    'desc',
    'info',
    'perms',
    'writable',
    'ssh-authkeys',
    'git-config',
    'daemon',
    'gitweb',
  ]

##### `package_ensure`

Data type: `String`

howto ensure the packages to install

Default value: 'present'

##### `packages`

Data type: `Array`

packages to install for gitolite

Default value: []

##### `additional_packages`

Data type: `Array`

any additional packages you like to install

Default value: []

##### `admin_key_source`

Data type: `String`

provide a admin key source (default to false)

Default value: ''

##### `admin_key`

Data type: `String`

admin key (string) (default to false)

Default value: ''

##### `additional_gitoliterc_notrc`

Data type: `Hash`

hash of additional lines to add on gitolite.rc file
after the rc vars
defaults to empty (beware of "' etc ...)
example:
{ '$REF_OR_FILENAME_PATT' => 'qr(^[0-9a-zA-Z][-0-9a-zA-Z._\@/+ :%,]*$)' }

Default value: {}

##### `fetch_cron`

Data type: `Boolean`

if a cronjob should be established to fetch from remote repos
defaults to false

Default value: `false`

### gitolite::admin

This class manages the gitolite.conf file
and prepares to manage the ssh keys with puppet.

do not use this class if you want to use the
gitolite-admin.git repositoy for these tasks.
(you have been warned ! if you use it once,
there is no puppet way back, only manual work
will get you back)

#### Parameters

The following parameters are available in the `gitolite::admin` class.

##### `remove_admin_repo`

Data type: `Boolean`

if true (the default) the repository
gitoline_admin.git will be removed

Default value: `true`

##### `repos`

Data type: `Hash`

a hash of repos, to be defined

Default value: {}

##### `users`

Data type: `Hash`

a hash of users, to be defined

Default value: {}

##### `add_testing_repo`

Data type: `Boolean`

allow RW+ for all users to the testing repo
default: true

Default value: `true`

### gitolite::client

Class to install git

### gitolite::ssh_key

Generate an SSH authentication key

Key generation for (passwordless) authentication to a
remote system.

#### Parameters

The following parameters are available in the `gitolite::ssh_key` class.

##### `filename`

Data type: `String`

Filename (full path) for the key. Required.

##### `type`

Data type: `String`

Type of key, either dsa, ecdsa or rsa. Defaults to rsa.

Default value: 'rsa'

##### `length`

Data type: `Integer`

Key length. Defaults to 2048. See man ssh-keygen for restrictions
regarding non RSA keys.

Default value: 2048

##### `password`

Data type: `String`

Password for the key. Defaults to no password. This is not very secure
as the password is visible in plain text in the puppet manifest and as a
process parameters when creating the key.

Default value: ''

##### `comment`

Data type: `String`

Comment describing the Key. Defaults to "Automatic authentication key for $user on $fqdn".

Default value: 'undef'

##### `user`

Data type: `String`

User who uses this key. This user must have write access to the directory
containing the key. Defaults to "root"

Default value: 'root'

## Defined types

### gitolite::repo

this resources defines a git repository
you also can use it to define values for a group of
repositories (by using an @ in front of the group name)

#### Parameters

The following parameters are available in the `gitolite::repo` defined type.

##### `repos`

Data type: `Array`

an array of repos (or a group of repos ( @blah )
defaults to [ $title ]

Default value: [$title]

##### `comments`

Data type: `Variant[String, Array]`

an array of comments to add defaults to []

Default value: []

##### `rules`

Data type: `Hash`

an array of rules.
a rule has three elements:
permission, refex and user/group
a hash of permissions:
[{ 'RW+' => 'username'}, ... ]

Default value: {}

##### `options`

Data type: `Hash`



Default value: {}

##### `configs`

Data type: `Hash`



Default value: {}

##### `add_configs`

Data type: `Hash`

additional configs, merged with configs

Default value: {}

##### `groups`

Data type: `Array`

an array of groups to append the repos to
the group names can be prefix with an @ sign
(if they are puppet take care of)

Default value: []

##### `order`

Data type: `String`

string, to order the repos
$order will be prefixed with 60 for the grouping section
and 90 for the repo section.
defaults to ''

Default value: ''

##### `description`

Data type: `String`

a description to add to the repo

Default value: ''

##### `hooks`

Data type: `Hash`

hooks to install

Default value: {}

##### `group`

Data type: `String`



Default value: 'root'

##### `remotes`

Data type: `Hash`

Hash of remote repos to sync branches and tags from
defaults to {}
Example:
'upstream' => {
  'url' => 'https://github.com/openstack/puppet-nova'
  'fetches' => [
    'master:master',
    'refs/tags/*:refs/tags/*',
    'refs/heads/stable/*:refs/heads/stable/*',
  ]
}
will update the master branch, all tags and all branches stable/*
from the remote location mentioned in url.

To remove an upstrem you can set ensure to 'absent'
You can set more than one repo to sync from, but it's up to you
to ensure that no conflicts occur !

Default value: {}

### gitolite::repos

this resource defines a group of repos with defaults

#### Parameters

The following parameters are available in the `gitolite::repos` defined type.

##### `defaults`

Data type: `Hash`

defaults for all generated repos

Default value: {}

##### `repos`

Data type: `Hash`

repos to create see gitolite::repo for parameters

Default value: {}

### gitolite::user

this resources defines a git user
you also can use it to define values for a group of
repositories (by using an @ in front of the group name)

#### Parameters

The following parameters are available in the `gitolite::user` defined type.

##### `user`

Data type: `String`

the user name
defaults to $title

Default value: $title

##### `keys`

Data type: `Array`

array of users ssh keys

Default value: []

##### `key_source`

Data type: `String`

a puppet source to fetch key from

Default value: ''

##### `comments`

Data type: `Variant[Array, String]`

an array of comments to add to this section
defaults to []

Default value: []

##### `groups`

Data type: `Array`

an array of groups to append the user to
the group names can be prefix with an @ sign
(if they are puppet take care of)
defaults to []

Default value: []

##### `order`

Data type: `String`

string, to order the repos
$order will be prefixed with 30 for the grouping section
and 20 for the user section.
defaults to ''

Default value: ''

### gitolite::users

this resource defines a group of users with defaults

#### Parameters

The following parameters are available in the `gitolite::users` defined type.

##### `defaults`

Data type: `Hash`

defaults for all generated users

Default value: {}

##### `users`

Data type: `Hash`

users to create see gitolite::user for parameters

Default value: {}

## Resource types

### gitremote

add a remote to a git repository

#### Properties

The following properties are available in the `gitremote` type.

##### `ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

##### `url`

the url of the remote repository

##### `fetches`

Array of fetch definitions

#### Parameters

The following parameters are available in the `gitremote` type.

##### `name`

namevar

the title

##### `remotename`

the name of the remote to create

##### `directory`

the the directory the repository is

##### `confowner`

the the owner of the config file