Bug 1558423

Summary: [DOCS] The dynamic PV is a needed for deploying APB.
Product: OpenShift Container Platform Reporter: Jian Zhang <jiazha>
Component: DocumentationAssignee: Alex Dellapenta <adellape>
Status: CLOSED EOL QA Contact: Jian Zhang <jiazha>
Severity: medium Docs Contact: Vikram Goyal <vigoyal>
Priority: medium    
Version: 3.9.0CC: aos-bugs, chezhang, jmatthew, jokerman, mmccomas, zhsun
Target Milestone: ---   
Target Release: 3.9.0   
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-07 17:20:13 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 Jian Zhang 2018-03-20 08:25:02 UTC
Document URL: 
https://docs.openshift.com/container-platform/3.9/install_config/install/advanced_install.html

Section Number and Name: 
https://docs.openshift.com/container-platform/3.9/install_config/install/advanced_install.html#configuring-openshift-ansible-broker

Describe the issue: 
The APBs(production plan for DB) creating depends on the dynamic PV. 


Suggestions for improvement: 
We should clarify this point in documents.

Additional information:

Comment 1 Alex Dellapenta 2018-03-23 15:56:51 UTC
https://github.com/openshift/openshift-docs/pull/8367

Added this line:

----
The PV depends on
xref:../../install_config/persistent_storage/dynamically_provisioning_pvs.adoc#install-config-persistent-storage-dynamically-provisioning-pvs[dynamic
storage provisioning] having been configured for the cluster.
----

http://file.rdu.redhat.com/~adellape/032218/fix39installupgrade4/install_config/install/advanced_install.html#configuring-openshift-ansible-broker

Comment 2 John Matthews 2018-03-23 16:52:01 UTC
I disagree with this documentation change and do not feel it should be made.

The production plans of example database APBs do require a PV to fulfill the PVC they generate, yet the PV does __not__ have to be dynamic.  It is perfectly acceptable to precreate a number of PVs (as oc cluster up does) and run through tests with APB provisioning.

Dynamic PVs are nice and smooth experience, but I feel it is misleading to state they are an absolute requirement for these example APBs to function...since that is not true.



Original text of the below looks good to me as-is:

"Some Ansible playbook bundles (APBs) also require a PV for their own usage in order to deploy. For example, each of the database APBs have two plans: the Development plan uses ephermal storage and does not require a PV, while the Production plan is persisted and does require a PV."

Comment 3 Jian Zhang 2018-03-25 09:51:20 UTC
John,

Thanks, totally agree with you. But, is it better to clarify how to precreate the PV if we do not point out the dynamic PV in the docs? The Meidiawiki also need the PV after all.

Comment 4 Jian Zhang 2018-03-28 03:20:32 UTC
John,

Maybe we can provide an example of how to create a PV for the Mediawiki APB, what do you think?

Comment 5 Alex Dellapenta 2018-03-28 17:28:17 UTC
I undid the change described in comment 1 after comment 2 was made, and it was not merged, so I'm setting this from ON_QA back to ASSIGNED until current needinfo is settled.

Comment 6 John Matthews 2018-04-04 11:35:04 UTC
@Jian, in regard to creating the PV for an APB I think noting the size requirements would be helpful, we can then link to how to create a PV to existing docs...to be clear no specifics steps are required to the PV to work with the APBs, a regular PV of sufficient size is only requirement.

In addition, as I looked into this I realized we have some inconsistencies with expectations, the APBs do not let you specify the size and their requirements are different.

Below are the sizes required for the APB examples released in 3.9.0:

https://github.com/ansibleplaybookbundle/mysql-apb/blob/master/roles/rhscl-mysql-apb-openshift/defaults/main.yml#L6
  10Gi

https://github.com/ansibleplaybookbundle/mariadb-apb/blob/master/roles/rhscl-mariadb-apb-openshift/defaults/main.yml#L6
  10Gi

https://github.com/ansibleplaybookbundle/postgresql-apb/blob/master/roles/rhscl-postgresql-apb/defaults/main.yml#L3
  1Gi

https://github.com/ansibleplaybookbundle/mediawiki-apb/blob/master/roles/mediawiki/defaults/main.yml#L4
  1Gi


I filed a new BZ to be addressed in 3.10.0 to:
 - Make these sizes consistent of 1Gi
 - Allow the size to be changed as a parameter of the persisted plans
 
https://bugzilla.redhat.com/show_bug.cgi?id=1563641

Comment 7 Jian Zhang 2018-04-05 03:02:02 UTC
John,

Yes, thanks, aligning the size of pv is great. And, I take that bug 1563641.
And, adding the link which introduces how to create a PV for these APBs is so good. Thanks!

Comment 8 Alex Dellapenta 2021-04-07 17:20:13 UTC
Discussed with Eng team lead and agreed it was good to close at this point.