summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJens Harbott <j.harbott@x-ion.de>2017-11-27 14:48:11 +0000
committerJens Harbott <j.harbott@x-ion.de>2017-12-04 06:44:15 +0000
commitca7da3dcd8e62c89665c36b1ccc2f2ea90b95110 (patch)
tree916886713ef551d96a078197409a27125419b235
parent2f75586379e8d611f37e06d385e79d0bc2c84ca1 (diff)
Update installation docs
- Replace keystone_authtoken section with v3 style parameters - Update Ubuntu doc to reference current LTS release - Update Ubuntu doc to use systemctl Change-Id: Ic1dedb04b08e09eda3d7772846eadeb7aa22fbb2 Closes-Bug: 1734635
Notes
Notes (review): Code-Review+2: Graham Hayes <gr@ham.ie> Workflow+1: Graham Hayes <gr@ham.ie> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 04 Dec 2017 16:46:53 +0000 Reviewed-on: https://review.openstack.org/523392 Project: openstack/designate Branch: refs/heads/master
-rw-r--r--doc/source/install/install-obs.rst14
-rw-r--r--doc/source/install/install-rdo.rst14
-rw-r--r--doc/source/install/install-ubuntu.rst35
-rw-r--r--doc/source/install/install.rst5
-rw-r--r--doc/source/install/next-steps.rst4
-rw-r--r--doc/source/install/verify.rst12
6 files changed, 46 insertions, 38 deletions
diff --git a/doc/source/install/install-obs.rst b/doc/source/install/install-obs.rst
index 3476f42..8115ab3 100644
--- a/doc/source/install/install-obs.rst
+++ b/doc/source/install/install-obs.rst
@@ -104,12 +104,14 @@ Install and configure components
104 .. code-block:: ini 104 .. code-block:: ini
105 105
106 [keystone_authtoken] 106 [keystone_authtoken]
107 auth_host = controller 107 auth_type = password
108 auth_port = 35357 108 username = designate
109 auth_protocol = http 109 password = DESIGNATE_PASS
110 admin_tenant_name = service 110 project_name = service
111 admin_user = designate 111 project_domain_name = Default
112 admin_password = DESIGNATE_PASS 112 user_domain_name = Default
113 auth_uri = http://controller:5000/
114 auth_url = http://controller:5000/
113 115
114 Replace ``DESIGNATE_PASS`` with the password you chose for the 116 Replace ``DESIGNATE_PASS`` with the password you chose for the
115 ``designate`` user in the Identity service. 117 ``designate`` user in the Identity service.
diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst
index 7c4d376..c797c9b 100644
--- a/doc/source/install/install-rdo.rst
+++ b/doc/source/install/install-rdo.rst
@@ -104,12 +104,14 @@ Install and configure components
104 .. code-block:: ini 104 .. code-block:: ini
105 105
106 [keystone_authtoken] 106 [keystone_authtoken]
107 auth_host = controller 107 auth_type = password
108 auth_port = 35357 108 username = designate
109 auth_protocol = http 109 password = DESIGNATE_PASS
110 admin_tenant_name = service 110 project_name = service
111 admin_user = designate 111 project_domain_name = Default
112 admin_password = DESIGNATE_PASS 112 user_domain_name = Default
113 auth_uri = http://controller:5000/
114 auth_url = http://controller:5000/
113 115
114 Replace ``DESIGNATE_PASS`` with the password you chose for the 116 Replace ``DESIGNATE_PASS`` with the password you chose for the
115 ``designate`` user in the Identity service. 117 ``designate`` user in the Identity service.
diff --git a/doc/source/install/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst
index f8d4e1e..51fddfc 100644
--- a/doc/source/install/install-ubuntu.rst
+++ b/doc/source/install/install-ubuntu.rst
@@ -4,7 +4,7 @@ Install and configure for Ubuntu
4~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5 5
6This section describes how to install and configure the DNS 6This section describes how to install and configure the DNS
7service for Ubuntu 14.04 (LTS). 7service for Ubuntu 16.04 (LTS).
8 8
9.. include:: common_prerequisites.rst 9.. include:: common_prerequisites.rst
10 10
@@ -74,7 +74,7 @@ Install and configure components
74 74
75 .. code-block:: console 75 .. code-block:: console
76 76
77 # service bind9 restart 77 # systemctl restart bind9.service
78 78
79#. Edit the ``/etc/designate/designate.conf`` file and 79#. Edit the ``/etc/designate/designate.conf`` file and
80 complete the following actions: 80 complete the following actions:
@@ -97,12 +97,14 @@ Install and configure components
97 .. code-block:: ini 97 .. code-block:: ini
98 98
99 [keystone_authtoken] 99 [keystone_authtoken]
100 auth_host = controller 100 auth_type = password
101 auth_port = 35357 101 username = designate
102 auth_protocol = http 102 password = DESIGNATE_PASS
103 admin_tenant_name = service 103 project_name = service
104 admin_user = designate 104 project_domain_name = Default
105 admin_password = DESIGNATE_PASS 105 user_domain_name = Default
106 auth_uri = http://controller:5000/
107 auth_url = http://controller:5000/
106 108
107 Replace ``DESIGNATE_PASS`` with the password you chose for the 109 Replace ``DESIGNATE_PASS`` with the password you chose for the
108 ``designate`` user in the Identity service. 110 ``designate`` user in the Identity service.
@@ -130,12 +132,14 @@ Install and configure components
130 132
131 # su -s /bin/sh -c "designate-manage database sync" designate 133 # su -s /bin/sh -c "designate-manage database sync" designate
132 134
133#. Restart the designate central and API services: 135#. Restart the designate central and API services and configure them
136 to start when the system boots:
134 137
135 .. code-block:: console 138 .. code-block:: console
136 139
137 # service designate-central restart 140 # systemctl restart openstack-designate-central openstack-designate-api
138 # service designate-api restart 141
142 # systemctl enable openstack-designate-central openstack-designate-api
139 143
140#. Create a pools.yaml file in ``/etc/designate/pools.yaml`` with the following 144#. Create a pools.yaml file in ``/etc/designate/pools.yaml`` with the following
141 contents: 145 contents:
@@ -200,10 +204,11 @@ Install and configure components
200 # apt install designate-producer 204 # apt install designate-producer
201 # apt install designate-mdns 205 # apt install designate-mdns
202 206
203#. Restart the designate and mDNS services: 207#. Start the designate and mDNS services and configure them to start when the
208 system boots:
204 209
205 .. code-block:: console 210 .. code-block:: console
206 211
207 # service designate-worker restart 212 # systemctl start designate-worker designate-producer designate-mdns
208 # service designate-producer restart 213
209 # service designate-mdns restart 214 # systemctl enable designate-worker designate-producer designate-mdns
diff --git a/doc/source/install/install.rst b/doc/source/install/install.rst
index 3a5a84a..8be3a4a 100644
--- a/doc/source/install/install.rst
+++ b/doc/source/install/install.rst
@@ -7,15 +7,14 @@ This section describes how to install and configure the
7DNS service, code-named designate, on the controller node. 7DNS service, code-named designate, on the controller node.
8 8
9This section assumes that you already have a working OpenStack 9This section assumes that you already have a working OpenStack
10environment with at least the following components installed: 10environment with at least the Identity service installed.
11Identity service, Image service, Compute service, and Networking service.
12 11
13Note that installation and configuration vary by distribution. 12Note that installation and configuration vary by distribution.
14 13
15.. toctree:: 14.. toctree::
16 :maxdepth: 2 15 :maxdepth: 2
17 16
17 install-obs.rst
18 install-rdo.rst 18 install-rdo.rst
19 install-ubuntu.rst 19 install-ubuntu.rst
20 install-obs.rst
21 20
diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst
index d698799..1a02f57 100644
--- a/doc/source/install/next-steps.rst
+++ b/doc/source/install/next-steps.rst
@@ -5,8 +5,8 @@ Next steps
5 5
6Your OpenStack environment now includes the designate service. 6Your OpenStack environment now includes the designate service.
7 7
8To add additional services, see the `additional OpenStack install documentation 8To add additional services, see the `OpenStack install guide
9<http://docs.openstack.org/#install-guides>`_. 9<https://docs.openstack.org/install-guide/>`_.
10 10
11To learn more about the designate service, read the `Designate developer documentation 11To learn more about the designate service, read the `Designate developer documentation
12<https://docs.openstack.org/designate/latest/contributor/index.html>`_. 12<https://docs.openstack.org/designate/latest/contributor/index.html>`_.
diff --git a/doc/source/install/verify.rst b/doc/source/install/verify.rst
index b8b2162..d612f4c 100644
--- a/doc/source/install/verify.rst
+++ b/doc/source/install/verify.rst
@@ -22,12 +22,12 @@ Verify operation of the DNS service.
22 22
23 $ ps -aux | grep designate 23 $ ps -aux | grep designate
24 24
25 ../usr/bin/python /usr/local/bin/designate-mdns --config-file /etc/designate/designate.conf 25 ../usr/bin/python /usr/bin/designate-mdns --config-file /etc/designate/designate.conf
26 ../usr/bin/python /usr/local/bin/designate-central --config-file /etc/designate/designate.conf 26 ../usr/bin/python /usr/bin/designate-central --config-file /etc/designate/designate.conf
27 ../usr/bin/python /usr/local/bin/designate-agent --config-file /etc/designate/designate.conf 27 ../usr/bin/python /usr/bin/designate-agent --config-file /etc/designate/designate.conf
28 ../usr/bin/python /usr/local/bin/designate-api --config-file /etc/designate/designate.conf 28 ../usr/bin/python /usr/bin/designate-api --config-file /etc/designate/designate.conf
29 ../usr/bin/python /usr/local/bin/designate-worker --config-file /etc/designate/designate.conf 29 ../usr/bin/python /usr/bin/designate-worker --config-file /etc/designate/designate.conf
30 ../usr/bin/python /usr/local/bin/designate-producer --config-file /etc/designate/designate.conf 30 ../usr/bin/python /usr/bin/designate-producer --config-file /etc/designate/designate.conf
31 31
32 $ openstack dns service list 32 $ openstack dns service list
33 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+ 33 +--------------------------------------+--------------------------+--------------+--------+-------+--------------+