[docs] Release notes for Lakelse
[barometer.git] / docs / release / release-notes / lakelse-release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Anuket and others.
4
5 ============================
6 Lakelse Release Notes
7 ============================
8
9 .. _Release Notes_lakelse:
10
11 Lakelse
12 =======
13
14 .. _Release Notes_lakelse_Release Summary:
15
16 Release Summary
17 ---------------
18
19 .. docs/release/release-notes/notes/lakelse/add_unix_sock-e29efe16156c5c8e.yaml @ None
20
21 Added unixsock plugin to one-click install.
22
23
24 .. docs/release/release-notes/notes/lakelse/ansible-build-containers-b4a4cc9cb70f83b3.yaml @ None
25
26 Add ansible playbook for building the containers locally.
27
28
29 .. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None
30
31 Since the anuket dockerhub repository was created, and containers are being pushed to there, instructions and build scripts have been updated to reflect this.
32
33
34 .. docs/release/release-notes/notes/lakelse/collectd-5-v-6-testing-cc821b32bad2794c.yaml @ None
35
36 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.
37
38
39 .. docs/release/release-notes/notes/lakelse/remove_dpdk_stats_events_plugins-59f366855f6e4261.yaml @ None
40
41 Remove dpdkstats and dpdkevents from Barometer.
42
43
44 .. docs/release/release-notes/notes/lakelse/update_logparser_config-0db3d2746e6ad582.yaml @ None
45
46 Enable the Logparser plugin by default when using one-click install.
47
48
49 .. _Release Notes_lakelse_Testing Notes:
50
51 Testing Notes
52 -------------
53
54 .. docs/release/release-notes/notes/lakelse/collectd-5-v-6-testing-cc821b32bad2794c.yaml @ None
55
56 - Added a playbook to compare collectd 5 and collectd 6. The playbook uses
57   existing ansible roles to build both collectd 5 and collectd 6 container
58   images, creates a common configuration, then runs the containers and shows
59   the outputs to let the user inspect the metrics and whether they match.
60
61
62 .. _Release Notes_lakelse_Documentation Updates:
63
64 Documentation Updates
65 ---------------------
66
67 .. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None
68
69 - Docs have been updated to use anuket/ repository in dockerhub.
70   Container build instructions now use anuket/ prefix to tag images.
71
72
73 .. _Release Notes_lakelse_Container updates:
74
75 Container updates
76 -----------------
77
78 .. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None
79
80 - Containers are now pulled from anuket/ repository in dockerhub.
81
82 .. docs/release/release-notes/notes/lakelse/collectd-6-testing-flask-app-2bb0ca1326775dd8.yaml @ None
83
84 - Add a flask app for testing collectd using metrics sent via write_http plugin.
85
86 .. docs/release/release-notes/notes/lakelse/update-grafana-9bee82ecfa11f54a.yaml @ None
87
88 - Grafana container was updated to support both jiffies and percent for cpu metrics.
89
90
91 .. _Release Notes_lakelse_Ansible playbook updates:
92
93 Ansible playbook updates
94 ------------------------
95
96 .. docs/release/release-notes/notes/lakelse/add_unix_sock-e29efe16156c5c8e.yaml @ None
97
98 - Added `unixsock <https://collectd.org/documentation/manpages/collectd-unixsock.5.shtml>`_
99   plugin to one-click install, which allows the user to interact with collectd using the
100   ``collectdctl`` command in the bar-collectd-* containers.
101   The unixsock plugin is useful for debugging issues in collectd, and can
102   be used to verify that metrics are being collected without having to
103   create CSV files or log into the container.
104
105 .. docs/release/release-notes/notes/lakelse/ansible-build-containers-b4a4cc9cb70f83b3.yaml @ None
106
107 - Added a playbook and role for building the collectd containers locally.
108   This automates the actions described in the docker install guide. The
109   ``barometer-collectd``, ``barometer-collectd-latest`` and the
110   ``barometer-collectd-experimental`` containers are now easier to build
111   locally. The ``barometer-collectd-6`` and
112   ``barometer-collectd-experimental`` containers can also be built with
113   arbirtary PRs applied, to aid in testing locally.
114
115 .. docs/release/release-notes/notes/lakelse/anuket_containers-21b4206cb26c9975.yaml @ None
116
117 - Containers are now pulled from anuker/ repository in dockerhub.
118
119 .. docs/release/release-notes/notes/lakelse/update_logparser_config-0db3d2746e6ad582.yaml @ None
120
121 - The logparser plugin is now rendered for all flavours.
122   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.
123
124
125 .. _Release Notes_lakelse_Build script updates:
126
127 Build script updates
128 --------------------
129
130 .. docs/release/release-notes/notes/lakelse/update-apply-pr-script-46e6d547d331c5f2.yaml @ None
131
132 - 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.
133
134
135 .. _Release Notes_lakelse_Normal Bug Fixes:
136
137 Normal Bug Fixes
138 ----------------
139
140 .. docs/release/release-notes/notes/lakelse/update-grafana-9bee82ecfa11f54a.yaml @ None
141
142 - Update the grafana dashboard to show metrics in both jffies and percent, depending on what is configured.
143
144
145 .. _Release Notes_lakelse_Deprecations:
146
147 Deprecations
148 ------------
149
150 .. docs/release/release-notes/notes/lakelse/remove_dpdk_stats_events_plugins-59f366855f6e4261.yaml @ None
151
152 - The dpdkstats and dpdkevents plugins were removed from Barometer. These
153   plugins are still available in collectd, however, will not be deployed by
154   Barometer. It is recommended that the DPDK telemetry plugin be used instead.
155
156
157 .. _Release Notes_lakelse_Other Notes:
158
159 Other Notes
160 -----------
161
162 .. docs/release/release-notes/notes/lakelse/add-reno-12eb20e3448b663b.yaml @ None
163
164 - 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