Bug 1416242
Summary: | Example of storing Hammer CLI credentials specifies the wrong path | ||
---|---|---|---|
Product: | Red Hat Satellite | Reporter: | Russell Dickenson <rdickens> |
Component: | Docs Hammer CLI Guide | Assignee: | Zac Dover <zdover> |
Status: | CLOSED CURRENTRELEASE | QA Contact: | Charles Wood <chwood> |
Severity: | medium | Docs Contact: | |
Priority: | medium | ||
Version: | 6.2.2 | CC: | adahms, swadeley |
Target Milestone: | Unspecified | ||
Target Release: | Unused | ||
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: | 2017-02-08 03:40:02 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
Russell Dickenson
2017-01-25 03:06:23 UTC
Stephen, I set this BZ ticket NEEDINFO for you as I'd appreciate validation of this BZ ticket's description. Am I right in specifying the "Suggestions for improvement"? Hello Russell I agree the prompt should be $ as all the commands in the guide are, correctly, as non-root user. But also need to fix this bit: For example, if you plan to issue hammer commands as root, issue: (there is actually no point in that command as those would be the default perms for root). The whole procedure is a bit backwards, telling you to change the perms before creating and closing the file. How about: Step 1: Create the file `~/.hammer/cli_config.yml` and add the following contents to the file: ~~~ :foreman: :host: 'https://satellite.example.com/' :username: 'username' :password: 'password' ~~~ Replace the example values with your own details. Do not use tabs in the file, always use indentation by spaces. Step 2: To protect your password, make sure the file is only readable by the current user: ~~~ $ chmod 600 ~/.hammer/cli_config.yml ~~~ Step 3: Save and close the file. Now when you start hammer it will use the credentials in the ~/.hammer/cli_config.yml file. Important Do not use tabs in Hammer configuration files. Always use indentation by spaces. HTH Assigning to Zac for review. Stephen, Thanks for your feedback, especially confirmation that this is an issue. I think your suggested reworked version of the content looks good. I have only one suggested change, and that is to change the order of the admonition about spacing. Instead of opening with "Do not...", I think it reads better to open with "Use *only* spaces for indentation...". This content is now live on the Customer Portal. Closing. |