influxdata / influxdata/influxdb

Create Ansible module collection

Open
#23,543 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
31.7k
Forks
3.7k
Avg merge
13h 37m
Merged PRs (30d)
8

Description

We want to enable users to scale deployments of OSS across their global topologies. To help with this, we should try to meet them where they are from a distributed deployment standpoint. A common tool used for this is Ansible.

Currently, there is a [community-contributed InfluxDB deployment module for 1.X](https://docs.ansible.com/ansible/latest/collections/community/general/influxdb_database_module.html#ansible-collections-community-general-influxdb-database-module) as well as a set of InfluxDB modules that interact with the other APIs:
![Screen Shot 2022-07-12 at 8 01 13 PM](https://user-images.githubusercontent.com/4852912/178641692-379d45e0-38f8-4311-a742-024697a46bd2.png)

This is a request to do something in a similar vein with v2. I think we need a collection of modules that encompass at least most of the operational APIs (i.e., not `query` or `write`). I say operational APIs as that is, in my experience, the audience that uses Ansible. Interfacing with InfluxDB via query and writes should be done elsewhere. Ansible's role in "usage" of instances is likely best for testing/benchmarking.

### MVP Spec:
- (discuss) _Download, install, run, restart (it's possible this could be left out as it's fairly simple to do this with service/package management modules)_
- Setup
- Health
- Users
- Authorizations
- Buckets (create and delete)
- Tasks
- Remotes and replications

### Full Spec:
- Rest of APIs -- priority order (debatable):
- Dashboards
- Labels and variables
- Scrapers
- Write (for benchmarking)
- Query (benchmarking)
- v1 write/query
- Backup/restore
- Checks/Notifications
- ...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked community.general InfluxDB module and the InfluxDB operational API documentation. Compare the proposed MVP list—setup, health, users, authorizations, buckets, tasks, remotes, and replications—and clarify the collection scope and priorities before implementation. Done means an agreed Ansible collection covering the selected operational APIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
ansible
Domain
databases, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.