Skip to content

Commit 1175fcc

Browse files
committed
format using puppet-strings style
1 parent accaa4b commit 1175fcc

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

manifests/plugin/dns_ovh.pp

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,36 @@
1-
# == Class: letsencrypt::plugin::dns_ovh
1+
# @summary This class installs and configures the Let's Encrypt dns-ovh plugin.
22
#
3-
# This class installs and configures the Let's Encrypt dns-ovh plugin.
4-
# https://certbot-dns-ovh.readthedocs.io
3+
# @example Basic usage
4+
# class { 'letsencrypt::plugin::dns_ovh':
5+
# endpoint => 'ovh-eu',
6+
# application_key => 'MDAwMDAwMDAwMDAw',
7+
# application_secret => 'MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw',
8+
# consumer_key => 'MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw',
9+
# }
10+
# letsencrypt::certonly { 'foo':
11+
# domains => ['foo.example.com', 'bar.example.com'],
12+
# plugin => 'dns-ovh',
13+
# }
14+
#
15+
# @see https://certbot-dns-ovh.readthedocs.io
516
#
617
# === Parameters:
718
#
8-
# [*endpoint*]
19+
# @param endpoint
920
# Target OVH DNS endpoint.
10-
# [*application_key*]
21+
# @param application_key
1122
# OVH application key.
12-
# [*application_secret*]
23+
# @param application_secret
1324
# DNS OVH application secret.
14-
# [*consumer_key*]
25+
# @param consumer_key
1526
# DNS OVH consumer key.
16-
# [*manage_package*]
27+
# @param propagation_seconds
28+
# DNS OVH propagation seconds (default: 30s)
29+
# @param manage_package
1730
# Manage the plugin package.
18-
# [*package_name*]
31+
# @param package_name
1932
# The name of the package to install when $manage_package is true.
20-
# [*config_dir*]
33+
# @param config_dir
2134
# The path to the configuration directory.
2235
#
2336
class letsencrypt::plugin::dns_ovh (

0 commit comments

Comments
 (0)