summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNguyen Van Trung <trungnv@vn.fujitsu.com>2017-07-12 10:35:00 +0700
committerNguyen Van Trung <trungnv@vn.fujitsu.com>2017-08-03 08:41:54 +0700
commitedc0684ace513d2ae73f06941e0898d1e963f298 (patch)
tree12dc4a85a98d055551369231c8a0f466a69e26f2
parente8bc10c97967c511434cb9f5bd75578060a2c10a (diff)
Improve and update docs5.0.0.0rc15.0.0
- Update install-guide. Change-Id: Ic27e27b4653efee35004457a843e2afb7786b5b0
Notes
Notes (review): Code-Review+2: Graham Hayes <ghayes@suse.de> Workflow+1: Graham Hayes <ghayes@suse.de> Code-Review+1: Tovin Seven <vinhnt@vn.fujitsu.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Thu, 03 Aug 2017 09:45:50 +0000 Reviewed-on: https://review.openstack.org/482784 Project: openstack/designate Branch: refs/heads/master
-rw-r--r--doc/source/install/common_prerequisites.rst2
-rw-r--r--doc/source/install/create-zone.rst21
-rw-r--r--doc/source/install/install-obs.rst13
-rw-r--r--doc/source/install/install-rdo.rst13
-rw-r--r--doc/source/install/install-ubuntu.rst31
-rw-r--r--doc/source/install/verify.rst21
6 files changed, 59 insertions, 42 deletions
diff --git a/doc/source/install/common_prerequisites.rst b/doc/source/install/common_prerequisites.rst
index af2705a..24da1da 100644
--- a/doc/source/install/common_prerequisites.rst
+++ b/doc/source/install/common_prerequisites.rst
@@ -36,4 +36,4 @@ you must create service credentials and API endpoints.
36 .. code-block:: console 36 .. code-block:: console
37 37
38 $ openstack endpoint create --region RegionOne \ 38 $ openstack endpoint create --region RegionOne \
39 dns public http://controller:9001/ \ No newline at end of file 39 dns public http://controller:9001/
diff --git a/doc/source/install/create-zone.rst b/doc/source/install/create-zone.rst
index 548141f..f2ba7df 100644
--- a/doc/source/install/create-zone.rst
+++ b/doc/source/install/create-zone.rst
@@ -79,3 +79,24 @@ In environments that include the DNS service, you can create a DNS Zone.
79 .. code-block:: console 79 .. code-block:: console
80 80
81 $ openstack zone delete example.com. 81 $ openstack zone delete example.com.
82 +----------------+--------------------------------------+
83 | Field | Value |
84 +----------------+--------------------------------------+
85 | action | DELETE |
86 | attributes | |
87 | created_at | 2017-07-12T03:26:25.000000 |
88 | description | None |
89 | email | dnsmaster@example.com |
90 | id | 4a21a893-2c58-4797-82ed-19fcef7c418d |
91 | masters | |
92 | name | example.com. |
93 | pool_id | 794ccc2c-d751-44fe-b57f-8894c9f5c842 |
94 | project_id | d53f80b5a22b4962a176935eea23f9c4 |
95 | serial | 1499830029 |
96 | status | PENDING |
97 | transferred_at | None |
98 | ttl | 3600 |
99 | type | PRIMARY |
100 | updated_at | 2017-07-12T03:27:25.000000 |
101 | version | 4 |
102 +----------------+--------------------------------------+
diff --git a/doc/source/install/install-obs.rst b/doc/source/install/install-obs.rst
index 954e34c..f113082 100644
--- a/doc/source/install/install-obs.rst
+++ b/doc/source/install/install-obs.rst
@@ -31,7 +31,7 @@ Install and configure components
31 .. code-block:: console 31 .. code-block:: console
32 32
33 # mysql -u root -p 33 # mysql -u root -p
34 MariaDB [(none)]> CREATE DATABASE designate; 34 MariaDB [(none)]> CREATE DATABASE designate CHARACTER SET utf8 COLLATE utf8_general_ci;
35 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \ 35 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \
36 IDENTIFIED BY 'DESIGNATE_DBPASS'; 36 IDENTIFIED BY 'DESIGNATE_DBPASS';
37 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'%' \ 37 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'%' \
@@ -41,7 +41,7 @@ Install and configure components
41 41
42 .. code-block:: console 42 .. code-block:: console
43 43
44 # zypper install bind 44 # zypper install bind bind-utils
45 45
46#. Add the following options in the ``/etc/named.conf`` file: 46#. Add the following options in the ``/etc/named.conf`` file:
47 47
@@ -51,7 +51,9 @@ Install and configure components
51 ... 51 ...
52 allow-new-zones yes; 52 allow-new-zones yes;
53 request-ixfr no; 53 request-ixfr no;
54 listen-on port 53 { 127.0.0.1; };
54 recursion no; 55 recursion no;
56 allow-query { 127.0.0.1; };
55 }; 57 };
56 58
57#. Create an RNDC Key: 59#. Create an RNDC Key:
@@ -65,12 +67,7 @@ Install and configure components
65 .. code-block:: none 67 .. code-block:: none
66 68
67 ... 69 ...
68 # This should be the contents of ``/etc/designate/rndc.key`` 70 include "/etc/designate/rndc.key";
69 key "designate" {
70 algorithm hmac-md5;
71 secret "OAkHNQy0m6UPcv55fiVAPw==";
72 };
73 # End of content from ``/etc/designate/rndc.key``
74 71
75 controls { 72 controls {
76 inet 127.0.0.1 port 953 73 inet 127.0.0.1 port 953
diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst
index 6a34838..ca14167 100644
--- a/doc/source/install/install-rdo.rst
+++ b/doc/source/install/install-rdo.rst
@@ -31,7 +31,7 @@ Install and configure components
31 .. code-block:: console 31 .. code-block:: console
32 32
33 # mysql -u root -p 33 # mysql -u root -p
34 MariaDB [(none)]> CREATE DATABASE designate; 34 MariaDB [(none)]> CREATE DATABASE designate CHARACTER SET utf8 COLLATE utf8_general_ci;
35 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \ 35 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \
36 IDENTIFIED BY 'DESIGNATE_DBPASS'; 36 IDENTIFIED BY 'DESIGNATE_DBPASS';
37 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'%' \ 37 MariaDB [(none)]> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'%' \
@@ -41,7 +41,7 @@ Install and configure components
41 41
42 .. code-block:: console 42 .. code-block:: console
43 43
44 # yum install bind 44 # yum install bind bind-utils
45 45
46#. Add the following options in the ``/etc/named.conf`` file: 46#. Add the following options in the ``/etc/named.conf`` file:
47 47
@@ -51,7 +51,9 @@ Install and configure components
51 ... 51 ...
52 allow-new-zones yes; 52 allow-new-zones yes;
53 request-ixfr no; 53 request-ixfr no;
54 listen-on port 53 { 127.0.0.1; };
54 recursion no; 55 recursion no;
56 allow-query { 127.0.0.1; };
55 }; 57 };
56 58
57#. Create an RNDC Key: 59#. Create an RNDC Key:
@@ -65,12 +67,7 @@ Install and configure components
65 .. code-block:: none 67 .. code-block:: none
66 68
67 ... 69 ...
68 # This should be the contents of ``/etc/designate/rndc.key`` 70 include "/etc/designate/rndc.key";
69 key "designate" {
70 algorithm hmac-md5;
71 secret "OAkHNQy0m6UPcv55fiVAPw==";
72 };
73 # End of content from ``/etc/designate/rndc.key``
74 71
75 controls { 72 controls {
76 inet 127.0.0.1 port 953 73 inet 127.0.0.1 port 953
diff --git a/doc/source/install/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst
index d13f92d..f8d4e1e 100644
--- a/doc/source/install/install-ubuntu.rst
+++ b/doc/source/install/install-ubuntu.rst
@@ -31,7 +31,7 @@ Install and configure components
31 .. code-block:: console 31 .. code-block:: console
32 32
33 # mysql -u root -p 33 # mysql -u root -p
34 mysql> CREATE DATABASE designate; 34 mysql> CREATE DATABASE designate CHARACTER SET utf8 COLLATE utf8_general_ci;
35 mysql> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \ 35 mysql> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \
36 IDENTIFIED BY 'DESIGNATE_DBPASS'; 36 IDENTIFIED BY 'DESIGNATE_DBPASS';
37 mysql> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'%' \ 37 mysql> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'%' \
@@ -41,18 +41,7 @@ Install and configure components
41 41
42 .. code-block:: console 42 .. code-block:: console
43 43
44 # apt-get install bind9 44 # apt-get install bind9 bind9utils bind9-doc
45
46#. Add the following options in the ``/etc/bind/named.conf.options`` file:
47
48 .. code-block:: none
49
50 options {
51 ...
52 allow-new-zones yes;
53 request-ixfr no;
54 recursion no;
55 };
56 45
57#. Create an RNDC Key: 46#. Create an RNDC Key:
58 47
@@ -60,17 +49,21 @@ Install and configure components
60 49
61 # rndc-confgen -a -k designate -c /etc/designate/rndc.key 50 # rndc-confgen -a -k designate -c /etc/designate/rndc.key
62 51
63#. Add the key to ``/etc/bind/named.conf``: 52#. Add the following options in the ``/etc/bind/named.conf.options`` file:
64 53
65 .. code-block:: none 54 .. code-block:: none
66 55
67 ... 56 ...
68 # This should be the contents of ``/etc/designate/rndc.key`` 57 include "/etc/designate/rndc.key";
69 key "designate" { 58
70 algorithm hmac-md5; 59 options {
71 secret "OAkHNQy0m6UPcv55fiVAPw=="; 60 ...
61 allow-new-zones yes;
62 request-ixfr no;
63 listen-on port 53 { 127.0.0.1; };
64 recursion no;
65 allow-query { 127.0.0.1; };
72 }; 66 };
73 # End of content from ``/etc/designate/rndc.key``
74 67
75 controls { 68 controls {
76 inet 127.0.0.1 port 953 69 inet 127.0.0.1 port 953
diff --git a/doc/source/install/verify.rst b/doc/source/install/verify.rst
index 4be9060..b8b2162 100644
--- a/doc/source/install/verify.rst
+++ b/doc/source/install/verify.rst
@@ -20,21 +20,30 @@ Verify operation of the DNS service.
20 20
21 .. code-block:: console 21 .. code-block:: console
22 22
23 $ ps -aux | grep designate
24
25 ../usr/bin/python /usr/local/bin/designate-mdns --config-file /etc/designate/designate.conf
26 ../usr/bin/python /usr/local/bin/designate-central --config-file /etc/designate/designate.conf
27 ../usr/bin/python /usr/local/bin/designate-agent --config-file /etc/designate/designate.conf
28 ../usr/bin/python /usr/local/bin/designate-api --config-file /etc/designate/designate.conf
29 ../usr/bin/python /usr/local/bin/designate-worker --config-file /etc/designate/designate.conf
30 ../usr/bin/python /usr/local/bin/designate-producer --config-file /etc/designate/designate.conf
31
23 $ openstack dns service list 32 $ openstack dns service list
24 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+ 33 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+
25 | id | hostname | service_name | status | stats | capabilities | 34 | id | hostname | service_name | status | stats | capabilities |
26 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+ 35 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+
27 | 14283849-ff64-4467-9cbb-d9050ffa08c0 | vagrant-ubuntu-trusty-64 | central | UP | - | - | 36 | 918a8f6e-9e7e-453e-8583-cbefa7ae7f8f | vagrant-ubuntu-trusty-64 | central | UP | - | - |
28 | eb7d938f-5b24-4c9b-b4f7-05b9a8ea45f2 | vagrant-ubuntu-trusty-64 | api | UP | - | - | 37 | 982f78d5-525a-4c36-af26-a09aa39de5d7 | vagrant-ubuntu-trusty-64 | api | UP | - | - |
29 | 5dca293e-5fa2-4a3d-b486-4debad920da3 | vagrant-ubuntu-trusty-64 | zone_manager | UP | - | - | 38 | eda2dc16-ad27-4ee1-b091-bb75b6ceaffe | vagrant-ubuntu-trusty-64 | mdns | UP | - | - |
30 | 487e7215-6f61-495d-87b3-86be09406750 | vagrant-ubuntu-trusty-64 | mdns | UP | - | - | 39 | 00c5c372-e630-49b1-a6b6-17e3fa4544ea | vagrant-ubuntu-trusty-64 | worker | UP | - | - |
31 | 6b1d1de6-c820-4843-993b-663fca73f905 | vagrant-ubuntu-trusty-64 | pool_manager | UP | - | - | 40 | 8cdaf2e9-accd-4665-8e9e-be26f1ccfe4a | vagrant-ubuntu-trusty-64 | producer | UP | - | - |
32 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+ 41 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+
33 42
34 .. note:: 43 .. note::
35 44
36 This output should indicate at least one of each of the ``central``, 45 This output should indicate at least one of each of the ``central``,
37 ``api``, ``zone_manager``, ``mdns`` and ``pool_manager`` components 46 ``api``, ``producer``, ``mdns`` and ``worker`` components
38 on the controller node. 47 on the controller node.
39 48
40 This output may differ slightly depending on the distribution. 49 This output may differ slightly depending on the distribution.