Skip to content

Commit

Permalink
reference
Browse files Browse the repository at this point in the history
  • Loading branch information
stjmt committed Jul 31, 2024
1 parent 40e08b4 commit 0bcaa59
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
17 changes: 13 additions & 4 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@

### Data types

* [`Elasticsearch::Multipath`](#Elasticsearch--Multipath)
* [`Elasticsearch::Status`](#Elasticsearch--Status)
* [`Elasticsearch::Multipath`](#Elasticsearch--Multipath): Elasticsearch datadir multipath type
* [`Elasticsearch::Status`](#Elasticsearch--Status): Elasticsearch service status type

## Classes

Expand Down Expand Up @@ -144,6 +144,7 @@ The following parameters are available in the `elasticsearch` class:
* [`oss`](#-elasticsearch--oss)
* [`package_dir`](#-elasticsearch--package_dir)
* [`package_dl_timeout`](#-elasticsearch--package_dl_timeout)
* [`package_hold`](#-elasticsearch--package_hold)
* [`package_name`](#-elasticsearch--package_name)
* [`package_provider`](#-elasticsearch--package_provider)
* [`package_url`](#-elasticsearch--package_url)
Expand Down Expand Up @@ -508,6 +509,14 @@ Data type: `Integer`
For http, https, and ftp downloads, you may set how long the exec resource
may take.

##### <a name="-elasticsearch--package_hold"></a>`package_hold`

Data type: `Boolean`

Set to hold to tell Debian apt/Solaris pkg to hold the package version.

Default value: `false`

##### <a name="-elasticsearch--package_name"></a>`package_name`

Data type: `String`
Expand Down Expand Up @@ -3237,13 +3246,13 @@ Returns: `Any` String

### <a name="Elasticsearch--Multipath"></a>`Elasticsearch::Multipath`

The Elasticsearch::Multipath data type.
Elasticsearch datadir multipath type

Alias of `Variant[Array[Stdlib::Absolutepath], Stdlib::Absolutepath]`

### <a name="Elasticsearch--Status"></a>`Elasticsearch::Status`

The Elasticsearch::Status data type.
Elasticsearch service status type

Alias of `Enum['enabled', 'disabled', 'running', 'unmanaged']`

1 change: 1 addition & 0 deletions types/multipath.pp
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# Elasticsearch datadir multipath type
type Elasticsearch::Multipath = Variant[Array[Stdlib::Absolutepath], Stdlib::Absolutepath]
1 change: 1 addition & 0 deletions types/status.pp
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# Elasticsearch service status type
type Elasticsearch::Status = Enum['enabled', 'disabled', 'running', 'unmanaged']

0 comments on commit 0bcaa59

Please sign in to comment.