summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Simmons <tim.simmons@rackspace.com>2017-03-14 20:51:17 +0000
committerTim Simmons <tim.simmons@rackspace.com>2017-03-14 20:51:17 +0000
commit8f4adefbedd5a3c4214cafc01d3f6a4a102e99bf (patch)
tree8f64c514e0f030909de8afa7a23b15275690ef1f
parentf48feafccdb7860d777d96c11e7a7c7934637c83 (diff)
Make Pools documentation better5.0.0.0b1
Moves a bit that was generally helpful out of a how-to guide onto the main pools doc page. Change-Id: I952b8e57f332fcbb727faf1bf9244d8fe6ae297c
Notes
Notes (review): Code-Review+2: Graham Hayes <graham.hayes@hpe.com> Code-Review+1: sonu <sonu.kumar@nectechnologies.in> Code-Review+2: Tim Simmons <tim.r.simmons@gmail.com> Workflow+1: Tim Simmons <tim.r.simmons@gmail.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Thu, 16 Mar 2017 16:00:35 +0000 Reviewed-on: https://review.openstack.org/445651 Project: openstack/designate Branch: refs/heads/master
-rw-r--r--doc/source/howtos/multiple-pools.rst33
-rw-r--r--doc/source/pools.rst23
2 files changed, 28 insertions, 28 deletions
diff --git a/doc/source/howtos/multiple-pools.rst b/doc/source/howtos/multiple-pools.rst
index c557338..b432b86 100644
--- a/doc/source/howtos/multiple-pools.rst
+++ b/doc/source/howtos/multiple-pools.rst
@@ -14,9 +14,9 @@
14 under the License. 14 under the License.
15 15
16 16
17================================= 17===============================
18 How To Configure Multiple Pools 18How To Configure Multiple Pools
19================================= 19===============================
20 20
21Designate supports "pools" of nameservers. A pool is a collection of 21Designate supports "pools" of nameservers. A pool is a collection of
22nameservers and targets that Designate will write to and read from to 22nameservers and targets that Designate will write to and read from to
@@ -25,31 +25,8 @@ pools that you need to manage differently. For example, you might use
25separate pools to distribute tenants across some subset of your DNS 25separate pools to distribute tenants across some subset of your DNS
26infrastructure. 26infrastructure.
27 27
28 28Read the section on :ref:`pools` to learn more about what pools are
29Target vs. Nameserver 29and what they can do.
30=====================
31
32One thing that can be confusing about pools is the differentiation
33between a target and a nameserver. The target is where Designate will
34try to write the change, while a namserver is where Designate checks
35that the change exists.
36
37A great example of this is `bind's stealth master system
38<http://www.zytrax.com/books/dns/ch4/#stealth>`_. In this
39configuration, there could be a stealth master that you configure as
40your target and a set of slaves pointed to that master as your
41nameservers. Designate will write to the master and then look for the
42changes on the slaves before considering the change active.
43
44Another example would be where Designate uses an API backend such as
45DynDNS or even another Designate instance. In this situation, you will
46typically have a single target with a set of nameservers to test that
47meet your requirements.
48
49Yet another example is when using a Designate agent. In this scenario
50your agent instances are the targets and the nameservers the agent
51updates would be checked for the correct information.
52
53 30
54Pools Configuration 31Pools Configuration
55=================== 32===================
diff --git a/doc/source/pools.rst b/doc/source/pools.rst
index bbb9a8b..de71da8 100644
--- a/doc/source/pools.rst
+++ b/doc/source/pools.rst
@@ -52,6 +52,29 @@ but it will **not** trigger zones to be moved from one pool to another.
52 Currently the only zone attribute that is accepted is the `pool_id` attribute. 52 Currently the only zone attribute that is accepted is the `pool_id` attribute.
53 As more filters are merged there will be support for dynamic filters. 53 As more filters are merged there will be support for dynamic filters.
54 54
55Target vs. Nameserver
56=====================
57
58One thing that can be confusing about pools is the differentiation
59between a target and a nameserver. The target is where Designate will
60try to write the change, while a namserver is where Designate checks
61that the change exists.
62
63A great example of this is `bind's stealth master system
64<http://www.zytrax.com/books/dns/ch4/#stealth>`_. In this
65configuration, there could be a stealth master that you configure as
66your target and a set of slaves pointed to that master as your
67nameservers. Designate will write to the master and then look for the
68changes on the slaves before considering the change active.
69
70Another example would be where Designate uses an API backend such as
71DynDNS or even another Designate instance. In this situation, you will
72typically have a single target with a set of nameservers to test that
73meet your requirements.
74
75Yet another example is when using a Designate agent. In this scenario
76your agent instances are the targets and the nameservers the agent
77updates would be checked for the correct information.
55 78
56Managing Pools 79Managing Pools
57============== 80==============