Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 3.02 KB

README.md

File metadata and controls

69 lines (45 loc) · 3.02 KB

Build Status

Modules

This repository contains a collection of useful Ansible Modules to manage CouchDB instances. All modules are compatible with CouchDB 1.6.x and >2.x.

couchdb_user

This module lets you easily manage admin and user accounts of a CouchDB database with Ansible.

Installation

To use it, just copy the file lib/couchdb_user.py into one of your Ansible library folders.

Usage

The full documentation can be found at the top of the module file; but it basically boils down to this:

- name: create admin account
  couchdb_user: name=heisenberg password=the-one-who-knocks admin=yes state=present

You'll also find plenty more examples in the integration test suite.

couchdb_config

This module lets you easily change the configuration of a running CouchDB instance via the REST API.

Installation

To use it, just copy the file lib/couchdb_config.py into one of your Ansible library folders.

Example

- name: change httpd configuration
  couchdb_config: section=httpd key=socket_keys value='[{recbuf, 262140}, {sndbuf, 262140}]'

More examples can be found in the integration test suite.

couchdb_database

This module lets you easily create and remove databases and manage their permissions.

Installation

To use it, just copy the file lib/couchdb_database.py into one of your Ansible library folders.

Example

---
- name: create database
  couchdb_database: name=foo state=present
---
- name: create secured database
  couchdb_database: name=foo member_names=["kevin"]
---
- name: delete database
  couchdb_database: name=foo state=absent

More examples can be found in the integration test suite.

Develop

Check here for instructions on how to start developing on this project.

License

This project is licensed under the terms of the MIT license.