Merge d032d13083 into d36a289deb

Docs/authorized_key: clarify that the path key should probably NOT be set

SUMMARY

Docs: Fixed unclearance in documentation connected wirh relative path
Added additional description in documentation.

ISSUE TYPE


Docs Pull Request

COMPONENT NAME

authorized_key.py
ADDITIONAL INFORMATION

Clarify the documentation unclearance in connected with relative path ~/.ssh/authorized_keys
The purpose of the pull request is to eliminate ambiguities in the documentation.
In our case, when using the ~ sign, we get the user's root directory (although we explicitly specify a different username)
Here is the issue and full picture of problem which we want to fix: LINK

Closese:  #483

Reviewed-by: Gonéri Le Bouder <goneri@lebouder.net>
Reviewed-by: atom4git
Reviewed-by: Hideki Saito <saito@fgrep.org>

changelogs/fragments/490_doc_authorized_key_path.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - "Bugfix in the documentation regarding the path option for authorised_key(https://github.com/ansible-collections/ansible.posix/issues/483)."

plugins/action/synchronize.py

@@ -77,7 +77,14 @@ class ActionModule(ActionBase):
 
         if self._host_is_ipv6_address(host):
             return '[%s%s]:%s' % (user_prefix, host, path)
-        return '%s%s:%s' % (user_prefix, host, path)
+
+        # preserve formatting of remote paths if host or user@host is explicitly defined in the path
+        if ':' not in path:
+            return '%s%s:%s' % (user_prefix, host, path)
+        elif '@' not in path:
+            return '%s%s' % (user_prefix, path)
+        else:
+            return path
 
     def _process_origin(self, host, path, user):
 

plugins/modules/authorized_key.py

@@ -28,8 +28,10 @@ options:
     required: true
   path:
     description:
-      - Alternate path to the authorized_keys file.
+      - Alternative path to the authorized_keys file.
-      - When unset, this value defaults to I(~/.ssh/authorized_keys).
+      - The default value is the C(.ssh/authorized_keys) of the home of the user specified in the O(user) parameter.
+      - Most of the time, it's not necessary to set this key.
+      - Use the path to your target authorized_keys if you need to explicitly point on it.
     type: path
   manage_dir:
     description: