OpenStack DNS As A Service (Designate)
Go to file
Graham Hayes e9db59d3b3 Start Designate API-Ref style documentation
Creates api-ref test env
Add basic v2/zones API documentation

Change-Id: I1783234c59319fdcb13b0df90f662253e822bab3
Depends-On: I0e615d36a2e5a8fa0d83f20bdcc2c33ad868ebd5
2016-05-16 16:41:02 +01:00
api-ref/source Start Designate API-Ref style documentation 2016-05-16 16:41:02 +01:00
contrib Fix the memory of the VM in VirtualBox 2016-05-09 20:44:19 +01:00
designate Merge "Enable V2 API as default" 2016-05-13 10:50:34 +00:00
devstack Merge "Support multiple API and mDNS listen address pairs" 2016-05-04 17:22:12 +00:00
doc Merge "Expose /v2/recordsets api endpoint" 2016-05-12 15:29:18 +00:00
etc/designate Merge "Enable V2 API as default" 2016-05-13 10:50:34 +00:00
functionaltests Merge "Remove more tests migrated to tempest plugin" 2016-05-12 19:22:50 +00:00
rally-jobs Grammar mistakes have been corrected 2015-08-22 21:32:18 +05:30
releasenotes Expose /v2/recordsets api endpoint 2016-05-11 16:36:21 +00:00
tools Removed old tooling for ks CLI 2016-04-18 20:34:29 +01:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:26:01 +00:00
.gitignore Start Designate API-Ref style documentation 2016-05-16 16:41:02 +01: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
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-05-12 03:21:44 +00:00
setup.cfg Added attribute filter to scheduler 2016-04-29 10:03:28 -05:00
setup.py Updated from global requirements 2015-09-17 12:11:31 +00:00
test-requirements.txt Start Designate API-Ref style documentation 2016-05-16 16:41:02 +01:00
tests-py3.txt Fix the python34 check job 2016-01-21 17:37:19 +01:00
tox.ini Start Designate API-Ref style documentation 2016-05-16 16:41:02 +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