cleanup readme

This commit is contained in:
Robert Kaussow 2020-01-30 22:58:49 +01:00
parent caa5235934
commit ee42de5629
1 changed files with 6 additions and 107 deletions

113
README.md
View File

@ -1,115 +1,14 @@
# xoxys.network
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.network/status.svg)](https://drone.rknet.org/ansible/xoxys.network)
[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.network?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.network)
Role to manage network interfaces
## Table of content
### License
* [Default Variables](#default-variables)
* [network_defaultif](#network_defaultif)
* [network_disable_ipv6](#network_disable_ipv6)
* [network_dns_server](#network_dns_server)
* [network_fqdn](#network_fqdn)
* [network_hostname](#network_hostname)
* [network_hosts_entries](#network_hosts_entries)
* [network_interfaces](#network_interfaces)
* [Dependencies](#dependencies)
* [License](#license)
* [Author](#author)
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
### Maintainers and Contributors
## Default Variables
### network_defaultif
#### Default value
```YAML
network_defaultif: eth0
```
### network_disable_ipv6
#### Default value
```YAML
network_disable_ipv6: false
```
### network_dns_server
#### Default value
```YAML
network_dns_server: 8.8.8.8
```
### network_fqdn
#### Default value
```YAML
network_fqdn: localdomain
```
### network_hostname
#### Default value
```YAML
network_hostname: localhost
```
### network_hosts_entries
#### Default value
```YAML
network_hosts_entries: []
```
#### Example usage
```YAML
network_hosts_entries:
- hostname: myhost
fqdn: myhost.rknet.org
address: 1.2.3.4
```
### network_interfaces
#### Default value
```YAML
network_interfaces: {}
```
#### Example usage
```YAML
network_interfaces:
eth0:
bootproto: none
onboot: yes
hwaddr: "aa:bb:cc:dd:ee"
ipaddr: 192.168.0.5
prefix: 26
gateway: "192.168.0.1"
userctl: no
```
## Dependencies
None.
## License
MIT
## Author
[xoxys](https://gitea.rknet.org/xoxys)
[Robert Kaussow](https://gitea.rknet.org/xoxys)