Fix plugins (names, constants, FQCNs in examples) (#722)

* cobbler inventory: fix NAME * oc transport: fix transport name * Inventory plugins: fix plugin identifications * Use FQCN in lookup plugin examples. * Use FQCN in callback plugins. * Add changelog fragment. * Adjust documentation. * Fix lookup plugin linting errors. * Fix quotes.
2026-05-07 22:02:50 +00:00 · 2020-08-08 22:04:34 +02:00
parent 0951833a6c
commit ea21341686
40 changed files with 183 additions and 137 deletions
--- a/plugins/inventory/cobbler.py
+++ b/plugins/inventory/cobbler.py
@@ -17,9 +17,9 @@ DOCUMENTATION = '''
        - inventory_cache
    options:
      plugin:
-        description: The name of this plugin, it should always be set to C(cobbler) for this plugin to recognize it as it's own.
+        description: The name of this plugin, it should always be set to C(community.general.cobbler) for this plugin to recognize it as it's own.
        required: yes
-        choices: ['cobbler']
+        choices: [ 'cobbler', 'community.general.cobbler' ]
      url:
        description: URL to cobbler.
        default: 'http://cobbler/cobbler_api'
@@ -92,7 +92,7 @@ except ImportError:
 class InventoryModule(BaseInventoryPlugin, Cacheable):
    ''' Host inventory parser for ansible using cobbler as source. '''

-    NAME = 'cobbler'
+    NAME = 'community.general.cobbler'

    def __init__(self):

--- a/plugins/inventory/docker_machine.py
+++ b/plugins/inventory/docker_machine.py
@@ -24,7 +24,7 @@ DOCUMENTATION = '''
        plugin:
            description: token that ensures this is a source file for the C(docker_machine) plugin.
            required: yes
-            choices: ['docker_machine']
+            choices: ['docker_machine', 'community.general.docker_machine']
        daemon_env:
            description:
                - Whether docker daemon connection environment variables should be fetched, and how to behave if they cannot be fetched.
@@ -54,7 +54,7 @@ DOCUMENTATION = '''

 EXAMPLES = '''
 # Minimal example
-plugin: docker_machine
+plugin: community.general.docker_machine

 # Example using constructed features to create a group per Docker Machine driver
 # (https://docs.docker.com/machine/drivers/), e.g.:
--- a/plugins/inventory/docker_swarm.py
+++ b/plugins/inventory/docker_swarm.py
@@ -26,11 +26,11 @@ DOCUMENTATION = '''
          I(nonleaders) - all nodes except the swarm leader."
    options:
        plugin:
-            description: The name of this plugin, it should always be set to C(docker_swarm) for this plugin to
-                         recognize it as it's own.
+            description: The name of this plugin, it should always be set to C(community.general.docker_swarm)
+                         for this plugin to recognize it as it's own.
            type: str
            required: true
-            choices: docker_swarm
+            choices: [ docker_swarm, community.general.docker_swarm ]
        docker_host:
            description:
                - Socket of a Docker swarm manager node (C(tcp), C(unix)).
@@ -101,20 +101,20 @@ DOCUMENTATION = '''

 EXAMPLES = '''
 # Minimal example using local docker
-plugin: docker_swarm
+plugin: community.general.docker_swarm
 docker_host: unix://var/run/docker.sock

 # Minimal example using remote docker
-plugin: docker_swarm
+plugin: community.general.docker_swarm
 docker_host: tcp://my-docker-host:2375

 # Example using remote docker with unverified TLS
-plugin: docker_swarm
+plugin: community.general.docker_swarm
 docker_host: tcp://my-docker-host:2376
 tls: yes

 # Example using remote docker with verified TLS and client certificate verification
-plugin: docker_swarm
+plugin: community.general.docker_swarm
 docker_host: tcp://my-docker-host:2376
 validate_certs: yes
 ca_cert: /somewhere/ca.pem
@@ -122,7 +122,7 @@ client_key: /somewhere/key.pem
 client_cert: /somewhere/cert.pem

 # Example using constructed features to create groups and set ansible_host
-plugin: docker_swarm
+plugin: community.general.docker_swarm
 docker_host: tcp://my-docker-host:2375
 strict: False
 keyed_groups:
--- a/plugins/inventory/gitlab_runners.py
+++ b/plugins/inventory/gitlab_runners.py
@@ -28,6 +28,7 @@ DOCUMENTATION = '''
            required: true
            choices:
              - gitlab_runners
+              - community.general.gitlab_runners
        server_url:
            description: The URL of the GitLab server, with protocol (i.e. http or https).
            env:
@@ -60,11 +61,11 @@ DOCUMENTATION = '''

 EXAMPLES = '''
 # gitlab_runners.yml
-plugin: gitlab_runners
+plugin: community.general.gitlab_runners
 host: https://gitlab.com

 # Example using constructed features to create groups and set ansible_host
-plugin: gitlab_runners
+plugin: community.general.gitlab_runners
 host: https://gitlab.com
 strict: False
 keyed_groups:
--- a/plugins/inventory/kubevirt.py
+++ b/plugins/inventory/kubevirt.py
@@ -24,7 +24,7 @@ DOCUMENTATION = '''
      plugin:
        description: token that ensures this is a source file for the 'kubevirt' plugin.
        required: True
-        choices: ['kubevirt']
+        choices: ['kubevirt', 'community.general.kubevirt']
        type: str
      host_format:
        description:
@@ -123,7 +123,7 @@ EXAMPLES = '''
 # File must be named kubevirt.yaml or kubevirt.yml

 # Authenticate with token, and return all virtual machines for all namespaces
-plugin: kubevirt
+plugin: community.general.kubevirt
 connections:
 - host: https://kubevirt.io
   token: xxxxxxxxxxxxxxxx
@@ -131,7 +131,7 @@ connections:

 # Use default config (~/.kube/config) file and active context, and return vms with interfaces
 # connected to network myovsnetwork and from namespace vms
-plugin: kubevirt
+plugin: community.general.kubevirt
 connections:
  - namespaces:
      - vms
--- a/plugins/inventory/linode.py
+++ b/plugins/inventory/linode.py
@@ -22,7 +22,7 @@ DOCUMENTATION = r'''
        plugin:
            description: marks this as an instance of the 'linode' plugin
            required: true
-            choices: ['linode']
+            choices: ['linode', 'community.general.linode']
        access_token:
            description: The Linode account personal access token.
            required: true
@@ -42,10 +42,10 @@ DOCUMENTATION = r'''

 EXAMPLES = r'''
 # Minimal example. `LINODE_ACCESS_TOKEN` is exposed in environment.
-plugin: linode
+plugin: community.general.linode

 # Example with regions, types, groups and access token
-plugin: linode
+plugin: community.general.linode
 access_token: foobar
 regions:
  - eu-west
--- a/plugins/inventory/nmap.py
+++ b/plugins/inventory/nmap.py
@@ -19,7 +19,7 @@ DOCUMENTATION = '''
        plugin:
            description: token that ensures this is a source file for the 'nmap' plugin.
            required: True
-            choices: ['nmap']
+            choices: ['nmap', 'community.general.nmap']
        address:
            description: Network IP or range of IPs to scan, you can use a simple range (10.2.2.15-25) or CIDR notation.
            required: True
@@ -43,10 +43,10 @@ DOCUMENTATION = '''
        - 'TODO: add OS fingerprinting'
 '''
 EXAMPLES = '''
-    # inventory.config file in YAML format
-    plugin: nmap
-    strict: False
-    address: 192.168.0.0/24
+# inventory.config file in YAML format
+plugin: community.general.nmap
+strict: False
+address: 192.168.0.0/24
 '''

 import os
--- a/plugins/inventory/online.py
+++ b/plugins/inventory/online.py
@@ -18,7 +18,7 @@ DOCUMENTATION = '''
        plugin:
            description: token that ensures this is a source file for the 'online' plugin.
            required: True
-            choices: ['online']
+            choices: ['online', 'community.general.online']
        oauth_token:
            required: True
            description: Online OAuth token.
@@ -49,7 +49,7 @@ EXAMPLES = '''
 # online_inventory.yml file in YAML format
 # Example command line: ansible-inventory --list -i online_inventory.yml

-plugin: online
+plugin: community.general.online
 hostnames:
  - public_ipv4
 groups:
--- a/plugins/inventory/scaleway.py
+++ b/plugins/inventory/scaleway.py
@@ -17,7 +17,7 @@ DOCUMENTATION = '''
        plugin:
            description: token that ensures this is a source file for the 'scaleway' plugin.
            required: True
-            choices: ['scaleway']
+            choices: ['scaleway', 'community.general.scaleway']
        regions:
            description: Filter results on a specific Scaleway region
            type: list
@@ -60,7 +60,7 @@ EXAMPLES = '''

 # use hostname as inventory_hostname
 # use the private IP address to connect to the host
-plugin: scaleway
+plugin: community.general.scaleway
 regions:
  - ams1
  - par1
@@ -73,7 +73,7 @@ variables:
  state: state

 # use hostname as inventory_hostname and public IP address to connect to the host
-plugin: scaleway
+plugin: community.general.scaleway
 hostnames:
  - hostname
 regions:
--- a/plugins/inventory/virtualbox.py
+++ b/plugins/inventory/virtualbox.py
@@ -19,7 +19,7 @@ DOCUMENTATION = '''
        plugin:
            description: token that ensures this is a source file for the 'virtualbox' plugin
            required: True
-            choices: ['virtualbox']
+            choices: ['virtualbox', 'community.general.virtualbox']
        running_only:
            description: toggles showing all vms vs only those currently running
            type: boolean
@@ -38,7 +38,7 @@ DOCUMENTATION = '''
 EXAMPLES = '''
 # file must be named vbox.yaml or vbox.yml
 simple_config_file:
-    plugin: virtualbox
+    plugin: community.general.virtualbox
    settings_password_file: /etc/virtulbox/secrets
    query:
      logged_in_users: /VirtualBox/GuestInfo/OS/LoggedInUsersList
@@ -46,7 +46,7 @@ simple_config_file:
      ansible_connection: ('indows' in vbox_Guest_OS)|ternary('winrm', 'ssh')

 # add hosts (all match with minishift vm) to the group container if any of the vms are in ansible_inventory'
-plugin: virtualbox
+plugin: community.general.virtualbox
 groups:
  container: "'minis' in (inventory_hostname)"
 '''