Bug 1503260 - Jenkins Template Missing App Label to Display Properly in UI
Summary: Jenkins Template Missing App Label to Display Properly in UI
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Templates
Version: 3.6.1
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: 3.8.0
Assignee: Gabe Montero
QA Contact: XiuJuan Wang
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-10-17 16:45 UTC by Justin Holmes
Modified: 2018-03-28 14:08 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Cause: the example quickstart and jenkins templates did not group associated objects under the "app" label Consequence: if the templates were instantiated via oc process instead of oc new-app, the object grouping by label was not done, making tasks like later deletion of the template related objects more difficult, or the grouping display function in the webconsole would not work Fix: add the app label to the templates Result: grouping the user would expect exists when templates processed via oc process
Clone Of:
Environment:
Last Closed: 2018-03-28 14:08:09 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
expected (76.64 KB, image/png)
2017-10-17 16:45 UTC, Justin Holmes
no flags Details
actual (72.42 KB, image/png)
2017-10-17 16:45 UTC, Justin Holmes
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2018:0489 0 None None None 2018-03-28 14:08:33 UTC

Description Justin Holmes 2017-10-17 16:45:31 UTC
Created attachment 1339809 [details]
expected

Description of problem:

Jenkins DeploymentConfig in the templates are missing the label `app=jenkins`, which as of 3.6 is used to change the way the app is displayed in the web console
 
Version-Release number of selected component (if applicable):
OCP v3.6.173.0.21

Templates don't appear to have a version?

How reproducible:
100%

Steps to Reproduce:
1. apply the template
2. look at the web console
3. 

Actual results:


Expected results:
see expected attachment

Additional info:

Comment 1 Justin Holmes 2017-10-17 16:45:58 UTC
Created attachment 1339810 [details]
actual

Comment 2 Justin Holmes 2017-10-17 16:47:16 UTC
added attachments for expected vs actual screenshots

Comment 3 Ben Parees 2017-10-17 20:50:42 UTC
the app label is not the responsibility of the template, the oc new-app command and web console will add it to all resources in a template, when provisioning a template.

How did you instantiate the template?

Comment 4 Justin Holmes 2017-10-17 21:01:22 UTC
Ansible automation that calls `oc process | oc apply`. We'll look to update that automation if you do not believe this information should be kept in the template itself.

Thanks Ben.

Comment 5 Ben Parees 2017-10-17 21:14:03 UTC
Let me discuss it w/ Sam Padgett.  Historically that label has been something that was applied by the tooling, but it's possible it would make sense to just hardcode it into the templates so that provisoning via oc process will still get the label (and also the template service broker which likely does not apply the app label today).

I'm not sure if we want to codify that label into our templates or not.

Comment 6 Justin Holmes 2017-10-20 19:05:58 UTC
Ben anything further here? We need to make a decision on our side whether to add this to our automation

Comment 7 Ben Parees 2017-10-20 19:45:31 UTC
we're going to add the label, but it's not my top priority.  you're welcome to submit a PR.

Comment 8 Justin Holmes 2017-10-21 17:31:51 UTC
I'll take you up on that offer. What is the proper location to make a PR? I see:

https://github.com/openshift/openshift-ansible/tree/master/roles/openshift_examples/files/examples

and

https://github.com/openshift/origin/blob/master/examples/jenkins

Comment 9 Ben Parees 2017-10-21 19:50:04 UTC
the ones you need to change are in:
https://github.com/openshift/origin/blob/master/examples/jenkins

but you'll also need to run hack/update-generated-bindata.sh in origin when you change the files.

(the ansible repo will pick up from the origin repo)

Comment 10 Ben Parees 2017-11-06 23:32:14 UTC
low hanging fruit for you, gabe.

Comment 11 Justin Holmes 2017-11-07 15:39:30 UTC
Ben / Gabe:

I'm starting to realize this is bigger than just Jenkins. All the out of the box templates need to be able to set the app label. 

Another example:

PostgreSQL being used for an app. It's nice to group them in the UI, so that an app and its DB are presented together. Right now, this isn't possible. How would you like this bigger item tracked?

Comment 12 Gabe Montero 2017-11-07 16:23:41 UTC
I can update the other templates in https://github.com/openshift/origin/blob/master/examples/quickstarts and db-templates

Note, the analogous location in the openshift ansible repo has dotnet repos.  I suspect that comes from the scl team.  If so, I think Justin needs to work with them to get that updated.

Also, the cfme and xpaas templates are managed by those respective teams as well.  I would similarly propose Justin would need to work with them as well.

Thoughts?

Comment 13 Gabe Montero 2017-11-07 18:46:56 UTC
PR https://github.com/openshift/origin/pull/17224 has been opened to address this bug

currently PR only targeted to origin/master; advise if addition targets needed

Comment 14 Gabe Montero 2017-11-07 18:48:05 UTC
Ben, I think you may have been off cc: and were not initially advised of comments 11 and 12

Comment 15 Gabe Montero 2017-11-09 15:20:31 UTC
The PR from #Comment 13 has merged and per discussion with Ben we are simply targeting to 3.8.

Per process marking this OCP bug modified

Comment 16 Gabe Montero 2017-11-09 15:21:19 UTC
Ben - do you think this bug requires a doc update ?

Comment 17 Ben Parees 2017-11-09 15:23:41 UTC
if you mean doc text in the bug, yes.  if you mean product docs, no.

Comment 18 Gabe Montero 2017-11-09 15:25:05 UTC
Meant the former, thanks.

Comment 19 Samuel Padgett 2017-11-27 18:05:33 UTC
I am good with the changes that have merged. Thanks Gabe and Ben.

(Commenting to clear the need info flag.)

Comment 21 XiuJuan Wang 2018-01-15 08:41:21 UTC
The updates take effect on openshift cluster v3.9.0-0.19.0
Can't reproduce this bug

Comment 24 errata-xmlrpc 2018-03-28 14:08:09 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2018:0489


Note You need to log in before you can comment on or make changes to this bug.