Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fboender/ansible-cmdb

Generate host overview from ansible fact gathering output
https://github.com/fboender/ansible-cmdb

ansible cmdb frontend inventory overview

Last synced: 2 days ago
JSON representation

Generate host overview from ansible fact gathering output

Host: GitHub
URL: https://github.com/fboender/ansible-cmdb
Owner: fboender
License: gpl-3.0
Created: 2015-06-09T19:56:02.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-05-15T14:47:48.000Z (7 months ago)
Last Synced: 2024-12-03T09:07:45.683Z (9 days ago)
Topics: ansible, cmdb, frontend, inventory, overview
Language: Python
Size: 1.41 MB
Stars: 2,361
Watchers: 146
Forks: 468
Open Issues: 48
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-repositories - fboender/ansible-cmdb - Generate host overview from ansible fact gathering output (Python)
awesome-ansible - Ansible cmdb - Takes the output of Ansible's fact gathering and converts it into a static HTML page. (Tools)
awesome-starred - fboender/ansible-cmdb - Generate host overview from ansible fact gathering output (frontend)
Retro-Gaming-Guide - Ansible cmdb
awesome-ansible - Ansible cmdb - Takes the output of Ansible's fact gathering and converts it into a static HTML overview page containing system configuration information. (Tools)
awesome-list-ansible - ansible-cmdb
awesome-ansible - Ansible cmdb - Takes the output of Ansible's fact gathering and converts it into a static HTML page. (Tools)

README

        Ansible Configuration Management Database

=========================================

![Status: Stable](https://img.shields.io/badge/status-stable-green.svg)

![Build Status](http://build.electricmonk.nl/job/ansible-cmdb/shield)

![Activity: Active development](https://img.shields.io/badge/activity-active%20development-green.svg)

![License: GPLv3](https://img.shields.io/badge/license-GPLv3-blue.svg)

About

-----

Ansible-cmdb takes the output of Ansible's fact gathering and converts it into

a static HTML overview page (and other things) containing system configuration

information.

It supports multiple types of output (html, csv, sql, etc) and extending

information gathered by Ansible with custom data. For each host it also shows

the groups, host variables, custom variables and machine-local facts.

![](https://raw.githubusercontent.com/fboender/ansible-cmdb/master/contrib/screenshot-overview.png)

![](https://raw.githubusercontent.com/fboender/ansible-cmdb/master/contrib/screenshot-detail.png)

[HTML example](https://rawgit.com/fboender/ansible-cmdb/master/example/html_fancy.html) output.

Features

--------

(Not all features are supported by all templates)

* Multiple formats / templates:

    * Fancy HTML (`--template html_fancy`), as seen in the screenshots above.

    * Fancy HTML Split (`--template html_fancy_split`), with each host's details

      in a separate file (for large number of hosts).

    * CSV (`--template csv`), the trustworthy and flexible comma-separated format.

    * JSON (`--template json`), a dump of all facts in JSON format.

    * Markdown (`--template markdown`), useful for copy-pasting into Wiki's and

      such.

    * Markdown Split (`--template markdown_split`), with each host's details

      in a seperate file (for large number of hosts).

    * SQL (`--template sql`), for importing host facts into a (My)SQL database.

    * Plain Text table (`--template txt_table`), for the console gurus.

    * and of course, any custom template you're willing to make.

* Host overview and detailed host information.

* Host and group variables.

* Gathered host facts and manual custom facts.

* Adding and extending facts of existing hosts and manually adding entirely

  new hosts.

* Custom columns

Getting started

---------------

Links to the full documentation can be found below, but here's a rough

indication of how Ansible-cmdb works to give you an idea:

1. Install Ansible-cmdb from [source, a release

   package](https://github.com/fboender/ansible-cmdb/releases) or through pip: `pip

   install ansible-cmdb`.

1. Fetch your host's facts through ansible:

        $ mkdir out

        $ ansible -m setup --tree out/ all

1. Generate the CMDB HTML with Ansible-cmdb:

        $ ansible-cmdb out/ > overview.html

1. Open `overview.html` in your browser.

That's it! Please do read the full documentation on usage, as there are some

caveats to how you can use the generated HTML.

Documentation

-------------

All documentation can be viewed at [readthedocs.io](http://ansible-cmdb.readthedocs.io/en/latest/).

* [Full documentation](http://ansible-cmdb.readthedocs.io/en/latest/)

* [Requirements and installation](http://ansible-cmdb.readthedocs.io/en/latest/installation/)

* [Usage](http://ansible-cmdb.readthedocs.io/en/latest/usage/)

* [Contributing and development](http://ansible-cmdb.readthedocs.io/en/latest/dev/)

License

-------

Ansible-cmdb is licensed under the GPLv3:

    This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation, either version 3 of the License, or

    (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program.  If not, see .

    For the full license, see the LICENSE file.