openstack/designate
Code Issues Proposed changes
OpenStack DNS As A Service (Designate)
4,463 Commits 10 Branches 59 Tags 56 MiB
Python 93.7%
Shell 3.4%
PHP 2.6%
HTML 0.2%
39652d7a51
Go to file
Michael Johnson 39652d7a51 Add simple API versioning to the Designate API 
Adds simple API versioning for Designate. Designate API minor releases are
additive to the API major revision and share the same URL path. Subsequent
minor versions are a superset of the previous versions of the same major
revision.
Updates the version discovery document to be compliant with OpenStack
version discovery.
Restructures the API reference to provide more information about the
versioning.

Depends-On: https://review.opendev.org/c/openstack/designate-tempest-plugin/+/848323
Change-Id: I13162711b521472ec8b796ced34d0b7107aaed36
2022-06-30 18:30:54 +00:00
api-ref/source Add simple API versioning to the Designate API 2022-06-30 18:30:54 +00:00
contrib Merge "Add template for testing review or branch" 2022-02-17 23:43:59 +00:00
designate Add simple API versioning to the Designate API 2022-06-30 18:30:54 +00:00
devstack Adds api_ca_cert configuration variable to pools.yaml 2022-05-13 11:21:47 -04:00
doc Merge "Removed RPC calls from MDNS and moved them to the Worker" 2022-06-25 05:58:17 +00:00
etc/designate Integrate OSprofiler and Designate 2022-02-07 07:12:18 +00:00
playbooks Add fips jobs 2021-11-05 18:10:48 +00:00
rally-jobs Add validation to improve pep8 check for designate project 2017-11-20 12:26:16 +00:00
releasenotes Add simple API versioning to the Designate API 2022-06-30 18:30:54 +00:00
roles Merge "Stop double compressing pdns logs" 2022-05-12 19:00:02 +00:00
tools Remove references to sys.version_info 2021-09-18 11:05:49 +08: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 Fix FIPS job - nslookup_target 2022-06-22 21:40:00 +00:00
CONTRIBUTING.rst Community Goal: Project PTL & Contrib Docs Update 2020-04-14 14:17:15 -06: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
LICENSE Add LICENSE file. 2013-06-18 16:13:03 -04:00
README.rst Moving to OFTC 2021-05-27 06:21:33 -06:00
requirements.txt Merge "Removed RPC calls from MDNS and moved them to the Worker" 2022-06-25 05:58:17 +00:00
setup.cfg Drop python3.6/3.7 support in testing runtime 2022-06-07 21:27:10 +00:00
setup.py Cleanup py27 support 2020-04-05 08:11:51 +02:00
test-requirements.txt Bump hacking version 2022-06-16 09:31:18 +02:00
tox.ini Bump hacking version 2022-06-16 09:31:18 +02:00

README.rst

Team and repository tags

image

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