Update Designate docs
other changes:
removed unused local_bind parameter
Change-Id: I2ba577b5a49bd77ad5c612b881e75019dd967d25
diff --git a/README.rst b/README.rst
index 3797b05..48cb5ff 100644
--- a/README.rst
+++ b/README.rst
@@ -8,38 +8,109 @@
Sample pillars
==============
+For Designate with BIND9 local backend:
+
.. code:: yaml
- designate:
- server:
- backend:
- bind9:
- rndc_key: AahjHKbdslHOLs42h/asQA==
- database:
- host: ${_param:database_vip_address}
- notification: true
- message_queue:
- members:
- - host: ${_param:messaging_node01_address}
- - host: ${_param:messaging_node02_address}
- - host: ${_param:messaging_node03_address}
- pool:
- pool_id: cae73b6f-95eb-4a7d-a567-099ae6176e08
+ designate:
+ server:
+ enabled: true
+ region: RegionOne
+ domain_id: 5186883b-91fb-4891-bd49-e6769234a8fc
+ version: ocata
+ backend:
+ bind9:
+ rndc_key: 4pc+X4PDqb2q+5o72dISm72LM1Ds9X2EYZjqg+nmsS7FhdTwzFFY8l/iEDmHxnyjkA33EQC8H+z0fLLBunoitw==
+ rndc_algorithm: hmac-sha512
+ bind:
+ api:
+ address: 127.0.0.1
+ database:
+ engine: mysql
+ host: 127.0.0.1
+ port: 3306
+ name:
+ main_database: designate
+ pool_manager: designate_pool_manager
+ user: designate
+ password: passw0rd
+ identity:
+ engine: keystone
+ host: 127.0.0.1
+ port: 35357
+ tenant: service
+ user: designate
+ password: passw0rd
+ message_queue:
+ engine: rabbitmq
+ members:
+ - host: 127.0.0.1
+ user: openstack
+ password: password
+ virtual_host: '/openstack'
+ pools:
+ default:
+ description: 'default pool'
+ attributes:
+ service_tier: GOLD
+ ns_records:
+ - hostname: 'ns1.example.org.'
+ priority: 10
nameservers:
- - uuid: 690d7bc8-811b-404c-abcc-9cec54d87092
- host: ${_param:cluster_node01_address}
- port: 53
- - uuid: bc5ddcf0-8d95-4f87-b435-9ff831a4a14c
- host: ${_param:cluster_node02_address}
- port: 53
- - uuid: a43d5375-a5ec-4077-8c87-ec0b08fa3bd1
- host: ${_param:cluster_node03_address}
+ - host: 127.0.0.1
port: 53
targets:
- uuid: f26e0b32-736f-4f0a-831b-039a415c481e
- options: 'port: 53, host: 127.0.0.1'
- masters: 127.0.0.1:5354
- type: bind9
+ default_target:
+ type: bind9
+ description: 'default target'
+ masters:
+ - host: 127.0.0.1
+ port: 5354
+ options:
+ host: 127.0.0.1
+ port: 53
+ rndc_host: 127.0.0.1
+ rndc_port: 953
+ rndc_key_file: /etc/designate/rndc.key
+
+.. note::
+ *domain_id* parameter is UUID of DNS zone managed by designate-sink service. This zone will
+ be populated by A records for fixed and floating ip addresses of spawned VMs. After designate
+ is deployed and zone is created, this parameter should be updated accordingly to UUID of
+ newly created zone. Then designate state should be reapplied.
+
+Pools pillar for BIND9 master and multiple slaves setup:
+
+.. code:: yaml
+
+ pools:
+ default:
+ description: 'default pool'
+ attributes:
+ service_tier: GOLD
+ ns_records:
+ - hostname: 'ns1.example.org.'
+ priority: 10
+ nameservers:
+ - host: 192.168.0.1
+ port: 53
+ - host: 192.168.0.2
+ port: 53
+ - host: 192.168.0.3
+ port: 53
+ targets:
+ default_target:
+ type: bind9
+ description: 'default target'
+ masters:
+ - host: 192.168.0.4
+ port: 5354
+ options:
+ host: 192.168.0.4
+ port: 53
+ rndc_host: 192.168.0.4
+ rndc_port: 953
+ rndc_key_file: /etc/designate/rndc.key
Usage
=====
diff --git a/tests/pillar/designate_ocata.sls b/tests/pillar/designate_ocata.sls
index eee747c..630cccc 100644
--- a/tests/pillar/designate_ocata.sls
+++ b/tests/pillar/designate_ocata.sls
@@ -4,7 +4,6 @@
enabled: false
server:
enabled: true
- local_bind: true
region: RegionOne
domain_id: 5186883b-91fb-4891-bd49-e6769234a8fc
version: ocata