Skip to content

Latest commit

 

History

History
166 lines (93 loc) · 3.73 KB

REFERENCE.md

File metadata and controls

166 lines (93 loc) · 3.73 KB

Reference

Table of Contents

Classes

  • gnupg: == Class: gnupg Manage gnupg and public key entries === Parameters [package_ensure] Remove or install the s3tools package. Possible va
  • gnupg::install
  • gnupg::params: PRIVATE CLASS: do not use directly

Resource types

  • gnupg_key: Manage PGP public keys with GnuPG

Classes

gnupg

== Class: gnupg

Manage gnupg and public key entries

=== Parameters

[package_ensure] Remove or install the s3tools package. Possible values present or absent, however most of modern Linux distros relays on gnupg so you shouldn't remove the package

[package_name] name of the package usually gnupg/gnupg2 depends of the distro

=== Examples

include gnupg

=== Authors

Dejan Golja dejan@golja.org

Parameters

The following parameters are available in the gnupg class:

package_ensure

Data type: Any

Default value: $gnupg::params::package_ensure

package_name

Data type: Any

Default value: $gnupg::params::package_name

gnupg::install

The gnupg::install class.

gnupg::params

PRIVATE CLASS: do not use directly

Resource types

gnupg_key

Manage PGP public keys with GnuPG

Properties

The following properties are available in the gnupg_key type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the gnupg_key type.

gnupg_home

The gnupg home directory. Overrides the default user's homedir.

Default value: false

key_content

Key content. The result of exporting the key using ASCII armor. Can be either a public or private key.

key_id

Key ID. Usually the traditional 8-character key ID. Also accepted the long more accurate (but less convenient) 16-character key ID.

key_server

PGP key server from where to retrieve the public key

key_source

A source file containing PGP key. Values can be URIs pointing to remote files, or fully qualified paths to files available on the local system.

The available URI schemes are puppet, https, http and file. Puppet URIs will retrieve files from Puppet's built-in file server, and are usually formatted as:

puppet:///modules/name_of_module/filename

key_type

Valid values: public, private, both

The type of the key(s) being managed.

Default value: public

name

namevar

This attribute is currently used as a system-wide primary key - namevar and therefore has to be unique.

provider

The specific backend to use for this gnupg_key resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

proxy

Set the proxy to use for HTTP and HKP keyservers.

user

The user account in which the PGP public key should be installed. Usually it's stored in HOME/.gnupg/ dir