From 8d8e43750e801b5c7abc2eadcba9f056635d7fdb Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Thu, 12 Aug 2021 12:43:39 +0100 Subject: [docs][reno] Update reno to include template The template for release notes wasn't conforming to the expected headings. A template was added to the config. To generate a new note (from the base directory in the repo), use:: reno --rel-notes-dir docs/release/release-notes/ new slug-goes-here The release notes are also included as part of the docs build, and the existing releases notes have been renamed accordingly. Signed-off-by: Emma Foley Change-Id: I05d1950b37f266bb6eb3515b3660665cfd5c1d8b --- docs/conf.py | 2 + docs/release/release-notes/config.yaml | 35 +++ docs/release/release-notes/index.rst | 7 +- docs/release/release-notes/kali-release-notes.rst | 6 +- .../notes/add-reno-12eb20e3448b663b.yaml | 5 +- docs/release/release-notes/old-release-notes.rst | 239 +++++++++++++++++++++ docs/release/release-notes/release-notes.rst | 239 --------------------- docs/release/release-notes/unreleased.rst | 10 + 8 files changed, 297 insertions(+), 246 deletions(-) create mode 100644 docs/release/release-notes/old-release-notes.rst delete mode 100644 docs/release/release-notes/release-notes.rst create mode 100644 docs/release/release-notes/unreleased.rst diff --git a/docs/conf.py b/docs/conf.py index 3c4453e7..041afc56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1 +1,3 @@ from docs_conf.conf import * + +extensions = ['reno.sphinxext'] diff --git a/docs/release/release-notes/config.yaml b/docs/release/release-notes/config.yaml index 5c2b7a7b..ae56f82d 100644 --- a/docs/release/release-notes/config.yaml +++ b/docs/release/release-notes/config.yaml @@ -1,3 +1,4 @@ +--- unreleased_version_title: 'Lakelse' sections: - [ features, New Features ] @@ -15,3 +16,37 @@ branch_name_prefix: stable/ prelude_section_name: release_summary stop_at_branch_base: False collapse_pre_releases: False +template: | + release_summary: > + Add a summary of the change here. All sections (including this one) are + optional, and if they are not needed, you can completely remove that section. + Each section is rendered separately, this mean you should assume each item + below is self-contained, and should not depend on info in any other section. + This means repetition is sometimes necessary, and this is okay. + features: + - | + List new features here + testing: + - | + List new testing notes here + docs: + - | + List documentation updates here + containers: + - | + List container updates here + ansible: + - | + List ansible playbook updates here + build: + - | + List build script updates here + fixes: + - | + List normal bug fixes here + deprecations: + - | + List deprecations here + other: + - | + List other notes here diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index df4696a5..6185fc97 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -4,13 +4,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Anuket, Intel Corporation and others. -================================================== +============================== Anuket Barometer Release Notes -================================================== +============================== .. toctree:: :maxdepth: 1 + unreleased kali-release-notes - release-notes + old-release-notes diff --git a/docs/release/release-notes/kali-release-notes.rst b/docs/release/release-notes/kali-release-notes.rst index 250becc1..cac7325b 100644 --- a/docs/release/release-notes/kali-release-notes.rst +++ b/docs/release/release-notes/kali-release-notes.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -============================ -Barometer Kali Release Notes -============================ +================== +Kali Release Notes +================== This document provides the release notes for Kali release of Barometer. diff --git a/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml index 4dbf2e88..c0e8c7e9 100644 --- a/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml +++ b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml @@ -1,4 +1,7 @@ --- +documentation: + - | + Release notes are now automatically generated and included in the documentation using `reno `_. other: - | - Add reno and corresponding tox jobs to make compiling release notes easier + Add `reno `_ and corresponding tox jobs to make compiling release notes easier diff --git a/docs/release/release-notes/old-release-notes.rst b/docs/release/release-notes/old-release-notes.rst new file mode 100644 index 00000000..d5c1b7e5 --- /dev/null +++ b/docs/release/release-notes/old-release-notes.rst @@ -0,0 +1,239 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +=================== +Older Release Notes +=================== + +This document provides the release notes for Euphrates release of Barometer. + + +Important notes +----------------- +None to date. + +Summary +------------ +The Barometer@OPNFV project adds a platform telemetry agent to compute nodes +that is capable of retrieving platform statistics and events, and relay them +to Openstack Gnocchi and Aodh. The telemetry agent currently supported by barometer +is collectd. Some additional collectd plugins and application were developed to add +the following functionality: + +Write/publishing Plugins: + +- aodh plugin: A notification plugin that pushes events to Aodh, and + creates/updates alarms appropriately. +- SNMP agent plugin: A write plugin that will act as an AgentX subagent that + receives and handles queries from SNMP master agent and returns the data + collected by read plugins. The SNMP Agent plugin handles requests only for OIDs + specified in configuration file. To handle SNMP queries the plugin gets data + from collectd and translates requested values from collectd’s internal format + to SNMP format. Supports SNMP: get, getnext and walk requests. +- gnocchi plugin: A write plugin that pushes the retrieved stats to Gnocchi. + It’s capable of pushing any stats read through collectd to Gnocchi, not just + the DPDK stats. + +Read Plugins: + +- Intel RDT plugin: A read plugin that provides the last level cache + utilization and memory bandwidth utilization. +- virt plugin: A read plugin that uses virtualization API libvirt to gather + statistics and events about virtualized guests on a system directly from the + hypervisor, without a need to install collectd instance on the guest. +- Open vSwitch stats plugin: A read plugin that retrieves interface stats from + OVS. + +In addition to the previous plugins from the Danube Release described below. + +Release Data +--------------- + ++--------------------------------------+--------------------------------------+ +| **Project** | Euphrates/barometer/barometer@opnfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | barometer/opnfv-5.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Euphrates 5.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | December 15th, 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Official OPNFV release | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +^^^^^^^^^^^^^^^^ + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- There have been no version changes. + +Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +Reason for version +^^^^^^^^^^^^^^^^^^^^ +Feature additions +~~~~~~~~~~~~~~~~~~~~~~~ + +**JIRA BACK-LOG:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BAROMETER-51 | RDT Cache Feature | +| | | ++--------------------------------------+--------------------------------------+ +| BAROMETER-53 | RAS Metrics and Events/ | +| | MCELOG Memory Errors | ++--------------------------------------+--------------------------------------+ +| BAROMETER-55 | Libvirt Metrics and Events | +| | | ++--------------------------------------+--------------------------------------+ +| BAROMETER-56 | Openvswitch Mrtics and Events | +| | | ++--------------------------------------+--------------------------------------+ +| BAROMETER-59 | AODH plugin | +| | | ++--------------------------------------+--------------------------------------+ +| BAROMETER-60 | Gnocchi Plugin | +| | | ++--------------------------------------+--------------------------------------+ +| BAROMETER-58 | SNMP Agent | +| | | ++--------------------------------------+--------------------------------------+ + +Bugs +~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BAROMETER-80 | SNMP Agent testing with Intel RDT, | +| | MCELOG, Hugepages, and OVS Stats not | +| | functional in the Apex image of OPNFV| +| | Release E | ++--------------------------------------+--------------------------------------+ +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +---------------- + +Software deliverables +^^^^^^^^^^^^^^^^^^^^^^^ + +Features to Date +~~~~~~~~~~~~~~~~ + +Release B +~~~~~~~~~~ +The features implemented for OPNFV release B (as part of SFQM) in DPDK include: + +* Callback API to enable TX/RX timestamping to measure latency through DPDK. +* Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed + statistics for DPDK interfaces in addition to the overall aggregate statistics. +* DPDK Keep Alive. + +Release C +~~~~~~~~~~ +The features implemented for OPNFV release C (as part of SFQM) include: + +* DPDK extended NIC stats API improvement; migrate from key value pairs to + using id value pairs. +* DPDK Keep Alive improvement, so that core status is exposed through a posix + shared memory object. +* collectd dpdkstat plugin that can retrieve DPDK interface statistics. +* collectd ceilometer plugin that can publish any statistics collected by + collectd to ceilometer. +* Fuel plugin support for the collectd ceilometer plugin for OPNFV. + +Release D +~~~~~~~~~ +The features implemented for OPNFV release D include: + +* collectd hugepages plugin that can retrieves the number of available and free hugepages + on a platform as well as what is available in terms of hugepages per socket. +* collectd Open vSwitch Events plugin that can retrieves events from OVS. +* collectd mcelog plugin that can use mcelog client protocol to check for memory Machine + Check Exceptions and sends the stats for reported exceptions. +* collectd ceilometer plugin that can publish any statistics collected by + collectd to ceilometer. + +Documentation deliverables +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- Configuration guide +- User guide +- Release notes +- Scenario documentation. + +Known Limitations, Issues and Workarounds +-------------------------------------------- + +System Limitations +^^^^^^^^^^^^^^^^^^^^ + +For Intel RDT plugin, compute node needs to support Intel RDT. + +Known issues +^^^^^^^^^^^^^^^ + +No known issues to date. + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Workarounds +^^^^^^^^^^^^^^^^^ + +- None to date. + +Test Result +--------------- + +Barometer@OPNFV Euphrates has undergone QA test runs with the following results: + ++--------------------------------------+--------------------------------------+ +| **TEST-SUITE** | **Results:** | +| | | ++--------------------------------------+--------------------------------------+ +| barometercollectd | | +| | | +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +References +------------ diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst deleted file mode 100644 index 75a2e391..00000000 --- a/docs/release/release-notes/release-notes.rst +++ /dev/null @@ -1,239 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -====================================================================== -Barometer Release Notes -====================================================================== - -This document provides the release notes for Euphrates release of Barometer. - - -Important notes ------------------ -None to date. - -Summary ------------- -The Barometer@OPNFV project adds a platform telemetry agent to compute nodes -that is capable of retrieving platform statistics and events, and relay them -to Openstack Gnocchi and Aodh. The telemetry agent currently supported by barometer -is collectd. Some additional collectd plugins and application were developed to add -the following functionality: - -Write/publishing Plugins: - -- aodh plugin: A notification plugin that pushes events to Aodh, and - creates/updates alarms appropriately. -- SNMP agent plugin: A write plugin that will act as an AgentX subagent that - receives and handles queries from SNMP master agent and returns the data - collected by read plugins. The SNMP Agent plugin handles requests only for OIDs - specified in configuration file. To handle SNMP queries the plugin gets data - from collectd and translates requested values from collectd’s internal format - to SNMP format. Supports SNMP: get, getnext and walk requests. -- gnocchi plugin: A write plugin that pushes the retrieved stats to Gnocchi. - It’s capable of pushing any stats read through collectd to Gnocchi, not just - the DPDK stats. - -Read Plugins: - -- Intel RDT plugin: A read plugin that provides the last level cache - utilization and memory bandwidth utilization. -- virt plugin: A read plugin that uses virtualization API libvirt to gather - statistics and events about virtualized guests on a system directly from the - hypervisor, without a need to install collectd instance on the guest. -- Open vSwitch stats plugin: A read plugin that retrieves interface stats from - OVS. - -In addition to the previous plugins from the Danube Release described below. - -Release Data ---------------- - -+--------------------------------------+--------------------------------------+ -| **Project** | Euphrates/barometer/barometer@opnfv | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/commit-ID** | barometer/opnfv-5.1.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Euphrates 5.1.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | December 15th, 2017 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Official OPNFV release | -| | | -+--------------------------------------+--------------------------------------+ - -Version change -^^^^^^^^^^^^^^^^ - -Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- There have been no version changes. - -Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -Reason for version -^^^^^^^^^^^^^^^^^^^^ -Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ - -**JIRA BACK-LOG:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| BAROMETER-51 | RDT Cache Feature | -| | | -+--------------------------------------+--------------------------------------+ -| BAROMETER-53 | RAS Metrics and Events/ | -| | MCELOG Memory Errors | -+--------------------------------------+--------------------------------------+ -| BAROMETER-55 | Libvirt Metrics and Events | -| | | -+--------------------------------------+--------------------------------------+ -| BAROMETER-56 | Openvswitch Mrtics and Events | -| | | -+--------------------------------------+--------------------------------------+ -| BAROMETER-59 | AODH plugin | -| | | -+--------------------------------------+--------------------------------------+ -| BAROMETER-60 | Gnocchi Plugin | -| | | -+--------------------------------------+--------------------------------------+ -| BAROMETER-58 | SNMP Agent | -| | | -+--------------------------------------+--------------------------------------+ - -Bugs -~~~~ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| BAROMETER-80 | SNMP Agent testing with Intel RDT, | -| | MCELOG, Hugepages, and OVS Stats not | -| | functional in the Apex image of OPNFV| -| | Release E | -+--------------------------------------+--------------------------------------+ -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Deliverables ----------------- - -Software deliverables -^^^^^^^^^^^^^^^^^^^^^^^ - -Features to Date -~~~~~~~~~~~~~~~~ - -Release B -~~~~~~~~~~ -The features implemented for OPNFV release B (as part of SFQM) in DPDK include: - -* Callback API to enable TX/RX timestamping to measure latency through DPDK. -* Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed - statistics for DPDK interfaces in addition to the overall aggregate statistics. -* DPDK Keep Alive. - -Release C -~~~~~~~~~~ -The features implemented for OPNFV release C (as part of SFQM) include: - -* DPDK extended NIC stats API improvement; migrate from key value pairs to - using id value pairs. -* DPDK Keep Alive improvement, so that core status is exposed through a posix - shared memory object. -* collectd dpdkstat plugin that can retrieve DPDK interface statistics. -* collectd ceilometer plugin that can publish any statistics collected by - collectd to ceilometer. -* Fuel plugin support for the collectd ceilometer plugin for OPNFV. - -Release D -~~~~~~~~~ -The features implemented for OPNFV release D include: - -* collectd hugepages plugin that can retrieves the number of available and free hugepages - on a platform as well as what is available in terms of hugepages per socket. -* collectd Open vSwitch Events plugin that can retrieves events from OVS. -* collectd mcelog plugin that can use mcelog client protocol to check for memory Machine - Check Exceptions and sends the stats for reported exceptions. -* collectd ceilometer plugin that can publish any statistics collected by - collectd to ceilometer. - -Documentation deliverables -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -- Configuration guide -- User guide -- Release notes -- Scenario documentation. - -Known Limitations, Issues and Workarounds --------------------------------------------- - -System Limitations -^^^^^^^^^^^^^^^^^^^^ - -For Intel RDT plugin, compute node needs to support Intel RDT. - -Known issues -^^^^^^^^^^^^^^^ - -No known issues to date. - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Workarounds -^^^^^^^^^^^^^^^^^ - -- None to date. - -Test Result ---------------- - -Barometer@OPNFV Euphrates has undergone QA test runs with the following results: - -+--------------------------------------+--------------------------------------+ -| **TEST-SUITE** | **Results:** | -| | | -+--------------------------------------+--------------------------------------+ -| barometercollectd | | -| | | -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ - -References ------------- diff --git a/docs/release/release-notes/unreleased.rst b/docs/release/release-notes/unreleased.rst new file mode 100644 index 00000000..e3b0dccc --- /dev/null +++ b/docs/release/release-notes/unreleased.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Anuket and others. + +============================ +Current Series Release Notes +============================ + +.. release-notes:: + :relnotessubdir: docs/release/release-notes/ -- cgit 1.2.3-korg