designate/doc/source/install.rst

Install

Designate is comprised of three components for more info on these please see architecture.

Note

Designate makes extensive use of the messaging bus, but has not yet been tested with ZeroMQ. We recommend using RabbitMQ for now.

From Packages

From Source / GIT

Common Steps

double: installing; common_steps

Note

The below operations should take place underneath your <project>/etc folder.

1. Install system package dependencies (Ubuntu):

   $ apt-get install python-pip python-virtualenv
   $ apt-get install rabbitmq-server bind9
   $ apt-get build-dep python-lxml

2. Clone the Designate repo off of Stackforge:

   $ git clone https://github.com/stackforge/designate.git
   $ cd designate

3. Setup virtualenv:

Note

This is to not interfere with system packages etc.

$ virtualenv --no-site-packages .venv $ . .venv/bin/activate

4. Install Designate and it's dependencies:

   $ cd designate
   $ pip install -rtools/setup-requires -rtools/pip-requires -rtools/pip-options
   $ python setup.py develop

   Copy sample configs to usable ones, inside the etc folder do:

   $ ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done

5. Configure Bind or other if needed:

   $ vi /etc/bind/named.conf

   Add the following line to the file:

   include "$CHECKOUT_PATH/bind9/zones.config"

6. Restart bind:

   $ sudo service bind9 restart

7. If you intend to run Designate as a non-root user, then permissions and other things needs to be fixed up:

   $ MUSER=username
   $ echo "$MUSER ALL=(ALL) NOPASSWD:ALL" | sudo tee -a /etc/sudoers.d/90-designate-$MUSER
   $ sudo chmod 0440 /etc/sudoers.d/90-designate-$MUSER

Note on running processes

You can start each of the processes mentioned below in for example a screen session to view output

Installing the Central

double: installing; central

1. See Common Steps before proceeding.

2. Configure the central service:

   Change the wanted configuration settings to match your environment, the file is in the etc folder:

   $ vi designate-central.conf

   Refer to configuration details on configuring the service.

3. Initialize and sync the central:

   $ designate-manage database-init
   $ designate-manage database-sync

4. Start the central service:

   $ designate-central

Installing the Agent

double: installing; agent

1. See Common Steps before proceeding.

2. Configure the agent service:

   Change the wanted configuration settings to match your environment, the file is in the etc folder:

   $ vi designate-agent.conf

   Refer to configuration details on configuring the service.

3. Start the agent service:

   $ designate-agent

Installing the API

double: installing; api

Note

The API Server needs to able to talk to Keystone for AuthN + Z and communicates via MQ to other services.

1. See Common Steps before proceeding.

2. Configure the api service:

   Change the wanted configuration settings to match your environment, the file is in the etc folder:

   $ vi designate-api.conf
   $ vi designate-api-paste.ini

   Refer to configuration details on configuring the service.

3. Start the API service:

   $ designate-api