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 -u root -p
   mysql> CREATE DATABASE designate;
   mysql> GRANT ALL PRIVILEGES ON designate.* TO 'designate'@'localhost' \
   IDENTIFIED BY 'DESIGNATE_DBPASS';
   

3. Install the BIND9 packages:

   # apt-get install bind9
   

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

   options {
       ...
       allow-new-zones yes;
       request-ixfr no;
       recursion no;
   };
   

5. Create an RNDC Key:

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

6. Add the key to /etc/bind/named.conf:

   ...
   # This should be the contents of ``/etc/designate/rndc.key``
   key "designate" {
     algorithm hmac-md5;
     secret "OAkHNQy0m6UPcv55fiVAPw==";
   };
   # End of content from ``/etc/designate/rndc.key``
   
   controls {
     inet 127.0.0.1 port 953
       allow { 127.0.0.1; } keys { "designate"; };
   };
   

7. Restart the DNS service:

   # service bind9 restart
   

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

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

     [service:api]
     api_host = 0.0.0.0
     api_port = 9001
     auth_strategy = keystone
     enable_api_v1 = True
     enabled_extensions_v1 = quotas, reports
     enable_api_v2 = True
     

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

     [keystone_authtoken]
     auth_host = controller
     auth_port = 35357
     auth_protocol = http
     admin_tenant_name = service
     admin_user = designate
     admin_password = DESIGNATE_PASS
     

     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
     

9. Restart the designate central and API services:

   # service designate-central restart
   # service designate-api restart
   

10. 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: bind
          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
    

11. Update the pools:

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

12. Install Designate Worker, producer and mini-dns

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

13. Restart the designate and mDNS services:

    # service designate-worker restart
    # service designate-producer restart
    # service designate-mdns restart