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

Synchronize: Document the private_key option #32754

Merged
merged 1 commit into from
Nov 9, 2017
Merged

Synchronize: Document the private_key option #32754

merged 1 commit into from
Nov 9, 2017

Conversation

towolf
Copy link
Contributor

@towolf towolf commented Nov 9, 2017

synchronize has supported the private_key option for a long time,
apparently. But for some reason it was never documented.

Today I managed to workaround the synchronize quoting bug by just using

private_key: /path/to/id_rsa

instead of

rsync_opts:
  - "--rsh 'ssh -i /path/to/id_rsa'"

So, I'll just go ahead and document this useful option ...

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

synchronize

ANSIBLE VERSION
ansible 2.5.0 (synchronize_document_private_key_option 71e93039c8) last updated 2017/11/09 18:13:49 (GMT +200)
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/towolf/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/towolf/src/local/github/ansible/lib/ansible
  executable location = /home/towolf/src/local/github/ansible/bin/ansible
  python version = 2.7.14 (default, Sep 23 2017, 22:06:14) [GCC 7.2.0]

@towolf
Synchronize: Document the private_key option
71e9303 
`synchronize` has supported the `private_key` option for a long time,
apparently. But for some reason it was never documented.

Today I managed to workaround the synchronize quoting bug by just using

```
private_key: /path/to/id_rsa
```

instead of

```
rsync_opts:
  - "--rsh 'ssh -i /path/to/id_rsa'"
```

So, I'll just go ahead and document this useful option ...
@ansibot
Copy link
Contributor

ansibot commented Nov 9, 2017

cc @tima
click here for bot help

@ansibot ansibot added affects_2.5 This issue/PR affects Ansible v2.5 core_review In order to be merged, this PR must follow the core review workflow. docs_pull_request module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Nov 9, 2017
@ansibot
Copy link
Contributor

ansibot commented Nov 9, 2017

The test ansible-test sanity --test validate-modules [?] failed with the following error:

lib/ansible/modules/files/synchronize.py:0:0: E309 version_added for new option (private_key) should be 2.5. Currently 1.6

click here for bot help

@ansibot ansibot added 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. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Nov 9, 2017
@samdoran samdoran removed the needs_triage Needs a first human triage before being processed. label Nov 9, 2017
@samdoran samdoran merged commit bed7887 into ansible:devel Nov 9, 2017
@towolf towolf deleted the synchronize_document_private_key_option branch November 10, 2017 07:32
@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_pull_request labels Mar 4, 2018
@ansible ansible locked and limited conversation to collaborators Apr 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
affects_2.5 This issue/PR affects Ansible v2.5 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. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@towolf @ansibot @samdoran