From ef2d70a8066ddfd1ee3efe0384225b1f83a7dc20 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 10 Jun 2019 12:40:50 +0200 Subject: [PATCH] Rename ali_instance_facts -> ali_instance_info (#57036) * Rename ali_instance_facts -> ali_instance_info. * Add changelog. --- changelogs/fragments/57036-facts-info-rename.yaml | 2 ++ .../rst/porting_guides/porting_guide_2.9.rst | 1 + .../modules/cloud/alicloud/_ali_instance_facts.py | 1 + .../{ali_instance_facts.py => ali_instance_info.py} | 13 ++++++++----- 4 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 changelogs/fragments/57036-facts-info-rename.yaml create mode 120000 lib/ansible/modules/cloud/alicloud/_ali_instance_facts.py rename lib/ansible/modules/cloud/alicloud/{ali_instance_facts.py => ali_instance_info.py} (96%) diff --git a/changelogs/fragments/57036-facts-info-rename.yaml b/changelogs/fragments/57036-facts-info-rename.yaml new file mode 100644 index 00000000000..5891626244e --- /dev/null +++ b/changelogs/fragments/57036-facts-info-rename.yaml @@ -0,0 +1,2 @@ +minor_changes: +- The ``ali_instance_facts`` module has been renamed to ``ali_instance_info``. diff --git a/docs/docsite/rst/porting_guides/porting_guide_2.9.rst b/docs/docsite/rst/porting_guides/porting_guide_2.9.rst index b807ec4ba26..96f0c88c77c 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_2.9.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_2.9.rst @@ -78,6 +78,7 @@ Noteworthy module changes * The ``memset_memstore_facts`` module was renamed to :ref:`memset_memstore_info `. * The ``memset_server_facts`` module was renamed to :ref:`memset_server_info `. * The ``one_image_facts`` module was renamed to :ref:`one_image_info `. +* The ``ali_instance_facts`` module was renamed to :ref:`ali_instance_info `. * The ``azure_rm_resourcegroup_facts`` module was renamed to :ref:`azure_rm_resourcegroup_info `. * The ``digital_ocean_account_facts`` module was renamed to :ref:`digital_ocean_account_info `. * The ``digital_ocean_certificate_facts`` module was renamed to :ref:`digital_ocean_certificate_info `. diff --git a/lib/ansible/modules/cloud/alicloud/_ali_instance_facts.py b/lib/ansible/modules/cloud/alicloud/_ali_instance_facts.py new file mode 120000 index 00000000000..5202c554481 --- /dev/null +++ b/lib/ansible/modules/cloud/alicloud/_ali_instance_facts.py @@ -0,0 +1 @@ +ali_instance_info.py \ No newline at end of file diff --git a/lib/ansible/modules/cloud/alicloud/ali_instance_facts.py b/lib/ansible/modules/cloud/alicloud/ali_instance_info.py similarity index 96% rename from lib/ansible/modules/cloud/alicloud/ali_instance_facts.py rename to lib/ansible/modules/cloud/alicloud/ali_instance_info.py index 591ff887a61..886bf5e7155 100644 --- a/lib/ansible/modules/cloud/alicloud/ali_instance_facts.py +++ b/lib/ansible/modules/cloud/alicloud/ali_instance_info.py @@ -26,12 +26,13 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' --- -module: ali_instance_facts +module: ali_instance_info version_added: "2.8" -short_description: Gather facts on instances of Alibaba Cloud ECS. +short_description: Gather information on instances of Alibaba Cloud ECS. description: - This module fetches data from the Open API in Alicloud. The module must be called from within the ECS instance itself. + - This module was called C(ali_instance_facts) before Ansible 2.9. The usage did not change. options: availability_zone: @@ -71,14 +72,14 @@ EXAMPLES = ''' tasks: - name: Find all instances in the specified region - ali_instance_facts: + ali_instance_info: alicloud_access_key: '{{ alicloud_access_key }}' alicloud_secret_key: '{{ alicloud_secret_key }}' alicloud_region: '{{ alicloud_region }}' register: all_instances - name: Find all instances based on the specified ids - ali_instance_facts: + ali_instance_info: alicloud_access_key: '{{ alicloud_access_key }}' alicloud_secret_key: '{{ alicloud_secret_key }}' alicloud_region: '{{ alicloud_region }}' @@ -88,7 +89,7 @@ EXAMPLES = ''' register: instances_by_ids - name: Find all instances based on the specified names/name-prefixes - ali_instance_facts: + ali_instance_info: alicloud_access_key: '{{ alicloud_access_key }}' alicloud_secret_key: '{{ alicloud_secret_key }}' alicloud_region: '{{ alicloud_region }}' @@ -373,6 +374,8 @@ def main(): ) ) module = AnsibleModule(argument_spec=argument_spec) + if module._name == 'ali_instance_facts': + module.deprecate("The 'ali_instance_facts' module has been renamed to 'ali_instance_info'", version='2.13') if HAS_FOOTMARK is False: module.fail_json(msg=missing_required_lib('footmark'), exception=FOOTMARK_IMP_ERR)