Project

Profile

Help

Issue #2808

Clarify use of `pulp-consumer`

Added by kdelee@redhat.com over 3 years ago. Updated 6 months ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
Estimated time:
Severity:
1. Low
Version:
Platform Release:
2.14.0
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix, Pulp 2
Sprint:
Quarter:

Description

Documentation could be clearer about use of pulp-consumer. While reading the Quick Start Guide[0] it was not clear that pulp-consumer must be run as root.

This fact is mentioned under the user-guide/consumer-client page of the docs[1], but other parts of the docs vacillate between using:

$ sudo pulp-consumer ...

or just plain

$ pulp-consumer

To make it clear, perhaps use:

# pulp-consumer ...

or preface every invocation shown in examples with

$ sudo pulp-consumer ....

[0] http://docs.pulpproject.org/plugins/pulp_rpm/user-guide/quick-start.html
[1] http://docs.pulpproject.org/user-guide/consumer-client/register.html#pre-registration-authentication

Associated revisions

Revision 33a8dc65 View on GitHub
Added by kdelee@redhat.com over 3 years ago

pulp-consumer sometimes needs be run as root

Add notes to user-guide/nodes for users who may have skipped the consumer-client documentation.

closes #2808 https://pulp.plan.io/issues/2808

History

#1 Updated by kdelee@redhat.com over 3 years ago

  • Copied from Task #2790: Add documentation about PR builder added

#2 Updated by kdelee@redhat.com over 3 years ago

Just found the note that the `#` symbol should be avoided [0], so I suppose that leaves the `$ sudo pulp-consumer ...` option

[0] http://docs.pulpproject.org/en/2.12/dev-guide/contributing/documenting.html#command-line-user-guide

#3 Updated by bmbouter over 3 years ago

  • Description updated (diff)

I think the user only need sudo for some actions with pulp-consumerwhich is part of the confusion. I recommend adding a "Sphinx note" saying that if you get a permission denied to try it with sudo as general advice and have all command disinclude sudo in the examples.

I also rewrote the description a bit with more formatting.

#4 Updated by bmbouter over 3 years ago

  • Copied from deleted (Task #2790: Add documentation about PR builder)

#5 Updated by ttereshc over 3 years ago

  • Status changed from NEW to POST
  • Assignee set to kdelee@redhat.com

#6 Updated by kdelee@redhat.com over 3 years ago

I updated my PR to only add a couple notes to pages that lacked any notification that users may need root permissions.

https://github.com/pulp/pulp/pull/3053

#7 Updated by ttereshc over 3 years ago

  • Triaged changed from No to Yes

#8 Updated by kdelee@redhat.com over 3 years ago

  • Status changed from POST to MODIFIED

#9 Updated by pcreech over 3 years ago

  • Platform Release set to 2.14.0

#10 Updated by pcreech over 3 years ago

  • Status changed from MODIFIED to 5

#11 Updated by pcreech over 3 years ago

  • Status changed from 5 to CLOSED - CURRENTRELEASE

#12 Updated by bmbouter almost 2 years ago

  • Tags Pulp 2 added

#13 Updated by bmbouter 8 months ago

  • Category deleted (23)

Please register to edit this issue

Also available in: Atom PDF