Skip to content

Commit

Permalink
update role README
Browse files Browse the repository at this point in the history
  • Loading branch information
ntk148v committed Jun 13, 2024
1 parent 334b118 commit e8397c5
Show file tree
Hide file tree
Showing 6 changed files with 107 additions and 31 deletions.
19 changes: 19 additions & 0 deletions ansible/roles/alertmanager/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Ansible Role: alertmanager

Deploy [alertmanager](https://github.com/prometheus/alertmanager) using Ansible and Docker.

## Requirements

- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it).

## Role variables

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

## Example playbook

```yaml
- hosts: all
roles:
- { role: alertmanager }
```
43 changes: 12 additions & 31 deletions ansible/roles/cadvisor/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,19 @@
Role Name
=========
# Ansible Role: cadvisor

A brief description of the role goes here.
Deploy [cadvisor](https://github.com/google/cadvisor) using Ansible and Docker.

Requirements
------------
## Requirements

Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it).

Role Variables
--------------
## Role variables

A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
All variables which can be overridden are stored in [defaults/main.yml](./defaults/main.yml) file as well as in [meta/argument_specs.yml](./meta/argument_specs.yml).

Dependencies
------------
## Example playbook

A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.

Example Playbook
----------------

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

- hosts: servers
roles:
- { role: username.rolename, x: 42 }

License
-------

BSD

Author Information
------------------

An optional section for the role authors to include contact information, or a website (HTML is not allowed).
```yaml
- hosts: all
roles:
- { role: cadvisor }
```
19 changes: 19 additions & 0 deletions ansible/roles/grafana/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Ansible Role: grafana

Deploy [grafana](https://github.com/grafana/grafana) using Ansible and Docker.

## Requirements

- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it).

## Role variables

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

## Example playbook

```yaml
- hosts: all
roles:
- { role: grafana }
```
19 changes: 19 additions & 0 deletions ansible/roles/mysqld_exporter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Ansible Role: mysqld-exporter

Deploy [mysqld-exporter](https://github.com/prometheus/mysqld_exporter) using Ansible and Docker.

## Requirements

- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it).

## Role variables

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

## Example playbook

```yaml
- hosts: all
roles:
- { role: mysqld_exporter }
```
19 changes: 19 additions & 0 deletions ansible/roles/node_exporter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Ansible Role: node-exporter

Deploy [node-exporter](https://github.com/prometheus/node_exporter) using Ansible and Docker.

## Requirements

- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it).

## Role variables

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

## Example playbook

```yaml
- hosts: all
roles:
- { role: node_exporter }
```
19 changes: 19 additions & 0 deletions ansible/roles/prometheus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Ansible Role: prometheus

Deploy [prometheus](https://github.com/prometheus/prometheus) using Ansible and Docker.

## Requirements

- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it).

## Role variables

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

## Example playbook

```yaml
- hosts: all
roles:
- { role: prometheus }
```

0 comments on commit e8397c5

Please sign in to comment.