OpenStack DNS As A Service (Designate)
Go to file
Ghanshyam Mann 1c0bd99c08 [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: I81e7ee3243af11ebb3589f530533731b87178a96
2021-03-08 19:13:17 -06:00
api-ref/source Switch to newer openstackdocstheme and reno versions 2020-05-20 08:13:38 +02:00
contrib Update hacking for Python3 2020-04-01 21:52:38 +00:00
designate [goal] Deprecate the JSON formatted policy file 2021-03-08 19:13:17 -06:00
devstack Drop deprecated tail_log function from devstack plugin 2020-10-27 19:19:58 +00:00
doc [goal] Deprecate the JSON formatted policy file 2021-03-08 19:13:17 -06:00
etc/designate Add a /healthcheck middleware 2020-07-24 22:21:05 +00:00
playbooks Native Zuul v3 designate-grenade-pdns4 job 2020-08-23 16:54:43 +02:00
rally-jobs Add validation to improve pep8 check for designate project 2017-11-20 12:26:16 +00:00
releasenotes [goal] Deprecate the JSON formatted policy file 2021-03-08 19:13:17 -06:00
roles Update Zuul Jobs 2019-03-25 15:32:40 +00:00
tools Merge "[part1]:Remove six" 2020-10-14 13:32:58 +00: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 Add Python3 wallaby unit tests 2020-10-14 06:09:56 -06: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
lower-constraints.txt [goal] Deprecate the JSON formatted policy file 2021-03-08 19:13:17 -06:00
README.rst Updated Readme 2019-10-03 00:36:42 -07:00
requirements.txt [goal] Deprecate the JSON formatted policy file 2021-03-08 19:13:17 -06:00
setup.cfg Remove translation sections from setup.cfg 2020-06-20 22:04:03 +08:00
setup.py Cleanup py27 support 2020-04-05 08:11:51 +02:00
test-requirements.txt Fix lower-constraints 2020-12-13 14:07:52 +01:00
tox.ini Merge "Update requirements URLs in tox config" 2020-11-12 08:54:40 +00:00

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