Add some basic documentation for users covering how to create zones.
Nameserver list is not in the client CLI, once that is
available an additional command can be added showing how to get
the backend nameserver to query when verifying results.
Change-Id: I914875cfd6273c01c74194c8a6296ae74537d169
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
Added a new section to the documentation introducing the core
concepts of DNS, providing an overview of Designate and how
it integrates with Neutron and external nameservers and linking
to other documentation for more information.
The Designate architecture diagram has been updated to reflect
modern deployments:
- All services are run as HA
- Nova does not interact with the Designate API, it has been
replaced with 'Users'
- The DB only receives connections from MiniDNS or Central so
its arrows are all incoming
- The backend is a part of the worker service
- MiniDNS sends NOTIFY to customer DNS Servers and
also receives transfer requests so their connection is
bidirectional
A subsequent change can update the architecture section to reflect
these clarifications, though they are for the most part already
mentioned in the text there.
Change-Id: I471db98544332cb454d15f29d86407cd09e91d6c
In version 2.7.0 pygments contains this change[0] to be stricter
when parsing json, breaking highlighting for some of our samples.
This patch fixes the json examples.
[0] 9514e794e0
Change-Id: I59adc546dbf8079bd5cc3aab4a1500360649d210
The ubuntu PPA was for havana and there appears to be no
more modern equivalent
The nova and neutron designate plugins both link to github
repositories that are now deleted.
The chef cookbook, debian packages and example plugin have no
updates in the last 7 years
The bug and blueprint links are current and are already on the
getting-started page
The git repo has been added to the getting started page as that
was the only remaining link
Change-Id: I5d93ffdbeac54a396fc34d13a96636b23c5845e1
In case a user wants to use the CLI add the appropriate invocations.
Change-Id: I49272ea9631dc142e80f7a2376fc1f2c3c9e0a61
Signed-off-by: Nicolas Bock <nicolas.bock@canonical.com>
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Set openstackdocs_auto_name to use 'project' as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Add openstackdocstheme options to api-ref.
Change-Id: I0cf71327ca5d9da1d88a826225374c8801849c36
- Drop reference to weekly meeting
- Use https when possible
- Update comment about devstack plugin
- Need to use Ubuntu 18.04 or newer
- Change deprecated option in example
Change-Id: Icdff59fb24fde99b02b9d5e85e3b6d17d5f3434e
This patch standardizes the CONTRIBUTING.rst file and adds information
from the required doc/source/contributor/contributing.rst.
Change-Id: I4a47ef22c70c6f6b225ea779227627d7f3078f4e
Story: #2007236
Task: #38520
Signed-off-by: Nicolas Bock <nicolas.bock@canonical.com>
* Mark Akamai v2 as untested
* Mark Akamai eDNS as known broken due to the API being removed
* Add basic docs for Akamai v2
Change-Id: I4f6c6c1c96251bfc4f7ad3bb6b0bd2025397fa03
Signed-off-by: Graham Hayes <gr@ham.ie>
--dry-run and --delete should be switchs.
now --dry_run acts as key value pair. users do not know what is behind
--dry-run. and now whatever the value is acceptable. this is unreasonable.
Closes-bug: #1847393
Change-Id: Ia6ab93395deb95173e443f9d3ea77dd52edfcf2c
This is better practice and we should recommend
this value set in the install guides.
Host headers makes use of request host_url provided
by Flask, instead of relying on the hard-coded url in
the configuration.
Change-Id: I9fbb71acd063d2034190e773f69f7a80275b2f3c
The pool-manager has been deprecated since Newton and
is now being removed with the Train release.
Change-Id: Ib258043d492bb25e1c061d765b40885317c73804
Running "sphinx-build -b man doc/source doc/build/man" allows the
build of man pages which are useful when working from the command
line.
Change-Id: Ia9e2bb2cc9d68bea71a19ff8296bbf9bd3cd95a4
- Enable PDF documentation. Based on [1].
- Enable table of contents generation for pdf
- Removed literalinclude of designate.conf [2]
- Removed illegal character (a literal ESC)
- Fix incorrect column count in backends summary section
- Replace nodes.line() with nodes.paragraph()
[1] https://review.opendev.org/601659
[2] https://github.com/sphinx-doc/sphinx/issues/3099
Change-Id: Ie454f8f9ebc8e36347ce33b22f2e6da0257fe4e0
Signed-off-by: Nicolas Bock <nicolas.bock@suse.com>
There is an error in the service:api section
of the documentation. Quotas and reports are
valid admin extensions and not v2 extensions.
In addition we also never actually enabled
the admin api.
Change-Id: I240a274d9129612596fe06798e8b29bd9159bd03
Did not specify between 2.8 and 2.7, went with
generic documentation link for ease of future use.
Change-Id: I43c5f71c9b335055ee8691566eb662fdb27eeba8
backport: stein rocky
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: Ibd4ed1a1e282f0088467a6fcafe44b1dad46ed5f
> Could not lex literal_block as "guess". Highlighting skipped.
Changes guess to none (no highlighting) to resolve this.
Change-Id: Iffe1846f0fff4e9f1c980fcbeed6f71f941eeaf9
Based upon the established conf paradigm used in Nova,
this patch moves most of the configuration to a
central location. Making config a lot easier to
manage, as well a lot easier to locate.
There is still some configuration listed in classes,
that I would like to eventually move to
designate.conf as well, but to lower complexity not
all config was moved.
General changes
* Centrelized most configuration under designate.conf.
* Cleaned up configuration.
* Simplified config generation.
* Renamed generated config to designate.conf.sample.
Previously broken
* xfr_timeout now in the appropriate section.
* memcached_servers now in the appropriate section.
Previously missing from sample config
* allowed_remote_exmods listed in sample config.
* backend:akamai section listed in sample config.
* backend:dynect section listed in sample config.
* backend:infoblox section listed in sample config.
blueprint centralize-config-designate
Change-Id: I3be68bf294157631a9bac128df0841220020de96
Sphinx 2.0.0 dropped Python 2.7 support. This is aligned with
Change-Id If558f184c959e4b63b56dec3ca1571d1034cfe5c in requirements
project.
Change-Id: I01467293fffbcf45ee9b311731f5d8699040215a
Co-Authored-By: Carlos Goncalves <cgoncalves@redhat.com>
