Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 7.0.0
- , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'maeq-linky_exporter', '0.1.1'
Learn more about managing modules with a PuppetfileDocumentation
maeq-linky_exporter
Table of Contents
Description
This module automates the install of linky Exporter.
Usage
For more information see REFERENCE.md.
Install linky Exporter
Puppet
include linky_exporter
Examples
Change device file
linky_exporter::serial_device: '/dev/ttyAMA0'
Development
This project contains tests for rspec-puppet.
Quickstart to run all linter and unit tests:
bundle install --path .vendor/
bundle exec rake test
Reference
Table of Contents
Classes
linky_exporter
: This module manages linky Exporterlinky_exporter::install
: This class install linky exporter requirements and binaries.linky_exporter::service
: This class manages service
Classes
linky_exporter
Init class of linky Exporter module. It can installes linky Exporter binaries and single Service.
Examples
include linky_exporter
Parameters
The following parameters are available in the linky_exporter
class.
version
Data type: String
linky exporter release. See https://github.com/syberalexis/linky-exporter/releases
Default value: '1.0.0'
os
Data type: String
Operating system.
Default value: downcase($facts['kernel'])
base_dir
Data type: Stdlib::Absolutepath
Base directory where linky is extracted.
Default value: '/opt'
bin_dir
Data type: Stdlib::Absolutepath
Directory where binaries are located.
Default value: '/usr/local/bin'
base_url
Data type: Stdlib::HTTPUrl
Base URL for linky Exporter.
Default value: 'https://github.com/syberalexis/linky-exporter/releases/download'
download_url
Data type: Optional[Stdlib::HTTPUrl]
Complete URL corresponding to the linky exporter release, default to undef.
Default value: undef
extract_command
Data type: Optional[String]
Custom command passed to the archive resource to extract the downloaded archive.
Default value: undef
manage_user
Data type: Boolean
Whether to create user for linky_exporter or rely on external code for that.
Default value: false
manage_group
Data type: Boolean
Whether to create user for linky_exporter or rely on external code for that.
Default value: false
user
Data type: String
User running linky_exporter.
Default value: 'root'
group
Data type: String
Group under which linky_exporter is running.
Default value: 'root'
user_shell
Data type: Stdlib::Absolutepath
if requested, we create a user for linky_exporter. The default shell is false. It can be overwritten to any valid path.
Default value: '/bin/false'
extra_groups
Data type: Array[String]
Add other groups to the managed user.
Default value: []
service_ensure
Data type: Variant[Stdlib::Ensure::Service, Enum['absent']]
State ensured from linky_exporter service.
Default value: 'running'
listen_address
Data type: Stdlib::Host
linky exporter listen address.
Default value: '0.0.0.0'
listen_port
Data type: Stdlib::Port
linky exporter listen port (required to be accessible).
Default value: 9901
serial_device
Data type: Stdlib::Absolutepath
linky serial device.
Default value: '/dev/serial0'
baud_rate
Data type: Integer
linky baud rate.
Default value: 1200
linky_exporter::install
This class install linky exporter requirements and binaries.
Examples
include linky_exporter::install
Parameters
The following parameters are available in the linky_exporter::install
class.
version
Data type: String
linky exporter release. See https://github.com/anclrii/linky-Exporter/releases
Default value: $linky_exporter::version
os
Data type: String
Operating system.
Default value: $linky_exporter::os
arch
Data type: String
Architecture.
Default value: $linky_exporter::real_arch
base_dir
Data type: Stdlib::Absolutepath
Base directory where linky is extracted.
Default value: $linky_exporter::base_dir
bin_dir
Data type: Stdlib::Absolutepath
Directory where binaries are located.
Default value: $linky_exporter::bin_dir
download_url
Data type: Stdlib::HTTPUrl
Complete URL corresponding to the linky exporter release, default to undef.
Default value: $linky_exporter::real_download_url
extract_command
Data type: Optional[String]
Custom command passed to the archive resource to extract the downloaded archive.
Default value: $linky_exporter::extract_command
manage_user
Data type: Boolean
Whether to create user for linky_exporter or rely on external code for that.
Default value: $linky_exporter::manage_user
manage_group
Data type: Boolean
Whether to create user for linky_exporter or rely on external code for that.
Default value: $linky_exporter::manage_group
user
Data type: String
User running linky_exporter.
Default value: $linky_exporter::user
group
Data type: String
Group under which linky_exporter is running.
Default value: $linky_exporter::group
user_shell
Data type: Stdlib::Absolutepath
if requested, we create a user for linky_exporter. The default shell is false. It can be overwritten to any valid path.
Default value: $linky_exporter::user_shell
extra_groups
Data type: Array[String]
Add other groups to the managed user.
Default value: $linky_exporter::extra_groups
linky_exporter::service
This class manages service
Examples
include linky_exporter::service
Parameters
The following parameters are available in the linky_exporter::service
class.
ensure
Data type: Variant[Stdlib::Ensure::Service, Enum['absent']]
State ensured from linky_exporter service.
Default value: $linky_exporter::service_ensure
user
Data type: String
User running linky_exporter.
Default value: $linky_exporter::user
group
Data type: String
Group under which linky_exporter is running.
Default value: $linky_exporter::group
listen_address
Data type: Stdlib::Host
linky exporter listem address (required to be accessible).
Default value: $linky_exporter::listen_address
listen_port
Data type: Stdlib::Port
linky exporter listen port (required to be accessible).
Default value: $linky_exporter::listen_port
serial_device
Data type: Stdlib::Absolutepath
linky serial device.
Default value: $linky_exporter::serial_device
baud_rate
Data type: Integer
linky baud rate.
Default value: $linky_exporter::baud_rate
bin_dir
Data type: Stdlib::Absolutepath
Directory where binaries are located.
Default value: $linky_exporter::bin_dir
Dependencies
- puppetlabs/stdlib (>= 6.2.0 < 7.0.0)
- puppet/archive (>= 4.4.0 < 5.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.