Move default availability_zone docs into doc_fragment

If availability_zone is defined in the module this will override the fragment

Change-Id: I4f6abcbfee89a53480134dc64ca06782c8e6d094

plugins/doc_fragments/openstack.py

@@ -80,11 +80,15 @@ options:
     aliases: [ key ]
   interface:
     description:
-        - Endpoint URL type to fetch from the service catalog.
+      - Endpoint URL type to fetch from the service catalog.
     type: str
     choices: [ admin, internal, public ]
     default: public
     aliases: [ endpoint_type ]
+  availability_zone:
+    description:
+      - Ignored. Present for backwards compatibility
+    type: str
 requirements:
   - python >= 3.6
   - openstacksdk >= 0.12.0

plugins/modules/os_auth.py

@@ -19,11 +19,6 @@ description:
 requirements:
     - "python >= 3.6""
     - "openstacksdk"
-options:
-  availability_zone:
-    description:
-      - Ignored. Present for backwards compatibility
-    required: false
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_coe_cluster.py

@@ -17,9 +17,6 @@ author: "Feilong Wang (@flwang)"
 description:
    - Add or Remove COE cluster from the OpenStack Container Infra service.
 options:
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    cluster_template_id:
      description:
         - The template ID of cluster template.

plugins/modules/os_coe_cluster_template.py

@@ -18,9 +18,6 @@ description:
    - Add or Remove COE cluster template from the OpenStack Container Infra
      service.
 options:
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    coe:
      description:
         - The Container Orchestration Engine for this clustertemplate

plugins/modules/os_flavor_info.py

@@ -64,9 +64,6 @@ options:
          storage. Format is the same as the I(ram) parameter
      type: bool
      default: 'no'
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_floating_ip.py

@@ -69,9 +69,6 @@ options:
           IP completely, or only detach it from the server. Default is to detach only.
      type: bool
      default: 'no'
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements: ["openstacksdk"]
 
 extends_documentation_fragment:

plugins/modules/os_group.py

@@ -32,9 +32,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_group_info.py

@@ -34,10 +34,6 @@ options:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
      type: dict
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     type: str
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_image.py

@@ -75,9 +75,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    volume:
      description:
        - ID of a volume to create an image from.

plugins/modules/os_image_info.py

@@ -30,10 +30,6 @@ options:
         - Dict of properties of the images used for query
      type: dict
      required: false
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     required: false
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_ironic.py

@@ -112,10 +112,6 @@ options:
       type: bool
       default: 'no'
       aliases: [ skip_update_of_driver_password ]
-    availability_zone:
-      description:
-        - Ignored. Present for backwards compatibility
-
 requirements: ["openstacksdk", "jsonpatch"]
 
 extends_documentation_fragment:

plugins/modules/os_ironic_inspect.py

@@ -37,9 +37,6 @@ options:
       description:
         - A timeout in seconds to tell the role to wait for the node to complete introspection if wait is set to True.
       default: 1200
-    availability_zone:
-      description:
-        - Ignored. Present for backwards compatibility
 
 requirements: ["openstacksdk"]
 

plugins/modules/os_ironic_node.py

@@ -84,9 +84,6 @@ options:
       description:
         - An integer value representing the number of seconds to
           wait for the node activation or deactivation to complete.
-    availability_zone:
-      description:
-        - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_keypair.py

@@ -38,9 +38,6 @@ options:
         with the new content.
     choices: [present, absent, replace]
     default: present
-  availability_zone:
-    description:
-      - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_keystone_domain.py

@@ -37,9 +37,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_keystone_domain_info.py

@@ -28,9 +28,6 @@ options:
      description:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_keystone_role.py

@@ -27,10 +27,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_keystone_service.py

@@ -39,9 +39,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_listener.py

@@ -48,9 +48,6 @@ options:
         - The amount of time the module should wait for the load balancer to get
           into ACTIVE state.
      default: 180
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements: ["openstacksdk"]
 
 extends_documentation_fragment:

plugins/modules/os_loadbalancer.py

@@ -119,9 +119,6 @@ options:
     description:
       - The amount of time the module should wait.
     default: 180
-  availability_zone:
-    description:
-      - Ignored. Present for backwards compatibility
 requirements: ["openstacksdk"]
 
 extends_documentation_fragment:

plugins/modules/os_member.py

@@ -49,9 +49,6 @@ options:
         - The amount of time the module should wait for the load balancer to get
           into ACTIVE state.
      default: 180
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements: ["openstacksdk"]
 
 extends_documentation_fragment:

plugins/modules/os_network.py

@@ -57,9 +57,6 @@ options:
    project:
      description:
         - Project name or ID containing the network (name admin-only)
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    port_security_enabled:
      description:
         -  Whether port security is enabled on the network or not.

