Fix eleven typos on designate documentation
restructred => restructured specifaclly => specifically Reserverd => Reserved 2 gerenated => generated Defintion => Definition relavant => relevant occour => occur paramaters => parameters suppied => supplied peform => perform Change-Id: If9d2d8953be8af9e4497425ad1e06ef0ccd74076 Closes-Bug: #1481114
This commit is contained in:
parent
86f85d085a
commit
77a8952290
@ -25,7 +25,7 @@ python setup.py develop
|
|||||||
````
|
````
|
||||||
|
|
||||||
## Building the documentation
|
## Building the documentation
|
||||||
To build the documentation from the restructred text source, do the following:
|
To build the documentation from the restructured text source, do the following:
|
||||||
````
|
````
|
||||||
cd doc
|
cd doc
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
@ -60,7 +60,7 @@ You need to configure PowerDNS to use the MySQL backend.
|
|||||||
.. note::
|
.. note::
|
||||||
PowerDNS can connect via socket or host/port.
|
PowerDNS can connect via socket or host/port.
|
||||||
|
|
||||||
3. Configure the options for designate-central - specifaclly "connection" to point to your MySQL database::
|
3. Configure the options for designate-central - specifically "connection" to point to your MySQL database::
|
||||||
|
|
||||||
[backend:powerdns]
|
[backend:powerdns]
|
||||||
connection = mysql+pymysql://<username>:<password>@<host>:<port>/<dbname>
|
connection = mysql+pymysql://<username>:<password>@<host>:<port>/<dbname>
|
||||||
|
@ -20,7 +20,7 @@ IP space will likely trigger search indexers etc to begin crawling.
|
|||||||
Reserved Domains
|
Reserved Domains
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
Reserverd DNS domains are documented here: `IANA Special Use Domain Names`_.
|
Reserved DNS domains are documented here: `IANA Special Use Domain Names`_.
|
||||||
|
|
||||||
Several common reserved domains:
|
Several common reserved domains:
|
||||||
|
|
||||||
@ -31,7 +31,7 @@ Several common reserved domains:
|
|||||||
Reserved IP Space
|
Reserved IP Space
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
Reserverd IP space is documented here: `IANA IPv4 Special Registry`_, and
|
Reserved IP space is documented here: `IANA IPv4 Special Registry`_, and
|
||||||
`IANA IPv6 Special Registry`_.
|
`IANA IPv6 Special Registry`_.
|
||||||
|
|
||||||
Several common reserved IP blocks:
|
Several common reserved IP blocks:
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
Guru Meditation Reports
|
Guru Meditation Reports
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
A Guru Meditation Reports(GMR) is gerenated by the Designate services when
|
A Guru Meditation Reports(GMR) is generated by the Designate services when
|
||||||
service processes receiving SIGUSR1 signal. The report is a general-purpose
|
service processes receiving SIGUSR1 signal. The report is a general-purpose
|
||||||
debug report for developers and system admins which contains the current state
|
debug report for developers and system admins which contains the current state
|
||||||
of a running Designate service process.
|
of a running Designate service process.
|
||||||
|
@ -182,7 +182,7 @@ In both cases the interaction between your master and Designate is handled by
|
|||||||
the MDNS instance at the Designate side.
|
the MDNS instance at the Designate side.
|
||||||
|
|
||||||
|
|
||||||
Defintion of values:
|
Definition of values:
|
||||||
|
|
||||||
- *email* set to the value of the *managed_resource_email* option in the
|
- *email* set to the value of the *managed_resource_email* option in the
|
||||||
*central* section of the Designate configuration.
|
*central* section of the Designate configuration.
|
||||||
|
@ -4,14 +4,14 @@ Production Guidelines
|
|||||||
|
|
||||||
This document aims to provide a location for documented production
|
This document aims to provide a location for documented production
|
||||||
configurations and considerations. Including common misconfigurations, attack
|
configurations and considerations. Including common misconfigurations, attack
|
||||||
mitigation techniques, and other relavant tips.
|
mitigation techniques, and other relevant tips.
|
||||||
|
|
||||||
DNS Zone Squatting
|
DNS Zone Squatting
|
||||||
==================
|
==================
|
||||||
|
|
||||||
Designate's multi-tenant nature allows for any user to create (almost) any
|
Designate's multi-tenant nature allows for any user to create (almost) any
|
||||||
zone, which can result in the legitimate owner being unable to create the zone
|
zone, which can result in the legitimate owner being unable to create the zone
|
||||||
within Designate. There are several ways this can occour:
|
within Designate. There are several ways this can occur:
|
||||||
|
|
||||||
1. The squatter simply creates "example.com." in Designate before the
|
1. The squatter simply creates "example.com." in Designate before the
|
||||||
legitimate owner can.
|
legitimate owner can.
|
||||||
|
@ -88,12 +88,12 @@ Pagination and Sorting
|
|||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
Pagination is available on all collections and is controlled
|
Pagination is available on all collections and is controlled
|
||||||
using a combination of four optional query paramaters:
|
using a combination of four optional query parameters:
|
||||||
|
|
||||||
* `marker` - denotes the ID of the last item in the previous list.
|
* `marker` - denotes the ID of the last item in the previous list.
|
||||||
* `limit` - use to set the maximum number of items per page, use
|
* `limit` - use to set the maximum number of items per page, use
|
||||||
"max" to return the upper limit of results as defined
|
"max" to return the upper limit of results as defined
|
||||||
by the operator. If not suppied, the default per page
|
by the operator. If not supplied, the default per page
|
||||||
limit as defined by the operator will be used.
|
limit as defined by the operator will be used.
|
||||||
* `sort_key` - sorts the results by the specified attribute
|
* `sort_key` - sorts the results by the specified attribute
|
||||||
|
|
||||||
|
@ -295,7 +295,7 @@ Update Pool
|
|||||||
|
|
||||||
This would **replace** the value of the `ns_records` key.
|
This would **replace** the value of the `ns_records` key.
|
||||||
|
|
||||||
It is a good practice to peform a GET and mutate the result
|
It is a good practice to perform a GET and mutate the result
|
||||||
accordingly.
|
accordingly.
|
||||||
|
|
||||||
:statuscode 202: Accepted
|
:statuscode 202: Accepted
|
||||||
|
Loading…
Reference in New Issue
Block a user