@@ -172,8 +172,8 @@ information appropiate to your cloud and re-deploy.
172172
173173Friendly Network Names
174174=======================
175- For operators that prefer to see descriptive or friendly interface names the
176- following play can be run. This takes network names as defined in kayobe and
175+ For operators that prefer to see descriptive or friendly interface names the
176+ following play can be run. This takes network names as defined in kayobe and
177177relabels the devices/interfaces in Prometheus to make use of these names.
178178
179179**Check considerations and known limitations to see if this is suitable in any
@@ -189,38 +189,40 @@ To enable the change:
189189 kayobe playbook run etc/kayobe/ansible/prometheus-network-names.yml
190190 kayobe overcloud service reconfigure --kt prometheus
191191
192- This first generates a template based on the prometheus.yml.j2
192+ This first generates a template based on the prometheus.yml.j2
193193``etc/kayobe/ansible/ `` and which is further templated for use with
194194kolla-ansible.
195195This is then rolled out via service reconfigure.
196196
197197
198- This helps Prometheus provide insights that can be more easily understood by
198+ This helps Prometheus provide insights that can be more easily understood by
199199those without an intimate understanding of a given site. Prometheus Node
200200Exporter and cAdvisor both provide network statistics using the
201201interface/device names. This play causes Prometheus to relabel these fields to
202- human readable names based on the networks as defined in kayobe
202+ human readable names based on the networks as defined in kayobe
203203 e.g. bond1.1838 may become storage_network.
204204
205- The default labels are preserved with the prefix ``original_ ``.
205+ The default labels are preserved with the prefix ``original_ ``.
206206
207- * For node_exporter, ``device `` is then used for network names, while
207+ * For node_exporter, ``device `` is then used for network names, while
208208 ``original_device `` is used for the interface itself.
209- * For cAdvisor, ``interface `` is used for network names, and
209+ * For cAdvisor, ``interface `` is used for network names, and
210210 ``original_interface `` is used to preserve the interface name.
211211
212212:Known-Limitations/Considerations/Requirements:
213213
214- Before enabling this feature, the implications must be discussed with the
214+ Before enabling this feature, the implications must be discussed with the
215215customer. The following are key considerations for that conversation:
216216
217217* Only network names defined within kayobe are within scope.
218218* Tenant network interfaces, including SR-IOV are not considered or modified.
219- * In the case of bonded interfaces, only the bond itself is relablled.
220- The bond members are displayed with their standard naming.
219+ * Only the interface directly attributed to a network will be relabelled.
220+ This may be a bond, a vlan tagged sub-interface, or both.
221+ The parent bond, or bond members are not relabelled unless they are
222+ captured within a distinct defined network.
221223* Modified entries will be within existing labels. This may be breaking for
222224 anything that expects the original structure, including custom dashboards,
223- alerting, billing, etc.
225+ alerting, billing, etc.
224226* After applying, there will be inconsistency in the time-series db for the
225227 duration of the retention period i.e until previously ingested entries
226228 expire.
0 commit comments