REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• opensearch_dashboards: Module to manage OpensSearch Dashboards

Private Classes

• opensearch_dashboards::config: Configure OpenSearch Dashboards.
• opensearch_dashboards::install: Installs OpenSearch Dashboards via archive, package, or repository.
• opensearch_dashboards::install::archive: Install OpenSearch Dashboards via tarball.
• opensearch_dashboards::install::package: Install OpenSearch Dashboards via deb/rpm package.
• opensearch_dashboards::repository: Handle OpenSearch Dashboards repository.
• opensearch_dashboards::repository::debian: Install the Debian apt repository for OpenSearch Dashboards.
• opensearch_dashboards::repository::redhat: Install the RedHat yum repository for OpenSearch Dashboards.
• opensearch_dashboards::service: Handle OpenSearch Dashboards service.

Classes

opensearch_dashboards

Module to manage OpensSearch Dashboards

Parameters

The following parameters are available in the opensearch_dashboards class:

• version
• manage_package
• package_directory
• package_ensure
• package_source
• pin_package
• apt_pin_priority
• manage_repository
• repository_ensure
• repository_location
• repository_gpg_key
• manage_config
• settings
• manage_service
• service_ensure
• service_enable
• restart_on_config_change
• restart_on_package_change

version

Data type: Optional[String]

The version to be installed

Default value: undef

manage_package

Data type: Boolean

Whether to manage the package installation

Default value: true

package_directory

Data type: Stdlib::Absolutepath

The directory to install the package. Only used for package_install_method = 'archive'

Default value: '/opt/opensearch-dashboards'

package_ensure

Data type: Enum['present', 'absent']

The status of the package

Default value: 'present'

package_source

Data type: Enum['archive', 'download', 'repository']

The source for the package

Default value: 'repository'

pin_package

Data type: Boolean

Whether to enable the apt::pin or yum::versionlock for the package

Default value: true

apt_pin_priority

Data type: Integer

The priority for apt::pin of the opensearch-dashboards package

Default value: 1001

manage_repository

Data type: Boolean

Whether to manage the package repository

Default value: true

repository_ensure

Data type: Enum['present', 'absent']

The status of the repository

Default value: 'present'

repository_location

Data type: Optional[Stdlib::HTTPUrl]

The location of the repository

Default value: undef

repository_gpg_key

Data type: Stdlib::HTTPUrl

The GnuPG key of the repository

Default value: 'https://artifacts.opensearch.org/publickeys/opensearch.pgp'

manage_config

Data type: Boolean

Whether to manage the configuration

Default value: true

settings

Data type: Hash

Custom settings for OpenSearch Dashboards

Default value: {}

manage_service

Data type: Boolean

Whether to manage the opensearch-dashboards service

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

The state for the opensearch-dashboards service

Default value: 'running'

service_enable

Data type: Boolean

Whether to enable the service

Default value: true

restart_on_config_change

Data type: Boolean

Restart the service on any config changes

Default value: true

restart_on_package_change

Data type: Boolean

Restart the service on package changes

Default value: true