Skip to content

Latest commit

 

History

History
138 lines (77 loc) · 2.76 KB

REFERENCE.md

File metadata and controls

138 lines (77 loc) · 2.76 KB

Reference

Table of Contents

Classes

Public Classes

  • gnupg: Manage gnupg and public key entries

Private Classes

  • gnupg::install: Install the package

Resource types

  • gnupg_key: Manage PGP public keys with GnuPG

Classes

gnupg

Manage gnupg and public key entries

Examples

Basic installation
include gnupg

Parameters

The following parameters are available in the gnupg class:

package_ensure

Data type: String

value passed to ensure param of package resource. if package[gnupg] is already declared in the catalog, the package will not be managed by this module.

package_name

Data type: String

name of the package to ensure supported operating systems have this value populated from hiera

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.

home

Gnupg home directory. Overrides gpg default, typically .gnupg under the user's home directory

Default value: false

key_content

Content of an ASCII armor PGP key

key_id

8, 16, or 40 character version of the key ID

key_server

PGP key server from where to retrieve the public key

key_source

Location of a file containing the PGP key. Values may be a local file path or Puppet supported URL.

key_type

Valid values: public, private, both

type of key(s) being managed

Default value: public

name

namevar

arbitrary catalog unique resource name

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

execute gpg command with this user