File: REFERENCE.md

package info (click to toggle)
puppet-module-voxpupuli-elastic-stack 9.0.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 224 kB
  • sloc: ruby: 142; sh: 10; makefile: 4
file content (83 lines) | stat: -rw-r--r-- 1,822 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# Reference

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

## Table of Contents

### Classes

* [`elastic_stack::repo`](#elastic_stack--repo): Set up the package repository for Elastic Stack components

## Classes

### <a name="elastic_stack--repo"></a>`elastic_stack::repo`

elastic_stack::repo

#### Examples

##### 

```puppet
include elastic_stack::repo
```

#### Parameters

The following parameters are available in the `elastic_stack::repo` class:

* [`oss`](#-elastic_stack--repo--oss)
* [`prerelease`](#-elastic_stack--repo--prerelease)
* [`priority`](#-elastic_stack--repo--priority)
* [`proxy`](#-elastic_stack--repo--proxy)
* [`version`](#-elastic_stack--repo--version)
* [`base_repo_url`](#-elastic_stack--repo--base_repo_url)

##### <a name="-elastic_stack--repo--oss"></a>`oss`

Data type: `Boolean`

Whether to use the purely open source (i.e., bundled without X-Pack) repository

Default value: `false`

##### <a name="-elastic_stack--repo--prerelease"></a>`prerelease`

Data type: `Boolean`

Whether to use a repo for prerelease versions, like "6.0.0-rc2"

Default value: `false`

##### <a name="-elastic_stack--repo--priority"></a>`priority`

Data type: `Optional[Integer]`

A numeric priority for the repo, passed to the package management system

Default value: `undef`

##### <a name="-elastic_stack--repo--proxy"></a>`proxy`

Data type: `String`

The URL of a HTTP proxy to use for package downloads (YUM only)

Default value: `'absent'`

##### <a name="-elastic_stack--repo--version"></a>`version`

Data type: `Integer`

The (major) version of the Elastic Stack for which to configure the repo

Default value: `7`

##### <a name="-elastic_stack--repo--base_repo_url"></a>`base_repo_url`

Data type: `Optional[String]`

The base url for the repo path

Default value: `undef`