plugins/modules/os_networks_info.py

@@ -31,10 +31,6 @@ options:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
      required: false
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     required: false
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_nova_flavor.py

@@ -61,9 +61,6 @@ options:
         - ID for the flavor. This is optional as a unique UUID will be
           assigned if a value is not specified.
      default: "auto"
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    extra_specs:
      description:
         - Metadata dictionary

plugins/modules/os_object.py

@@ -42,10 +42,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     required: false
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_pool.py

@@ -53,9 +53,6 @@ options:
         - The amount of time the module should wait for the pool to get
           into ACTIVE state.
      default: 180
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements: ["openstacksdk"]
 
 extends_documentation_fragment:

plugins/modules/os_port.py

@@ -77,9 +77,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    vnic_type:
      description:
        - The type of the port that should be created

plugins/modules/os_port_info.py

@@ -30,9 +30,6 @@ options:
               of this dictionary will be matched against the returned port
               dictionaries. Matching is currently limited to strings within
               the port dictionary, or strings within nested dictionaries.
-    availability_zone:
-      description:
-        - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_project.py

@@ -41,9 +41,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_project_access.py

@@ -42,9 +42,6 @@ options:
   resource_name:
     description:
       - The resource name (eg. tiny).
-  availability_zone:
-    description:
-      - The availability zone of the resource.
 requirements:
     - "openstacksdk"
 

plugins/modules/os_project_info.py

@@ -32,9 +32,6 @@ options:
      description:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_quota.py

@@ -92,10 +92,6 @@ options:
         description: Number of volumes to allow.
     volumes_lvm:
         description: Number of LVM volumes to allow.
-    availability_zone:
-      description:
-        - Ignored. Present for backwards compatibility
-
 
 requirements:
     - "python >= 3.6""

plugins/modules/os_recordset.py

@@ -45,9 +45,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_router.py

@@ -62,9 +62,6 @@ options:
           User defined portip is often required when a multiple router need
           to be connected to a single subnet for which the default gateway has
           been already used.
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements: ["openstacksdk"]
 
 extends_documentation_fragment:

plugins/modules/os_security_group.py

@@ -35,9 +35,6 @@ options:
      description:
         - Unique name or ID of the project.
      required: false
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_security_group_rule.py

@@ -62,9 +62,6 @@ options:
      description:
         - Unique name or ID of the project.
      required: false
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements: ["openstacksdk"]
 
 extends_documentation_fragment:

plugins/modules/os_server_action.py

@@ -44,9 +44,6 @@ options:
    image:
      description:
        - Image the server should be rebuilt with
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_server_group.py

@@ -35,10 +35,6 @@ options:
           valid policy names are anti-affinity, affinity, soft-anti-affinity
           and soft-affinity.
      required: false
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_server_info.py

@@ -38,9 +38,6 @@ options:
      description:
         - restrict results to servers matching a dictionary of
           filters
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    all_projects:
      description:
        - Whether to list servers from all projects or just the current auth

plugins/modules/os_server_volume.py

@@ -35,9 +35,6 @@ options:
    device:
      description:
       - Device you want to attach. Defaults to auto finding a device name.
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_stack.py

@@ -51,9 +51,6 @@ options:
       description:
         - Maximum number of seconds to wait for the stack creation
       default: 3600
-    availability_zone:
-      description:
-        - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_subnet.py

@@ -85,9 +85,6 @@ options:
    project:
      description:
         - Project name or ID containing the subnet (name admin-only)
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    extra_specs:
      description:
         - Dictionary with extra key/value pairs passed to the API

plugins/modules/os_subnets_info.py

@@ -33,10 +33,6 @@ options:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
      required: false
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     required: false
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_user.py

@@ -55,9 +55,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_user_group.py

@@ -29,10 +29,6 @@ options:
        - Should the user be present or absent in the group
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_user_info.py

@@ -32,9 +32,6 @@ options:
      description:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 
 extends_documentation_fragment:
 - openstack.cloud.openstack

plugins/modules/os_user_role.py

@@ -43,9 +43,6 @@ options:
        - Should the roles be present or absent on the user.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"

plugins/modules/os_volume.py

@@ -50,9 +50,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
    scheduler_hints:
      description:
        - Scheduler hints passed to volume API in form of dict

plugins/modules/os_volume_snapshot.py

@@ -41,9 +41,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Availability zone in which to create the snapshot.
 requirements:
      - "python >= 3.6""
      - "openstacksdk"

plugins/modules/os_zone.py

@@ -43,9 +43,6 @@ options:
        - Should the resource be present or absent.
      choices: [present, absent]
      default: present
-   availability_zone:
-     description:
-       - Ignored. Present for backwards compatibility
 requirements:
     - "python >= 3.6""
     - "openstacksdk"