forked from ghoneycutt/puppet-ssh
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
76 lines (72 loc) · 2.44 KB
/
README
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
ssh
Manages SSH and provides functionality to install public/private keys and authorized_keys files.
# Definition: ssh::authorized_keys
#
# install an authorized key file
#
# Parameters:
# $path - path to where private key should be installed, defaults to /home/$name
# $group - specify group permissions on private key, defaults to $name
# $ensure - should the private key file be 'present' or 'absent', defaults to present
# $key - name of file storing private key, defaults to 'id_rsa'
# $user - used in retrieve_priv_key.erb
# $owner - specify owner permissions on private key, defaults to $name
#
# Actions:
# install an authorized key file
#
# Requires:
# must specify $user
#
# Sample Usage:
# # setup authorized key for post-commit
# ssh::authorized_keys { "puppetreposvn":
# users => [ "puppetreposvn-puppetrepo" ],
# require => Generic::Mkuser[puppetreposvn]
# } # ssh::authorized_keys
# Definition: ssh::public_key
#
# install a public key file
#
# Parameters:
# $path - path to where public key should be installed, defaults to /home/$name/.
# Under the $path directory '.ssh/id_rsa.pub' will be created
# $group - specify group permissions on public key, defaults to $name
# $ensure - should the public key file be 'present' or 'absent', defaults to present
# $owner - specify owner permissions on public key, defaults to $name
#
# Actions:
# install a public key file
#
# Requires:
# file matching $name must exist in modules/ssh/public_keys/
#
# Sample Usage:
# # install public_key for user foo
# ssh::public_key { "foo":
# require => Generic::Mkuser[foo],
# } # ssh::public_key
# Definition: ssh::private_key
#
# install a private ssh key
#
# Parameters:
# $path - path to where private key should be installed, defaults to /home/$name
# $group - specify group permissions on private key, defaults to $name
# $ensure - should the private key file be 'present' or 'absent', defaults to present
# $key - name of file storing private key, defaults to 'id_rsa'
# $user - used in retrieve_priv_key.erb
# $owner - specify owner permissions on private key, defaults to $name
#
# Actions:
# install a private ssh key
#
# Requires:
# must specify $user
#
# Sample Usage:
# # setup private key for post-commit
# ssh::private_key { "puppetreposvn":
# user => "puppetreposvn",
# require => Generic::Mkuser[puppetreposvn]
# } # ssh::private_key