Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating known_hosts module Docs #58785

Merged
merged 1 commit into from Jul 11, 2019
Merged

Updating known_hosts module Docs #58785

merged 1 commit into from Jul 11, 2019

Conversation

kedark3
Copy link
Contributor

@kedark3 kedark3 commented Jul 5, 2019 •
edited

SUMMARY

When I came across this module for the first time I ran into errors as I could not understand from the docs that I need to mention hostname in key attribute and also use same in name/host attribute. Hence adding some clarity around the same.

ISSUE TYPE
  • Docs Pull Request

+label: docsite_pr

ISSUE TYPE

The issue was because of lack of clarity in the documentation I ran into following error Host parameter does not match hashed host field in supplied key

  • Docs Pull Request
COMPONENT NAME

known_hosts

ADDITIONAL INFORMATION

Run following:

known_hosts:
  key: host1.example.com ssh-rsa some-key-gibberish
  name: host1

Before it will fail as follows:

 "msg": "Host parameter does not match hashed host field in supplied key"

But after I got the clarity around how to use the module more appropriately, I was able to run the module with parameters like below:

known_hosts:
  key: host1.example.com ssh-rsa some-key-gibberish
  name: host1.example.com

Added an example as well.

@ansibot
Copy link
Contributor

ansibot commented Jul 5, 2019

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/system/known_hosts.py:40:1: W293 blank line contains whitespace

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Jul 5, 2019

cc @mcv21
click here for bot help

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 ci_verified Changes made in this PR are causing tests to fail. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. small_patch support:community This issue/PR relates to code supported by the Ansible community. system System category labels Jul 5, 2019
@Akasurde
Copy link
Member

Akasurde commented Jul 6, 2019

@kedark3 Thanks for the contribution. Could you please address #58785 (comment) ? Thanks.

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Jul 6, 2019
@kedark3
Copy link
Contributor Author

kedark3 commented Jul 6, 2019

@Akasurde thanks. Updated my PR.

@ansibot ansibot added community_review In order to be merged, this PR must follow the community review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 6, 2019
@kedark3
Updating known_hosts module Docs
3926082 
##### SUMMARY
When I came across this module for the first time I ran into errors as I could not understand from the docs that I need to mention hostname in key attribute and also use same in `name`/`host` attribute. Hence adding some clarity around the same.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
@kedark3
Copy link
Contributor Author

kedark3 commented Jul 11, 2019

@Akasurde Can you please review this? Do you have merge rights?

@samccann samccann merged commit 17c8872 into ansible:devel Jul 11, 2019
@samccann
Copy link
Contributor

Thanks @kedark3 for the Ansible documentation fix!

@ansible ansible locked and limited conversation to collaborators Aug 8, 2019
@dagwieers dagwieers added the docsite_pr This PR is created from documentation using the "Edit on GitHub" link. label Sep 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samccann samccann samccann approved these changes

@acozine acozine Awaiting requested review from acozine

Assignees
No one assigned
Labels
affects_2.9 This issue/PR affects Ansible v2.9 community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. docsite_pr This PR is created from documentation using the "Edit on GitHub" link. module This issue/PR relates to a module. new_contributor This PR is the first contribution by a new community member. support:community This issue/PR relates to code supported by the Ansible community. system System category
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@kedark3 @ansibot @Akasurde @samccann @dagwieers