Jump to: navigation, search

Difference between revisions of "Designate/Atlanta/Workshop 1"

(Start the Designate Central Service)
(Start the Designate API Service)
Line 60: Line 60:
==== Start the Designate API Service ====
==== Start the Designate API Service ====
* $ designate-api > /dev/null 2>&1 &
* $ designate-api &
==== Check services are up ====
==== Check services are up ====

Revision as of 16:40, 5 May 2014

Designate: Interactive Workshop - Install and Operate - Openstack Summit, May 2014

Designate provides DNSaaS services for OpenStack.

This interactive workshop will guide attendees on how Designate can be installed with PowerDNS. For the purposes of the workshop the various designate components will be installed on a single node. Once installed it shows some of the V1 and V2 APIs for domain and record management. The workshop will conclude by using a tool like dig to retrieve the added records from the PowerDNS backend, showing a fully functional by-hand deployment.

The workshop will also cover the steps for contributing to the development of Designate.

Several of the Designate contributors will be on hand during the workshop to help attendees work through the deployment.

See also: "Designate: An Overview of DNSaaS for Openstack" and “Designate: Deep Dive for Operators/Deployers”

Designate Installation Instructions

Install Designate

  1. Start the VM
    $ vagrant up
  2. Log into the VM
    $ vagrant ssh
  3. Be super user
    $ sudo su -
  4. Install Designate and its dependencies
    $ cd /home/vagrant/designate
    $ apt-get -y build-dep python-lxml
    $ pip install -r requirements.txt -r test-requirements.txt
    $ python setup.py develop
  5. Copy sample designate files and edit
    $ cd etc/designate (/home/vagrant/designate/etc/designate)
    $ ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done
  6. Now Edit designate.conf
    (Replace contents of designate.conf with contents of file /home/vagrant/designate.conf.wkshp )
    $ cp /home/vagrant/designate.conf.wkshp ./designate.conf
  7. Create directory for maintaining designate state information (this directory was referenced by 'state_path' variable in designate.conf file)
    $ mkdir /var/lib/designate
  8. Create directory for maintaining designate log files (this directory was referenced by 'logdir' variable in designate.conf file)
    $ mkdir /home/vagrant/designate/log

Configure the DNS server (PowerDNS)

In /etc/powerdns/pdns.d/pdns.local.gmysql, verify (set) 'gmysql-dbname=pdns'

  • $ vi /etc/powerdns/pdns.d/pdns.local.gmysql

Re-Start PowerDNS

  • $ service pdns restart

Verify PowerDNS is running on port 53

  • $ netstat -tnlp (look for pdns_server-in)

Test PowerDNS

  • $ dig @localhost openstack.com (You should get some response with status:SERVFAIL)

Create, Initialize and sync the databases

The Designate database
  • $ mysql -e 'CREATE DATABASE `designate` CHARACTER SET utf8 COLLATE utf8_general_ci;'
  • $ designate-manage database init
  • $ designate-manage database sync
The PowerDNS database

(Database already exists. Just init and sync)

  • $ designate-manage powerdns init
  • $ designate-manage powerdns sync

Start the Designate Central Service

  • $ designate-central &

Start the Designate API Service

  • $ designate-api &

Check services are up

  • $ ps aux | grep designate

Setup the Designate Keystone service and endpoints

Install Designate Client

  • $ cd /home/vagrant/python-designateclient
  • $ pip install -r requirements.txt -r test-requirements.txt
  • $ python setup.py develop
Test Designate Client
  • $ cd /home/vagrant
  • $ source openrc.admin
  • $ designate --debug server-list

Exercise the Designate API

  1. Test API locally on VM:
    $ curl http://localhost:9001
  2. Test API from External Client (e.g. Google Chrome HTTP Client):

More Sample Helpful commands below in "Other Designate Workshop Command Lines"

Other Designate Workshop Command Lines

  • $ killall designate-api
  • $ killall designate-central
Also, other log files exist in /var/log (e.g syslog for traces on services such as PowerDNS)

Additional Notes on the workshop

I chose PowerDNS as the backend rather than BIND as it is more well tested as of now. I put in a single node – so that it is easier to control and easier for newbies to install. Also we talked about the workshop showing migration to Designate. However I think it is early at this point for us to talk about migration as we have not yet done a migrate with Designate.


  • REST API for domain & record management
  • Multi-tenant
  • Integrated with Keystone for authentication
  • Framework in place to integrate with Nova and Neutron notifications (for auto-generated records)
  • Support for PowerDNS and Bind9 out of the box