Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
275 changes: 274 additions & 1 deletion REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* [`knot::records::defaults::srv`](#knot--records--defaults--srv): defaults for srv records
* [`knot::records::defaults::tlsa`](#knot--records--defaults--tlsa): defaults for tlsa records
* [`knot::records::defaults::webserver`](#knot--records--defaults--webserver): default values for knot::records::webserver
* [`knot::records::defaults::xmpp`](#knot--records--defaults--xmpp): default settings for knot::records::xmpp
* [`knot::records::sshfp::export`](#knot--records--sshfp--export): export sshfp keys for inclusion in dns
* [`knot::records::sshfp::import`](#knot--records--sshfp--import): import exported sshfp records

Expand All @@ -26,6 +27,7 @@
* [`knot::records::srv`](#knot--records--srv): add srv records
* [`knot::records::tlsa`](#knot--records--tlsa): add tlsa records
* [`knot::records::webserver`](#knot--records--webserver): add webserver dns records to the domain
* [`knot::records::xmpp`](#knot--records--xmpp): add srv records

### Resource types

Expand Down Expand Up @@ -586,7 +588,6 @@ Example:
'target_port' => 443,
'target' => 'autodiscover.hostname.com'
}
default from knot::records::defaults::mail

Default value: `[]`

Expand Down Expand Up @@ -858,6 +859,118 @@ tlsa service records to create (using define knot::records::tlsa)

Default value: `[{ 'port' => 443, 'proto' => 'tcp' }]`

### <a name="knot--records--defaults--xmpp"></a>`knot::records::defaults::xmpp`

default settings for knot::records::xmpp

#### Parameters

The following parameters are available in the `knot::records::defaults::xmpp` class:

* [`xmpp_client`](#-knot--records--defaults--xmpp--xmpp_client)
* [`xmpp_client_service`](#-knot--records--defaults--xmpp--xmpp_client_service)
* [`xmpps_client`](#-knot--records--defaults--xmpp--xmpps_client)
* [`xmpps_client_service`](#-knot--records--defaults--xmpp--xmpps_client_service)
* [`xmpp_server`](#-knot--records--defaults--xmpp--xmpp_server)
* [`xmpp_server_service`](#-knot--records--defaults--xmpp--xmpp_server_service)
* [`xmpps_server`](#-knot--records--defaults--xmpp--xmpps_server)
* [`xmpps_server_service`](#-knot--records--defaults--xmpp--xmpps_server_service)
* [`txt_records`](#-knot--records--defaults--xmpp--txt_records)
* [`tlsa`](#-knot--records--defaults--xmpp--tlsa)
* [`ttl`](#-knot--records--defaults--xmpp--ttl)

##### <a name="-knot--records--defaults--xmpp--xmpp_client"></a>`xmpp_client`

Data type: `Array`

srv setting for SRV record of xmpp_client
if not explicitly set { target => $dest_server } will be added.

Default value: `[{ 'priority' => 0, 'weight' => 5, 'target_port' => 5222 }]`

##### <a name="-knot--records--defaults--xmpp--xmpp_client_service"></a>`xmpp_client_service`

Data type: `Array[Knot::Record::Service]`

Array of services for xmpp_client.

Default value: `[{ 'port' => 'xmpp-client', 'proto' => 'tcp' }]`

##### <a name="-knot--records--defaults--xmpp--xmpps_client"></a>`xmpps_client`

Data type: `Array`

srv setting for SRV record of xmpps_client
if not explicitly set { target => $dest_server } will be added.

Default value: `[{ 'priority' => 0, 'weight' => 5, 'target_port' => 5223 }]`

##### <a name="-knot--records--defaults--xmpp--xmpps_client_service"></a>`xmpps_client_service`

Data type: `Array[Knot::Record::Service]`

Array of services for xmpps_client.

Default value: `[{ 'port' => 'xmpps-client', 'proto' => 'tcp' }]`

##### <a name="-knot--records--defaults--xmpp--xmpp_server"></a>`xmpp_server`

Data type: `Array`

srv setting for SRV record of xmpp_server
if not explicitly set { target => $dest_server } will be added.

Default value: `[{ 'priority' => 0, 'weight' => 5, 'target_port' => 5269 }]`

##### <a name="-knot--records--defaults--xmpp--xmpp_server_service"></a>`xmpp_server_service`

Data type: `Array[Knot::Record::Service]`

Array of services for xmpp_server.

Default value: `[{ 'port' => 'xmpp-server', 'proto' => 'tcp' }]`

##### <a name="-knot--records--defaults--xmpp--xmpps_server"></a>`xmpps_server`

Data type: `Array`

srv setting for SRV record of xmpps_server
if not explicitly set { target => $dest_server } will be added.

Default value: `[{ 'priority' => 0, 'weight' => 5, 'target_port' => 5270 }]`

##### <a name="-knot--records--defaults--xmpp--xmpps_server_service"></a>`xmpps_server_service`

Data type: `Array[Knot::Record::Service]`

Array of services for xmpps_server.

Default value: `[{ 'port' => 'xmpps-server', 'proto' => 'tcp' }]`

##### <a name="-knot--records--defaults--xmpp--txt_records"></a>`txt_records`

Data type: `Array[String[1]]`

add _xmppconnect txt records.

Default value: `[]`

##### <a name="-knot--records--defaults--xmpp--tlsa"></a>`tlsa`

Data type: `Array[Knot::Record::Tlsa]`

tlsa records to create (using define knot::records::tlsa)

Default value: `[]`

##### <a name="-knot--records--defaults--xmpp--ttl"></a>`ttl`

Data type: `Integer`

the time to live (used for all records)

Default value: `3600`

### <a name="knot--records--sshfp--export"></a>`knot::records::sshfp::export`

export sshfp keys for inclusion in dns
Expand Down Expand Up @@ -2484,6 +2597,166 @@ default from knot::records::defaults::webserver (port 443, tcp)

Default value: `undef`

### <a name="knot--records--xmpp"></a>`knot::records::xmpp`

default values can be configured in the class
knot::records::defaults::srv which is included
here (eg in hiera).

#### Parameters

The following parameters are available in the `knot::records::xmpp` defined type:

* [`dest_server`](#-knot--records--xmpp--dest_server)
* [`rname`](#-knot--records--xmpp--rname)
* [`target_zone`](#-knot--records--xmpp--target_zone)
* [`xmpp_client`](#-knot--records--xmpp--xmpp_client)
* [`xmpp_client_service`](#-knot--records--xmpp--xmpp_client_service)
* [`xmpps_client`](#-knot--records--xmpp--xmpps_client)
* [`xmpps_client_service`](#-knot--records--xmpp--xmpps_client_service)
* [`xmpp_server`](#-knot--records--xmpp--xmpp_server)
* [`xmpp_server_service`](#-knot--records--xmpp--xmpp_server_service)
* [`xmpps_server`](#-knot--records--xmpp--xmpps_server)
* [`xmpps_server_service`](#-knot--records--xmpp--xmpps_server_service)
* [`ttl`](#-knot--records--xmpp--ttl)
* [`txt_records`](#-knot--records--xmpp--txt_records)
* [`tlsa`](#-knot--records--xmpp--tlsa)
* [`tlsa_service`](#-knot--records--xmpp--tlsa_service)

##### <a name="-knot--records--xmpp--dest_server"></a>`dest_server`

Data type: `String[1]`

the destination xmpp server

##### <a name="-knot--records--xmpp--rname"></a>`rname`

Data type: `Optional[String[1]]`

the hostname to add

Default value: `undef`

##### <a name="-knot--records--xmpp--target_zone"></a>`target_zone`

Data type: `Optional[String[1]]`

the target zone to add the records

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpp_client"></a>`xmpp_client`

Data type: `Optional[Array]`

srv setting for SRV record of xmpp_client
if not explicitly set { target => $dest_server } will be added.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpp_client_service"></a>`xmpp_client_service`

Data type: `Optional[Array[Knot::Record::Service]]`

Array of services for xmpp_client.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpps_client"></a>`xmpps_client`

Data type: `Optional[Array]`

srv setting for SRV record of xmpps_client
if not explicitly set { target => $dest_server } will be added.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpps_client_service"></a>`xmpps_client_service`

Data type: `Optional[Array[Knot::Record::Service]]`

Array of services for xmpps_client.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpp_server"></a>`xmpp_server`

Data type: `Optional[Array]`

srv setting for SRV record of xmpp_server
if not explicitly set { target => $dest_server } will be added.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpp_server_service"></a>`xmpp_server_service`

Data type: `Optional[Array[Knot::Record::Service]]`

Array of services for xmpp_server.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpps_server"></a>`xmpps_server`

Data type: `Optional[Array]`

srv setting for SRV record of xmpps_server
if not explicitly set { target => $dest_server } will be added.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--xmpps_server_service"></a>`xmpps_server_service`

Data type: `Optional[Array[Knot::Record::Service]]`

Array of services for xmpps_server.
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--ttl"></a>`ttl`

Data type: `Optional[Integer]`

the time to live (used for all records)
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--txt_records"></a>`txt_records`

Data type: `Optional[Array[String[1]]]`

add _xmppconnect txt records.
remark: deprecated but ...

Default value: `undef`

##### <a name="-knot--records--xmpp--tlsa"></a>`tlsa`

Data type: `Optional[Array[Knot::Record::Tlsa]]`

tlsa records to create (using define knot::records::tlsa)
default from knot::records::defaults::xmpp

Default value: `undef`

##### <a name="-knot--records--xmpp--tlsa_service"></a>`tlsa_service`

Data type: `Optional[Array[Knot::Record::Service]]`

tlsa services to create tlsa records for (using define knot::records::tlsa)
defaults to the target ports of $xmpps_server + $xmpps_client

Default value: `undef`

## Resource types

### <a name="knot_record"></a>`knot_record`
Expand Down
1 change: 0 additions & 1 deletion manifests/records/defaults/mail.pp
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
# 'target_port' => 443,
# 'target' => 'autodiscover.hostname.com'
# }
# default from knot::records::defaults::mail
# @param autoconfig
# target to config for autconfig (eg. Thunderbird)
# a CNAME record is created
Expand Down
43 changes: 43 additions & 0 deletions manifests/records/defaults/xmpp.pp
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# @summary default settings for knot::records::xmpp
#
# @param xmpp_client
# srv setting for SRV record of xmpp_client
# if not explicitly set { target => $dest_server } will be added.
# @param xmpp_client_service
# Array of services for xmpp_client.
# @param xmpps_client
# srv setting for SRV record of xmpps_client
# if not explicitly set { target => $dest_server } will be added.
# @param xmpps_client_service
# Array of services for xmpps_client.
# @param xmpp_server
# srv setting for SRV record of xmpp_server
# if not explicitly set { target => $dest_server } will be added.
# @param xmpp_server_service
# Array of services for xmpp_server.
# @param xmpps_server
# srv setting for SRV record of xmpps_server
# if not explicitly set { target => $dest_server } will be added.
# @param xmpps_server_service
# Array of services for xmpps_server.
# @param txt_records
# add _xmppconnect txt records.
# @param tlsa
# tlsa records to create (using define knot::records::tlsa)
# @param ttl
# the time to live (used for all records)
#
class knot::records::defaults::xmpp (
Array $xmpp_client = [{ 'priority' => 0, 'weight' => 5, 'target_port' => 5222 }],
Array[Knot::Record::Service] $xmpp_client_service = [{ 'port' => 'xmpp-client', 'proto' => 'tcp' }],
Array $xmpps_client = [{ 'priority' => 0, 'weight' => 5, 'target_port' => 5223 }],
Array[Knot::Record::Service] $xmpps_client_service = [{ 'port' => 'xmpps-client', 'proto' => 'tcp' }],
Array $xmpp_server = [{ 'priority' => 0, 'weight' => 5, 'target_port' => 5269 }],
Array[Knot::Record::Service] $xmpp_server_service = [{ 'port' => 'xmpp-server', 'proto' => 'tcp' }],
Array $xmpps_server = [{ 'priority' => 0, 'weight' => 5, 'target_port' => 5270 }],
Array[Knot::Record::Service] $xmpps_server_service = [{ 'port' => 'xmpps-server', 'proto' => 'tcp' }],
Array[Knot::Record::Tlsa] $tlsa = [],
Array[String[1]] $txt_records = [],
Integer $ttl = 3600,
) {
}
Loading
Loading