Skip to content
This repository has been archived by the owner on Sep 12, 2020. It is now read-only.

Commit

Permalink
document classes and defined types
Browse files Browse the repository at this point in the history
  • Loading branch information
tobru committed Apr 21, 2016
1 parent 09202c7 commit 334b08d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,12 @@ with git.

## Reference

### Classes

#### Public Classes

* `knot`: Installs and configures Knot in your environment.

All configuration is passed to `init.pp`:

[*manage_package_repo*]
Expand Down Expand Up @@ -349,6 +355,17 @@ All configuration is passed to `init.pp`:
Default: {}.
Creates signing policies. See https://www.knot-dns.cz/docs/2.0/html/man_keymgr.html#policy-commands

#### Private Classes

* `knot::install`: Manages the APT repo and installs Knot
* `knot::config`: Writes the Knot configuration files and prepares DNSSEC things
* `knot::service`: Manages the Knot system service

### Defined Types

* `knot::signing_policy`: Adds signing policy using `keymgr`
* `knot::zone_policy`: Adds zone policy using `keymgr`

## Testing

There are rspec-puppet tests available. To run them you first need to install all
Expand Down

0 comments on commit 334b08d

Please sign in to comment.