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.