Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tbauriedel committed Dec 28, 2023
1 parent c61d1b2 commit 00025dc
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![Lint](https://github.com/tbauriedel/ansible-collection-influxdb/actions/workflows/yamllint.yml/badge.svg)

> **Note:** Collection is work in progress
# ansible-collection-influxdb
Expand All @@ -16,5 +18,5 @@ It was created with the aim of refreshing my Ansible knowledge and getting in to

## Roles

* repos
* influxdb
* [Role: repos](roles/repos/README.md) (add repositories)
* [Role: influxdb](roles/influxdb/README.md) (install and configure influxdb)
24 changes: 24 additions & 0 deletions roles/influxdb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# influxdb.influxdb

## Description

With that role you can install and configure InfluxDB.
At the moment the configuration is very basic. Over time, this role will be expanded.

## Variables

* `influxdb_influxdb_bolt_path`: InfluxDB bolt-path
* `influxdb_influxdb_engine_path`: InfluxDB engine-path

Defaults can be viewed in vars/defaults.yml

## Example

Install the official InfluxDB repository:
```
- hosts: all
become: true
roles:
- influxdb
```
20 changes: 20 additions & 0 deletions roles/repos/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# influxdb.repos

## Description

With that role the official [InfluxDB repository](https://repos.influxdata.com) and signing key will be installed.

## Variables

Defaults can be viewed in vars/defaults.yml

## Example

Install the official InfluxDB repository:
```
- hosts: all
become: true
roles:
- repos
```

0 comments on commit 00025dc

Please sign in to comment.