Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme to show 'private' and 'public' params as strings #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update readme to show 'private' and 'public' params as strings #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ gnupg_key { 'hkp_server_20BC0A86':
key_id => '20BC0A86',
user => 'root',
key_server => 'hkp://pgp.mit.edu/',
key_type => public,
key_type => 'public',
}
```

Expand All @@ -50,7 +50,7 @@ gnupg_key { 'jenkins_foo_key':
key_id => 'D50582E6',
user => 'foo',
key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
key_type => public,
key_type => 'public',
}
```

Expand All @@ -62,7 +62,19 @@ gnupg_key { 'jenkins_foo_key':
key_id => 'D50582E6',
user => 'foo',
key_source => 'puppet:///modules/gnupg/D50582E6.key',
key_type => public,
key_type => 'public',
}
```

####Add private key D50582E6 from puppet fileserver to user foo

```puppet
gnupg_key { 'jenkins_foo_key':
ensure => present,
key_id => 'D50582E6',
user => 'foo',
key_source => 'puppet:///modules/gnupg/D50582E6.key',
key_type => 'private',
}
```

Expand All @@ -74,7 +86,7 @@ gnupg_key { 'jenkins_foo_key':
key_id => 'D50582E6',
user => 'bar',
key_content => '-----BEGIN BROKEN PUBLIC KEY BLOCK-----...',
key_type => public,
key_type => 'public',
}
```
*Note*: You should use hiera lookup to get the key content
Expand All @@ -86,7 +98,7 @@ gnupg_key {'root_remove':
ensure => absent,
key_id => '20BC0A86',
user => 'root',
key_type => public,
key_type => 'public',
}
```

Expand Down Expand Up @@ -164,7 +176,7 @@ before the gnupg_key resource executes.

#####`key_type`

**OPTIONAL** - key type. Valid values (public|private|both). Default: public
**OPTIONAL** - key type. Valid values ('public'|'private'|'both'). Default: 'public'

PGP key server from where to retrieve the public key. Valid URI schemes are
*http*, *https*, *ldap* and *hkp*.
Expand Down