OpenSearch Dashboards Puppet Module

Table of Contents

1. Description
2. Setup
   • The module manages the following
3. Usage
   • Basic usage
   • Use another version
   • Do not use default settings, only my settings
   • Do not restart the service on package or configuration changes
4. Reference
5. Limitations
6. Development

Description

This module sets up OpenSearch Dashboards.

Setup

The module manages the following

• package installation via archive, package, or repository
• configuration file
• service

Usage

Some examples for the usage of the modules

Basic usage

class { 'opensearch_dashboards':
}

Use another version (see https://opensearch.org/downloads.html for valid versions)

class { 'opensearch_dashboards':
  version => '2.6.0',
}

Customize settings

class { 'opensearch_dashboards':
  settings => {
    'opensearch.hosts' => [
      'https://opensearch.example.com:9200',
    ],
  },
}

Do not restart the service on package or configuration changes

class { 'opensearch_dashboards':
  restart_on_package_changes => false,
  restart_on_config_changes  => false,
}

Reference

Please see the REFERENCE.md

Limitations

This module is built upon and tested against the versions of Puppet listed in the metadata.json file (i.e. the listed compatible versions on the Puppet Forge).

Development

Please see the CONTRIBUTING.md file for instructions regarding development environments and testing.

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

Changelog

All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.

v1.0.0 (2023-08-02)

Full Changelog

Fixed bugs:

• Fix installation from archive #1 (smortex)

* This Changelog was automatically generated by github_changelog_generator