OpenStack DNS As A Service (Designate)
Go to file
Nicolas Bock 437cbf05ad Add pdf-docs env to tox.ini
- Enable PDF documentation. Based on [1].
- Enable table of contents generation for pdf
- Removed literalinclude of designate.conf [2]
- Removed illegal character (a literal ESC)
- Fix incorrect column count in backends summary section
- Replace nodes.line() with nodes.paragraph()

[1] https://review.opendev.org/601659
[2] https://github.com/sphinx-doc/sphinx/issues/3099

Change-Id: Ie454f8f9ebc8e36347ce33b22f2e6da0257fe4e0
Signed-off-by: Nicolas Bock <nicolas.bock@suse.com>
2019-09-07 09:26:57 +00:00
api-ref/source Merge "Remove the deprecated "giturl" option" 2018-02-03 14:16:52 +00:00
contrib Update vagrant config 2019-06-19 14:44:37 +01:00
designate Merge "Ensure coordination IDs are encoded" 2019-08-26 04:46:46 +00:00
devstack Drop creating extra endpoints in devstack 2019-08-12 14:27:15 +00:00
doc Add pdf-docs env to tox.ini 2019-09-07 09:26:57 +00:00
etc/designate Moved most configuration into designate.conf 2019-05-28 23:54:00 +00:00
playbooks Replace git.openstack.org URLs with opendev.org URLs 2019-04-24 08:47:23 +08:00
rally-jobs Add validation to improve pep8 check for designate project 2017-11-20 12:26:16 +00:00
releasenotes Ensure coordination IDs are encoded 2019-08-14 10:28:22 -04:00
roles Update Zuul Jobs 2019-03-25 15:32:40 +00:00
tools Switch to using stestr 2018-06-03 11:32:57 -04:00
.coveragerc Update .coveragerc after the removal of respective directory 2016-10-18 17:56:48 +05:30
.gitignore Remove testrepository 2018-07-11 17:44:40 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:14 +00:00
.stestr.conf Switch to using stestr 2018-06-03 11:32:57 -04:00
.zuul.yaml Add non voting ipv6 only jobs 2019-08-23 18:20:19 -07:00
CONTRIBUTING.rst Added CONTRIBUTING.rst file to the project 2018-07-06 10:50:46 +08:00
LICENSE Add LICENSE file. 2013-06-18 16:13:03 -04:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-24 08:47:23 +08: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
lower-constraints.txt Merge "Add designate-status command for upgrade checks" 2019-01-04 20:04:38 +00:00
requirements.txt Blacklist Bandit 1.6.0 due to directory exclusion bug 2019-05-09 20:27:37 -07:00
setup.cfg Removing manage command for akamai backend 2019-06-23 17:17:03 -07:00
setup.py Updated from global requirements 2017-03-08 23:22:13 +00:00
test-requirements.txt Bump to hacking 1.1.0 2019-07-04 00:33:00 -07:00
tox.ini Add pdf-docs env to tox.ini 2019-09-07 09:26:57 +00:00

README.rst

Team and repository tags

image

OpenStack Designate

Designate is an OpenStack project, providing DNSaaS.

IRC: #openstack-dns

Installation: https://docs.openstack.org/designate/latest/

Development

Designate follows the OpenStack Gerrit Workflow

Setup

Setup a working environment:

git clone https://opendev.org/openstack/designate
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