Project

Profile

Help

Story #8434

Pulp users don't understand app labels in the status api/cli

Added by daviddavis about 2 months ago. Updated about 2 months ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Sprint:
Quarter:

Description

It's kind of confusing and perhaps nonobvious what the components in the status api mean. Suppose for example you have a package/plugin called pulp_foo that has app labels bar and baz. Users may not understand what bar and baz come from or what they mean.

I think this may have contributed to this user's confusion: https://github.com/pulp/pulp-cli/issues/184

History

#1 Updated by daviddavis about 2 months ago

One possible solution is to show the package name with the app label:

{                                                                                                                                                                                             
  "versions": [                                                                                                                                                                               
    {                                                                                                                                                                                         
      "component": "core", 
      "package": "pulpcore",                                                                                                                                                                   
      "version": "3.12.0.dev"                                                                                                                                                                 
    },                                                                                                                                                                                        
    {                                                                                                                                                                                         
      "component": "bar",
      "package": "pulp_foo",
      "version": "5.6.0.dev"
    },
...

#2 Updated by ttereshc about 2 months ago

  • Tracker changed from Issue to Story
  • % Done set to 0
  • Severity deleted (2. Medium)
  • Triaged deleted (No)

#3 Updated by bmbouter about 2 months ago

I'm reading that it would be helpful for the status API to list the actual python package providing the Django app name. That makes sense to me. That field could be added whereby the plugin provides that data explicitly.

Is there any concern about a django app being packaged multiple times? I don't think that would happen par-se, but if it did, the repackager would have to modify the code during packaging. I think that's ok tho, but I wanted to share it here.

#4 Updated by daviddavis about 2 months ago

I'm reading that it would be helpful for the status API to list the actual python package providing the Django app name. That makes sense to me. That field could be added whereby the plugin provides that data explicitly.

That sounds great.

Is there any concern about a django app being packaged multiple times? I don't think that would happen par-se, but if it did, the repackager would have to modify the code during packaging. I think that's ok tho, but I wanted to share it here.

Hmm, I can't think of a case where a django app would be shipped in two different packages. It seems theoretically but perhaps not practically possible. Then again, I am not super familiar with django app stuff.

Please register to edit this issue

Also available in: Atom PDF