REFERENCE.md

Reference

Table of Contents

Classes

• elastic_stack::repo: Set up the package repository for Elastic Stack components

Classes

elastic_stack::repo

elastic_stack::repo

Examples

include elastic_stack::repo

Parameters

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

• oss
• prerelease
• priority
• proxy
• version
• base_repo_url
• gpg_key_source
• apt_keyring_name
• apt_keyring_dir

oss

Data type: Boolean

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

Default value: false

prerelease

Data type: Boolean

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

Default value: false

priority

Data type: Optional[Integer]

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

Default value: undef

proxy

Data type: String

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

Default value: 'absent'

version

Data type: Integer

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

Default value: 7

base_repo_url

Data type: Optional[String]

The base url for the repo path

Default value: undef

gpg_key_source

Data type: Stdlib::Filesource

The gpg key for the repo

Default value: 'https://artifacts.elastic.co/GPG-KEY-elasticsearch'

apt_keyring_name

Data type: String[1]

The keyring filename to create (APT only) The filename extention is important here. Use .asc if the key is armored and .gpg if it's unarmored

Default value: 'elastic-keyring.asc'

apt_keyring_dir

Data type: Stdlib::Absolutepath

The path where the GPG key should be stored (APT only)

Default value: '/etc/apt/keyrings'