From 53def3428dfae9d5d5a106f1c60e9e6422ce12f3 Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Fri, 15 Dec 2023 12:36:04 +0100 Subject: [PATCH] Regenerate REFERENCE.md --- REFERENCE.md | 77 ++++++++++++++++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 29 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 7de7135..f4adc81 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,31 +1,32 @@ # Reference + ## Table of Contents -**Classes** +### Classes * [`spiped`](#spiped): Installs spiped -**Defined types** +### Defined types -_Public Defined types_ +#### Public Defined types -* [`spiped::tunnel::client`](#spipedtunnelclient): Creates and manages the client side of a spiped tunnel. -* [`spiped::tunnel::server`](#spipedtunnelserver): Creates and manages the server side of a spiped tunnel. +* [`spiped::tunnel::client`](#spiped--tunnel--client): Creates and manages the client side of a spiped tunnel. +* [`spiped::tunnel::server`](#spiped--tunnel--server): Creates and manages the server side of a spiped tunnel. -_Private Defined types_ +#### Private Defined types -* `spiped::tunnel`: +* `spiped::tunnel` ## Classes -### spiped +### `spiped` Installs spiped * **See also** -https://www.tarsnap.com/spiped.html + * https://www.tarsnap.com/spiped.html #### Examples @@ -39,9 +40,11 @@ class { 'spiped': #### Parameters -The following parameters are available in the `spiped` class. +The following parameters are available in the `spiped` class: + +* [`package_source`](#-spiped--package_source) -##### `package_source` +##### `package_source` Data type: `Optional[String[1]]` @@ -51,7 +54,7 @@ Default value: `undef` ## Defined types -### spiped::tunnel::client +### `spiped::tunnel::client` Creates and manages the client side of a spiped tunnel. @@ -70,15 +73,23 @@ spiped::tunnel::client { 'redis': #### Parameters -The following parameters are available in the `spiped::tunnel::client` defined type. +The following parameters are available in the `spiped::tunnel::client` defined type: -##### `secret` +* [`secret`](#-spiped--tunnel--client--secret) +* [`source_socket_file`](#-spiped--tunnel--client--source_socket_file) +* [`source_host`](#-spiped--tunnel--client--source_host) +* [`source_port`](#-spiped--tunnel--client--source_port) +* [`target_socket_file`](#-spiped--tunnel--client--target_socket_file) +* [`target_host`](#-spiped--tunnel--client--target_host) +* [`target_port`](#-spiped--tunnel--client--target_port) + +##### `secret` Data type: `Variant[Sensitive[String[1]],String[1]]` An arbitrarily-long shared symmetric key. For full strength encryption, this string should contain 256 bits or more of entropy. -##### `source_socket_file` +##### `source_socket_file` Data type: `Optional[Stdlib::Unixpath]` @@ -86,7 +97,7 @@ Unix domain socket file on which spiped should listen for incoming connections. Default value: `undef` -##### `source_host` +##### `source_host` Data type: `Optional[Stdlib::Host]` @@ -94,7 +105,7 @@ hostname or IP address that spiped should listen on. If specified, `source_port` Default value: `undef` -##### `source_port` +##### `source_port` Data type: `Optional[Stdlib::Port]` @@ -102,7 +113,7 @@ TCP port that spiped should listen on. Used in conjuction with `source_host`. Default value: `undef` -##### `target_socket_file` +##### `target_socket_file` Data type: `Optional[Stdlib::Unixpath]` @@ -110,7 +121,7 @@ Unix domain socket file to which spiped should connect. If specified, `target_ho Default value: `undef` -##### `target_host` +##### `target_host` Data type: `Optional[Stdlib::Host]` @@ -118,7 +129,7 @@ hostname or IP address that spiped should connect to. If specified, `target_port Default value: `undef` -##### `target_port` +##### `target_port` Data type: `Optional[Stdlib::Port]` @@ -126,7 +137,7 @@ TCP port that spiped should connect to. Default value: `undef` -### spiped::tunnel::server +### `spiped::tunnel::server` Creates and manages the server side of a spiped tunnel. @@ -145,15 +156,23 @@ spiped::tunnel::server { 'redis': #### Parameters -The following parameters are available in the `spiped::tunnel::server` defined type. +The following parameters are available in the `spiped::tunnel::server` defined type: + +* [`secret`](#-spiped--tunnel--server--secret) +* [`source_socket_file`](#-spiped--tunnel--server--source_socket_file) +* [`source_host`](#-spiped--tunnel--server--source_host) +* [`source_port`](#-spiped--tunnel--server--source_port) +* [`target_socket_file`](#-spiped--tunnel--server--target_socket_file) +* [`target_host`](#-spiped--tunnel--server--target_host) +* [`target_port`](#-spiped--tunnel--server--target_port) -##### `secret` +##### `secret` Data type: `Variant[Sensitive[String[1]],String[1]]` An arbitrarily-long shared symmetric key. For full strength encryption, this string should contain 256 bits or more of entropy. -##### `source_socket_file` +##### `source_socket_file` Data type: `Optional[Stdlib::Unixpath]` @@ -161,7 +180,7 @@ Unix domain socket file on which spiped should listen for incoming connections. Default value: `undef` -##### `source_host` +##### `source_host` Data type: `Optional[Stdlib::Host]` @@ -169,7 +188,7 @@ hostname or IP address that spiped should listen on. If specified, `source_port` Default value: `undef` -##### `source_port` +##### `source_port` Data type: `Optional[Stdlib::Port]` @@ -177,7 +196,7 @@ TCP port that spiped should listen on. Used in conjuction with `source_host`. Default value: `undef` -##### `target_socket_file` +##### `target_socket_file` Data type: `Optional[Stdlib::Unixpath]` @@ -185,7 +204,7 @@ Unix domain socket file to which spiped should connect. If specified, `target_ho Default value: `undef` -##### `target_host` +##### `target_host` Data type: `Optional[Stdlib::Host]` @@ -193,7 +212,7 @@ hostname or IP address that spiped should connect to. If specified, `target_port Default value: `undef` -##### `target_port` +##### `target_port` Data type: `Optional[Stdlib::Port]`