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 and tests.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: I0dbb8484e749e645627756e88ec79c1b26a6414a
Extend neutron metering agent to generate Granular metering data.
The rationale here is to have data (bytes and packets) not just in
a label basis, but also in tenant, router, and router-label, and tenant-label
basis. This allows operators to develop more complex network monitoring
solutions.
Moreover, I added documentation to explain what is the neutron metering agent,
its configs, and different message formats.
Change-Id: I7b6172f88efd4df89d7bed9a0af52f80c61acbe0
Implements: https://blueprints.launchpad.net/neutron/+spec/granular-metering-data
Closes-Bug: #1886949
The following changes are made for PDF document.
- Sample config/policy files are skipped for PDF doc build.
We hit several problems around verbatim of inline samples
in neutron, nova and others, so we decided to skip them now.
Downloadable links also should be avoided in PDF doc
as PDF doc is expected to work alone.
- tocdepth for latex is explicitly set to 3 for better navigation
in the generated PDF. The default was 1 and we cannot provide
enough information in PDF TOC.
- The module index is disabled as the neutron document does not
generate a full module index and it shows only partial entries.
'makeindex' and 'printindex' are set to empty in latex_elements.
The existing contents (mainly the top page) are reorganized a bit
for a better TOC of the generated PDF document:
- The top page of the documentation is simplified only with toctree
to avoid almost duplicated entries in the TOC of the PDF documentation.
The current TOC for PDF doc seems to use section titles as the first
level and title of linked pages as the second level. They are almost
same and the generated TOC would be redundant.
- The link to the API reference in the top page was moved
to a subdirectory so that PDF TOC can include it.
- 'Search' section is shown in index.rst only when the builder is 'html'
as this section uses a form and makes sense only for HTML doc.
Story: 2006099
Task: 35127
Depends-On: https://review.opendev.org/664555
Change-Id: I6f1614a643efa7fad3c2a6ce5692d6873ca0ebd0
This is the preparation of migration to DocumendedRuleDefault.
Partially Implements: blueprint neutron-policy-in-code
Change-Id: I1d10f5db43167a04546565545d7d21010d16a808
oslo.config provides sphinx extensions to generate config reference
and sample config files. This commit enables the auto-generation of
the networking config reference.
Part of doc-migration work
Suppress pyroute2 warning to pass the doc build.
Change-Id: I74f0def7110674a6a735af77b9b07fb679b2959d