mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
added required missing field for common yaml fmt
This commit is contained in:
parent
50905b980d
commit
2496fd35fb
10 changed files with 41 additions and 0 deletions
|
@ -15,6 +15,10 @@ DOCUMENTATION = '''
|
||||||
- Get inventory hosts from Amazon Web Services EC2.
|
- Get inventory hosts from Amazon Web Services EC2.
|
||||||
- Uses a <name>.aws_ec2.yaml (or <name>.aws_ec2.yml) YAML configuration file.
|
- Uses a <name>.aws_ec2.yaml (or <name>.aws_ec2.yml) YAML configuration file.
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'aws_ec2' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['aws_ec2']
|
||||||
boto_profile:
|
boto_profile:
|
||||||
description: The boto profile to use.
|
description: The boto profile to use.
|
||||||
env:
|
env:
|
||||||
|
|
|
@ -15,6 +15,11 @@ DOCUMENTATION = '''
|
||||||
- The JInja2 exprpessions are calculated and assigned to the variables
|
- 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.
|
- 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).
|
- 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:
|
extends_documentation_fragment:
|
||||||
- constructed
|
- constructed
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -18,6 +18,10 @@ DOCUMENTATION = '''
|
||||||
- Get inventory hosts from Google Cloud Platform GCE.
|
- Get inventory hosts from Google Cloud Platform GCE.
|
||||||
- Uses a <name>.gcp.yaml (or <name>.gcp.yml) YAML configuration file.
|
- Uses a <name>.gcp.yaml (or <name>.gcp.yml) YAML configuration file.
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'gcp_compute' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['gcp_compute']
|
||||||
zones:
|
zones:
|
||||||
description: A list of regions in which to describe GCE instances.
|
description: A list of regions in which to describe GCE instances.
|
||||||
default: all zones available to a given project
|
default: all zones available to a given project
|
||||||
|
|
|
@ -15,6 +15,10 @@ DOCUMENTATION = '''
|
||||||
- Every element of every layer is combined to create a host for every layer combination
|
- 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
|
- Parent groups can be defined with reference to hosts and other groups using the same template variables
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'generator' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['generator']
|
||||||
hosts:
|
hosts:
|
||||||
description:
|
description:
|
||||||
- The C(name) key is a template used to generate
|
- The C(name) key is a template used to generate
|
||||||
|
|
|
@ -19,6 +19,10 @@ DOCUMENTATION = '''
|
||||||
- Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
|
- Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
|
||||||
|
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'k8s' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['k8s']
|
||||||
connections:
|
connections:
|
||||||
description:
|
description:
|
||||||
- Optional list of cluster connection settings. If no connections are provided, the default
|
- Optional list of cluster connection settings. If no connections are provided, the default
|
||||||
|
|
|
@ -17,6 +17,10 @@ DOCUMENTATION = '''
|
||||||
requirements:
|
requirements:
|
||||||
- nmap CLI installed
|
- nmap CLI installed
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'nmap' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['nmap']
|
||||||
address:
|
address:
|
||||||
description: Network IP or range of IPs to scan, you can use a simple range (10.2.2.15-25) or CIDR notation.
|
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
|
required: True
|
||||||
|
|
|
@ -19,6 +19,10 @@ DOCUMENTATION = '''
|
||||||
- Uses openshift.(yml|yaml) YAML configuration file to set parameter values.
|
- Uses openshift.(yml|yaml) YAML configuration file to set parameter values.
|
||||||
|
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'openshift' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['openshift']
|
||||||
connections:
|
connections:
|
||||||
description:
|
description:
|
||||||
- Optional list of cluster connection settings. If no connections are provided, the default
|
- Optional list of cluster connection settings. If no connections are provided, the default
|
||||||
|
|
|
@ -20,6 +20,10 @@ DOCUMENTATION = '''
|
||||||
- Uses openstack.(yml|yaml) YAML configuration file to configure the inventory plugin
|
- Uses openstack.(yml|yaml) YAML configuration file to configure the inventory plugin
|
||||||
- Uses standard clouds.yaml YAML configuration file to configure cloud credentials
|
- Uses standard clouds.yaml YAML configuration file to configure cloud credentials
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'openstack' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['openstack']
|
||||||
show_all:
|
show_all:
|
||||||
description: toggles showing all vms vs only those with a working IP
|
description: toggles showing all vms vs only those with a working IP
|
||||||
type: bool
|
type: bool
|
||||||
|
|
|
@ -14,6 +14,10 @@ DOCUMENTATION = '''
|
||||||
description:
|
description:
|
||||||
- Get inventory hosts from Scaleway
|
- Get inventory hosts from Scaleway
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'scaleway' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['scaleway']
|
||||||
regions:
|
regions:
|
||||||
description: Filter results on a specific Scaleway region
|
description: Filter results on a specific Scaleway region
|
||||||
type: list
|
type: list
|
||||||
|
|
|
@ -16,6 +16,10 @@ DOCUMENTATION = '''
|
||||||
- constructed
|
- constructed
|
||||||
- inventory_cache
|
- inventory_cache
|
||||||
options:
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'virtualbox' plugin
|
||||||
|
required: True
|
||||||
|
choices: ['virtualbox']
|
||||||
running_only:
|
running_only:
|
||||||
description: toggles showing all vms vs only those currently running
|
description: toggles showing all vms vs only those currently running
|
||||||
type: boolean
|
type: boolean
|
||||||
|
|
Loading…
Reference in a new issue