Solr Prometheus exporter Ansible role

This role installs a Prometheus exporter for Solr

• Getting Started
  • Prerequisites
  • Installing
• Usage
• Testing
• Built With
• Versioning
• Authors
• License
• Contributing

Getting started

This role installs a Prometheus exporter for Solr Standalone or Solr Cloud. If you need to install Apache Solr use this other role idealista/solrcloud-role

Prerequesites

Python, Ansible, Molecule and Docker

Installing

Create or add to your roles dependency file (e.g requirements.yml):

- src: idealista.prometheus_solr_exporter_role
  version: 2.0.0
  name: prometheus_solr_exporter

Install the role with ansible-galaxy command:

ansible-galaxy install -p roles -r requirements.yml -f

Use in a playbook:

- hosts: someserver
  roles:
    - role: prometheus_solr_exporter

Usage

Variables explanation:

• prometheus_solr_exporter_version this is the solr prometheus exporter version to install
• prometheus_solr_exporter_installation_dir this is a path location to install the exporter
• prometheus_solr_exporter_user user owner of all files
• prometheus_solr_exporter_group group owner of all files
• prometheus_solr_exporter_temp_dir the path for a temporary directory
• prometheus_solr_exporter_port listening port
• prometheus_solr_exporter_solr_mode 'standalone' or 'cluster'
• prometheus_solr_exporter_threads number of threads
• prometheus_solr_exporter_config_file this is the config file path. Use it to override default config file
• prometheus_solr_exporter_service_location this is a path location to move the service file
• prometheus_solr_exporter_service_name service name
• prometheus_solr_exporter_service_file the service template file.
• prometheus_solr_exporter_env_file java environment template file
• prometheus_solr_exporter_env_location this is a path location to move the java environment file
• prometheus_solr_exporter_xmx java heap max size
• prometheus_solr_exporter_xms java heap initial size
• prometheus_solr_exporter_java_opts jvm extra options
• prometheus_solr_exporter_jmx_enabled jmx enabled or disabled variable
• prometheus_solr_exporter_jmx_port jmx remote port

Excluding variables:

• prometheus_solr_exporter_zookeeper_host if cluster mode, the zookeeper host. For ex, http://localhost:8983/solr
• prometheus_solr_exporter_solr_baseurl if standalone mode, the solr url. For ex, localhost:2181/solr

Testing

Run pip install requirements-test.yml before running tests

Launch tests:

molecule test

Built With

Versioning

For the versions available, see the tags on this repository.

Additionaly you can see what change in each version in the CHANGELOG.md file.

Authors

• Idealista - Work with - idealista

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.