Install and configure for Ubuntu¶

Prerequisites¶

Before you install and configure the DNS service, you must create service credentials and API endpoints.

1. Source the admin credentials to gain access to admin-only CLI commands:

   $ source admin-openrc
   

2. To create the service credentials, complete these steps:

   • Create the designate user:

     $ openstack user create --domain default --password-prompt designate
     

   • Add the admin role to the designate user:

     $ openstack role add --project service --user designate admin
     

   • Create the designate service entities:

     $ openstack service create --name designate --description "DNS" dns
     

3. Create the DNS service API endpoint:

   $ openstack endpoint create --region RegionOne \
     dns public http://controller:9001/
   

Install and configure components¶

1. Install the packages:

   # apt-get install designate
   

2. Create a designate database that is accessible by the designate user. Replace DESIGNATE_DBPASS with a suitable password:

   # mysql
   mysql> CREATE DATABASE designate CHARACTER SET utf8 COLLATE utf8_general_ci;
   mysql> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \
   IDENTIFIED BY 'DESIGNATE_DBPASS';
   mysql> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'%' \
   IDENTIFIED BY 'DESIGNATE_DBPASS';
   

3. Install the BIND9 packages:

   # apt-get install bind9 bind9utils bind9-doc
   

4. Create an RNDC Key:

   # rndc-confgen -a -k designate -c /etc/designate/rndc.key
   

5. Add the following options in the /etc/bind/named.conf.options file:

   ...
   include "/etc/designate/rndc.key";
   
   options {
       ...
       allow-new-zones yes;
       request-ixfr no;
       listen-on port 53 { 127.0.0.1; };
       recursion no;
       allow-query { 127.0.0.1; };
   };
   
   controls {
     inet 127.0.0.1 port 953
       allow { 127.0.0.1; } keys { "designate"; };
   };
   

6. Restart the DNS service:

   # systemctl restart bind9.service
   

7. Edit the /etc/designate/designate.conf file and complete the following actions:

   • In the [service:api] section, configure auth_strategy:

     [service:api]
     listen = 0.0.0.0:9001
     auth_strategy = keystone
     api_base_uri = http://controller:9001/
     enable_api_v2 = True
     enabled_extensions_v2 = quotas, reports
     

   • In the [keystone_authtoken] section, configure the following options:

     [keystone_authtoken]
     auth_type = password
     username = designate
     password = DESIGNATE_PASS
     project_name = service
     project_domain_name = Default
     user_domain_name = Default
     www_authenticate_uri = http://controller:5000/
     auth_url = http://controller:5000/
     

     Replace DESIGNATE_PASS with the password you chose for the designate user in the Identity service.

   • In the [service:worker] section, enable the worker model:

     enabled = True
     notify = True
     

   • In the [storage:sqlalchemy] section, configure database access:

     [storage:sqlalchemy]
     connection = mysql+pymysql://designate:DESIGNATE_DBPASS@controller/designate
     

     Replace DESIGNATE_DBPASS with the password you chose for the designate database.

   • Populate the designate database

     # su -s /bin/sh -c "designate-manage database sync" designate
     

8. Restart the designate central and API services and configure them to start when the system boots:

   # systemctl restart designate-central designate-api
   
   # systemctl enable designate-central designate-api
   

9. Create a pools.yaml file in /etc/designate/pools.yaml with the following contents:

   - name: default
     # The name is immutable. There will be no option to change the name after
     # creation and the only way will to change it will be to delete it
     # (and all zones associated with it) and recreate it.
     description: Default Pool
   
     attributes: {}
   
     # List out the NS records for zones hosted within this pool
     # This should be a record that is created outside of designate, that
     # points to the public IP of the controller node.
     ns_records:
       - hostname: ns1-1.example.org.
         priority: 1
   
     # List out the nameservers for this pool. These are the actual BIND servers.
     # We use these to verify changes have propagated to all nameservers.
     nameservers:
       - host: 127.0.0.1
         port: 53
   
     # List out the targets for this pool. For BIND there will be one
     # entry for each BIND server, as we have to run rndc command on each server
     targets:
       - type: bind9
         description: BIND9 Server 1
   
         # List out the designate-mdns servers from which BIND servers should
         # request zone transfers (AXFRs) from.
         # This should be the IP of the controller node.
         # If you have multiple controllers you can add multiple masters
         # by running designate-mdns on them, and adding them here.
         masters:
           - host: 127.0.0.1
             port: 5354
   
         # BIND Configuration options
         options:
           host: 127.0.0.1
           port: 53
           rndc_host: 127.0.0.1
           rndc_port: 953
           rndc_key_file: /etc/designate/rndc.key
   

10. Update the pools:

    # su -s /bin/sh -c "designate-manage pool update" designate
    

11. Install Designate Worker, producer and mini-dns

    # apt install designate-worker
    # apt install designate-producer
    # apt install designate-mdns
    

12. Start the designate and mDNS services and configure them to start when the system boots:

    # systemctl start designate-worker designate-producer designate-mdns
    
    # systemctl enable designate-worker designate-producer designate-mdns