Bug 1848738

Summary:	remove pvc name from example prometheus storage config
Product:	OpenShift Container Platform	Reporter:	Paul Gier <pgier>
Component:	Documentation	Assignee:	Paul Needle <pneedle>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Junqi Zhao <juzhao>
Severity:	low	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	low
Version:	4.5	CC:	aos-bugs, jokerman, juzhao
Target Milestone:	---
Target Release:	4.5.z
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:	2021-04-29 15:24:52 UTC	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 Paul Gier 2020-06-18 20:46:50 UTC

Document URL: 
https://docs.openshift.com/container-platform/4.4/monitoring/cluster_monitoring/configuring-the-monitoring-stack.html#configuring-a-local-persistent-volume-claim_configuring-monitoring


Section Number and Name: 
Monitoring -> Configuring the Monitoring Stack -> Configuring a local persistent volume claim

Describe the issue: 
The example configuration sets a custom name for the PVC instead of using the default.  This setting is unnecessary and due to a bug (https://bugzilla.redhat.com/show_bug.cgi?id=1832124) in the way prometheus operator handles metadata this setting can cause problems during upgrades between certain versions.

Suggestions for improvement: 
Remove the volumeClaimTemplate.metadata.name field from the example.

      volumeClaimTemplate:
        metadata:
          name: localpvc


Additional information:

Comment 1 Junqi Zhao 2020-06-19 03:32:29 UTC

@Paul

I don't it is a good solution, two reasons:
1. since the bug is fixed in 4.4.9 and higher version, only exists in 4.4.0-4.4.8, if we want to change the 4.4 doc, there are also other parts should be changed, example, step 2 of 4.4 doc
**************************
      volumeClaimTemplate:
        metadata:
          name: <PVC_name_prefix>


4.4 doc: https://docs.openshift.com/container-platform/4.4/monitoring/cluster_monitoring/configuring-the-monitoring-stack.html#configuring-a-local-persistent-volume-claim_configuring-monitoring

2. for consistency, we should also change 4.1/4.2/4.3 doc, otherwise if customer configured the volumeClaimTemplate.metadata.name in these versions and upgrade to [4.4.0,4.4.8], they still would meet the issue

4.1 doc: https://docs.openshift.com/container-platform/4.3/monitoring/cluster_monitoring/configuring-the-monitoring-stack.html#configuring-a-local-persistent-volume-claim_configuring-monitoring
4.2 doc:https://docs.openshift.com/container-platform/4.2/monitoring/cluster_monitoring/configuring-the-monitoring-stack.html#configuring-a-local-persistent-volume-claim_configuring-monitoring
4.3 doc: https://docs.openshift.com/container-platform/4.1/monitoring/cluster_monitoring/configuring-the-monitoring-stack.html#configuring-a-local-persistent-volume-claim_configuring-monitoring

I should keep the doc unchanged, and advise customer upgrade to 4.4.9 and higher version. WDYT?

Comment 2 Paul Gier 2020-06-19 12:51:42 UTC

@Junqi I get your point, but I'd prefer that we remove it for all versions since it's not necessary.  And it should be a very uncommon use case that a customer would want/need to use a name other than the default.

Comment 3 Junqi Zhao 2020-06-22 02:34:29 UTC

(In reply to Paul Gier from comment #2)
> @Junqi I get your point, but I'd prefer that we remove it for all versions
> since it's not necessary.  And it should be a very uncommon use case that a
> customer would want/need to use a name other than the default.

Thanks,it makes sense, then we should update 4.4 doc first, then update 4.1 - 4.3 docs

Comment 4 Paul Needle 2021-04-28 16:42:47 UTC

Pull request: https://github.com/openshift/openshift-docs/pull/32016.

The PR applies to branch/enterprise-4.5 only, because the volume claim template name has been removed from the examples in the equivalent section for 4.6 onward already.

Comment 6 Paul Needle 2021-04-29 15:24:52 UTC

Updated content is now available in the following:

https://docs.openshift.com/container-platform/4.5/monitoring/cluster_monitoring/configuring-the-monitoring-stack.html#configuring-a-local-persistent-volume-claim_configuring-monitoring