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.

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

Remove additional references to smart connections #1340

Merged
merged 1 commit into from
May 2, 2024

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Apr 25, 2024

Follows up on #1042 and #1258 by removing additional references to the smart connection type in the example uptime script and FAQ.

@oraNod oraNod added backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.14 Automatically create a backport for the stable-2.14 branch backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch labels Apr 25, 2024
@oraNod oraNod requested review from gotmax23 and samccann April 25, 2024 11:37
@dilyanpalauzov
Copy link

I think the one change is not valid, as it refers to scp_if_ssh = smart - https://docs.ansible.com/ansible/latest/collections/ansible/builtin/ssh_connection.html#parameter-scp_if_ssh . The last hyperlink does not say that smart is invalid option. It says that scp_if_ssh is a removed parameter in version 2.17. So the correct fix would be to remove the references to ANSIBLE_SCP_IF_SSH and scp_if_ssh.

Also at https://docs.ansible.com/ansible/latest/collections/ansible/builtin/ssh_connection.html#parameter-scp_if_ssh : This setting will overridden by ssh_transfer_method if set. - be is missing.

@oraNod oraNod force-pushed the cleanup-smart-scripts branch from c1d7628 to b3e077d Compare April 25, 2024 13:34
@oraNod
Copy link
Contributor Author

oraNod commented Apr 25, 2024

I think the one change is not valid, as it refers to scp_if_ssh = smart - https://docs.ansible.com/ansible/latest/collections/ansible/builtin/ssh_connection.html#parameter-scp_if_ssh . The last hyperlink does not say that smart is invalid option. It says that scp_if_ssh is a removed parameter in version 2.17. So the correct fix would be to remove the references to ANSIBLE_SCP_IF_SSH and scp_if_ssh.

Also at https://docs.ansible.com/ansible/latest/collections/ansible/builtin/ssh_connection.html#parameter-scp_if_ssh : This setting will overridden by ssh_transfer_method if set. - be is missing.

@dilyanpalauzov Thanks for pointing that out! I should have looked there myself tbh. I've removed that commit from this PR and will open a separate issue for the removed parameter in 2.17 so we don't lose track of it. That typo in the module docs needs to be fixed in ansible/ansible, not in this repo, if you'd like to point that out in another issue.

@dilyanpalauzov
Copy link

This setting will overridden by ssh_transfer_method if set., with missing be, and scp_if_ssh in its whole was removed by ansible/ansible#81715ansible/ansible#82072 . So the documentation about scp_if_ssh is currently at https://docs.ansible.com/ansible/latest/collections/ansible/builtin/ssh_connection.html#parameter-scp_if_ssh , and in the ansible-documentation repository, but not in the ansible/ansible repository.

@oraNod
Copy link
Contributor Author

oraNod commented Apr 29, 2024

Those docs on docs.ansible.com are generated from Python docstrings. The missing be is here: https://github.com/ansible/ansible/blob/691ee745e072f38ee4ba695b5526f66447a7910f/lib/ansible/plugins/connection/ssh.py#L331 which looks like it has been updated on the devel branch.

@samccann samccann merged commit e16dbd3 into ansible:devel May 2, 2024
8 checks passed
Copy link

patchback bot commented May 2, 2024

Backport to stable-2.15: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.15/e16dbd39a56a837f72f870540af073ca06af71a0/pr-1340

Backported as #1395

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link

patchback bot commented May 2, 2024

Backport to stable-2.14: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.14/e16dbd39a56a837f72f870540af073ca06af71a0/pr-1340

Backported as #1396

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link

patchback bot commented May 2, 2024

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/e16dbd39a56a837f72f870540af073ca06af71a0/pr-1340

Backported as #1397

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link

patchback bot commented May 2, 2024

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/e16dbd39a56a837f72f870540af073ca06af71a0/pr-1340

Backported as #1398

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

samccann pushed a commit that referenced this pull request May 2, 2024
samccann pushed a commit that referenced this pull request May 6, 2024
samccann pushed a commit that referenced this pull request May 6, 2024
samccann pushed a commit that referenced this pull request May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.14 Automatically create a backport for the stable-2.14 branch backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants