Browse Source

Merge "Add documentation about designate CCP plugin"

Jenkins 2 years ago
parent
commit
ab916c8ab0
2 changed files with 101 additions and 0 deletions
  1. 1
    0
      doc/source/index.rst
  2. 100
    0
      doc/source/plugins/designate.rst

+ 1
- 0
doc/source/index.rst View File

@@ -42,6 +42,7 @@ Service plugins docs
42 42
    :maxdepth: 1
43 43
 
44 44
    plugins/searchlight
45
+   plugins/designate
45 46
 
46 47
 Developer docs
47 48
 --------------

+ 100
- 0
doc/source/plugins/designate.rst View File

@@ -0,0 +1,100 @@
1
+.. _designate:
2
+
3
+==================================
4
+Designate CCP plugin documentation
5
+==================================
6
+
7
+This is Fuel-CCP plugin for OpenStack Designate service.
8
+
9
+Original designate service developer docs are
10
+placed `here <http://docs.openstack.org/developer/designate/>`_.
11
+
12
+Overview
13
+~~~~~~~~
14
+
15
+Designate provides DNSaaS services for OpenStack. Designate architecture has
16
+next components:
17
+
18
+* ``designate-api`` – provides the standard OpenStack style REST API service;
19
+
20
+* ``designate-central`` –  is the service that handles RPC requests via the MQ,
21
+  it coordinates the persistent storage of data and applies business logic to
22
+  data from the API;
23
+
24
+* ``designate-mdns`` – is the service that sends DNS NOTIFY and answers zone
25
+  transfer (AXFR) requests;
26
+
27
+* ``designate-pool-manager`` – is a service that handles the states of the DNS
28
+  servers Designate manages;
29
+
30
+* ``designate-zone-manager`` – is a service that handles all periodic tasks
31
+  related to the zone shard it is responsible for;
32
+
33
+* ``designate-sink`` – is an optional service which listens for event
34
+  notifications, such as compute.instance.create.end. Currently supports Nova
35
+  and Neutron;
36
+
37
+* ``designate-agent`` – pool manager agent backend. This is an optional
38
+  service. Agent uses an extension of the DNS protocol to send management
39
+  requests to the remote agent processes, where the requests will be processed.
40
+
41
+CCP components have names of components above, ``designate-sink`` and
42
+``designate-agent`` components are *optional*.
43
+
44
+Configuration
45
+~~~~~~~~~~~~~
46
+
47
+Designate has configurable options for each component, which could be
48
+set for specific node with :ref:`nodes` configs section. These options
49
+are: `workers` and `threads`. They are placed in
50
+`designate.service.<service name>.<workers or threads>` configs path. Also,
51
+designate CCP plugin allows to configure defaults of domain purge: `interval`,
52
+`batch_size` and `time threshold`.
53
+
54
+Installation
55
+~~~~~~~~~~~~
56
+
57
+Currently designate CCP plugin is not supported by default, so
58
+installation has next steps:
59
+
60
+#. Add next item to ``repositories.repos`` list of CCP configuration file:
61
+
62
+   ::
63
+
64
+     - git_url: https://git.openstack.org/openstack/fuel-ccp-designate
65
+       name: fuel-ccp-designate
66
+
67
+#. Add designate components to roles list. Next components are required:
68
+
69
+   ::
70
+
71
+     - designate-api
72
+     - designate-central
73
+     - designate-mdns
74
+     - designate-pool-manager
75
+     - designate-zone-manager
76
+
77
+
78
+   Components ``designate-sink`` and ``designate-agent`` are optional and could
79
+   not be deployed.
80
+
81
+#. Fetch, build, deploy components.
82
+
83
+#. Install `python-designateclient` and also install/update
84
+   `python-openstackclient` with pip:
85
+
86
+   ::
87
+
88
+      pip install --user -U python-designateclient python-openstackclient
89
+
90
+
91
+Dashboard plugin
92
+~~~~~~~~~~~~~~~~
93
+
94
+Designate has horizon dashboard plugin, which allows to create and manage
95
+domains and records. It is already available in horizon and is activated when
96
+designate is on board. Domain panel is placed in ``Projects`` menu.
97
+
98
+Unfortunately, domain requires at least one server, created by designate with
99
+command :command:`designate server-create`, so you cannot use only horizon for
100
+full dns management.

Loading…
Cancel
Save