Skip to content

Commit

Permalink
docs: remove outdated info from README
Browse files Browse the repository at this point in the history
Signed-off-by: gardar <[email protected]>
  • Loading branch information
gardar committed Mar 8, 2024
1 parent c940d84 commit d702d95
Showing 1 changed file with 2 additions and 26 deletions.
28 changes: 2 additions & 26 deletions roles/process_exporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
# Ansible Role: process_exporter

[![Build Status](https://travis-ci.com/cloudalchemy/ansible-process_exporter.svg?branch=master)](https://travis-ci.com/cloudalchemy/ansible-process_exporter)
[![License](https://img.shields.io/badge/license-MIT%20License-brightgreen.svg)](https://opensource.org/licenses/MIT)
[![Ansible Role](https://img.shields.io/badge/ansible%20role-cloudalchemy.process_exporter-blue.svg)](https://galaxy.ansible.com/cloudalchemy/process_exporter/)
[![GitHub tag](https://img.shields.io/github/tag/cloudalchemy/ansible-process_exporter.svg)](https://github.com/cloudalchemy/ansible-process_exporter/tags)

## Description

Deploy [process-exporter](https://github.com/ncabatoff/process-exporter) using ansible.
Expand All @@ -17,14 +12,8 @@ Note. This repository and role uses the name process_exporter to conform with an

## Role Variables

All variables which can be overridden are stored in [defaults/main.yml](defaults/main.yml) file as well as in table below.

| Name | Default Value | Description |
| -------------- | ------------- | -----------------------------------|
| `process_exporter_version` | 0.7.5 | Process exporter package version. Also accepts latest as parameter |
| `process_exporter_web_listen_address` | "0.0.0.0:9256" | Address on which process_exporter will listen |
| `process_exporter_config_dir` | "/etc/process_exporter" | Path to directory with process_exporter configuration |
`process_exporter_names` handling has been set up in an unusual way to handle recommended process-exporter 'Template variables' (such as {{.Comm}}). Follow the example in [defaults/main.yml](defaults/main.yml) if you want to define custom filtering/grouping of processes that use Template variables and make sure to keep the {% raw %} block delimiters.
All variables which can be overridden are stored in [meta/argument_specs.yml](meta/argument_specs.yml) file.
See the [prometheus.prometheus.process_exporter](https://prometheus-community.github.io/ansible/branch/main/process_exporter_role.html) docs.

## Example

Expand All @@ -36,16 +25,3 @@ Use it in a playbook as follows:
roles:
- prometheus.prometheus.process_exporter
```
## Contributing
See [contributor guideline](CONTRIBUTING.md).
## Troubleshooting
See [troubleshooting](TROUBLESHOOTING.md).
## License
This project is licensed under MIT License. See [LICENSE](/LICENSE) for more details.

0 comments on commit d702d95

Please sign in to comment.