Ansibledb_collection gives you the ability to quickly collect facts about your Infrastucture estate [linux, windows & network devices] and via our API, pull out the information important to you. If you've used puppetDB, the functionality is almost identical. With ansibleDB OpenSource, you can create dynamic ansible inventories to target specific servers with a specific action.
You need to first install and setup our ansibledb_api_opensource repo: ansibledb_api_opensource repo
This collection is maintained by APIDB LTD
Includes:
- apidb_localfacts
- apidb_collect
- apidb_net_role
- apidb_post
Install the collection locally:
$ ansible-galaxy collection install apidb.ansibledb_opensource -p ./collections
Only if your control node is Ubuntu or RHEL/Centos/OEL 8, you may need to install python-requests to use this collection.
$ sudo apt-get install -y python-requests
or
$ yum install -y python-requests
- Ansible >= 2.7
- Python >= 2.7
- Tested with
jqversion 1.5.1
AnsibleDB can collect Linux, Windows and network device facts. Below you will get documentation for either the linux or windows servers, or network devices. Expand the section you wish to set up.
This section explains the windows and Linux setup. Scroll down for Network Devices.
You need to first install and setup our ansibledb_api_opensource repo - ansibledb_api_opensource repo
Once ansibledb_api_opensource is installed and setup, this step will setup the ansibledb_opensource collection from ansible-galaxy which will collect facts from your servers using the ansible setup module.
Once Ansibledb_api_opensource is setup, go ahead and setup this repo to start collection and posting facts into ansibledb_api_opensource.
Create your own deploy.yml file and add the contents below.
---
- name: collect facts
hosts: all
collections:
- apidb.ansibledb_opensource
tasks:
- import_role:
name: apidb_localfacts
tags: facts
- import_role:
name: apidb_collect
tags: collect
- name: Post to APIDB
hosts: localhost
connection: local
gather_facts: false
collections:
- apidb.ansibledb_opensource
roles:
- role: apidb_post
tags: post
Run the following command to add a group_vars/all file and add the TOKEN:
mkdir group_vars- Now add the endpoint
vi group_vars/all - Add the following to the file.
---
ansibledb_server: https://ansibledb_IP_Address
- Now save the file.
Consider adding these settings to your ansible.cfg file under [defaults]
- Forks allows to run more concurrent runs than the default of 5.
- Inventory should point to your inventory file
- display_skipped_hosts won't show all the "skipped" ansible code.
[defaults]
forks = 20
inventory = inventory
display_skipped_hosts = false
Now you've setup ansibledb_opensource, run it to check everything is working and you have connectivity. In my exampe, I've added the inventory file to the ansible.cfg file. If you haven't, you'll need to include the inventory file in additon to the command below.
ansible-playbook deploy.yml
We've setup a simple way for your to run you're own custom playbooks to collect facts important to you. Follow this process:
Use our prepared ansible playbooks from our custom_extensions repo in github.
- Clone the repo into the same base DIR as our collection:
git clone https://github.com/apidb-io/custom_extensions.git - Edit the main.yml
vi custom_extensions/main.yml - Un-hash the playbooks you would like to run.
- Some fact collections will only work on specific operating system versions.
- custom_extensions/extensions/tidyup.yml # Cleans out old files
# - custom_extensions/extensions/sample_facts.yml # My own loacl fact collection populates the dashboard.
# - custom_extensions/extensions/cis.yml # Checks CIS controls against RHEL7
# - custom_extensions/extensions/packages.yml # adds packages intot he dashboard.
# - custom_extensions/extensions/sysctl.yml # Add sysctl settings into the dashboard.
- Run the playbook as below:
ansible-playbook deploy.yml
You're free to add your own playbooks into the same directory once you create it and they will be picked up when the apidb collection runs.
- In the same base DIR of the collection, create the directory:
mkdir custom_extensions - Add your own playbooks templates, files, etc into this DIR.
- To create your own facts, you need to create a file ON THE REMOTE SERVERS in ````/tmp/local/.fact```
- Add a title to top of the file. It must be in this format:
[fact_name] - The facts listed in the <name.fact> file must to be in this format
key: value:
EXAMPLE
[local_facts]
cloud: AWS
INSTANCE_TYPE: t2.micro
AVAIL_ZONE: eu-west-1b
REGION: eu-west-1
- You're free to collect the facts anyway you wish. Either manually or scripted is fine. All we are looking for is a file in the format above with key: values.
- Run the playbook as below and ansibledb_opensource will collect the facts and insert them into the DB.
- Test your updates
ansible-playbook deploy.yml
If you're running against lots of servers, you can utilise the ansible.cfg "forks" setting. The default is 5 forks but you can increase this (depending on the size of your control node). You will need to do some testing, but you should be able to double or triple the number of forks you run.
I.E.
[defaults]
forks = 20
To pull out server and fact information directly from the database. Here are some examples:
-
Pull out all data:
curl -s https://ansibledb_api_IP_address:5000/api/servers | jq -
List all servernames, distribution and version:
curl -s https://ansibledb_api_IP_address:5000/api/servers | jq '[.[] | {name:.ansible_facts.ansible_fqdn, distribution:.ansible_facts.ansible_distribution, version: .ansible_facts.ansible_distribution_version}]' -
Generate a list of servernames that match a specific fact (in this case ubuntu 18.04):
curl -s https://ansibledb_api_IP_address:5000/api/servers | jq --arg INPUT "$INPUT" -r '.[] | select(.ansible_facts.ansible_distribution_version | tostring | contains("18.04")) | (.ansible_facts.ansible_fqdn)' -
if you've generated local facts, access them like this:
curl -s https://ansibledb_api_IP_address:5000/api/servers | jq -r '.[].ansible_facts.ansible_local.local' -
And to get to specific facts:
curl -s https://ansibledb_api_IP_address:5000/api/servers | jq -r '.[].ansible_facts.ansible_local.local.local_facts.region'
This section explains how to setup and use network devices.
Apidb_net_role gives you the ability to quickly collect facts from your Network Devices and via our API, pull out the information important to you. If you've used puppetDB, the functionality is almost identical. With ansibleDB OpenSource, you can also create dynamic ansible inventories to target specific servers with a specific action.
We are adding more supported network devices all the time. Here is a list of the currently supported devices:
- Palo Alto
- Cisco
You need to first install and setup:
This role is maintained by APIDB LTD
Includes:
- apidb_collect_net
Usage
Saves this role in the apidb_opensource collection under roles
- Ansible >= 2.9
- Python >= 2.7
- Tested with
jqversion 1.5.1 - Collection from the network vendor for example Cisco or Palo
Each specific Network Device will need to utilise it's own vendors collection. The below deployment file gives an example of using Palo Alto and Cisco devices, but you will need to install the vendor collections, before you can collect the facts. For more information see:
Install the required collection for you device by follwoing the instructions on the links above.
Create your own deploy.yml file and add the contents below.
---
- name: collect facts
hosts: all
collections:
- apidb.ansibledb_opensource
tasks:
- import_role:
name: apidb_net_role
tags: collect_net
- name: Post to APIDB
hosts: localhost
connection: local
gather_facts: false
collections:
- apidb.ansibledb_opensource
roles:
- role: apidb_post
tags: post
Run the following command to add a group_vars/all file and add the TOKEN:
mkdir group_vars- Now add the endpoint
vi group_vars/all - Add the following to the file.
---
ansibledb_server: "http://ansibledb_api_IP_Address:5000/api/servers"
- Now save the file.
Set-up the devices
For networking device you need for example:
ansible_connection: local
ansible_network_os: panos
Now you've setup ansibledb_net, run it to check everything is working and you have connectivity. In my exampe, I've added the inventory file to the ansible.cfg file. If you haven't, you'll need to include the inventory file in additon to the command below.
ansible-playbook deploy.yml
curl -s http://ansibledb_api_IP_address:5000/api/servers | jq '[.[] | {name:.ansible_facts.ansible_net_model}]'
BSD
This role has been create by the APIDB team. Further information and contact is available from here
Only send facts you are happy to send and make use of the "Resticted Keys" functionality.
This role was written and contributed to by the following people:
- Dennis McCarthy
- Seth Daemen
- [Toby Lockyer] (https://github/tobylockyer)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent