Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.5.0 < 6.0.0
- , , , , ,
This module has been deprecated by its author since Mar 30th 2022.
The author has suggested puppet-kibana as its replacement.
Start using this module
Documentation
Kibana Puppet Module
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with Kibana
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This module manages Kibana for use with Elasticsearch.
Module Description
In addition to managing the Kibana system package and service, this module also exposes options to control the configuration file for Kibana. Kibana plugins are also supported via a native type and provider.
Dependencies are fairly standard (such as stdlib).
Setup
What Kibana affects
- The
kibanasystem package and service /etc/kibana/kibana.yml/usr/share/kibana/plugins/*
Setup Requirements
In addition to basic puppet settings (such as pluginsync), ensure that the
required dependencies for the module are met (these are listed in
metadata.json and listed in the Puppet Forge).
Beginning with kibana
Quick start:
class { 'kibana' : }
Usage
In order to control Kibana's configuration file, use the config parameter:
class { 'kibana':
config => {
'server.port' => '8080',
}
}
The kibana class also supports additional values for the ensure parameter
that will be passed along to the package resource for Kibana.
For example, to ensure the latest version of Kibana is always installed:
class { 'kibana': ensure => latest }
In order to explicitly ensure that version 5.2.0 of Kibana is installed:
class { 'kibana': ensure => '5.2.0' }
Package revisions are supported too:
class { 'kibana': ensure => '5.2.2-1' }
The kibana class also supports removal through use of ensure => absent:
class { 'kibana': ensure => absent }
OSS Packages and Repository Management
This module uses the elastic/elastic_stack module to manage the elastic package repositories.
In order to control which major version of package repository to manage, declare the associated repository version in the elastic_stack::repo class.
For example, to explicitly set the repository version to 5 instead of the default (which, at the time of this writing, is 6):
class { 'elastic_stack::repo':
version => 5,
}
class { 'kibana':
ensure => latest
}
This module defaults to the upstream package repositories, which as of 6.3, includes X-Pack. In order to use the purely OSS (open source) package and repository, the appropriate oss flag must be set on the elastic_stack::repo and kibana classes:
class { 'elastic_stack::repo':
oss => true,
}
class { 'kibana':
oss => true,
}
Plugins
Kibana plugins can be managed by this module.
Kibana 5.x & 6.x
In the most basic form, official plugins (provided by Elastic) can simply be specified by name alone:
kibana_plugin { 'x-pack': }
The type also supports installing third-party plugins from a remote URL:
kibana_plugin { 'health_metric_vis':
url => 'https://github.com/DeanF/health_metric_vis/releases/download/v0.3.4/health_metric_vis-5.2.0.zip',
}
When updating plugins, it is important to specify the version of the plugin
that should be installed.
For example, the preceding block of code installed version 0.3.4 of the
health_metric_vis plugin. In order to update that plugin to version 0.3.5,
you could use a resource such as the following:
kibana_plugin { 'health_metric_vis':
url => 'https://github.com/DeanF/health_metric_vis/releases/download/v0.3.5/health_metric_vis-5.2.0.zip',
version => '0.3.5',
}
Plugins can also be removed:
kibana_plugin { 'x-pack': ensure => absent }
Kibana 4.x
Plugin operations are similar to 6.x resources, but in keeping with the
kibana command-line utility, an organization and version must be specified:
kibana_plugin { 'marvel':
version => '2.4.4',
organization => 'elasticsearch',
}
The version and organization parameters correspond to the same values for a
given plugin in the plugin's documentation, and the provider assembles the
correct name on the backend on your behalf.
For instance, the previous example will be translated to
kibana plugin --install elasticsearch/marvel/2.4.4
For you.
Removal through the use of ensure => absent is the same as for 5.x plugins.
Reference
Class parameters are available in the auto-generated documentation pages. Autogenerated documentation for types, providers, and ruby helpers is also available on the same documentation site.
Limitations
This module is actively tested against the versions and distributions listed in
metadata.json.
Development
See CONTRIBUTING.md with help to get started.
Quickstart
Install gem dependencies:
$ bundle install
Run the test suite (without acceptance tests):
$ bundle exec rake test
Run acceptance tests against a platform (requires Docker):
$ bundle exec rake beaker:centos-7-x64
Types in this module release
6.3.1 (October 19, 2018)
Fixes
- This module no longer requires or enforces a version of the puppetlabs/apt module, which is transitively handled through the
elastic/elastic_stackdependency. - Permit hashes to be passed as configuration parameter values.
6.3.0 (June 18, 2018)
This release deprecates Kibana 4.x, which is end-of-life.
Migration Guide
- Support for 4.x has been deprecated, so consider upgrading to Kibana 5 or later before upgrading this module since only versions 5 and later are supported.
- The module defaults to the upstream package repositories, which now include X-Pack bundled by default. To preserve previous behavior which does not include X-Pack, follow the
READMEinstructions to configureoss-only repositories/packages. - Use of the
elastic_stack::repoclass for managing package repositories may mean that leftover yum/apt/etc. repositories namedkibanamay persist after upgrade.
Features
- Support for 6.3 style repositories using elastic_stack module
Fixes
6.0.1 (March 13, 2018)
Fixes
- Fixed language compatibility errors that could arise when using JRuby 1.7 on Puppet Servers.
6.0.0 (November 14, 2017)
Major version upgrade with important deprecations:
- Puppet version 3 is no longer supported.
The following migration guide is intended to help aid in upgrading this module.
Migration Guide
Puppet 3.x No Longer Supported
Puppet 4.5.0 is the new minimum required version of Puppet, which offers better safety, module metadata, and Ruby features. Migrating from Puppet 3 to Puppet 4 is beyond the scope of this guide, but the official upgrade documentation can help. As with any version or module upgrade, remember to restart any agents and master servers as needed.
5.2.0 (November 13, 2017)
Features
- Added support for service status
5.1.0 (August 18, 2017)
Features
- Installation via package files (
.deb/.rpm) now supported. See documentation for thepackage_sourceparameter for usage. - Updated puppetlabs/apt dependency to reflect support for 4.x versions.
5.0.1 (July 19, 2017)
This is a bugfix release to properly contain classes within the kibana class so that relationship ordering is respected correctly.
5.0.0 (May 10, 2017)
Summary
Formally release major version 5.0 of the module.
Fixes
- metadata.json dependencies now compatible with Puppet 3.x.
0.3.0 (April 26, 2017)
Summary
This release backports support for Puppet 3.8.
0.2.1 (April 10, 2017)
Summary
Bugfix release resolving several minor issues.
Features
- Package revisions now supported for ensure values.
Fixes
- The
urlparameter for 4.x plugins is now properly passed to the plugin install command. - Nonzero plugin commmands now properly raise errors during catalog runs.
- Boolean values allowed in config hash.
- apt-transport-https package no longer managed by this module.
0.2.0 (March 20, 2017)
Summary
Minor fixes and full 4.x support.
Features
- Feature parity when managing plugins on Kibana 4.x.
Fixes
- Removed potential conflict with previously-defined apt-transport-https packages.
- Permit boolean values in configuration hashes.
0.1.1 (March 11, 2017)
Summary
Small bugfix release.
Fixes
- Actually aknowledge and use the manage_repo class flag.
0.1.0 (March 8, 2017)
Summary
Initial release.
Features
- Support for installing, removing, and updating Kibana and the Kibana service.
- Plugin support.
- Initial support for version 4.x management.
Fixes
Dependencies
- elastic/elastic_stack (>= 6.1.0 < 7.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 2012-2017 Elasticsearch
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.