631b18bd12
This patch updates the "list service statuses" section of the API reference to document the response parameters. It also adds the missing "show service status" section. Change-Id: If451fc099d2a3dc8ce77c807d9553da7c4122190
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 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