OpenStack DNS As A Service (Designate)
7472f515a6
hacking 3.0.x is too old. This also removes the note about old behavior of pip which has been changed in recent versions. Notes: - A few errors newly detected are also fixed. - This also fixes the compatibility with flake8 >= 3.0 because flake8 is also bumped when we bump hacking. - pretty_flake8 tool is removed because it's not commonly used but needs maintenance effort to keep it in sync with newer releases Change-Id: I8e91b06199bfbed1d6e9f8d62ddf52fafd60b7f9 |
||
---|---|---|
api-ref/source | ||
contrib | ||
designate | ||
devstack | ||
doc | ||
etc/designate | ||
playbooks | ||
rally-jobs | ||
releasenotes | ||
roles | ||
tools | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.stestr.conf | ||
.zuul.yaml | ||
bindep.txt | ||
CONTRIBUTING.rst | ||
designate.sublime-project | ||
LICENSE | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
Team and repository tags
OpenStack Designate
Designate is an OpenStack project, providing DNSaaS.
IRC: #openstack-dns @ oftc
Installation: https://docs.openstack.org/designate/latest/
API
To learn how to use Designate's API, consult the documentation available online at:
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
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
pip install -e .
Building Docs
To build the documentation from the restructured text source, do the following:
tox -e docs
Now point your browser at doc/build/html/index.html (the official documentation is published to docs.openstack.org by the maintainers.
Testing
Execute all unit tests
tox -e py3
Execute only backend tests
tox -e py3 -- unit.backend
Execute only a single test
tox -e py3 -- unit.backend.test_pdns4.PDNS4BackendTestCase.test_create_zone_success
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
Other Information
- Free software: Apache license
- Documentation: https://docs.openstack.org/designate/latest/
- Release notes: https://docs.openstack.org/releasenotes/designate/
- Source: https://opendev.org/openstack/designate
- Bugs: https://bugs.launchpad.net/designate
- Blueprints: https://blueprints.launchpad.net/designate