Revision as of 20:33, 24 April 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 - DRAFT

1. Verify VM and Openstack core components are installed and correctly configured

verify python environment is installed
$ which pip

/usr/bin/pip

$ which virtualenv

/usr/bin/virtualenv
verify RabbitMQ Server is installed and configured correctly:
verify Glance Service is installed and configured correctly:
verify Glance Client is installed and configured correctly:
verify Keystone Service is installed and configured correctly:
verify Keystone Client is installed and configured correctly:
verify Neutron Service is installed and configured correctly:
verify Neutron Client is installed and configured correctly:
verify Nova Service is installed and configured correctly:
verify Nova Client is installed and configured correctly:
verify MySQL is installed: <cmd>
verify MySQl is configured correctly:

2. Install Designate

Start the VM
$ vagrant up
Log into the VM
$ vagrant ssh
Be super user
$ sudo su -
Install Designate and its dependencies
$ cd to /home/vagrant/designate

$ apt-get build-dep python-lxml. Respond "Y" to question (or just hit enter)

$ [sudo] pip install -r requirements.txt -r test-requirements.txt

$ python setup.py develop
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

(See section below for config values - "Other Designate Workshop Command Lines")
Create directory for maintaining designate state information (this directory was referenced by 'state_path' variable in designate.conf file)
$ mkdir /var/lib/designate
Create directory for maintaining designate log files (this directory was referenced by 'logdir' variable in designate.conf file)
$ mkdir /var/log/designate

3. Install the DNS server (powerDNS)

4. Initialize and sync the databases

The Designate database

$ designate-manage database init

$ designate-manage database sync

The PowerDNS database

$ designate-manage powerdns init

$ designate-manage powerdns sync

5. Initialize & Start the Designate Central Service

designate-central&

6. Initialize & Start the Designate API Service

designate-api&

Check services are up

ps aux | grep designate

7. Exercise the Designate API

Test API locally on VM:
$ curl http://localhost:9001

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

Other Designate Workshop Command Lines

$ killall designate-api

$ killall designate-central

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.

Removed

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

@@ Line 15: / Line 15: @@
 === 1. Verify VM and Openstack core components are installed and correctly configured ===
 # verify python environment is installed
-#:pip: ''<cmd>''
+#:$ which pip
-#:virtualenv: ''<cmd>''
+#:''/usr/bin/pip''
+#:$ which virtualenv
+#:''/usr/bin/virtualenv''
 # verify RabbitMQ Server is installed and configured correctly:
 # verify Glance Service is installed and configured correctly:
@@ Line 29: / Line 31: @@
 # verify MySQl is configured correctly:
 === 2. Install Designate ===
-# Install system package dependencies
+# Start the VM
-#:$ apt-get build-dep python-lxml
+#: $ vagrant up
-# Clone the Designate repo off of Stackforge
+# Log into the VM
-#:$ git clone https://github.com/stackforge/designate.git
+#: $ vagrant ssh
-#:$ cd designate
+# Be super user
-# Setup virtual env
+#: $ sudo su -
-#:$ virtualenv --no-site-packages .venv
-#:$ . .venv/bin/activate
 # Install Designate and its dependencies
-#:$ pip install -r requirements.txt -r test-requirements.txt
+#: $ cd to /home/vagrant/designate
-#:$ python setup.py develop
+#: $ apt-get build-dep python-lxml. Respond "Y" to question (or just hit enter)
-# Copy sample config files to edit
+#: $ [sudo] pip install -r requirements.txt -r test-requirements.txt
-#:$ cd etc/designate
+#: $ python setup.py develop
-#:$ ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done
+# Copy sample designate files and edit
-# Install the DNS server, PowerDNS
+#: $ cd etc/designate (/home/vagrant/designate/etc/designate)
-#Grant sudo permissions if you intend to run Designate as a non-root user
+#: $ ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done
-#Make the directory for Designate’s log files
+#: (See section below for config values - "Other Designate Workshop Command Lines")
-=== 3. Configure Designate ===
+# Create directory for maintaining designate state information (this directory was referenced by 'state_path' variable in designate.conf file)
-#: editor (vi) designate.conf
+#: $ mkdir /var/lib/designate
+# Create directory for maintaining designate log files (this directory was referenced by 'logdir' variable in designate.conf file)
+#: $ mkdir /var/log/designate
+=== 3. Install the DNS server (powerDNS) ===
+=== 4. Initialize and sync the databases ===
+==== The Designate database ====
+#: $ designate-manage database init
+#: $ designate-manage database sync
+==== The PowerDNS database ====
+#:$ designate-manage powerdns init
+#:$ designate-manage powerdns sync
+=== 5. Initialize & Start the Designate Central Service ===
+designate-central&
+=== 6. Initialize & Start the Designate API Service ===
+designate-api&
+# Check services are up
+ps aux | grep designate
+=== 7. Exercise the Designate API ===
+# Test API locally on VM:
+#: $ curl http://localhost:9001
-=== 4. Initialize & Start the Designate Central Service ===
-=== 5. Initialize & Start the Designate API Service ===
-=== 6. Exercise the Designate API ===
 Sample Helpful commands below in "Other Designate Workshop Command Lines"
 == Other Designate Workshop Command Lines ==
+#:$ killall designate-api
+#:$ killall designate-central
 = Additional Notes on the workshop =

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