Document usage
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Luke Murphy 2020-03-28 19:40:08 +01:00
parent f4c291715f
commit 66716046e9
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 22 additions and 0 deletions

View File

@ -44,3 +44,25 @@ Include an entry in your `requirements.yml` like so.
See the [releases](https://git.autonomic.zone/autonomic-cooperative/autonomic.gandi/releases) for which is the latest version.
Then make sure to download the role with `ansible-galaxy install -r requirements.yml`.
## Example
```yaml
---
- hosts: localhost
gather_facts: false
connection: local
tasks:
- name: Create foobar.autonomic.zone
gandi_dns:
rest_api_key: "{{ lookup('env', 'LEXICON_GANDI_AUTH_TOKEN') }}"
domain: foobar.autonomic.zone
ipv4: 94.130.105.60
state: present
```
## Features
- [x] Create a new DNS entry
- [x] Delete an existing DNS entry
- [ ] Update an existing DNS entry