OpenStack DNS As A Service (Designate)
Go to file
Graham Hayes b25ab0e1dc Update README to RST
This allows the tooling used by the release management team parse the
content to grab links to bug trackers and docs.

Also updated the sample test command to a working one

Change-Id: I1dcfb2b5ae3ba07fbaf6eaabfef1d9e7da778400
Closes-Bug: #1532735
2016-02-23 15:16:18 +00:00
contrib Replace deprecated LOG.warn with LOG.warning 2016-01-05 09:20:58 +00:00
designate Merge "Actually poll for zone deletes" 2016-02-22 18:11:37 +00:00
devstack Actually poll for zone deletes 2016-02-16 22:30:37 +00:00
doc Merge "Fix a missing '\' in doc" 2016-02-22 23:03:45 +00:00
etc/designate Add delayed NOTIFY 2016-02-17 15:24:00 +00:00
functionaltests Merge "Actually poll for zone deletes" 2016-02-22 18:11:37 +00:00
rally-jobs Grammar mistakes have been corrected 2015-08-22 21:32:18 +05:30
releasenotes Add Reno for release notes tracking 2015-11-23 18:00:36 +00:00
tools Add delayed NOTIFY 2016-02-17 15:24:00 +00:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:26:01 +00:00
.gitignore Add Reno for release notes tracking 2015-11-23 18:00:36 +00:00
.gitreview Update .gitreview for repository move 2014-06-28 16:52:03 +01:00
.testr.conf Add functional tox env 2015-07-14 15:36:08 +01:00
LICENSE Add LICENSE file. 2013-06-18 16:13:03 -04:00
README.rst Update README to RST 2016-02-23 15:16:18 +00:00
babel.cfg Setup for translation 2014-07-04 16:40:02 +02:00
bandit.yaml Added bandit to designate 2016-01-13 09:09:30 +05:30
designate.sublime-project Add __pycache__ to ST2 Ignore 2015-07-09 20:19:53 +01:00
ipa-requirements.txt add support for FreeIPA backend - phase 5 - requirements 2014-05-07 17:16:12 -06:00
openstack-common.conf Switch to oslo.reports 2015-11-05 10:55:29 +01:00
requirements.txt Updated from global requirements 2016-02-20 21:54:35 +00:00
setup.cfg Update README to RST 2016-02-23 15:16:18 +00:00
setup.py Updated from global requirements 2015-09-17 12:11:31 +00:00
test-requirements.txt Updated from global requirements 2016-02-08 02:38:19 +00:00
tests-py3.txt Fix the python34 check job 2016-01-21 17:37:19 +01:00
tox.ini Fix the python34 check job 2016-01-21 17:37:19 +01:00

README.rst

OpenStack Designate

Designate is an OpenStack project, providing DNSaaS.

IRC: #openstack-dns

Installation: http://docs.openstack.org/developer/designate/getting-started.html

Development

Designate follows the OpenStack Gerrit Workflow

Setup

Setup a working environment:

git clone https://github.com/openstack/designate.git
cd designate
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py develop

Building Docs

To build the documentation from the restructured text source, do the following:

cd doc
pip install -r requirements.txt
sphinx-build  source/ build/html/

now point your browser at html/index.html (the official documentation is published to docs.openstack.org by the maintainers.

Contributing

Install the git-review package to make life easier

pip install git-review

Branch, work, & submit:

# cut a new branch, tracking master
git checkout --track -b bug/id origin/master
# work work work
git add stuff
git commit
# rebase/squash to a single commit before submitting
git rebase -i
# submit
git-review

Testing

Execute a single test using py27 (test is CentralServiceTest.test_count_domains)

tox -e py27 -- designate.tests.test_central.test_service.CentralServiceTest.test_count_zones_policy_check