Version information
This version is compatible with:
- Puppet Enterprise 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
- Puppet >= 6.21.0 < 8.0.0
- Debian,Ubuntu,CentOS
Start using this module
Add this module to your Puppetfile:
mod 'attachmentgenie-grafana_agent', '1.0.0'Learn more about managing modules with a PuppetfileDocumentation
attachmentgenie-grafana_agent
Deploy and configure grafana agent on a node.
Description
This project serves to install and configure grafana agent
Usage
All options and configuration can be done through interacting with the parameters on the main grafana_agent class. These are now documented via Puppet Strings
You can view grafana_agent usage in REFERENCE.
Reference
See REFERENCE.
Limitations
This is where you list OS compatibility, version compatibility, etc.
Development
Running tests
This project contains tests for both rspec-puppet and litmus to verify functionality. For detailed information on using these tools, please see their respective documentation.
Testing quickstart:
pdk bundle install
pdk bundle exec rake litmus:provision_list[puppet6]
pdk bundle exec rake litmus:install_agent[puppet6]
pdk bundle exec rake litmus:install_module
pdk bundle exec rake litmus:acceptance:parallel
pdk bundle exec rake litmus:tear_down
Reference
Table of Contents
Classes
Public Classes
grafana_agent: Class to install and configure grafana-agent. Use this module to install and configure grafana-agent.grafana_agent::repo: A short summary of the purpose of this class
Private Classes
grafana_agent::config: Class to configure grafana_agent.grafana_agent::install: Class to install grafana_agent.grafana_agent::service: Class to manage the grafana-agent service.
Classes
grafana_agent
Class to install and configure grafana-agent.
Use this module to install and configure grafana-agent.
Examples
Declaring the class
include ::grafana_agent
Parameters
The following parameters are available in the grafana_agent class:
groupinstall_dirinstall_methodmanage_repomanage_servicemanage_userpackage_namepackage_versionservice_nameservice_providerservice_ensureuserversionintergrations_config_hashloki_config_hashprometheus_config_hashserver_config_hashtempo_config_hash
group
Data type: String[1]
Group that owns grafana-agent files and processes.
install_dir
Data type: Stdlib::Absolutepath
Location of grafana-agent binary release.
install_method
Data type: Enum['archive','package']
How to install grafana-agent.
manage_repo
Data type: Boolean
Manage the grafana-agent repo.
manage_service
Data type: Boolean
Manage the grafana-agent service.
manage_user
Data type: Boolean
Manage grafana-agent user and group.
package_name
Data type: String[1]
Name of package to install.
package_version
Data type: String[1]
Version of grafana-agent to install.
service_name
Data type: String[1]
Name of service to manage.
service_provider
Data type: String[1]
Init system that is used.
service_ensure
Data type: Enum['running','stopped']
The state of the service.
user
Data type: String[1]
User that owns grafana-agent files and processes.
version
Data type: String[1]
Which version grafana-agent will be installed.
intergrations_config_hash
Data type: Optional[Hash]
Configuration specific to the integrations section.
Default value: undef
loki_config_hash
Data type: Optional[Hash]
Configuration specific to the loki section.
Default value: undef
prometheus_config_hash
Data type: Optional[Hash]
Configuration specific to the loki section.
Default value: undef
server_config_hash
Data type: Optional[Hash]
Configuration specific to the server section.
Default value: undef
tempo_config_hash
Data type: Optional[Hash]
Configuration specific to the server section
Default value: undef
grafana_agent::repo
A description of what this class does
Examples
include grafana_agent::repo
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v1.0.0 (2021-09-09)
UNCATEGORIZED PRS; LABEL THEM ON GITHUB
- initial release prep #3 (attachmentgenie)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppet/archive (>= 4.2.0 < 7.0.0)
- puppetlabs/concat (>= 6.0.0 < 8.0.0)
- grafana/promtail (>= 1.0.0 < 3.0.0)
- puppetlabs/stdlib (>= 4.25.0 < 9.0.0)
- puppet/systemd (>= 1.1.1 < 4.0.0)
Copyright (C) 2017 by Bram Vogelaar <bram@attachmentgenie.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.