Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/locaweb/power_dnsex
PowerDNS Elixir client
https://github.com/locaweb/power_dnsex
elixir hacktoberfest powerdns powerdns4
Last synced: about 2 months ago
JSON representation
PowerDNS Elixir client
- Host: GitHub
- URL: https://github.com/locaweb/power_dnsex
- Owner: locaweb
- License: mit
- Created: 2016-07-22T03:20:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-18T19:34:47.000Z (about 3 years ago)
- Last Synced: 2024-04-24T19:33:45.203Z (8 months ago)
- Topics: elixir, hacktoberfest, powerdns, powerdns4
- Language: Elixir
- Homepage:
- Size: 102 KB
- Stars: 10
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PowerDNSex
A client to [PowerDNS 4 API](https://doc.powerdns.com/md/httpapi/README/), with all CRUD operations to manage zones and records.
[](https://travis-ci.org/digaoddc/power_dnsex)
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add `powerdnsex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:powerdnsex, "~> 0.1.0"}]
end
```
2. Ensure `powerdnsex` is started before your application:
```elixir
def application do
[applications: [:powerdnsex]]
end
```
## Configuration
Insert this in your configuration files. Eg: `config.exs`
```elixir
config :powerdnsex, url: "localhost:8081",
token: "sometoken"
```
You can also use ENV vars to configure PowerDNSex.
```elixir
config :powerdnsex, url: {:system, "POWERDNS_URL"},
token: {:system, "POWERDNS_TOKEN"}
```
Make sure you set those environment variables.
## Example usage
### Zone Management
```elixir
# CREATE ZONE:
zone_model = %PowerDNSex.Models.Zone{
id: "example.com.",
kind: "Master",
name: "example.com.",
serial: 1,
}
{:ok, zone} = PowerDNSex.create_zone(zone_model)
# SHOW ZONE:
{:ok, zone} = PowerDNSex.show_zone("example.com")
# SHOW ZONE without RRSets:
{:ok, zone} = PowerDNSex.get_zone("example.com")
# DELETE ZONE:
res = PowerDNSex.delete_zone("example.com")
```
### Record management
```elixir
# CREATE RECORD:
{:ok, zone} = PowerDNSex.show_zone("example.com")
record = %{
name: "test.example.com.",
type: "A",
ttl: 60,
records: [
%{
content: "192.168.11.67",
disabled: false,
}
]
}
res = PowerDNSex.create_record(zone, record)
# SHOW RECORD:
record = %{
name: "test.example.com.",
type: "A",
}
rrset = PowerDNSex.show_record("example.com", record)
# UPDATE RECORD:
{:ok, zone} = PowerDNSex.show_zone("example.com")
record = %{
name: "test.example.com.",
type: "A",
ttl: 60,
records: [
%{
content: "192.168.11.100",
disabled: false,
}
]
}
res = PowerDNSex.update_record(zone, record)
# DELETE RECORD:
{:ok, zone} = PowerDNSex.show_zone("example.com")
record = %{
name: "test.example.com.",
type: "A",
}
rrset = PowerDNSex.show_record("example.com", record)
res = PowerDNSex.delete_record(zone, rrset)
```
## Development
### Setup application
```bash
$ script/setup
```
### Run local console (IEX)
```bash
$ script/run
```
### Run tests
```bash
$ script/test
```
#### Run tests to a specific File
```bash
$ script/test test/lib/powerdnsex/powerdnsex_test.exs
```
### Reset environment (clean + setup)
### YOU WILL LOSE EVERYTHING
Good for then you change the elixir version and need to delete everything and start again
```bash
$ script/reset
```