[PR #8627/ce65eb87 backport][stable-9] Type options of connection plugins (#8662)

Type options of connection plugins (#8627)

Type options of connection plugins.

(cherry picked from commit ce65eb8736)

Co-authored-by: Felix Fontein <felix@fontein.de>

changelogs/fragments/8627-connection-types.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - "chroot, funcd, incus, iocage, jail, lxc, lxd, qubes, zone connection plugins - make sure that all options are typed (https://github.com/ansible-collections/community.general/pull/8627)."

plugins/connection/chroot.py

@@ -20,6 +20,7 @@ DOCUMENTATION = '''
       remote_addr:
         description:
             - The path of the chroot you want to access.
+        type: string
         default: inventory_hostname
         vars:
             - name: inventory_hostname
@@ -27,6 +28,7 @@ DOCUMENTATION = '''
       executable:
         description:
             - User specified executable shell
+        type: string
         ini:
           - section: defaults
             key: executable
@@ -38,6 +40,7 @@ DOCUMENTATION = '''
       chroot_exe:
         description:
             - User specified chroot binary
+        type: string
         ini:
           - section: chroot_connection
             key: exe

plugins/connection/funcd.py

@@ -21,6 +21,7 @@ DOCUMENTATION = '''
       remote_addr:
         description:
             - The path of the chroot you want to access.
+        type: string
         default: inventory_hostname
         vars:
             - name: ansible_host

plugins/connection/incus.py

@@ -19,6 +19,7 @@ DOCUMENTATION = """
       remote_addr:
         description:
             - The instance identifier.
+        type: string
         default: inventory_hostname
         vars:
             - name: inventory_hostname
@@ -27,6 +28,7 @@ DOCUMENTATION = """
       executable:
         description:
             - The shell to use for execution inside the instance.
+        type: string
         default: /bin/sh
         vars:
             - name: ansible_executable
@@ -35,6 +37,7 @@ DOCUMENTATION = """
         description:
             - The name of the Incus remote to use (per C(incus remote list)).
             - Remotes are used to access multiple servers from a single client.
+        type: string
         default: local
         vars:
             - name: ansible_incus_remote
@@ -42,6 +45,7 @@ DOCUMENTATION = """
         description:
             - The name of the Incus project to use (per C(incus project list)).
             - Projects are used to divide the instances running on a server.
+        type: string
         default: default
         vars:
             - name: ansible_incus_project

plugins/connection/iocage.py

@@ -20,12 +20,14 @@ DOCUMENTATION = '''
       remote_addr:
         description:
             - Path to the jail
+        type: string
         vars:
             - name: ansible_host
             - name: ansible_iocage_host
       remote_user:
         description:
             - User to execute as inside the jail
+        type: string
         vars:
             - name: ansible_user
             - name: ansible_iocage_user

plugins/connection/jail.py

@@ -20,6 +20,7 @@ DOCUMENTATION = '''
       remote_addr:
         description:
             - Path to the jail
+        type: string
         default: inventory_hostname
         vars:
             - name: inventory_hostname
@@ -28,6 +29,7 @@ DOCUMENTATION = '''
       remote_user:
         description:
             - User to execute as inside the jail
+        type: string
         vars:
             - name: ansible_user
             - name: ansible_jail_user

plugins/connection/lxc.py

@@ -17,6 +17,7 @@ DOCUMENTATION = '''
       remote_addr:
         description:
             - Container identifier
+        type: string
         default: inventory_hostname
         vars:
             - name: inventory_hostname
@@ -26,6 +27,7 @@ DOCUMENTATION = '''
         default: /bin/sh
         description:
             - Shell executable
+        type: string
         vars:
             - name: ansible_executable
             - name: ansible_lxc_executable

plugins/connection/lxd.py

@@ -19,6 +19,7 @@ DOCUMENTATION = '''
             - Instance (container/VM) identifier.
             - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.))
               is used as the instance identifier.
+        type: string
         default: inventory_hostname
         vars:
             - name: inventory_hostname
@@ -27,6 +28,7 @@ DOCUMENTATION = '''
       executable:
         description:
             - Shell to use for execution inside instance.
+        type: string
         default: /bin/sh
         vars:
             - name: ansible_executable
@@ -34,6 +36,7 @@ DOCUMENTATION = '''
       remote:
         description:
             - Name of the LXD remote to use.
+        type: string
         default: local
         vars:
             - name: ansible_lxd_remote
@@ -41,6 +44,7 @@ DOCUMENTATION = '''
       project:
         description:
             - Name of the LXD project to use.
+        type: string
         vars:
             - name: ansible_lxd_project
         version_added: 2.0.0

plugins/connection/qubes.py

@@ -25,14 +25,16 @@ DOCUMENTATION = '''
     options:
       remote_addr:
         description:
-            - vm name
+            - VM name.
+        type: string
         default: inventory_hostname
         vars:
             - name: ansible_host
       remote_user:
         description:
-            - The user to execute as inside the vm.
+            - The user to execute as inside the VM.
-        default: The *user* account as default in Qubes OS.
+        type: string
+        default: The I(user) account as default in Qubes OS.
         vars:
             - name: ansible_user
 #        keyword:

plugins/connection/zone.py

@@ -16,11 +16,12 @@ DOCUMENTATION = '''
     name: zone
     short_description: Run tasks in a zone instance
     description:
-        - Run commands or put/fetch files to an existing zone
+        - Run commands or put/fetch files to an existing zone.
     options:
       remote_addr:
         description:
             - Zone identifier
+        type: string
         default: inventory_hostname
         vars:
             - name: ansible_host