Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-opensearch', '1.1.0'Learn more about managing modules with a PuppetfileDocumentation
Opensearch Puppet Module
Table of Contents
Description
This module sets up Opensearch.
Setup
The module manages the following
- package installation via archive, package, or repository
- configuration file
- service
Requirements
Usage
Some exmaples for the usage of the modules
Basic usage
include opensearch
Use another version (see https://opensearch.org/downloads.html for valid versions)
class { 'opensearch':
version => '2.6.0',
}
Do not use default settings, only my settings
class { 'opensearch':
use_default_settings => false,
settings => {
'valid_opensearch_key' => 'valid_value',
},
}
Do not restart the service on package or configuration changes
class { 'opensearch':
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: Module to manage opensearch.
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:
versionmanage_packagepackage_sourcepackage_ensurepackage_architecturepackage_providerpackage_directorypin_packageapt_pin_prioritymanage_configuse_default_settingsdefault_settingssettingsuse_default_notifications_notificationsnotifications_notificationsuse_default_notifications_notifications_corenotifications_notifications_coreuse_default_observability_observabilityobservability_observabilityuse_default_reporting_reports_schedulerreporting_reports_scheduleruse_default_security_action_groupssecurity_action_groupsuse_default_security_allowlistsecurity_allowlistuse_default_security_auditsecurity_audituse_default_security_configsecurity_configuse_default_security_internal_userssecurity_internal_usersuse_default_security_nodes_dnsecurity_nodes_dnuse_default_security_roles_mappingsecurity_roles_mappinguse_default_security_rolessecurity_rolesuse_default_security_tenantssecurity_tenantsuse_default_security_whitelistsecurity_whitelistheap_sizemanage_serviceservice_ensureservice_enablerestart_on_config_changerestart_on_package_changemanage_repositoryrepository_ensurerepository_locationrepository_gpg_key
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'
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'
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.1.0 (2023-08-02)
Implemented enhancements:
Fixed bugs:
- Fix installation from archive #37 (smortex)
- Fix files recurse parameter when ensure => absent #36 (smortex)
Closed issues:
- Figure out how to handle opensearch-dashboards #20
v1.0.0 (2023-06-16)
Breaking changes:
- Require stdlib 9.x #32 (bastelfreak)
- Drop Puppet 6 #27 (smortex)
Implemented enhancements:
- If specific version specified, hold the package? #24
- Add Puppet 8 support #31 (bastelfreak)
- Relax dependencies version requirements #29 (smortex)
- Add package pinning/versionlock #25 (crazymind1337)
Merged pull requests:
- purge pdk settings from metadata.json #30 (bastelfreak)
v0.3.0 (2023-03-31)
Breaking changes:
- Refactor repository handling #17 (crazymind1337)
Implemented enhancements:
- Switch to module hiera data values #21 (crazymind1337)
- Do not use parameters for private classes #14 (smortex)
- Add Debian repository handling #12 (crazymind1337)
Fixed bugs:
- Fixes apt-get update to be executed before package installation #19 (crazymind1337)
Closed issues:
- Package is installed before apt-get update #18
- Use module hiera data instead of params.pp #16
- Using the repository will only install the current latest package version #15
Merged pull requests:
- Add Debian 11 to supported OSes #13 (crazymind1337)
v0.2.0 (2023-03-23)
Implemented enhancements:
- cleanup metadata.json; add missing source key #9 (crazymind1337)
v0.1.0 (2023-03-23)
Merged pull requests:
- update README.md and use latest repositories for depending modules in rspec tests #7 (crazymind1337)
- Add beaker tests; add missing dependencies to metadata.json #6 (crazymind1337)
- add rspec tests with fixes for manifests #5 (crazymind1337)
- fix lint issues #4 (crazymind1337)
- set a correct license in metadata #3 (crazymind1337)
- modulesync for puppet-opensearch #2 (crazymind1337)
- first stage of a working module #1 (crazymind1337)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/apt (>= 7.0.0 < 10.0.0)
- puppet/archive (>= 2.0.0 < 8.0.0)
- puppetlabs/concat (>= 1.2.5 < 10.0.0)
- puppetlabs/stdlib (>= 9.0.0 < 10.0.0)
- puppet/systemd (>= 2.10.0 < 6.0.0)
- puppet/yum (>= 5.0.0 < 8.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.