Pools.yaml file attributes documentation should be improved
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Designate |
In Progress
|
Undecided
|
Unassigned | ||
Bug Description
I am opening a new issue because the last generic docs topic was opened 8 years ago, some of its topics were implemented, some were removed / are deprecated today.
The pools.yaml file defines the relationship between the pools.yaml attributes (e.g. ns_records, nameservers for pools, targets for pools etc).
Note: I am not talking about the "attributes" section.
Today the contents of this file are explained in a few different places, the ones I am aware of are the following:
https:/
https:/
It is not clear what is the relationship between the pools.yaml attributes, for what use cases they should be used.
An example I could think of is having a smaller ns_records list than nameservers, in case we wouldn't like to advertise all of them, so we would have stealth nameservers.
Another example is having the opposite (less nameservers compared to ns_records), maybe we have only one primary nameserver that we want to make sure it receives updates, and additional ns_records specify secondary servers as well.
By providing those examples, we could explain better the pools.yaml use cases and the relationship between its attributes.
| OpenStack Infra (hudson-openstack) wrote Fix proposed to designate (master) | #1 |
| Changed in designate: | |
| status: | New → In Progress |
| summary: |
- Multipool docs need to be improved + Pools.yaml file attributes documentation should be improved |
Fix proposed to branch: master
Review: https:/