diff options
Diffstat (limited to 'docs/release/release-notes')
17 files changed, 314 insertions, 9 deletions
diff --git a/docs/release/release-notes/config.yaml b/docs/release/release-notes/config.yaml new file mode 100644 index 00000000..ae56f82d --- /dev/null +++ b/docs/release/release-notes/config.yaml @@ -0,0 +1,52 @@ +--- +unreleased_version_title: 'Lakelse' +sections: + - [ features, New Features ] + - [ testing, Testing Notes ] + - [ docs, Documentation Updates ] + - [ containers, Container updates ] + - [ ansible, Ansible playbook updates ] + - [ build, Build script updates ] + - [ fixes, Normal Bug Fixes ] + - [ deprecations, Deprecations ] + - [ other, Other Notes ] + +branch_name_prefix: stable/ +#release_tag_re: opnfv-((?:v?[\d.ab]|rc)+) +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..3f676753 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -4,13 +4,15 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Anuket, Intel Corporation and others. -================================================== +============================== Anuket Barometer Release Notes -================================================== +============================== .. toctree:: :maxdepth: 1 + unreleased + lakelse-release-notes 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/lakelse-release-notes.rst b/docs/release/release-notes/lakelse-release-notes.rst new file mode 100644 index 00000000..bf04342e --- /dev/null +++ b/docs/release/release-notes/lakelse-release-notes.rst @@ -0,0 +1,164 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Anuket and others. + +============================ +Lakelse Release Notes +============================ + +.. _Release Notes_lakelse: + +Lakelse +======= + +.. _Release Notes_lakelse_Release Summary: + +Release Summary +--------------- + +.. docs/release/release-notes/notes/lakelse/add_unix_sock-e29efe16156c5c8e.yaml @ None + +Added unixsock plugin to one-click install. + + +.. docs/release/release-notes/notes/lakelse/ansible-build-containers-b4a4cc9cb70f83b3.yaml @ None + +Add ansible playbook for building the containers locally. + + +.. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None + +Since the anuket dockerhub repository was created, and containers are being pushed to there, instructions and build scripts have been updated to reflect this. + + +.. docs/release/release-notes/notes/lakelse/collectd-5-v-6-testing-cc821b32bad2794c.yaml @ None + +Testing playbooks were added to compare collectd5 vs collectd6, for the purpose of helping to review new PRs by comparing the generated metrics between versions. + + +.. docs/release/release-notes/notes/lakelse/remove_dpdk_stats_events_plugins-59f366855f6e4261.yaml @ None + +Remove dpdkstats and dpdkevents from Barometer. + + +.. docs/release/release-notes/notes/lakelse/update_logparser_config-0db3d2746e6ad582.yaml @ None + +Enable the Logparser plugin by default when using one-click install. + + +.. _Release Notes_lakelse_Testing Notes: + +Testing Notes +------------- + +.. docs/release/release-notes/notes/lakelse/collectd-5-v-6-testing-cc821b32bad2794c.yaml @ None + +- Added a playbook to compare collectd 5 and collectd 6. The playbook uses + existing ansible roles to build both collectd 5 and collectd 6 container + images, creates a common configuration, then runs the containers and shows + the outputs to let the user inspect the metrics and whether they match. + + +.. _Release Notes_lakelse_Documentation Updates: + +Documentation Updates +--------------------- + +.. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None + +- Docs have been updated to use anuket/ repository in dockerhub. + Container build instructions now use anuket/ prefix to tag images. + + +.. _Release Notes_lakelse_Container updates: + +Container updates +----------------- + +.. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None + +- Containers are now pulled from anuket/ repository in dockerhub. + +.. docs/release/release-notes/notes/lakelse/collectd-6-testing-flask-app-2bb0ca1326775dd8.yaml @ None + +- Add a flask app for testing collectd using metrics sent via write_http plugin. + +.. docs/release/release-notes/notes/lakelse/update-grafana-9bee82ecfa11f54a.yaml @ None + +- Grafana container was updated to support both jiffies and percent for cpu metrics. + + +.. _Release Notes_lakelse_Ansible playbook updates: + +Ansible playbook updates +------------------------ + +.. docs/release/release-notes/notes/lakelse/add_unix_sock-e29efe16156c5c8e.yaml @ None + +- Added `unixsock <https://collectd.org/documentation/manpages/collectd-unixsock.5.shtml>`_ + plugin to one-click install, which allows the user to interact with collectd using the + ``collectdctl`` command in the bar-collectd-* containers. + The unixsock plugin is useful for debugging issues in collectd, and can + be used to verify that metrics are being collected without having to + create CSV files or log into the container. + +.. docs/release/release-notes/notes/lakelse/ansible-build-containers-b4a4cc9cb70f83b3.yaml @ None + +- Added a playbook and role for building the collectd containers locally. + This automates the actions described in the docker install guide. The + ``barometer-collectd``, ``barometer-collectd-latest`` and the + ``barometer-collectd-experimental`` containers are now easier to build + locally. The ``barometer-collectd-6`` and + ``barometer-collectd-experimental`` containers can also be built with + arbirtary PRs applied, to aid in testing locally. + +.. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None + +- Containers are now pulled from anuker/ repository in dockerhub. + +.. docs/release/release-notes/notes/lakelse/update_logparser_config-0db3d2746e6ad582.yaml @ None + +- The logparser plugin is now rendered for all flavours. + The Logparser plugin has been part of collectd since 5.11, however, the ansible playbooks had it marked as experimental, and would not deploy it by default. + + +.. _Release Notes_lakelse_Build script updates: + +Build script updates +-------------------- + +.. docs/release/release-notes/notes/lakelse/update-apply-pr-script-46e6d547d331c5f2.yaml @ None + +- Update collectd_apply_pull_request.sh to rebase only if multiple chanegs are selected. The script will checkout the PR branch if there's only one PR_ID passed. + + +.. _Release Notes_lakelse_Normal Bug Fixes: + +Normal Bug Fixes +---------------- + +.. docs/release/release-notes/notes/lakelse/update-grafana-9bee82ecfa11f54a.yaml @ None + +- Update the grafana dashboard to show metrics in both jffies and percent, depending on what is configured. + + +.. _Release Notes_lakelse_Deprecations: + +Deprecations +------------ + +.. docs/release/release-notes/notes/lakelse/remove_dpdk_stats_events_plugins-59f366855f6e4261.yaml @ None + +- The dpdkstats and dpdkevents plugins were removed from Barometer. These + plugins are still available in collectd, however, will not be deployed by + Barometer. It is recommended that the DPDK telemetry plugin be used instead. + + +.. _Release Notes_lakelse_Other Notes: + +Other Notes +----------- + +.. docs/release/release-notes/notes/lakelse/add-reno-12eb20e3448b663b.yaml @ None + +- Add `reno <https://docs.openstack.org/reno/latest/index.html#>`_ and corresponding tox jobs (compile notes and add new notes) to make compiling release notes easier diff --git a/docs/release/release-notes/notes/.placeholder b/docs/release/release-notes/notes/.placeholder new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/release/release-notes/notes/.placeholder diff --git a/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml new file mode 100644 index 00000000..2456c099 --- /dev/null +++ b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml @@ -0,0 +1,7 @@ +--- +documentation: + - | + Release notes are now automatically generated and included in the documentation using `reno <https://docs.openstack.org/reno/latest/index.html>`_. +other: + - | + Add `reno <https://docs.openstack.org/reno/latest/index.html#>`_ and corresponding tox jobs (compile notes and add new notes) to make compiling release notes easier diff --git a/docs/release/release-notes/notes/add_unix_sock-e29efe16156c5c8e.yaml b/docs/release/release-notes/notes/add_unix_sock-e29efe16156c5c8e.yaml new file mode 100644 index 00000000..7ba83afe --- /dev/null +++ b/docs/release/release-notes/notes/add_unix_sock-e29efe16156c5c8e.yaml @@ -0,0 +1,11 @@ +release_summary: > + Added unixsock plugin to one-click install. +ansible: + - | + Added `unixsock <https://collectd.org/documentation/manpages/collectd-unixsock.5.shtml>`_ + plugin to one-click install, which allows the user to interact with collectd using the + ``collectdctl`` command in the bar-collectd-* containers. + The unixsock plugin is useful for debugging issues in collectd, and can + be used to verify that metrics are being collected without having to + create CSV files or log into the container. + diff --git a/docs/release/release-notes/notes/ansible-build-containers-b4a4cc9cb70f83b3.yaml b/docs/release/release-notes/notes/ansible-build-containers-b4a4cc9cb70f83b3.yaml new file mode 100644 index 00000000..aae4b999 --- /dev/null +++ b/docs/release/release-notes/notes/ansible-build-containers-b4a4cc9cb70f83b3.yaml @@ -0,0 +1,11 @@ +release_summary: > + Add ansible playbook for building the containers locally. +ansible: + - | + Added a playbook and role for building the collectd containers locally. + This automates the actions described in the docker install guide. The + ``barometer-collectd``, ``barometer-collectd-latest`` and the + ``barometer-collectd-experimental`` containers are now easier to build + locally. The ``barometer-collectd-6`` and + ``barometer-collectd-experimental`` containers can also be built with + arbirtary PRs applied, to aid in testing locally. diff --git a/docs/release/release-notes/notes/anuket_containers-21b4206cb26c9975.yaml b/docs/release/release-notes/notes/anuket_containers-21b4206cb26c9975.yaml new file mode 100644 index 00000000..75e7e4f0 --- /dev/null +++ b/docs/release/release-notes/notes/anuket_containers-21b4206cb26c9975.yaml @@ -0,0 +1,12 @@ +release_summary: > + Since the anuket dockerhub repository was created, and containers are being pushed to there, instructions and build scripts have been updated to reflect this. +docs: + - | + Docs have been updated to use anuket/ repository in dockerhub. + Container build instructions now use anuket/ prefix to tag images. +containers: + - | + Containers are now pulled from anuket/ repository in dockerhub. +ansible: + - | + Containers are now pulled from anuker/ repository in dockerhub. diff --git a/docs/release/release-notes/notes/collectd-5-v-6-testing-cc821b32bad2794c.yaml b/docs/release/release-notes/notes/collectd-5-v-6-testing-cc821b32bad2794c.yaml new file mode 100644 index 00000000..20013147 --- /dev/null +++ b/docs/release/release-notes/notes/collectd-5-v-6-testing-cc821b32bad2794c.yaml @@ -0,0 +1,10 @@ +release_summary: > + Testing playbooks were added to compare collectd5 vs collectd6, for the + purpose of helping to review new PRs by comparing the generated metrics + between versions. +testing: + - | + Added a playbook to compare collectd 5 and collectd 6. The playbook uses + existing ansible roles to build both collectd 5 and collectd 6 container + images, creates a common configuration, then runs the containers and shows + the outputs to let the user inspect the metrics and whether they match. diff --git a/docs/release/release-notes/notes/collectd-6-testing-flask-app-2bb0ca1326775dd8.yaml b/docs/release/release-notes/notes/collectd-6-testing-flask-app-2bb0ca1326775dd8.yaml new file mode 100644 index 00000000..9c605876 --- /dev/null +++ b/docs/release/release-notes/notes/collectd-6-testing-flask-app-2bb0ca1326775dd8.yaml @@ -0,0 +1,3 @@ +containers: + - | + Add a flask app for testing collectd using metrics sent via write_http plugin. diff --git a/docs/release/release-notes/notes/remove_dpdk_stats_events_plugins-59f366855f6e4261.yaml b/docs/release/release-notes/notes/remove_dpdk_stats_events_plugins-59f366855f6e4261.yaml new file mode 100644 index 00000000..78ab1c4c --- /dev/null +++ b/docs/release/release-notes/notes/remove_dpdk_stats_events_plugins-59f366855f6e4261.yaml @@ -0,0 +1,8 @@ +--- +release_summary: > + Remove dpdkstats and dpdkevents from Barometer. +deprecations: + - | + The dpdkstats and dpdkevents plugins were removed from Barometer. These + plugins are still available in collectd, however, will not be deployed by + Barometer. It is recommended that the DPDK telemetry plugin be used instead. diff --git a/docs/release/release-notes/notes/update-apply-pr-script-46e6d547d331c5f2.yaml b/docs/release/release-notes/notes/update-apply-pr-script-46e6d547d331c5f2.yaml new file mode 100644 index 00000000..de1be994 --- /dev/null +++ b/docs/release/release-notes/notes/update-apply-pr-script-46e6d547d331c5f2.yaml @@ -0,0 +1,3 @@ +build: + - | + Update collectd_apply_pull_request.sh to rebase only if multiple chanegs are selected. The script will checkout the PR branch if there's only one PR_ID passed. diff --git a/docs/release/release-notes/notes/update-grafana-9bee82ecfa11f54a.yaml b/docs/release/release-notes/notes/update-grafana-9bee82ecfa11f54a.yaml new file mode 100644 index 00000000..95e2cbdb --- /dev/null +++ b/docs/release/release-notes/notes/update-grafana-9bee82ecfa11f54a.yaml @@ -0,0 +1,6 @@ +containers: + - | + Grafana container was updated to support both jiffies and percent for cpu metrics. +fixes: + - | + Update the grafana dashboard to show metrics in both jffies and percent, depending on what is configured. diff --git a/docs/release/release-notes/notes/update_logparser_config-0db3d2746e6ad582.yaml b/docs/release/release-notes/notes/update_logparser_config-0db3d2746e6ad582.yaml new file mode 100644 index 00000000..e5be3eff --- /dev/null +++ b/docs/release/release-notes/notes/update_logparser_config-0db3d2746e6ad582.yaml @@ -0,0 +1,6 @@ +release_summary: > + Enable the Logparser plugin by default when using one-click install. +ansible: + - | + The logparser plugin is now rendered for all flavours. + The Logparser plugin has been part of collectd since 5.11, however, the ansible playbooks had it marked as experimental, and would not deploy it by default. diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/old-release-notes.rst index 75a2e391..d5c1b7e5 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/old-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 Release Notes -====================================================================== +=================== +Older Release Notes +=================== This document provides the release notes for Euphrates release of Barometer. 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/ |