Bug 2106362

Summary:	job:kube_pv:count documentation wrong
Product:	[Red Hat Storage] Red Hat OpenShift Container Storage	Reporter:	Chris Blum <cblum>
Component:	ocs-operator	Assignee:	Nobody <nobody>
Status:	NEW ---	QA Contact:
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	unspecified	CC:	anpicker, jfajersk, juzhao, sostapov
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:		Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Chris Blum 2022-07-12 13:06:56 UTC

Description of problem:
The documentation for the metric job:kube_pv:count is wrong. It only counts ODF PVs.

The metric is created by ODF here:
https://github.com/red-hat-storage/ocs-operator/blob/main/controllers/storagecluster/prometheus/localcephrules.yaml#L24-L26

I've already opened a Github issue about this a while ago... it has become rotten by now
https://github.com/openshift/cluster-monitoring-operator/issues/1586

Version-Release number of selected component (if applicable):
OCP & ODF 4 (has been that way for a while now)

How reproducible:
Always when reading metric documentation at https://github.com/openshift/cluster-monitoring-operator

Comment 1 Jan Fajerski 2022-07-12 14:00:13 UTC

Thanks for filing a BZ. The documentation is certainly incorrect, I would argue so is the metric/recording rule name.

A better name would indicate that the PVs are ceph based, e.g. job:kube_ceph_pv:count.

Assigning to the ODF team as they own this rule.

Comment 8 Junqi Zhao 2023-06-21 11:17:45 UTC

issue is fixed in 4.12, see: 
https://github.com/openshift/cluster-monitoring-operator/blob/release-4.12/manifests/0000_50_cluster-monitoring-operator_04-config.yaml#L343-L352

"job:kube_pv:count" is deprecated in ODF 4.12, does that also mean we could remove it since OCP 4.13?

Comment 9 Chris Blum 2023-06-21 11:21:34 UTC

I would vote to remove the old metric