https://github.com/joellefkowitz/digitalocean-inventory
An Ansible dynamic inventory for DigitalOcean.
https://github.com/joellefkowitz/digitalocean-inventory
ansible digitalocean inventory
Last synced: 5 months ago
JSON representation
An Ansible dynamic inventory for DigitalOcean.
- Host: GitHub
- URL: https://github.com/joellefkowitz/digitalocean-inventory
- Owner: JoelLefkowitz
- License: mit
- Created: 2021-02-16T15:38:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T22:07:28.000Z (about 2 years ago)
- Last Synced: 2025-01-12T09:52:01.789Z (over 1 year ago)
- Topics: ansible, digitalocean, inventory
- Language: Python
- Homepage:
- Size: 85 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# DigitalOcean inventory
An Ansible dynamic inventory for DigitalOcean.
## Installing
```bash
pip install digitalocean-inventory
```
## Documentation
Documentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/digitalocean-inventory).
## Usage
Export the project environment variables:
```bash
export DO_PROJECT=example
export DO_ENV=production
export DO_SSH_DIR=/Users/joel/.ssh/example
```
Export an access token:
```bash
export DO_ACCESS_TOKEN=
```
The packages exposes the executable:
```bash
digitalocean-inventory --list
```
Tags and inventory metadata are compiled into the output:
```json
{
"meta": {
"hostvars": {
"123.123.123.123": {
"ansible_python_interpreter": "/usr/bin/python3",
"ansible_ssh_extra_args": "-o StrictHostKeyChecking=no",
"ansible_ssh_private_key_file": "/Users/joel/.ssh/example/example-production-0"
}
}
},
"all": {
"hosts": ["123.123.123.123"],
"vars": {},
"children": {}
},
"production": {
"hosts": ["123.123.123.123"]
},
"manager": {
"hosts": ["123.123.123.123"]
}
}
```
The executable has support for host, list and debug flags:
```bash
usage: Digital ocean inventory [-h] [--host [HOST]] [--list [LIST]] [--debug [DEBUG]]
[--private-ips [PRIVATE_IPS]]
optional arguments:
--host [HOST]
--list [LIST]
--debug [DEBUG]
--private-ips [PRIVATE_IPS]
```
To use with the ansible-playbook cli:
**`inventory.py`**:
```python
#!/usr/bin/env python
from digitalocean_inventory import fetch
if __name__ == '__main__':
fetch()
```
```bash
ansible-playbook -i inventory.py
```
You can consume the inventory in order to mutate it before outputting:
```python
#!/usr/bin/env python
from digitalocean_inventory import fetch
if __name__ == '__main__':
inventory = fetch(stdout=False)
print(inventory)
```
## Tooling
### Dependencies
To install dependencies:
```bash
yarn install
pip install .[all]
```
### Tests
To run tests:
```bash
thx test
```
### Documentation
To generate the documentation locally:
```bash
thx docs
```
### Linters
To run linters:
```bash
thx lint
```
### Formatters
To run formatters:
```bash
thx format
```
## Contributing
Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.
This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).
Bump2version is used to version and tag changes. For example:
```bash
bump2version patch
```
### Contributors
- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work
## Remarks
Lots of love to the open source community!
