diff --git a/README.md b/README.md index 493bdf9..5698eba 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,50 @@ # 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) + This module contains shared code for various Elastic modules, like elastic-elasticsearch, elastic-logstash etc. # Setting up the Elastic package repository This module can configure package repositories for Elastic Stack components. Example: ``` puppet include elastic_stack::repo ``` You may wish to specify a major version, since each has its own repository: ``` puppet class { 'elastic_stack::repo': version => 5, } ``` To access prerelease versions, such as release candidates, set `prerelease` to `true`. ``` puppet class { 'elastic_stack::repo': version => 6, prerelease => true, } ``` To access the repository for OSS-only packages, set `oss` to `true`. ``` puppet class { 'elastic_stack::repo': oss => true, } ``` To use a custom package repository, set `base_repo_url`, like this: ``` puppet class { 'elastic_stack::repo': base_repo_url => 'https://mymirror.example.org/elastic-artifacts/packages', } ```