README.md 1.73 KB
Newer Older
mrazekales's avatar
mrazekales committed
1
2
3
4
# Resolvers-YANG

YANG data models and tools for unified configuration of DNS resolvers

Aleš Mrázek's avatar
Aleš Mrázek committed
5
* [Official Documentation](https://labs.pages.labs.nic.cz/resolvers-yang/)
Aleš Mrázek's avatar
Aleš Mrázek committed
6
7
* [Examples of usage](https://gitlab.labs.nic.cz/labs/resolvers-yang/wikis/examples)
* [Wiki](https://gitlab.labs.nic.cz/labs/resolvers-yang/wikis/home)
Aleš Mrázek's avatar
Aleš Mrázek committed
8
* [Deckard config](https://gitlab.labs.nic.cz/labs/resolvers-yang/wikis/deckard)
Aleš Mrázek's avatar
Aleš Mrázek committed
9

mrazekales's avatar
mrazekales committed
10
11
12
13
14
Data model and library for DNS resolvers:
* [Knot Resolver](https://www.knot-resolver.cz/)
* [Unbound](https://www.unbound.net/)

## Data Model
Aleš Mrázek's avatar
Aleš Mrázek committed
15
* [Current schema tree](https://gitlab.labs.nic.cz/labs/resolvers-yang/raw/master/data-model/model.tree)
Aleš Mrázek's avatar
Aleš Mrázek committed
16
* [Example JSON data](https://gitlab.labs.nic.cz/labs/resolvers-yang/raw/master/examples/example-data.json)
mrazekales's avatar
mrazekales committed
17
18

#### YANG Modules
Aleš Mrázek's avatar
Aleš Mrázek committed
19
20
21
* [cznic-dns-types](https://gitlab.labs.nic.cz/labs/resolvers-yang//raw/master/yang-modules/cznic-dns-types@2018-05-14.yang)
* [cznic-resolver-common](https://gitlab.labs.nic.cz/labs/resolvers-yang/raw/master/yang-modules/cznic-resolver-common@2018-07-27.yang)
* [cznic-resolver-knot](https://gitlab.labs.nic.cz/labs/resolvers-yang/raw/master/yang-modules/cznic-resolver-knot@2018-07-27.yang)
mrazekales's avatar
mrazekales committed
22

23

mrazekales's avatar
mrazekales committed
24
25
## Getting Started

Aleš Mrázek's avatar
Aleš Mrázek committed
26
Requires **Python 3.5** or newer
mrazekales's avatar
mrazekales committed
27
28
29

```bash
$ sudo apt-get install python3
Aleš Mrázek's avatar
Aleš Mrázek committed
30
$ sudo apt-get install python3-pip
mrazekales's avatar
mrazekales committed
31
32
```

Aleš Mrázek's avatar
Aleš Mrázek committed
33
**Installation**
mrazekales's avatar
mrazekales committed
34

Aleš Mrázek's avatar
Aleš Mrázek committed
35
36
The Development instructions are [here](https://gitlab.labs.nic.cz/labs/resolvers-yang/wikis/devinstall).

mrazekales's avatar
mrazekales committed
37
```bash
Aleš Mrázek's avatar
Aleš Mrázek committed
38
$ git clone https://gitlab.labs.nic.cz/labs/resolvers-yang.git
Aleš Mrázek's avatar
Aleš Mrázek committed
39
$ cd resolvers-yang
mrazekales's avatar
mrazekales committed
40
41
$ python3 setup.py install
```
42
43
44
45


## Create local documentation

Aleš Mrázek's avatar
Aleš Mrázek committed
46
Local [Sphinx](http://www.sphinx-doc.org/en/master/) documentation is located in `docs` directory.
47
48
49
50
51
52

```
$ cd docs/
$ make html
```

Aleš Mrázek's avatar
Aleš Mrázek committed
53
Then open `_build/html/index.html` in your web browser.