Skip to content

Commit

Permalink
Regenerate REFERENCE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bastelfreak committed Dec 15, 2023
1 parent 0000627 commit 53def34
Showing 1 changed file with 48 additions and 29 deletions.
77 changes: 48 additions & 29 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## 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
### <a name="spiped"></a>`spiped`

Installs spiped

* **See also**
https://www.tarsnap.com/spiped.html
* https://www.tarsnap.com/spiped.html

#### Examples

Expand All @@ -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`
##### <a name="-spiped--package_source"></a>`package_source`

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

Expand All @@ -51,7 +54,7 @@ Default value: `undef`

## Defined types

### spiped::tunnel::client
### <a name="spiped--tunnel--client"></a>`spiped::tunnel::client`

Creates and manages the client side of a spiped tunnel.

Expand All @@ -70,63 +73,71 @@ 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)

##### <a name="-spiped--tunnel--client--secret"></a>`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`
##### <a name="-spiped--tunnel--client--source_socket_file"></a>`source_socket_file`

Data type: `Optional[Stdlib::Unixpath]`

Unix domain socket file on which spiped should listen for incoming connections. If specified, `source_host` and `source_port` should not be used.

Default value: `undef`

##### `source_host`
##### <a name="-spiped--tunnel--client--source_host"></a>`source_host`

Data type: `Optional[Stdlib::Host]`

hostname or IP address that spiped should listen on. If specified, `source_port` is also required.

Default value: `undef`

##### `source_port`
##### <a name="-spiped--tunnel--client--source_port"></a>`source_port`

Data type: `Optional[Stdlib::Port]`

TCP port that spiped should listen on. Used in conjuction with `source_host`.

Default value: `undef`

##### `target_socket_file`
##### <a name="-spiped--tunnel--client--target_socket_file"></a>`target_socket_file`

Data type: `Optional[Stdlib::Unixpath]`

Unix domain socket file to which spiped should connect. If specified, `target_host` and `target_port` should not be used.

Default value: `undef`

##### `target_host`
##### <a name="-spiped--tunnel--client--target_host"></a>`target_host`

Data type: `Optional[Stdlib::Host]`

hostname or IP address that spiped should connect to. If specified, `target_port` is also required.

Default value: `undef`

##### `target_port`
##### <a name="-spiped--tunnel--client--target_port"></a>`target_port`

Data type: `Optional[Stdlib::Port]`

TCP port that spiped should connect to.

Default value: `undef`

### spiped::tunnel::server
### <a name="spiped--tunnel--server"></a>`spiped::tunnel::server`

Creates and manages the server side of a spiped tunnel.

Expand All @@ -145,55 +156,63 @@ 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`
##### <a name="-spiped--tunnel--server--secret"></a>`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`
##### <a name="-spiped--tunnel--server--source_socket_file"></a>`source_socket_file`

Data type: `Optional[Stdlib::Unixpath]`

Unix domain socket file on which spiped should listen for incoming connections. If specified, `source_host` and `source_port` should not be used.

Default value: `undef`

##### `source_host`
##### <a name="-spiped--tunnel--server--source_host"></a>`source_host`

Data type: `Optional[Stdlib::Host]`

hostname or IP address that spiped should listen on. If specified, `source_port` is also required.

Default value: `undef`

##### `source_port`
##### <a name="-spiped--tunnel--server--source_port"></a>`source_port`

Data type: `Optional[Stdlib::Port]`

TCP port that spiped should listen on. Used in conjuction with `source_host`.

Default value: `undef`

##### `target_socket_file`
##### <a name="-spiped--tunnel--server--target_socket_file"></a>`target_socket_file`

Data type: `Optional[Stdlib::Unixpath]`

Unix domain socket file to which spiped should connect. If specified, `target_host` and `target_port` should not be used.

Default value: `undef`

##### `target_host`
##### <a name="-spiped--tunnel--server--target_host"></a>`target_host`

Data type: `Optional[Stdlib::Host]`

hostname or IP address that spiped should connect to. If specified, `target_port` is also required.

Default value: `undef`

##### `target_port`
##### <a name="-spiped--tunnel--server--target_port"></a>`target_port`

Data type: `Optional[Stdlib::Port]`

Expand Down

0 comments on commit 53def34

Please sign in to comment.