{"id":14994536,"url":"https://github.com/voxpupuli/puppet-kibana","last_synced_at":"2025-12-11T21:42:13.122Z","repository":{"id":37975059,"uuid":"83066606","full_name":"voxpupuli/puppet-kibana","owner":"voxpupuli","description":"Kibana Puppet module by Elastic.","archived":false,"fork":false,"pushed_at":"2024-09-17T07:35:16.000Z","size":402,"stargazers_count":16,"open_issues_count":7,"forks_count":48,"subscribers_count":264,"default_branch":"master","last_synced_at":"2024-10-29T14:22:37.185Z","etag":null,"topics":["amazon-puppet-module","centos-puppet-module","debian-puppet-module","fedora-puppet-module","hacktoberfest","kibana","linux-puppet-module","puppet","redhat-puppet-module","ubuntu-puppet-module"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voxpupuli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"open_collective":"vox-pupuli","github":"voxpupuli"}},"created_at":"2017-02-24T17:33:12.000Z","updated_at":"2024-09-17T07:35:18.000Z","dependencies_parsed_at":"2023-12-19T08:34:46.859Z","dependency_job_id":"487edc28-e0a1-4691-b59c-245e3f68a911","html_url":"https://github.com/voxpupuli/puppet-kibana","commit_stats":{"total_commits":260,"total_committers":22,"mean_commits":"11.818181818181818","dds":"0.35769230769230764","last_synced_commit":"891318cec267c985f78c9509e16f22202693f524"},"previous_names":["elastic/puppet-kibana"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-kibana","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-kibana/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-kibana/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-kibana/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voxpupuli","download_url":"https://codeload.github.com/voxpupuli/puppet-kibana/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246770561,"owners_count":20830908,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amazon-puppet-module","centos-puppet-module","debian-puppet-module","fedora-puppet-module","hacktoberfest","kibana","linux-puppet-module","puppet","redhat-puppet-module","ubuntu-puppet-module"],"created_at":"2024-09-24T16:03:47.450Z","updated_at":"2025-12-11T21:42:13.069Z","avatar_url":"https://github.com/voxpupuli.png","language":"Ruby","funding_links":["https://opencollective.com/vox-pupuli","https://github.com/sponsors/voxpupuli"],"categories":[],"sub_categories":[],"readme":"# Kibana Puppet Module\n\n[![Build Status](https://github.com/voxpupuli/puppet-kibana/workflows/CI/badge.svg)](https://github.com/voxpupuli/puppet-kibana/actions?query=workflow%3ACI)\n[![Release](https://github.com/voxpupuli/puppet-kibana/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-kibana/actions/workflows/release.yml)\n[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/kibana.svg)](https://forge.puppetlabs.com/puppet/kibana)\n[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/kibana.svg)](https://forge.puppetlabs.com/puppet/kibana)\n[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/kibana.svg)](https://forge.puppetlabs.com/puppet/kibana)\n[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/kibana.svg)](https://forge.puppetlabs.com/puppet/kibana)\n[![puppetmodule.info docs](http://www.puppetmodule.info/images/badge.png)](http://www.puppetmodule.info/m/puppet-kibana)\n[![Apache-2.0 License](https://img.shields.io/github/license/voxpupuli/puppet-kibana.svg)](LICENSE)\n\n#### Table of Contents\n\n1. [Overview](#overview)\n2. [Module Description - What the module does and why it is useful](#module-description)\n3. [Setup - The basics of getting started with Kibana](#setup)\n    * [What Kibana affects](#what-kibana-affects)\n    * [Setup requirements](#setup-requirements)\n    * [Beginning with Kibana](#beginning-with-kibana)\n4. [Usage - Configuration options and additional functionality](#usage)\n5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n5. [Limitations - OS compatibility, etc.](#limitations)\n6. [Development - Guide for contributing to the module](#development)\n\n## Overview\n\nThis module manages Kibana for use with Elasticsearch.\n\n## Module Description\n\nIn addition to managing the Kibana system package and service, this module also\nexposes options to control the configuration file for Kibana.\nKibana plugins are also supported via a native type and provider.\n\nDependencies are fairly standard (such as stdlib).\n\n## Setup\n\n### What Kibana affects\n\n* The `kibana` system package and service\n* `/etc/kibana/kibana.yml`\n* `/usr/share/kibana/plugins/*`\n\n### Setup Requirements\n\nIn addition to basic puppet settings (such as pluginsync), ensure that the\nrequired dependencies for the module are met (these are listed in\n`metadata.json` and listed in the Puppet Forge).\n\n### Beginning with kibana\n\nQuick start:\n\n```puppet\nclass { 'kibana' : }\n```\n\n## Usage\n\nIn order to control Kibana's configuration file, use the `config` parameter:\n\n```puppet\nclass { 'kibana':\n  config =\u003e {\n    'server.port' =\u003e '8080',\n  }\n}\n```\n\nThe `kibana` class also supports additional values for the `ensure` parameter\nthat will be passed along to the `package` resource for Kibana.\nFor example, to ensure the latest version of Kibana is always installed:\n\n```puppet\nclass { 'kibana': ensure =\u003e latest }\n```\n\nIn order to explicitly ensure that version 5.2.0 of Kibana is installed:\n\n```puppet\nclass { 'kibana': ensure =\u003e '5.2.0' }\n```\n\nPackage revisions are supported too:\n\n```puppet\nclass { 'kibana': ensure =\u003e '5.2.2-1' }\n```\n\nThe `kibana` class also supports removal through use of `ensure =\u003e absent`:\n\n```puppet\nclass { 'kibana': ensure =\u003e absent }\n```\n\n### OSS Packages and Repository Management\n\nThis module uses the [puppet/elastic_stack](https://forge.puppet.com/puppet/elastic_stack) module to manage the elastic package repositories.\nIn order to control which major version of package repository to manage, declare the associated repository version in the `elastic_stack::repo` class.\nFor example, to explicitly set the repository version to 5 instead of the default (which, at the time of this writing, is 6):\n\n```puppet\nclass { 'elastic_stack::repo':\n  version =\u003e 5,\n}\n\nclass { 'kibana':\n  ensure =\u003e latest\n}\n```\n\nThis 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:\n\n```puppet\nclass { 'elastic_stack::repo':\n  oss =\u003e true,\n}\n\nclass { 'kibana':\n  oss =\u003e true,\n}\n```\n\n### Plugins\n\nKibana plugins can be managed by this module.\n\n#### Kibana 5.x \u0026 6.x\n\nIn the most basic form, official plugins (provided by Elastic) can simply be\nspecified by name alone:\n\n```puppet\nkibana_plugin { 'x-pack': }\n```\n\nThe type also supports installing third-party plugins from a remote URL:\n\n```puppet\nkibana_plugin { 'health_metric_vis':\n  url =\u003e 'https://github.com/DeanF/health_metric_vis/releases/download/v0.3.4/health_metric_vis-5.2.0.zip',\n}\n```\n\nWhen updating plugins, it is important to specify the version of the plugin\nthat should be installed.\nFor example, the preceding block of code installed version 0.3.4 of the\n`health_metric_vis` plugin. In order to update that plugin to version 0.3.5,\nyou could use a resource such as the following:\n\n```puppet\nkibana_plugin { 'health_metric_vis':\n  url =\u003e 'https://github.com/DeanF/health_metric_vis/releases/download/v0.3.5/health_metric_vis-5.2.0.zip',\n  version =\u003e '0.3.5',\n}\n```\n\nPlugins can also be removed:\n\n```puppet\nkibana_plugin { 'x-pack': ensure =\u003e absent }\n```\n\n#### Kibana 4.x\n\nPlugin operations are similar to 6.x resources, but in keeping with the\n`kibana` command-line utility, an organization and version _must_ be specified:\n\n```puppet\nkibana_plugin { 'marvel':\n  version =\u003e '2.4.4',\n  organization =\u003e 'elasticsearch',\n}\n```\n\nThe `version` and `organization` parameters correspond to the same values for a\ngiven plugin in the plugin's documentation, and the provider assembles the\ncorrect name on the backend on your behalf.\nFor instance, the previous example will be translated to\n\n```shell\nkibana plugin --install elasticsearch/marvel/2.4.4\n```\n\nFor you.\nRemoval through the use of `ensure =\u003e absent` is the same as for 5.x plugins.\n\n## Reference\n\nClass parameters are available in [the auto-generated documentation\npages](https://elastic.github.io/puppet-kibana/puppet_classes/kibana.html).\nAutogenerated documentation for types, providers, and ruby helpers is also\navailable on the same documentation site.\n\n## Limitations\n\nThis module is actively tested against the versions and distributions listed in\n`metadata.json`.\n\n## Development\n\nSee CONTRIBUTING.md with help to get started.\n\n### Quickstart\n\nInstall gem dependencies:\n\n```shell\n$ bundle install\n```\n\nRun the test suite (without acceptance tests):\n\n```shell\n$ bundle exec rake test\n```\n\nRun acceptance tests against a platform (requires Docker):\n\n```shell\n$ bundle exec rake beaker:centos-7-x64\n```\n\n## Support\n\nNeed help? Join us in [#Kibana](https://webchat.freenode.net/#kibana) on Freenode IRC or on the https://discuss.elastic.co/c/kibana discussion forum.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-kibana","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoxpupuli%2Fpuppet-kibana","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-kibana/lists"}