designate  10.0.0
About: OpenStack Designate provides DNSaaS services for OpenStack.
The "Ussuri" series (latest release).
  Fossies Dox: designate-10.0.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

designate Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. designate-10.0.0.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.rst

Team and repository tags

image

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 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 py36

Execute only backend tests

tox -e py36 -- unit.backend

Execute only a single test

tox -e py36 -- 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