diff --git a/CHANGELOG.md b/CHANGELOG.md index d56fec6..d914277 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,61 +1,159 @@ -## Release 7.0.0 -- Default to Elastic Stack version 7 -- Drop support for Puppet version < 4.10.0 +# Changelog -## Release 6.3.2 - - Allow puppetlabs-apt version 7.x - - Allow puppetlabs-stdlib version 6.x - - Allow puppet-yum version 4.x - - Constrain puppetlabs-yumrepo_core to puppet 6+ +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. -## Release 6.3.1 -- Remove extraneous files from module package +## [v8.0.0](https://github.com/voxpupuli/puppet-elastic_stack/tree/v8.0.0) (2021-12-22) -## Release 6.3.0 [Deleted from Forge] +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/7.0.0...v8.0.0) -- Support Puppet 6 +**Breaking changes:** -## Release 6.2.4 +- Unlist Operating Systems which have reached EOL [\#41](https://github.com/voxpupuli/puppet-elastic_stack/pull/41) ([smortex](https://github.com/smortex)) +- Drop support for Puppet 4 and 5 \(EOL\) [\#40](https://github.com/voxpupuli/puppet-elastic_stack/pull/40) ([smortex](https://github.com/smortex)) -- Allow puppetlabs-apt version 6.x +**Implemented enhancements:** -## Release 6.2.3 +- Add support for Puppet 7 [\#42](https://github.com/voxpupuli/puppet-elastic_stack/pull/42) ([smortex](https://github.com/smortex)) -- Allow puppetlabs-yum version 3.x +**Closed issues:** -## Release 6.2.2 +- Module doesn't install and bugs puppet. [\#34](https://github.com/voxpupuli/puppet-elastic_stack/issues/34) -- Allow puppetlabs-stdlib version 5.x +**Merged pull requests:** -## Release 6.2.1 +- update metadata.json for Vox Pupuli namespace [\#50](https://github.com/voxpupuli/puppet-elastic_stack/pull/50) ([bastelfreak](https://github.com/bastelfreak)) +- puppet/yum: Allow 5.x [\#49](https://github.com/voxpupuli/puppet-elastic_stack/pull/49) ([bastelfreak](https://github.com/bastelfreak)) +- puppetlabs/apt: allow 8.x [\#48](https://github.com/voxpupuli/puppet-elastic_stack/pull/48) ([bastelfreak](https://github.com/bastelfreak)) +- puppetlabs/stdlib: Allow 8.x [\#47](https://github.com/voxpupuli/puppet-elastic_stack/pull/47) ([bastelfreak](https://github.com/bastelfreak)) +- Drop yumrepo\_core from metadata.json [\#46](https://github.com/voxpupuli/puppet-elastic_stack/pull/46) ([bastelfreak](https://github.com/bastelfreak)) +- Add recent distros [\#45](https://github.com/voxpupuli/puppet-elastic_stack/pull/45) ([smortex](https://github.com/smortex)) +- Download modules from git repo for unit testing [\#44](https://github.com/voxpupuli/puppet-elastic_stack/pull/44) ([smortex](https://github.com/smortex)) +- Remove Vagrant leftovers [\#43](https://github.com/voxpupuli/puppet-elastic_stack/pull/43) ([smortex](https://github.com/smortex)) +- Stop using Travis CI [\#37](https://github.com/voxpupuli/puppet-elastic_stack/pull/37) ([jmlrt](https://github.com/jmlrt)) +- Add badges [\#32](https://github.com/voxpupuli/puppet-elastic_stack/pull/32) ([fatmcgav](https://github.com/fatmcgav)) -- Allow puppetlabs-apt version 5.x +## [7.0.0](https://github.com/voxpupuli/puppet-elastic_stack/tree/7.0.0) (2019-08-13) -## Release 6.2.0 +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.3.2...7.0.0) -- Add base_repo_url param +**Merged pull requests:** -## Release 6.1.0 +- Default to Elastic Stack version 7 [\#26](https://github.com/voxpupuli/puppet-elastic_stack/pull/26) ([jarpy](https://github.com/jarpy)) -- Support OSS-only package repositories +## [6.3.2](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.3.2) (2019-08-13) -## Release 6.0.1 +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.3.1...6.3.2) -- Remove aggressive ordering causing all packages to come after apt::update +**Closed issues:** -## Release 6.0.0 +- r10k continuously updating elastic\_stack [\#19](https://github.com/voxpupuli/puppet-elastic_stack/issues/19) -Version number increase to indicate that this module is considered of reasonable -quality and is used by version 6.0.0 of elastic/logstash. +**Merged pull requests:** -- Changed default repository to version to 6 +- Release 6.3.2 [\#31](https://github.com/voxpupuli/puppet-elastic_stack/pull/31) ([jarpy](https://github.com/jarpy)) +- Do not pass facterversion to on\_supported\_os [\#30](https://github.com/voxpupuli/puppet-elastic_stack/pull/30) ([jarpy](https://github.com/jarpy)) +- Update metadata versions [\#28](https://github.com/voxpupuli/puppet-elastic_stack/pull/28) ([pillarsdotnet](https://github.com/pillarsdotnet)) -## Release 0.2.1 +## [6.3.1](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.3.1) (2019-04-17) -- Remove some resource defaults that were causing problems on Puppet 5 +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.2.4...6.3.1) -## Release 0.2.0 +**Closed issues:** -- Expand declared OS support -- Relax minimum Puppet version to 4.6.1 -- Support pre-release artifacts +- Current release tarball 6.2.4 erroneously contains local `.git` directory [\#24](https://github.com/voxpupuli/puppet-elastic_stack/issues/24) + +**Merged pull requests:** + +- Support Puppet 6 [\#25](https://github.com/voxpupuli/puppet-elastic_stack/pull/25) ([jarpy](https://github.com/jarpy)) + +## [6.2.4](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.2.4) (2018-09-16) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.2.3...6.2.4) + +**Merged pull requests:** + +- Allow puppetlabs-apt 6.x and newer [\#17](https://github.com/voxpupuli/puppet-elastic_stack/pull/17) ([jhooyberghs](https://github.com/jhooyberghs)) + +## [6.2.3](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.2.3) (2018-08-28) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.2.2...6.2.3) + +## [6.2.2](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.2.2) (2018-08-27) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.2.1...6.2.2) + +**Closed issues:** + +- Support stdlib 5 [\#15](https://github.com/voxpupuli/puppet-elastic_stack/issues/15) + +**Merged pull requests:** + +- Allow the use of stdlib version 5 [\#16](https://github.com/voxpupuli/puppet-elastic_stack/pull/16) ([jarpy](https://github.com/jarpy)) + +## [6.2.1](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.2.1) (2018-08-14) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.2.0...6.2.1) + +**Closed issues:** + +- Allow $version to set an specific release [\#13](https://github.com/voxpupuli/puppet-elastic_stack/issues/13) +- kibana packages not found in oss repository [\#10](https://github.com/voxpupuli/puppet-elastic_stack/issues/10) + +**Merged pull requests:** + +- Update puppetlabs/apt dependency [\#14](https://github.com/voxpupuli/puppet-elastic_stack/pull/14) ([l-lotz](https://github.com/l-lotz)) + +## [6.2.0](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.2.0) (2018-07-17) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.1.0...6.2.0) + +**Closed issues:** + +- release consistency [\#11](https://github.com/voxpupuli/puppet-elastic_stack/issues/11) +- repo\_url parameter [\#8](https://github.com/voxpupuli/puppet-elastic_stack/issues/8) + +**Merged pull requests:** + +- Add base\_repo\_url parameter [\#12](https://github.com/voxpupuli/puppet-elastic_stack/pull/12) ([baurmatt](https://github.com/baurmatt)) + +## [6.1.0](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.1.0) (2018-05-31) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.0.1...6.1.0) + +**Closed issues:** + +- Priority parameter should be undef by default [\#5](https://github.com/voxpupuli/puppet-elastic_stack/issues/5) +- apt::update ordering creates dependency cycles [\#4](https://github.com/voxpupuli/puppet-elastic_stack/issues/4) +- update Project URL on Puppet Forge and changelog [\#1](https://github.com/voxpupuli/puppet-elastic_stack/issues/1) + +**Merged pull requests:** + +- Support 6.3 OSS repositories [\#9](https://github.com/voxpupuli/puppet-elastic_stack/pull/9) ([tylerjl](https://github.com/tylerjl)) +- Support for 2.x-style Repository URLs [\#7](https://github.com/voxpupuli/puppet-elastic_stack/pull/7) ([tylerjl](https://github.com/tylerjl)) +- Change default of priority from 10 to undef [\#6](https://github.com/voxpupuli/puppet-elastic_stack/pull/6) ([baurmatt](https://github.com/baurmatt)) + +## [6.0.1](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.0.1) (2017-12-07) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/6.0.0...6.0.1) + +**Closed issues:** + +- Do not use cross module variables [\#2](https://github.com/voxpupuli/puppet-elastic_stack/issues/2) + +## [6.0.0](https://github.com/voxpupuli/puppet-elastic_stack/tree/6.0.0) (2017-11-14) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/0.2.1...6.0.0) + +## [0.2.1](https://github.com/voxpupuli/puppet-elastic_stack/tree/0.2.1) (2017-11-13) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/0.2.0...0.2.1) + +## [0.2.0](https://github.com/voxpupuli/puppet-elastic_stack/tree/0.2.0) (2017-11-10) + +[Full Changelog](https://github.com/voxpupuli/puppet-elastic_stack/compare/5cfd57919eb0116c82d76a782697e02d7d93604d...0.2.0) + + + +\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/README.md b/README.md index 5698eba..d4cb4ff 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,66 @@ # elastic_stack -[![Build Status](https://travis-ci.org/elastic/puppet-elastic-stack.png?branch=master)](https://travis-ci.org/elastic/puppet-elastic-stack) - -[![Puppet Forge](https://img.shields.io/puppetforge/v/elastic/elastic_stack.svg)](https://forge.puppetlabs.com/elastic/elastic_stack) -[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/elastic/elastic_stack.svg)](https://forge.puppetlabs.com/elastic/elastic_stack) - -[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/elastic/elastic_stack.svg)](https://forge.puppetlabs.com/elastic/elastic_stack) +[![Build Status](https://github.com/voxpupuli/puppet-elastic_stack/workflows/CI/badge.svg)](https://github.com/voxpupuli/puppet-elastic_stack/actions?query=workflow%3ACI) +[![Release](https://github.com/voxpupuli/puppet-elastic_stack/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-elastic_stack/actions/workflows/release.yml) +[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/elastic_stack.svg)](https://forge.puppetlabs.com/puppet/elastic_stack) +[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/elastic_stack.svg)](https://forge.puppetlabs.com/puppet/elastic_stack) +[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/elastic_stack.svg)](https://forge.puppetlabs.com/puppet/elastic_stack) +[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/elastic_stack.svg)](https://forge.puppetlabs.com/puppet/elastic_stack) +[![puppetmodule.info docs](http://www.puppetmodule.info/images/badge.png)](http://www.puppetmodule.info/m/puppet-elastic_stack) +[![Apache-2 License](https://img.shields.io/github/license/voxpupuli/puppet-elastic_stack.svg)](LICENSE) +[![Donated by Elastic](https://img.shields.io/badge/donated%20by-Elastic-fb7047.svg)](#transfer-notice) -This module contains shared code for various Elastic modules, like -elastic-elasticsearch, elastic-logstash etc. +This module contains shared code for various modules to manage Elastic +products, like puppet-elasticsearch, puppet-logstash etc. + +Version 8 and newer of this module are released by Vox Pupuli. They now follow +semantic versioning. Previously the module was maintained by Elastic. + +## Setting up the Elastic package repository -# Setting up the Elastic package repository This module can configure package repositories for Elastic Stack components. Example: -``` puppet +```puppet include elastic_stack::repo ``` You may wish to specify a major version, since each has its own repository: -``` puppet +```puppet class { 'elastic_stack::repo': version => 5, } ``` To access prerelease versions, such as release candidates, set `prerelease` to `true`. -``` puppet + +```puppet class { 'elastic_stack::repo': version => 6, prerelease => true, } ``` To access the repository for OSS-only packages, set `oss` to `true`. -``` puppet + +```puppet class { 'elastic_stack::repo': oss => true, } ``` To use a custom package repository, set `base_repo_url`, like this: -``` puppet + +```puppet class { 'elastic_stack::repo': base_repo_url => 'https://mymirror.example.org/elastic-artifacts/packages', } ``` + +## Transfer Notice + +This module was originally authored by [Elastic](https://www.elastic.co). +The maintainer preferred that Vox Pupuli take ownership of the module for future improvement and maintenance. +Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Elastic. diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 0000000..0ba668c --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,83 @@ +# Reference + + + +## Table of Contents + +### Classes + +* [`elastic_stack::repo`](#elastic_stackrepo): Set up the package repository for Elastic Stack components + +## Classes + +### `elastic_stack::repo` + +elastic_stack::repo + +#### Examples + +##### + +```puppet +include elastic_stack::repo +``` + +#### Parameters + +The following parameters are available in the `elastic_stack::repo` class: + +* [`oss`](#oss) +* [`prerelease`](#prerelease) +* [`priority`](#priority) +* [`proxy`](#proxy) +* [`version`](#version) +* [`base_repo_url`](#base_repo_url) + +##### `oss` + +Data type: `Boolean` + +Whether to use the purely open source (i.e., bundled without X-Pack) repository + +Default value: ``false`` + +##### `prerelease` + +Data type: `Boolean` + +Whether to use a repo for prerelease versions, like "6.0.0-rc2" + +Default value: ``false`` + +##### `priority` + +Data type: `Optional[Integer]` + +A numeric priority for the repo, passed to the package management system + +Default value: ``undef`` + +##### `proxy` + +Data type: `String` + +The URL of a HTTP proxy to use for package downloads (YUM only) + +Default value: `'absent'` + +##### `version` + +Data type: `Integer` + +The (major) version of the Elastic Stack for which to configure the repo + +Default value: `7` + +##### `base_repo_url` + +Data type: `Optional[String]` + +The base url for the repo path + +Default value: ``undef`` + diff --git a/metadata.json b/metadata.json index a0950d5..32188ec 100644 --- a/metadata.json +++ b/metadata.json @@ -1,69 +1,69 @@ { "name": "puppet-elastic_stack", - "version": "7.0.0", + "version": "8.0.0", "author": "voxpupuli@groups.io", "summary": "Helpers for installing and configuring components of the Elastic Stack.", "license": "Apache-2.0", "source": "https://github.com/voxpupuli/puppet-elastic-stack", "project_page": "https://github.com/voxpupuli/puppet-elastic-stack", "issues_url": "https://github.com/voxpupuli/puppet-elastic-stack/issues", "dependencies": [ { "name": "puppetlabs-stdlib", "version_requirement": ">= 4.13.1 < 9.0.0" }, { "name": "puppetlabs/apt", "version_requirement": ">= 2.0.0 < 9.0.0" }, { "name": "puppet/yum", "version_requirement": ">= 0.9.6 < 6.0.0" } ], "operatingsystem_support": [ { "operatingsystem": "Debian", "operatingsystemrelease": [ "10", "11" ] }, { "operatingsystem": "OpenSuSE", "operatingsystemrelease": [ "15" ] }, { "operatingsystem": "RedHat", "operatingsystemrelease": [ "7", "8" ] }, { "operatingsystem": "SLES", "operatingsystemrelease": [ "12", "15" ] }, { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "18.04", "20.04" ] } ], "requirements": [ { "name": "puppet", "version_requirement": ">= 6.1.0 < 8.0.0" } ], "pdk-version": "1.0.1", "template-url": "file:///opt/puppetlabs/pdk/share/cache/pdk-module-template.git", "template-ref": "heads/master-0-g5db7961" }