Skip to content

REFERENCE.md

Latest commit

 

History

History
550 lines (302 loc) · 14.6 KB

REFERENCE.md

File metadata and controls

550 lines (302 loc) · 14.6 KB

Reference

Table of Contents

Classes

Public Classes

Private Classes

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

Classes

opensearch

Module to manage opensearch.

Parameters

The following parameters are available in the opensearch class:

version

Data type: Optional[String]

The version to be installed. See also: https://opensearch.org/downloads.html

Default value: undef

manage_package

Data type: Boolean

Whether to manage the package installation.

Default value: true

package_source

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

The source for the package.

Default value: 'repository'

package_ensure

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

The status of the package.

Default value: 'present'

package_architecture

Data type: Enum['x64', 'arm64']

The architecture for the package.

package_provider

Data type: Enum['dpkg', 'rpm']

The provider for the package to be used to install the package.

package_directory

Data type: Stdlib::Absolutepath

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

Default value: '/opt/opensearch'

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 package.

Default value: 1001

manage_config

Data type: Boolean

Whether to manage the configuration.

Default value: true

use_default_settings

Data type: Boolean

Whether to use the modules default settings values.

Default value: true

default_settings

Data type: Hash

The modules default settings for opensearch.

settings

Data type: Hash

Additional settings for opensearch.

Default value: {}

use_default_notifications_notifications

Data type: Boolean

Whether to use the module default notification settings

Default value: true

notifications_notifications

Data type: Hash

Additional notification settings

Default value: {}

use_default_notifications_notifications_core

Data type: Boolean

Whether to use the module default notification-core settings

Default value: true

notifications_notifications_core

Data type: Hash

Additional notification-core settings

Default value: {}

use_default_observability_observability

Data type: Boolean

Whether to use the module default observability settings

Default value: true

observability_observability

Data type: Hash

Additional observability settings

Default value: {}

use_default_reporting_reports_scheduler

Data type: Boolean

Whether to use the module default reports-scheduler settings

Default value: true

reporting_reports_scheduler

Data type: Hash

Additional reports-scheduler settings

Default value: {}

use_default_security_action_groups

Data type: Boolean

Whether to use the module default security action_groups settings

Default value: true

security_action_groups

Data type: Hash

Additional security action_groups settings

Default value: {}

use_default_security_allowlist

Data type: Boolean

Whether to use the module default security allowlist settings

Default value: true

security_allowlist

Data type: Hash

Additional security allowlist settings

Default value: {}

use_default_security_audit

Data type: Boolean

Whether to use the module default security audit settings

Default value: true

security_audit

Data type: Hash

Additional security audit settings

Default value: {}

use_default_security_config

Data type: Boolean

Whether to use the module default security config settings

Default value: true

security_config

Data type: Hash

Additional security config settings

Default value: {}

use_default_security_internal_users

Data type: Boolean

Whether to use the module default security internal_users settings

Default value: true

security_internal_users

Data type: Hash

Additional security internal_users settings

Default value: {}

use_default_security_nodes_dn

Data type: Boolean

Whether to use the module default security nodes_dn settings

Default value: true

security_nodes_dn

Data type: Hash

Additional security nodes_dn settings

Default value: {}

use_default_security_roles_mapping

Data type: Boolean

Whether to use the module default security roles_mapping settings

Default value: true

security_roles_mapping

Data type: Hash

Additional security roles_mapping settings

Default value: {}

use_default_security_roles

Data type: Boolean

Whether to use the module default security roles settings

Default value: true

security_roles

Data type: Hash

Additional security roles settings

Default value: {}

use_default_security_tenants

Data type: Boolean

Whether to use the module default security tenants settings

Default value: true

security_tenants

Data type: Hash

Additional security tenants settings

Default value: {}

use_default_security_whitelist

Data type: Boolean

Whether to use the module default security whitelist settings

Default value: true

security_whitelist

Data type: Hash

Additional security whitelist settings

Default value: {}

heap_size

Data type: Pattern[/\d+[mg]/]

The heap size for the JVM.

Default value: '512m'

default_jvm_gc_settings

Data type: Array[String[1]]

Default settings for jvm gc.

Default value: []

use_default_jvm_gc_settings

Data type: Boolean

Whether to use the default jvm gc settings.

Default value: true

jvm_gc_settings

Data type: Array[String[1]]

User settings for jvm gc.

Default value: []

default_jvm_gc_logging_settings

Data type: Array[String[1]]

Default settings for jvm gc logging.

Default value: []

use_default_jvm_gc_logging_settings

Data type: Boolean

Whether to use the default jvm gc logging settings.

Default value: true

jvm_gc_logging_settings

Data type: Array[String[1]]

User settings for jvm logging gc.

Default value: []

manage_service

Data type: Boolean

Whether to manage the opensearch service.

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

The state for the opensearch 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

manage_repository

Data type: Boolean

Default value: true

repository_ensure

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

Default value: 'present'

repository_location

Data type: Optional[Stdlib::HTTPUrl]

Default value: undef

repository_gpg_key

Data type: Stdlib::HTTPUrl

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

heap_dump_on_oom

Data type: Boolean

Default value: true