Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openstack/designate
OpenStack DNS As A Service (Designate). Mirror of code maintained at opendev.org.
https://github.com/openstack/designate
service
Last synced: 4 days ago
JSON representation
OpenStack DNS As A Service (Designate). Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/designate
- Owner: openstack
- License: apache-2.0
- Created: 2014-06-28T15:47:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T18:58:50.000Z (7 months ago)
- Last Synced: 2024-04-13T02:35:28.908Z (7 months ago)
- Topics: service
- Language: Python
- Homepage: https://opendev.org/openstack/designate
- Size: 11.9 MB
- Stars: 158
- Watchers: 29
- Forks: 80
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/designate.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
===================
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:
- `DNS API Reference `__
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
- `OpenStack for App Developers `__
- `Development resources for OpenStack clouds
`__
Development
===========
Designate follows the `OpenStack Gerrit Workflow`_
Setup
-----
Setup a working environment:
.. code-block:: bash
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:
.. code-block:: bash
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
.. code-block:: shell
tox -e py3
Execute only backend tests
.. code-block:: shell
tox -e py3 -- unit.backend
Execute only a single test
.. code-block:: shell
tox -e py3 -- unit.backend.test_pdns4.PDNS4BackendTestCase.test_create_zone_success
Contributing
------------
Install the git-review package to make life easier
.. code-block:: shell
pip install git-review
Branch, work, & submit:
.. code-block:: shell
# 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
-----------------
* 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
.. _OpenStack Gerrit Workflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _docs.openstack.org: https://docs.openstack.org/designate/latest/