From 2496fd35fb4b1b03f21d1fcc8f7095dc5f9ebfb8 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Thu, 5 Jul 2018 13:01:16 -0400 Subject: [PATCH] added required missing field for common yaml fmt --- lib/ansible/plugins/inventory/aws_ec2.py | 4 ++++ lib/ansible/plugins/inventory/constructed.py | 5 +++++ lib/ansible/plugins/inventory/gcp_compute.py | 4 ++++ lib/ansible/plugins/inventory/generator.py | 4 ++++ lib/ansible/plugins/inventory/k8s.py | 4 ++++ lib/ansible/plugins/inventory/nmap.py | 4 ++++ lib/ansible/plugins/inventory/openshift.py | 4 ++++ lib/ansible/plugins/inventory/openstack.py | 4 ++++ lib/ansible/plugins/inventory/scaleway.py | 4 ++++ lib/ansible/plugins/inventory/virtualbox.py | 4 ++++ 10 files changed, 41 insertions(+) diff --git a/lib/ansible/plugins/inventory/aws_ec2.py b/lib/ansible/plugins/inventory/aws_ec2.py index 48c7a4a0db..3ac5321c42 100644 --- a/lib/ansible/plugins/inventory/aws_ec2.py +++ b/lib/ansible/plugins/inventory/aws_ec2.py @@ -15,6 +15,10 @@ DOCUMENTATION = ''' - Get inventory hosts from Amazon Web Services EC2. - Uses a .aws_ec2.yaml (or .aws_ec2.yml) YAML configuration file. options: + plugin: + description: token that ensures this is a source file for the 'aws_ec2' plugin. + required: True + choices: ['aws_ec2'] boto_profile: description: The boto profile to use. env: diff --git a/lib/ansible/plugins/inventory/constructed.py b/lib/ansible/plugins/inventory/constructed.py index 39b9f37ba3..8bb367f01c 100644 --- a/lib/ansible/plugins/inventory/constructed.py +++ b/lib/ansible/plugins/inventory/constructed.py @@ -15,6 +15,11 @@ DOCUMENTATION = ''' - The JInja2 exprpessions are calculated and assigned to the variables - Only variables already available from previous inventories or the fact cache can be used for templating. - When I(strict) is False, failed expressions will be ignored (assumes vars were missing). + options: + plugin: + description: token that ensures this is a source file for the 'constructed' plugin. + required: True + choices: ['constructed'] extends_documentation_fragment: - constructed ''' diff --git a/lib/ansible/plugins/inventory/gcp_compute.py b/lib/ansible/plugins/inventory/gcp_compute.py index 7396c5f5c0..af18bcf897 100644 --- a/lib/ansible/plugins/inventory/gcp_compute.py +++ b/lib/ansible/plugins/inventory/gcp_compute.py @@ -18,6 +18,10 @@ DOCUMENTATION = ''' - Get inventory hosts from Google Cloud Platform GCE. - Uses a .gcp.yaml (or .gcp.yml) YAML configuration file. options: + plugin: + description: token that ensures this is a source file for the 'gcp_compute' plugin. + required: True + choices: ['gcp_compute'] zones: description: A list of regions in which to describe GCE instances. default: all zones available to a given project diff --git a/lib/ansible/plugins/inventory/generator.py b/lib/ansible/plugins/inventory/generator.py index cea9bc3866..ff28b4e83b 100644 --- a/lib/ansible/plugins/inventory/generator.py +++ b/lib/ansible/plugins/inventory/generator.py @@ -15,6 +15,10 @@ DOCUMENTATION = ''' - Every element of every layer is combined to create a host for every layer combination - Parent groups can be defined with reference to hosts and other groups using the same template variables options: + plugin: + description: token that ensures this is a source file for the 'generator' plugin. + required: True + choices: ['generator'] hosts: description: - The C(name) key is a template used to generate diff --git a/lib/ansible/plugins/inventory/k8s.py b/lib/ansible/plugins/inventory/k8s.py index 9ce2c4c2a1..b24dcbe0d0 100644 --- a/lib/ansible/plugins/inventory/k8s.py +++ b/lib/ansible/plugins/inventory/k8s.py @@ -19,6 +19,10 @@ DOCUMENTATION = ''' - Uses k8s.(yml|yaml) YAML configuration file to set parameter values. options: + plugin: + description: token that ensures this is a source file for the 'k8s' plugin. + required: True + choices: ['k8s'] connections: description: - Optional list of cluster connection settings. If no connections are provided, the default diff --git a/lib/ansible/plugins/inventory/nmap.py b/lib/ansible/plugins/inventory/nmap.py index 4f0fb8be92..cca044ad02 100644 --- a/lib/ansible/plugins/inventory/nmap.py +++ b/lib/ansible/plugins/inventory/nmap.py @@ -17,6 +17,10 @@ DOCUMENTATION = ''' requirements: - nmap CLI installed options: + plugin: + description: token that ensures this is a source file for the 'nmap' plugin. + required: True + choices: ['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 diff --git a/lib/ansible/plugins/inventory/openshift.py b/lib/ansible/plugins/inventory/openshift.py index 6b1dabe5b8..7dd6396688 100644 --- a/lib/ansible/plugins/inventory/openshift.py +++ b/lib/ansible/plugins/inventory/openshift.py @@ -19,6 +19,10 @@ DOCUMENTATION = ''' - Uses openshift.(yml|yaml) YAML configuration file to set parameter values. options: + plugin: + description: token that ensures this is a source file for the 'openshift' plugin. + required: True + choices: ['openshift'] connections: description: - Optional list of cluster connection settings. If no connections are provided, the default diff --git a/lib/ansible/plugins/inventory/openstack.py b/lib/ansible/plugins/inventory/openstack.py index 086af9b092..027bf1dd94 100644 --- a/lib/ansible/plugins/inventory/openstack.py +++ b/lib/ansible/plugins/inventory/openstack.py @@ -20,6 +20,10 @@ DOCUMENTATION = ''' - Uses openstack.(yml|yaml) YAML configuration file to configure the inventory plugin - Uses standard clouds.yaml YAML configuration file to configure cloud credentials options: + plugin: + description: token that ensures this is a source file for the 'openstack' plugin. + required: True + choices: ['openstack'] show_all: description: toggles showing all vms vs only those with a working IP type: bool diff --git a/lib/ansible/plugins/inventory/scaleway.py b/lib/ansible/plugins/inventory/scaleway.py index 3c8c051bb1..c2be621b2e 100644 --- a/lib/ansible/plugins/inventory/scaleway.py +++ b/lib/ansible/plugins/inventory/scaleway.py @@ -14,6 +14,10 @@ DOCUMENTATION = ''' description: - Get inventory hosts from Scaleway options: + plugin: + description: token that ensures this is a source file for the 'scaleway' plugin. + required: True + choices: ['scaleway'] regions: description: Filter results on a specific Scaleway region type: list diff --git a/lib/ansible/plugins/inventory/virtualbox.py b/lib/ansible/plugins/inventory/virtualbox.py index 07bc61e74a..15425f1697 100644 --- a/lib/ansible/plugins/inventory/virtualbox.py +++ b/lib/ansible/plugins/inventory/virtualbox.py @@ -16,6 +16,10 @@ DOCUMENTATION = ''' - constructed - inventory_cache options: + plugin: + description: token that ensures this is a source file for the 'virtualbox' plugin + required: True + choices: ['virtualbox'] running_only: description: toggles showing all vms vs only those currently running type: boolean