This commit is contained in:
parent
3363f7a76b
commit
d9bae5646a
27
README.md
27
README.md
@ -7,14 +7,30 @@ Ansible libraries for manging Gandi resources.
|
|||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- [Ansible >= 2.9.6](https://pypi.org/project/ansible/)
|
- [Ansible >= 2.9.6](https://pypi.org/project/ansible/)
|
||||||
- [Gandi.cli >= 1.5](https://pypi.org/project/gandi.cli/)
|
- [dns-lexicon >= 3.3.19](https://pypi.org/project/dns-lexicon/) (if using `gandi_dns` module)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ pip install ansible==2.6.9 gandi.cli==1.5
|
$ pip install ansible==2.6.9 "dns-lexicon[gandi]==3.3.19"
|
||||||
```
|
```
|
||||||
|
|
||||||
These should be present on the localhost where you run Ansible.
|
These should be present on the localhost where you run Ansible.
|
||||||
|
|
||||||
|
## Gandi DNS Setup
|
||||||
|
|
||||||
|
If you want to use the `gandi_dns` module you need to prepare the environment.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export PROVIDER="gandi"
|
||||||
|
export LEXICON_GANDI_AUTH_TOKEN="${pass show users/decentral1se/gandi/api_key)"
|
||||||
|
export LEXICON_GANDI_API_PROTOCOL="rest"
|
||||||
|
```
|
||||||
|
|
||||||
|
You can test that everything is working by running the following.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ lexicon gandi list autonomic.zone
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Include an entry in your `requirements.yml` like so.
|
Include an entry in your `requirements.yml` like so.
|
||||||
@ -28,10 +44,3 @@ 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.
|
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`.
|
Then make sure to download the role with `ansible-galaxy install -r requirements.yml`.
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
|
|
||||||
- [ ] DNS entries
|
|
||||||
- [ ] Create
|
|
||||||
- [ ] Update
|
|
||||||
- [ ] Delete
|
|
||||||
|
Loading…
Reference in New Issue
Block a user