valentin-binotto/NOC-YAMLbox
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Valentin Binotto 2025-11-23 20:42:31 +00:00
parent 06907d42fa
commit 1057aa5c79
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -4,5 +4,33 @@
## Considerations
## Structure
```
/cmr
/cmr/devices
/cmr/devices/cccp.yaml
/cmr/devices/cccp.txt
/cmr/devices/nos/cccp.cli
/cmr/devices/nos/cccp.local.cli
/cmr/dns
/cmr/dns/cccp.yaml
/cmr/dns/cccp.zone
/cmr/dns/cccp.cli
/cmr/ipv4
/cmr/ipv4/cccp.yaml
/cmr/ipv4/cccp.txt
/cmr/ipv6
/cmr/ipv6/cccp.yaml
/cmr/ipv6/cccp.txt
/cmr/racks
/cmr/racks/a1e.cc.cit-mgmt-0001.yaml
/cmr/regions
/cmr/regions/cmr.yaml
/cmr/tenants
/cmr/tenants/cccp.yaml
/cmr/tenants/cccp.txt
```
## Data format
As the goal of NOC-YAMLbox is to be highly customizable, every plain-text based data format can be used. Users SHOULD only use ASCII-characters.
The only data format that IS REQUIRED and has a ruleset on which data needs to be present is YAML.