Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lfbear/ansible-api

A RESTful HTTP Api for Ansible
https://github.com/lfbear/ansible-api

ansible api http-api python realtime-messaging rest-api

Last synced: 11 days ago
JSON representation

A RESTful HTTP Api for Ansible

Host: GitHub
URL: https://github.com/lfbear/ansible-api
Owner: lfbear
License: gpl-3.0
Created: 2016-05-25T03:06:48.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2022-08-29T14:28:02.000Z (about 2 years ago)
Last Synced: 2024-09-21T10:38:18.624Z (about 2 months ago)
Topics: ansible, api, http-api, python, realtime-messaging, rest-api
Language: Python
Homepage:
Size: 238 KB
Stars: 135
Watchers: 11
Forks: 58
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-list-ansible - ansible-api

README

        # ansible-api v0.5.1

A restful http api for ansible

python version >= 3.7

## What is it?

[Ansible](https://github.com/ansible/ansible/) is a radically simple IT automation system.

If you are trying to use it and not like CLI, you can try me now. I can provide you use ansible by A RESTful HTTP Api and a realtime processing message (websocket api), you can see all details.

## Changelog

- 0.5.1 

  + add sha256 encryption support for signature (thx: jbackman)

  + fit for latest ansible(v2.8.6) and ansible-runner(v1.4.2)

  + add more error event capture in response

- 0.5.0 replace tornado with sanic, more lightly (python>=3.7) 

- 0.3.0 using ansible-runner as middleware

- 0.2.6 adaptive ansible 2.6.4 and add asynchronization mode

- 0.2.2 optimize log

- 0.2.1 optimize log and allow mutil-instance in the same host

- 0.2.0 support websocket, remove code invaded in ansible

## Structure chart

![image](https://github.com/lfbear/ansible-api/raw/master/data/structure.png)

## How to install

- [preparatory work] python version >= 3.7 (use asyncio featrue)

- ```pip3 install ansible-api```

## How to start it

- default configuration: /etc/ansible/api.cfg

- start: 

```

ansible-api -c [Configfile, Optional] -d [Daemon Mode, Optional]

```

eg: ansible-api -c /etc/ansible/api.cfg -d > /dev/null &

## How to prepare your data

[HTTP API Usage](https://github.com/lfbear/ansible-api/wiki/http-api-usage)