README.md
1# Bindman-DNS Webhook
2
3[](https://goreportcard.com/report/github.com/labbsr0x/bindman-dns-webhook)
4
5This repository lays out the pieces of code of a Bindman-DNS webhook.
6
7The libraries present here should be used in order to ease out integrations among clients and managers.
8
9# Clients and Managers
10
11The objective behind this project is to automate the management of DNS records of a number of different DNS Server providers.
12
13- **Clients** are pieces of software that has the knowledge of services being added and removed from your cluster. Depending of the technology adopted, they may be able to identify which hostname was attached to that service. With that information in hands, the client can then delegate the modification of a DNS Record to a Bindman DNS manager.
14
15- **Managers** are pieces of software that receives requests from clients to modify its DNS Server records.
16
17# Samples
18Two samples are provided in the `samples` folder.
19
20- **client**: demonstrates how one can leverage the client library to communicate with the DNS manager webhook APIs. It is configured via the `BINDMAN_DNS_MANAGER_ADDRESS` which defines the address of the manager instance.
21
22- **hook**: demonstrates how one can leverage the hook library to receive requests modifying the DNS records it manages.
23
24A postman collection is provided (`samples/bindman-dns-webhook-samples.postman_collection.json`) thats lays out the available apis and how to communicate with them.
25
26To build and run the samples just type `docker-compose up` from the samples folder.
27
){kind=link}