75668d084c
Added a new section to the documentation introducing the core
concepts of DNS, providing an overview of Designate and how
it integrates with Neutron and external nameservers and linking
to other documentation for more information.
The Designate architecture diagram has been updated to reflect
modern deployments:
- All services are run as HA
- Nova does not interact with the Designate API, it has been
replaced with 'Users'
- The DB only receives connections from MiniDNS or Central so
its arrows are all incoming
- The backend is a part of the worker service
- MiniDNS sends NOTIFY to customer DNS Servers and
also receives transfer requests so their connection is
bidirectional
A subsequent change can update the architecture section to reflect
these clarifications, though they are for the most part already
mentioned in the text there.
Change-Id: I471db98544332cb454d15f29d86407cd09e91d6c
Team and repository tags
OpenStack Designate
Designate is an OpenStack project, providing DNSaaS.
IRC: #openstack-dns @ freenode
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 docsNow 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 py36Execute only backend tests
tox -e py36 -- unit.backendExecute only a single test
tox -e py36 -- unit.backend.test_pdns4.PDNS4BackendTestCase.test_create_zone_successContributing
Install the git-review package to make life easier
pip install git-reviewBranch, 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-reviewOther 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