From 70b62ed7453efc286bb912e888dd59643d39e40e Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Thu, 26 Dec 2024 09:16:10 +1300 Subject: [PATCH] s[a-c]*: normalize docs (#9353) * s[a-c]*: normalize docs * Apply suggestions from code review Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein --- plugins/modules/say.py | 17 ++- plugins/modules/scaleway_compute.py | 53 ++++---- .../scaleway_compute_private_network.py | 31 ++--- plugins/modules/scaleway_container.py | 18 +-- plugins/modules/scaleway_container_info.py | 13 +- .../modules/scaleway_container_namespace.py | 15 +-- .../scaleway_container_namespace_info.py | 15 +-- .../modules/scaleway_container_registry.py | 13 +- .../scaleway_container_registry_info.py | 13 +- plugins/modules/scaleway_database_backup.py | 125 +++++++++--------- plugins/modules/scaleway_function.py | 20 +-- plugins/modules/scaleway_function_info.py | 15 +-- .../modules/scaleway_function_namespace.py | 15 +-- .../scaleway_function_namespace_info.py | 15 +-- plugins/modules/scaleway_image_info.py | 16 +-- plugins/modules/scaleway_ip.py | 38 +++--- plugins/modules/scaleway_ip_info.py | 16 +-- plugins/modules/scaleway_lb.py | 28 ++-- plugins/modules/scaleway_organization_info.py | 15 +-- plugins/modules/scaleway_private_network.py | 29 ++-- plugins/modules/scaleway_security_group.py | 25 ++-- .../modules/scaleway_security_group_info.py | 17 +-- .../modules/scaleway_security_group_rule.py | 37 +++--- plugins/modules/scaleway_server_info.py | 16 +-- plugins/modules/scaleway_snapshot_info.py | 16 +-- plugins/modules/scaleway_sshkey.py | 23 ++-- plugins/modules/scaleway_user_data.py | 29 ++-- plugins/modules/scaleway_volume.py | 19 ++- plugins/modules/scaleway_volume_info.py | 16 +-- 29 files changed, 336 insertions(+), 382 deletions(-) diff --git a/plugins/modules/say.py b/plugins/modules/say.py index 175e5feb0b..2dc359083d 100644 --- a/plugins/modules/say.py +++ b/plugins/modules/say.py @@ -9,12 +9,11 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: say short_description: Makes a computer to speak description: - - makes a computer speak! Amuse your friends, annoy your coworkers! + - Makes a computer speak! Amuse your friends, annoy your coworkers! notes: - In 2.5, this module has been renamed from C(osx_say) to M(community.general.say). - If you like this module, you may also be interested in the osx_say callback plugin. @@ -37,19 +36,19 @@ options: description: - What voice to use. required: false -requirements: [ say or espeak or espeak-ng ] +requirements: [say or espeak or espeak-ng] author: - - "Ansible Core Team" - - "Michael DeHaan (@mpdehaan)" -''' + - "Ansible Core Team" + - "Michael DeHaan (@mpdehaan)" +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Makes a computer to speak community.general.say: msg: '{{ inventory_hostname }} is all done' voice: Zarvox delegate_to: localhost -''' +""" import platform from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/scaleway_compute.py b/plugins/modules/scaleway_compute.py index d8480c199d..c61030bede 100644 --- a/plugins/modules/scaleway_compute.py +++ b/plugins/modules/scaleway_compute.py @@ -13,16 +13,15 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_compute short_description: Scaleway compute management module author: Remy Leone (@remyleone) description: - - "This module manages compute instances on Scaleway." + - This module manages compute instances on Scaleway. extends_documentation_fragment: - - community.general.scaleway - - community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -35,35 +34,33 @@ options: public_ip: type: str description: - - Manage public IP on a Scaleway server - - Could be Scaleway IP address UUID - - V(dynamic) Means that IP is destroyed at the same time the host is destroyed - - V(absent) Means no public IP at all + - Manage public IP on a Scaleway server. + - Could be Scaleway IP address UUID. + - V(dynamic) Means that IP is destroyed at the same time the host is destroyed. + - V(absent) Means no public IP at all. default: absent enable_ipv6: description: - - Enable public IPv6 connectivity on the instance + - Enable public IPv6 connectivity on the instance. default: false type: bool image: type: str description: - - Image identifier used to start the instance with + - Image identifier used to start the instance with. required: true name: type: str description: - - Name of the instance - + - Name of the instance. organization: type: str description: - Organization identifier. - Exactly one of O(project) and O(organization) must be specified. - project: type: str description: @@ -74,7 +71,7 @@ options: state: type: str description: - - Indicate desired state of the instance. + - Indicate desired state of the instance. default: present choices: - present @@ -87,14 +84,14 @@ options: type: list elements: str description: - - List of tags to apply to the instance (5 max) + - List of tags to apply to the instance (5 max). required: false default: [] region: type: str description: - - Scaleway compute zone + - Scaleway compute zone. required: true choices: - ams1 @@ -109,38 +106,38 @@ options: commercial_type: type: str description: - - Commercial name of the compute node + - Commercial name of the compute node. required: true wait: description: - - Wait for the instance to reach its desired state before returning. + - Wait for the instance to reach its desired state before returning. type: bool default: false wait_timeout: type: int description: - - Time to wait for the server to reach the expected state + - Time to wait for the server to reach the expected state. required: false default: 300 wait_sleep_time: type: int description: - - Time to wait before every attempt to check the state of the server + - Time to wait before every attempt to check the state of the server. required: false default: 3 security_group: type: str description: - - Security group unique identifier - - If no value provided, the default security group or current security group will be used + - Security group unique identifier. + - If no value provided, the default security group or current security group will be used. required: false -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a server community.general.scaleway_compute: name: foobar @@ -174,10 +171,10 @@ EXAMPLES = ''' project: 951df375-e094-4d26-97c1-ba548eeb9c42 region: ams1 commercial_type: VC1S -''' +""" -RETURN = ''' -''' +RETURN = r""" +""" import datetime import time diff --git a/plugins/modules/scaleway_compute_private_network.py b/plugins/modules/scaleway_compute_private_network.py index b41720be58..5339dfef15 100644 --- a/plugins/modules/scaleway_compute_private_network.py +++ b/plugins/modules/scaleway_compute_private_network.py @@ -11,18 +11,16 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_compute_private_network short_description: Scaleway compute - private network management version_added: 5.2.0 author: Pascal MANGIN (@pastral) description: - - This module add or remove a private network to a compute instance - (U(https://developer.scaleway.com)). + - This module add or remove a private network to a compute instance (U(https://developer.scaleway.com)). extends_documentation_fragment: - - community.general.scaleway - - community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -34,7 +32,7 @@ options: state: type: str description: - - Indicate desired state of the VPC. + - Indicate desired state of the VPC. default: present choices: - present @@ -49,7 +47,7 @@ options: region: type: str description: - - Scaleway region to use (for example V(par1)). + - Scaleway region to use (for example V(par1)). required: true choices: - ams1 @@ -64,18 +62,17 @@ options: compute_id: type: str description: - - ID of the compute instance (see M(community.general.scaleway_compute)). + - ID of the compute instance (see M(community.general.scaleway_compute)). required: true private_network_id: type: str description: - - ID of the private network (see M(community.general.scaleway_private_network)). + - ID of the private network (see M(community.general.scaleway_private_network)). required: true +""" -''' - -EXAMPLES = ''' +EXAMPLES = r""" - name: Plug a VM to a private network community.general.scaleway_compute_private_network: project: '{{ scw_project }}' @@ -92,10 +89,9 @@ EXAMPLES = ''' region: par1 compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89" private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89" +""" -''' - -RETURN = ''' +RETURN = r""" scaleway_compute_private_network: description: Information on the VPC. returned: success when O(state=present) @@ -117,7 +113,8 @@ scaleway_compute_private_network: "updated_at": "2022-01-15T11:12:04.624837Z", "zone": "fr-par-2" } -''' +""" + from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/scaleway_container.py b/plugins/modules/scaleway_container.py index a18cb1d75f..5cdd12da5d 100644 --- a/plugins/modules/scaleway_container.py +++ b/plugins/modules/scaleway_container.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_container short_description: Scaleway Container management version_added: 6.0.0 @@ -109,7 +108,8 @@ options: privacy: description: - Privacy policies define whether a container can be executed anonymously. - - Choose V(public) to enable anonymous execution, or V(private) to protect your container with an authentication mechanism provided by the Scaleway API. + - Choose V(public) to enable anonymous execution, or V(private) to protect your container with an authentication mechanism provided by the + Scaleway API. type: str default: public choices: @@ -147,9 +147,9 @@ options: - Redeploy the container if update is required. type: bool default: false -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a container community.general.scaleway_container: namespace_id: '{{ scw_container_namespace }}' @@ -169,9 +169,9 @@ EXAMPLES = ''' state: absent region: fr-par name: my-awesome-container -''' +""" -RETURN = ''' +RETURN = r""" container: description: The container information. returned: when O(state=present) @@ -181,7 +181,7 @@ container: description: Container used for testing scaleway_container ansible module domain_name: cnansibletestgfogtjod-cn-ansible-test.functions.fnc.fr-par.scw.cloud environment_variables: - MY_VAR: my_value + MY_VAR: my_value error_message: null http_option: "" id: c9070eb0-d7a4-48dd-9af3-4fb139890721 @@ -201,7 +201,7 @@ container: value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: created timeout: 300s -''' +""" from copy import deepcopy diff --git a/plugins/modules/scaleway_container_info.py b/plugins/modules/scaleway_container_info.py index 350c96e545..28cf40ac50 100644 --- a/plugins/modules/scaleway_container_info.py +++ b/plugins/modules/scaleway_container_info.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_container_info short_description: Retrieve information on Scaleway Container version_added: 6.0.0 @@ -46,18 +45,18 @@ options: description: - Name of the container. required: true -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Get a container info community.general.scaleway_container_info: namespace_id: '{{ scw_container_namespace }}' region: fr-par name: my-awesome-container register: container_info_task -''' +""" -RETURN = ''' +RETURN = r""" container: description: The container information. returned: always @@ -87,7 +86,7 @@ container: value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: created timeout: 300s -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway, diff --git a/plugins/modules/scaleway_container_namespace.py b/plugins/modules/scaleway_container_namespace.py index 0f5de6c31d..802a491321 100644 --- a/plugins/modules/scaleway_container_namespace.py +++ b/plugins/modules/scaleway_container_namespace.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_container_namespace short_description: Scaleway Container namespace management version_added: 6.0.0 @@ -24,7 +23,7 @@ extends_documentation_fragment: - community.general.scaleway_waitable_resource - community.general.attributes requirements: - - passlib[argon2] >= 1.7.4 + - passlib[argon2] >= 1.7.4 attributes: check_mode: @@ -84,9 +83,9 @@ options: - Injected in containers at runtime. type: dict default: {} -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a container namespace community.general.scaleway_container_namespace: project_id: '{{ scw_project }}' @@ -105,9 +104,9 @@ EXAMPLES = ''' state: absent region: fr-par name: my-awesome-container-namespace -''' +""" -RETURN = ''' +RETURN = r""" container_namespace: description: The container namespace information. returned: when O(state=present) @@ -128,7 +127,7 @@ container_namespace: - key: MY_SECRET_VAR value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: pending -''' +""" from copy import deepcopy diff --git a/plugins/modules/scaleway_container_namespace_info.py b/plugins/modules/scaleway_container_namespace_info.py index d783747203..d1e7196871 100644 --- a/plugins/modules/scaleway_container_namespace_info.py +++ b/plugins/modules/scaleway_container_namespace_info.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_container_namespace_info short_description: Retrieve information on Scaleway Container namespace version_added: 6.0.0 @@ -46,18 +45,18 @@ options: description: - Name of the container namespace. required: true -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Get a container namespace info community.general.scaleway_container_namespace_info: project_id: '{{ scw_project }}' region: fr-par name: my-awesome-container-namespace register: container_namespace_info_task -''' +""" -RETURN = ''' +RETURN = r""" container_namespace: description: The container namespace information. returned: always @@ -66,7 +65,7 @@ container_namespace: description: "" environment_variables: MY_VAR: my_value - error_message: null + error_message: id: 531a1fd7-98d2-4a74-ad77-d398324304b8 name: my-awesome-container-namespace organization_id: e04e3bdc-015c-4514-afde-9389e9be24b0 @@ -78,7 +77,7 @@ container_namespace: - key: MY_SECRET_VAR value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: pending -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway, diff --git a/plugins/modules/scaleway_container_registry.py b/plugins/modules/scaleway_container_registry.py index 4f17fecad7..132dfe8bb6 100644 --- a/plugins/modules/scaleway_container_registry.py +++ b/plugins/modules/scaleway_container_registry.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_container_registry short_description: Scaleway Container registry management module version_added: 5.8.0 @@ -77,9 +76,9 @@ options: - public - private default: private -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a container registry community.general.scaleway_container_registry: project_id: '{{ scw_project }}' @@ -94,9 +93,9 @@ EXAMPLES = ''' state: absent region: fr-par name: my-awesome-container-registry -''' +""" -RETURN = ''' +RETURN = r""" container_registry: description: The container registry information. returned: when O(state=present) @@ -116,7 +115,7 @@ container_registry: status: ready status_message: "" updated_at: "2022-10-14T09:51:07.949716Z" -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway, diff --git a/plugins/modules/scaleway_container_registry_info.py b/plugins/modules/scaleway_container_registry_info.py index 7645789cff..e0fc1db5f3 100644 --- a/plugins/modules/scaleway_container_registry_info.py +++ b/plugins/modules/scaleway_container_registry_info.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_container_registry_info short_description: Scaleway Container registry info module version_added: 5.8.0 @@ -46,18 +45,18 @@ options: description: - Name of the container registry. required: true -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Get a container registry info community.general.scaleway_container_registry_info: project_id: '{{ scw_project }}' region: fr-par name: my-awesome-container-registry register: container_registry_info_task -''' +""" -RETURN = ''' +RETURN = r""" container_registry: description: The container registry information. returned: always @@ -77,7 +76,7 @@ container_registry: status: ready status_message: "" updated_at: "2022-10-14T09:51:07.949716Z" -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway, diff --git a/plugins/modules/scaleway_database_backup.py b/plugins/modules/scaleway_database_backup.py index 1d0c17fb6d..b19a6b49bd 100644 --- a/plugins/modules/scaleway_database_backup.py +++ b/plugins/modules/scaleway_database_backup.py @@ -12,17 +12,16 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_database_backup short_description: Scaleway database backups management module version_added: 1.2.0 author: Guillaume Rodriguez (@guillaume_ro_fr) description: - - "This module manages database backups on Scaleway account U(https://developer.scaleway.com)." + - This module manages database backups on Scaleway account U(https://developer.scaleway.com). extends_documentation_fragment: - - community.general.scaleway - - community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: support: full @@ -31,118 +30,118 @@ attributes: options: state: description: - - Indicate desired state of the database backup. - - V(present) creates a backup. - - V(absent) deletes the backup. - - V(exported) creates a download link for the backup. - - V(restored) restores the backup to a new database. + - Indicate desired state of the database backup. + - V(present) creates a backup. + - V(absent) deletes the backup. + - V(exported) creates a download link for the backup. + - V(restored) restores the backup to a new database. type: str default: present choices: - - present - - absent - - exported - - restored + - present + - absent + - exported + - restored region: description: - - Scaleway region to use (for example V(fr-par)). + - Scaleway region to use (for example V(fr-par)). type: str required: true choices: - - fr-par - - nl-ams - - pl-waw + - fr-par + - nl-ams + - pl-waw id: description: - - UUID used to identify the database backup. - - Required for V(absent), V(exported) and V(restored) states. + - UUID used to identify the database backup. + - Required for V(absent), V(exported) and V(restored) states. type: str name: description: - - Name used to identify the database backup. - - Required for V(present) state. - - Ignored when O(state=absent), O(state=exported) or O(state=restored). + - Name used to identify the database backup. + - Required for V(present) state. + - Ignored when O(state=absent), O(state=exported) or O(state=restored). type: str required: false database_name: description: - - Name used to identify the database. - - Required for V(present) and V(restored) states. - - Ignored when O(state=absent) or O(state=exported). + - Name used to identify the database. + - Required for V(present) and V(restored) states. + - Ignored when O(state=absent) or O(state=exported). type: str required: false instance_id: description: - - UUID of the instance associated to the database backup. - - Required for V(present) and V(restored) states. - - Ignored when O(state=absent) or O(state=exported). + - UUID of the instance associated to the database backup. + - Required for V(present) and V(restored) states. + - Ignored when O(state=absent) or O(state=exported). type: str required: false expires_at: description: - - Expiration datetime of the database backup (ISO 8601 format). - - Ignored when O(state=absent), O(state=exported) or O(state=restored). + - Expiration datetime of the database backup (ISO 8601 format). + - Ignored when O(state=absent), O(state=exported) or O(state=restored). type: str required: false wait: description: - - Wait for the instance to reach its desired state before returning. + - Wait for the instance to reach its desired state before returning. type: bool default: false wait_timeout: description: - - Time to wait for the backup to reach the expected state. + - Time to wait for the backup to reach the expected state. type: int required: false default: 300 wait_sleep_time: description: - - Time to wait before every attempt to check the state of the backup. + - Time to wait before every attempt to check the state of the backup. type: int required: false default: 3 -''' +""" -EXAMPLES = ''' - - name: Create a backup - community.general.scaleway_database_backup: - name: 'my_backup' - state: present - region: 'fr-par' - database_name: 'my-database' - instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb' +EXAMPLES = r""" +- name: Create a backup + community.general.scaleway_database_backup: + name: 'my_backup' + state: present + region: 'fr-par' + database_name: 'my-database' + instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb' - - name: Export a backup - community.general.scaleway_database_backup: - id: '6ef1125a-037e-494f-a911-6d9c49a51691' - state: exported - region: 'fr-par' +- name: Export a backup + community.general.scaleway_database_backup: + id: '6ef1125a-037e-494f-a911-6d9c49a51691' + state: exported + region: 'fr-par' - - name: Restore a backup - community.general.scaleway_database_backup: - id: '6ef1125a-037e-494f-a911-6d9c49a51691' - state: restored - region: 'fr-par' - database_name: 'my-new-database' - instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb' +- name: Restore a backup + community.general.scaleway_database_backup: + id: '6ef1125a-037e-494f-a911-6d9c49a51691' + state: restored + region: 'fr-par' + database_name: 'my-new-database' + instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb' - - name: Remove a backup - community.general.scaleway_database_backup: - id: '6ef1125a-037e-494f-a911-6d9c49a51691' - state: absent - region: 'fr-par' -''' +- name: Remove a backup + community.general.scaleway_database_backup: + id: '6ef1125a-037e-494f-a911-6d9c49a51691' + state: absent + region: 'fr-par' +""" -RETURN = ''' +RETURN = r""" metadata: description: Backup metadata. returned: when O(state=present), O(state=exported), or O(state=restored) @@ -164,7 +163,7 @@ metadata: "updated_at": "2020-08-06T12:42:10.581649Z" } } -''' +""" import datetime import time diff --git a/plugins/modules/scaleway_function.py b/plugins/modules/scaleway_function.py index 2de0afd987..a5e81c37e4 100644 --- a/plugins/modules/scaleway_function.py +++ b/plugins/modules/scaleway_function.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_function short_description: Scaleway Function management version_added: 6.0.0 @@ -97,8 +96,8 @@ options: runtime: description: - - Runtime of the function - - See U(https://www.scaleway.com/en/docs/compute/functions/reference-content/functions-lifecycle/) for all available runtimes + - Runtime of the function. + - See U(https://www.scaleway.com/en/docs/compute/functions/reference-content/functions-lifecycle/) for all available runtimes. type: str required: true @@ -121,7 +120,8 @@ options: privacy: description: - Privacy policies define whether a function can be executed anonymously. - - Choose V(public) to enable anonymous execution, or V(private) to protect your function with an authentication mechanism provided by the Scaleway API. + - Choose V(public) to enable anonymous execution, or V(private) to protect your function with an authentication mechanism provided by the + Scaleway API. type: str default: public choices: @@ -133,9 +133,9 @@ options: - Redeploy the function if update is required. type: bool default: false -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a function community.general.scaleway_function: namespace_id: '{{ scw_function_namespace }}' @@ -155,9 +155,9 @@ EXAMPLES = ''' region: fr-par state: absent name: my-awesome-function -''' +""" -RETURN = ''' +RETURN = r""" function: description: The function information. returned: when O(state=present) @@ -186,7 +186,7 @@ function: value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: created timeout: 300s -''' +""" from copy import deepcopy diff --git a/plugins/modules/scaleway_function_info.py b/plugins/modules/scaleway_function_info.py index d65987664c..7a3acef11e 100644 --- a/plugins/modules/scaleway_function_info.py +++ b/plugins/modules/scaleway_function_info.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_function_info short_description: Retrieve information on Scaleway Function version_added: 6.0.0 @@ -46,18 +45,18 @@ options: description: - Name of the function. required: true -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Get a function info community.general.scaleway_function_info: namespace_id: '{{ scw_function_namespace }}' region: fr-par name: my-awesome-function register: function_info_task -''' +""" -RETURN = ''' +RETURN = r""" function: description: The function information. returned: always @@ -68,7 +67,7 @@ function: domain_name: fnansibletestfxamabuc-fn-ansible-test.functions.fnc.fr-par.scw.cloud environment_variables: MY_VAR: my_value - error_message: null + error_message: handler: handler.handle http_option: "" id: ceb64dc4-4464-4196-8e20-ecef705475d3 @@ -86,7 +85,7 @@ function: value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: created timeout: 300s -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway diff --git a/plugins/modules/scaleway_function_namespace.py b/plugins/modules/scaleway_function_namespace.py index 7779761e38..d43b42bc7f 100644 --- a/plugins/modules/scaleway_function_namespace.py +++ b/plugins/modules/scaleway_function_namespace.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_function_namespace short_description: Scaleway Function namespace management version_added: 6.0.0 @@ -84,9 +83,9 @@ options: - Injected in functions at runtime. type: dict default: {} -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a function namespace community.general.scaleway_function_namespace: project_id: '{{ scw_project }}' @@ -105,9 +104,9 @@ EXAMPLES = ''' state: absent region: fr-par name: my-awesome-function-namespace -''' +""" -RETURN = ''' +RETURN = r""" function_namespace: description: The function namespace information. returned: when O(state=present) @@ -116,7 +115,7 @@ function_namespace: description: "" environment_variables: MY_VAR: my_value - error_message: null + error_message: id: 531a1fd7-98d2-4a74-ad77-d398324304b8 name: my-awesome-function-namespace organization_id: e04e3bdc-015c-4514-afde-9389e9be24b0 @@ -128,7 +127,7 @@ function_namespace: - key: MY_SECRET_VAR value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: pending -''' +""" from copy import deepcopy diff --git a/plugins/modules/scaleway_function_namespace_info.py b/plugins/modules/scaleway_function_namespace_info.py index d5d48ee4dd..f2bed200dc 100644 --- a/plugins/modules/scaleway_function_namespace_info.py +++ b/plugins/modules/scaleway_function_namespace_info.py @@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_function_namespace_info short_description: Retrieve information on Scaleway Function namespace version_added: 6.0.0 @@ -46,18 +45,18 @@ options: description: - Name of the function namespace. required: true -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Get a function namespace info community.general.scaleway_function_namespace_info: project_id: '{{ scw_project }}' region: fr-par name: my-awesome-function-namespace register: function_namespace_info_task -''' +""" -RETURN = ''' +RETURN = r""" function_namespace: description: The function namespace information. returned: always @@ -66,7 +65,7 @@ function_namespace: description: "" environment_variables: MY_VAR: my_value - error_message: null + error_message: id: 531a1fd7-98d2-4a74-ad77-d398324304b8 name: my-awesome-function-namespace organization_id: e04e3bdc-015c-4514-afde-9389e9be24b0 @@ -78,7 +77,7 @@ function_namespace: - key: MY_SECRET_VAR value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: pending -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway, diff --git a/plugins/modules/scaleway_image_info.py b/plugins/modules/scaleway_image_info.py index bdae185148..0f6d1539c8 100644 --- a/plugins/modules/scaleway_image_info.py +++ b/plugins/modules/scaleway_image_info.py @@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = r''' ---- +DOCUMENTATION = r""" module: scaleway_image_info short_description: Gather information about the Scaleway images available description: @@ -37,9 +36,9 @@ options: - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 -''' +""" -EXAMPLES = r''' +EXAMPLES = r""" - name: Gather Scaleway images information community.general.scaleway_image_info: region: par1 @@ -47,14 +46,13 @@ EXAMPLES = r''' - ansible.builtin.debug: msg: "{{ result.scaleway_image_info }}" -''' +""" -RETURN = r''' ---- +RETURN = r""" scaleway_image_info: description: - Response from Scaleway API. - - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." + - 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/).' returned: success type: list elements: dict @@ -91,7 +89,7 @@ scaleway_image_info: "state": "available" } ] -''' +""" from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( diff --git a/plugins/modules/scaleway_ip.py b/plugins/modules/scaleway_ip.py index 79f0c7e3fb..4fad2faf61 100644 --- a/plugins/modules/scaleway_ip.py +++ b/plugins/modules/scaleway_ip.py @@ -11,17 +11,15 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_ip short_description: Scaleway IP management module author: Remy Leone (@remyleone) description: - - This module manages IP on Scaleway account - U(https://developer.scaleway.com) + - This module manages IP on Scaleway account U(https://developer.scaleway.com). extends_documentation_fragment: - - community.general.scaleway - - community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -33,7 +31,7 @@ options: state: type: str description: - - Indicate desired state of the IP. + - Indicate desired state of the IP. default: present choices: - present @@ -42,13 +40,13 @@ options: organization: type: str description: - - Scaleway organization identifier + - Scaleway organization identifier. required: true region: type: str description: - - Scaleway region to use (for example par1). + - Scaleway region to use (for example par1). required: true choices: - ams1 @@ -63,21 +61,19 @@ options: id: type: str description: - - id of the Scaleway IP (UUID) - + - Id of the Scaleway IP (UUID). server: type: str description: - - id of the server you want to attach an IP to. - - To unattach an IP don't specify this option - + - Id of the server you want to attach an IP to. + - To unattach an IP don't specify this option. reverse: type: str description: - - Reverse to assign to the IP -''' + - Reverse to assign to the IP. +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create an IP community.general.scaleway_ip: organization: '{{ scw_org }}' @@ -90,9 +86,9 @@ EXAMPLES = ''' id: '{{ ip_creation_task.scaleway_ip.id }}' state: absent region: par1 -''' +""" -RETURN = ''' +RETURN = r""" data: description: This is only present when O(state=present). returned: when O(state=present) @@ -110,8 +106,8 @@ data: "address": "212.47.232.136" } ] - } -''' + } +""" from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/scaleway_ip_info.py b/plugins/modules/scaleway_ip_info.py index 1fd4be5898..b597c7c42b 100644 --- a/plugins/modules/scaleway_ip_info.py +++ b/plugins/modules/scaleway_ip_info.py @@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = r''' ---- +DOCUMENTATION = r""" module: scaleway_ip_info short_description: Gather information about the Scaleway ips available description: @@ -37,9 +36,9 @@ options: - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 -''' +""" -EXAMPLES = r''' +EXAMPLES = r""" - name: Gather Scaleway ips information community.general.scaleway_ip_info: region: par1 @@ -47,14 +46,13 @@ EXAMPLES = r''' - ansible.builtin.debug: msg: "{{ result.scaleway_ip_info }}" -''' +""" -RETURN = r''' ---- +RETURN = r""" scaleway_ip_info: description: - Response from Scaleway API. - - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." + - 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)' returned: success type: list elements: dict @@ -71,7 +69,7 @@ scaleway_ip_info: } } ] -''' +""" from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( diff --git a/plugins/modules/scaleway_lb.py b/plugins/modules/scaleway_lb.py index 6cc947755d..7e13c3843f 100644 --- a/plugins/modules/scaleway_lb.py +++ b/plugins/modules/scaleway_lb.py @@ -13,16 +13,15 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_lb short_description: Scaleway load-balancer management module author: Remy Leone (@remyleone) description: - - "This module manages load-balancers on Scaleway." + - This module manages load-balancers on Scaleway. extends_documentation_fragment: - - community.general.scaleway - - community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -53,7 +52,7 @@ options: state: type: str description: - - Indicate desired state of the instance. + - Indicate desired state of the instance. default: present choices: - present @@ -62,7 +61,7 @@ options: region: type: str description: - - Scaleway zone. + - Scaleway zone. required: true choices: - nl-ams @@ -74,30 +73,29 @@ options: elements: str default: [] description: - - List of tags to apply to the load-balancer. - + - List of tags to apply to the load-balancer. wait: description: - - Wait for the load-balancer to reach its desired state before returning. + - Wait for the load-balancer to reach its desired state before returning. type: bool default: false wait_timeout: type: int description: - - Time to wait for the load-balancer to reach the expected state. + - Time to wait for the load-balancer to reach the expected state. required: false default: 300 wait_sleep_time: type: int description: - - Time to wait before every attempt to check the state of the load-balancer. + - Time to wait before every attempt to check the state of the load-balancer. required: false default: 3 -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a load-balancer community.general.scaleway_lb: name: foobar @@ -113,7 +111,7 @@ EXAMPLES = ''' state: absent organization_id: 951df375-e094-4d26-97c1-ba548eeb9c42 region: fr-par -''' +""" RETURNS = ''' { diff --git a/plugins/modules/scaleway_organization_info.py b/plugins/modules/scaleway_organization_info.py index e9e272c988..603ab3cd4c 100644 --- a/plugins/modules/scaleway_organization_info.py +++ b/plugins/modules/scaleway_organization_info.py @@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = r''' ---- +DOCUMENTATION = r""" module: scaleway_organization_info short_description: Gather information about the Scaleway organizations available description: @@ -27,20 +26,18 @@ extends_documentation_fragment: - community.general.scaleway - community.general.attributes - community.general.attributes.info_module +""" -''' - -EXAMPLES = r''' +EXAMPLES = r""" - name: Gather Scaleway organizations information community.general.scaleway_organization_info: register: result - ansible.builtin.debug: msg: "{{ result.scaleway_organization_info }}" -''' +""" -RETURN = r''' ---- +RETURN = r""" scaleway_organization_info: description: Response from Scaleway API. returned: success @@ -70,7 +67,7 @@ scaleway_organization_info: "warnings": [] } ] -''' +""" from ansible.module_utils.basic import AnsibleModule, env_fallback from ansible_collections.community.general.plugins.module_utils.scaleway import ( diff --git a/plugins/modules/scaleway_private_network.py b/plugins/modules/scaleway_private_network.py index 0cc9b900f4..922a780098 100644 --- a/plugins/modules/scaleway_private_network.py +++ b/plugins/modules/scaleway_private_network.py @@ -11,17 +11,16 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_private_network short_description: Scaleway private network management version_added: 4.5.0 author: Pascal MANGIN (@pastral) description: - - "This module manages private network on Scaleway account (U(https://developer.scaleway.com))." + - This module manages private network on Scaleway account (U(https://developer.scaleway.com)). extends_documentation_fragment: - - community.general.scaleway - - community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -33,7 +32,7 @@ options: state: type: str description: - - Indicate desired state of the VPC. + - Indicate desired state of the VPC. default: present choices: - present @@ -48,7 +47,7 @@ options: region: type: str description: - - Scaleway region to use (for example V(par1)). + - Scaleway region to use (for example V(par1)). required: true choices: - ams1 @@ -63,18 +62,16 @@ options: name: type: str description: - - Name of the VPC. - + - Name of the VPC. tags: type: list elements: str description: - - List of tags to apply to the instance. + - List of tags to apply to the instance. default: [] +""" -''' - -EXAMPLES = ''' +EXAMPLES = r""" - name: Create an private network community.general.scaleway_vpc: project: '{{ scw_project }}' @@ -88,9 +85,9 @@ EXAMPLES = ''' name: 'foo' state: absent region: par1 -''' +""" -RETURN = ''' +RETURN = r""" scaleway_private_network: description: Information on the VPC. returned: success when O(state=present) @@ -112,7 +109,7 @@ scaleway_private_network: "updated_at": "2022-01-15T11:12:04.624837Z", "zone": "fr-par-2" } -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/scaleway_security_group.py b/plugins/modules/scaleway_security_group.py index 3aee99e99a..3e1a28275e 100644 --- a/plugins/modules/scaleway_security_group.py +++ b/plugins/modules/scaleway_security_group.py @@ -12,16 +12,15 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_security_group short_description: Scaleway Security Group management module author: Antoine Barbare (@abarbare) description: - - "This module manages Security Group on Scaleway account U(https://developer.scaleway.com)." + - This module manages Security Group on Scaleway account U(https://developer.scaleway.com). extends_documentation_fragment: - - community.general.scaleway - - community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -34,7 +33,7 @@ options: description: - Indicate desired state of the Security Group. type: str - choices: [ absent, present ] + choices: [absent, present] default: present organization: @@ -79,21 +78,21 @@ options: description: - Default policy for incoming traffic. type: str - choices: [ accept, drop ] + choices: [accept, drop] outbound_default_policy: description: - Default policy for outcoming traffic. type: str - choices: [ accept, drop ] + choices: [accept, drop] organization_default: description: - Create security group to be the default one. type: bool -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create a Security Group community.general.scaleway_security_group: state: present @@ -106,9 +105,9 @@ EXAMPLES = ''' outbound_default_policy: accept organization_default: false register: security_group_creation_task -''' +""" -RETURN = ''' +RETURN = r""" data: description: This is only present when O(state=present). returned: when O(state=present) @@ -127,7 +126,7 @@ data: "stateful": false } } -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/scaleway_security_group_info.py b/plugins/modules/scaleway_security_group_info.py index fb28e87740..6664938e09 100644 --- a/plugins/modules/scaleway_security_group_info.py +++ b/plugins/modules/scaleway_security_group_info.py @@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = r''' ---- +DOCUMENTATION = r""" module: scaleway_security_group_info short_description: Gather information about the Scaleway security groups available description: @@ -36,10 +35,9 @@ extends_documentation_fragment: - community.general.scaleway - community.general.attributes - community.general.attributes.info_module +""" -''' - -EXAMPLES = r''' +EXAMPLES = r""" - name: Gather Scaleway security groups information community.general.scaleway_security_group_info: region: par1 @@ -47,14 +45,13 @@ EXAMPLES = r''' - ansible.builtin.debug: msg: "{{ result.scaleway_security_group_info }}" -''' +""" -RETURN = r''' ---- +RETURN = r""" scaleway_security_group_info: description: - Response from Scaleway API. - - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." + - 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/).' returned: success type: list elements: dict @@ -75,7 +72,7 @@ scaleway_security_group_info: ] } ] -''' +""" from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( diff --git a/plugins/modules/scaleway_security_group_rule.py b/plugins/modules/scaleway_security_group_rule.py index 9cbb2eb57e..ec89d41f6c 100644 --- a/plugins/modules/scaleway_security_group_rule.py +++ b/plugins/modules/scaleway_security_group_rule.py @@ -12,13 +12,12 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_security_group_rule short_description: Scaleway Security Group Rule management module author: Antoine Barbare (@abarbare) description: - - "This module manages Security Group Rule on Scaleway account U(https://developer.scaleway.com)." + - This module manages Security Group Rule on Scaleway account U(https://developer.scaleway.com). extends_documentation_fragment: - community.general.scaleway - community.general.attributes @@ -99,23 +98,23 @@ options: description: - Security Group unique identifier. required: true -''' +""" -EXAMPLES = ''' - - name: Create a Security Group Rule - community.general.scaleway_security_group_rule: - state: present - region: par1 - protocol: TCP - port: 80 - ip_range: 0.0.0.0/0 - direction: inbound - action: accept - security_group: b57210ee-1281-4820-a6db-329f78596ecb - register: security_group_rule_creation_task -''' +EXAMPLES = r""" +- name: Create a Security Group Rule + community.general.scaleway_security_group_rule: + state: present + region: par1 + protocol: TCP + port: 80 + ip_range: 0.0.0.0/0 + direction: inbound + action: accept + security_group: b57210ee-1281-4820-a6db-329f78596ecb + register: security_group_rule_creation_task +""" -RETURN = ''' +RETURN = r""" data: description: This is only present when O(state=present). returned: when O(state=present) @@ -133,7 +132,7 @@ data: "id": "10cb0b9a-80f6-4830-abd7-a31cd828b5e9" } } -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway, payload_from_object from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/scaleway_server_info.py b/plugins/modules/scaleway_server_info.py index 01e9410da8..39af47005e 100644 --- a/plugins/modules/scaleway_server_info.py +++ b/plugins/modules/scaleway_server_info.py @@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = r''' ---- +DOCUMENTATION = r""" module: scaleway_server_info short_description: Gather information about the Scaleway servers available description: @@ -37,9 +36,9 @@ options: - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 -''' +""" -EXAMPLES = r''' +EXAMPLES = r""" - name: Gather Scaleway servers information community.general.scaleway_server_info: region: par1 @@ -47,14 +46,13 @@ EXAMPLES = r''' - ansible.builtin.debug: msg: "{{ result.scaleway_server_info }}" -''' +""" -RETURN = r''' ---- +RETURN = r""" scaleway_server_info: description: - Response from Scaleway API. - - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." + - 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/).' returned: success type: list elements: dict @@ -157,7 +155,7 @@ scaleway_server_info: } } ] -''' +""" from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( diff --git a/plugins/modules/scaleway_snapshot_info.py b/plugins/modules/scaleway_snapshot_info.py index 687f43c85b..6b932cced2 100644 --- a/plugins/modules/scaleway_snapshot_info.py +++ b/plugins/modules/scaleway_snapshot_info.py @@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = r''' ---- +DOCUMENTATION = r""" module: scaleway_snapshot_info short_description: Gather information about the Scaleway snapshots available description: @@ -37,9 +36,9 @@ options: - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 -''' +""" -EXAMPLES = r''' +EXAMPLES = r""" - name: Gather Scaleway snapshots information community.general.scaleway_snapshot_info: region: par1 @@ -47,14 +46,13 @@ EXAMPLES = r''' - ansible.builtin.debug: msg: "{{ result.scaleway_snapshot_info }}" -''' +""" -RETURN = r''' ---- +RETURN = r""" scaleway_snapshot_info: description: - Response from Scaleway API. - - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." + - 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/).' returned: success type: list elements: dict @@ -75,7 +73,7 @@ scaleway_snapshot_info: "volume_type": "l_ssd" } ] -''' +""" from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( diff --git a/plugins/modules/scaleway_sshkey.py b/plugins/modules/scaleway_sshkey.py index 5647f9cd05..37e8ec8c3b 100644 --- a/plugins/modules/scaleway_sshkey.py +++ b/plugins/modules/scaleway_sshkey.py @@ -13,16 +13,15 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_sshkey short_description: Scaleway SSH keys management module author: Remy Leone (@remyleone) description: - - "This module manages SSH keys on Scaleway account U(https://developer.scaleway.com)." + - This module manages SSH keys on Scaleway account (U(https://developer.scaleway.com)). extends_documentation_fragment: -- community.general.scaleway -- community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -34,7 +33,7 @@ options: state: type: str description: - - Indicate desired state of the SSH key. + - Indicate desired state of the SSH key. default: present choices: - present @@ -42,7 +41,7 @@ options: ssh_pub_key: type: str description: - - The public SSH key as a string to add. + - The public SSH key as a string to add. required: true api_url: type: str @@ -50,9 +49,9 @@ options: - Scaleway API URL. default: 'https://account.scaleway.com' aliases: ['base_url'] -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: "Add SSH key" community.general.scaleway_sshkey: ssh_pub_key: "ssh-rsa AAAA..." @@ -68,9 +67,9 @@ EXAMPLES = ''' ssh_pub_key: "ssh-rsa AAAA..." state: "present" oauth_token: "6ecd2c9b-6f4f-44d4-a187-61a92078d08c" -''' +""" -RETURN = ''' +RETURN = r""" data: description: This is only present when O(state=present). returned: when O(state=present) @@ -80,7 +79,7 @@ data: {"key": "ssh-rsa AAAA...."} ] } -''' +""" from ansible.module_utils.basic import AnsibleModule, env_fallback from ansible_collections.community.general.plugins.module_utils.scaleway import scaleway_argument_spec, Scaleway diff --git a/plugins/modules/scaleway_user_data.py b/plugins/modules/scaleway_user_data.py index 72046ff532..f4f2c18624 100644 --- a/plugins/modules/scaleway_user_data.py +++ b/plugins/modules/scaleway_user_data.py @@ -13,17 +13,16 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_user_data short_description: Scaleway user_data management module author: Remy Leone (@remyleone) description: - - This module manages user_data on compute instances on Scaleway. - - It can be used to configure cloud-init for instance. + - This module manages user_data on compute instances on Scaleway. + - It can be used to configure cloud-init for instance. extends_documentation_fragment: -- community.general.scaleway -- community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -36,20 +35,20 @@ options: server_id: type: str description: - - Scaleway Compute instance ID of the server. + - Scaleway Compute instance ID of the server. required: true user_data: type: dict description: - - User defined data. Typically used with C(cloud-init). - - Pass your C(cloud-init) script here as a string. + - User defined data. Typically used with C(cloud-init). + - Pass your C(cloud-init) script here as a string. required: false region: type: str description: - - Scaleway compute zone. + - Scaleway compute zone. required: true choices: - ams1 @@ -60,19 +59,19 @@ options: - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Update the cloud-init community.general.scaleway_user_data: server_id: '5a33b4ab-57dd-4eb6-8b0a-d95eb63492ce' region: ams1 user_data: cloud-init: 'final_message: "Hello World!"' -''' +""" -RETURN = ''' -''' +RETURN = r""" +""" from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway diff --git a/plugins/modules/scaleway_volume.py b/plugins/modules/scaleway_volume.py index 46d72288e7..ed6a506742 100644 --- a/plugins/modules/scaleway_volume.py +++ b/plugins/modules/scaleway_volume.py @@ -12,16 +12,15 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' ---- +DOCUMENTATION = r""" module: scaleway_volume short_description: Scaleway volumes management module author: Henryk Konsek (@hekonsek) description: - - "This module manages volumes on Scaleway account U(https://developer.scaleway.com)." + - This module manages volumes on Scaleway account U(https://developer.scaleway.com). extends_documentation_fragment: -- community.general.scaleway -- community.general.attributes + - community.general.scaleway + - community.general.attributes attributes: check_mode: @@ -74,9 +73,9 @@ options: type: str description: - Type of the volume (for example 'l_ssd'). -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create 10GB volume community.general.scaleway_volume: name: my-volume @@ -92,9 +91,9 @@ EXAMPLES = ''' name: my-volume state: absent region: par1 -''' +""" -RETURN = ''' +RETURN = r""" data: description: This is only present when O(state=present). returned: when O(state=present) @@ -110,7 +109,7 @@ data: "volume_type": "l_ssd" } } -''' +""" from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/scaleway_volume_info.py b/plugins/modules/scaleway_volume_info.py index 471845c43e..1b2e95f88c 100644 --- a/plugins/modules/scaleway_volume_info.py +++ b/plugins/modules/scaleway_volume_info.py @@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -DOCUMENTATION = r''' ---- +DOCUMENTATION = r""" module: scaleway_volume_info short_description: Gather information about the Scaleway volumes available description: @@ -37,9 +36,9 @@ options: - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 -''' +""" -EXAMPLES = r''' +EXAMPLES = r""" - name: Gather Scaleway volumes information community.general.scaleway_volume_info: region: par1 @@ -47,14 +46,13 @@ EXAMPLES = r''' - ansible.builtin.debug: msg: "{{ result.scaleway_volume_info }}" -''' +""" -RETURN = r''' ---- +RETURN = r""" scaleway_volume_info: description: - Response from Scaleway API. - - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." + - 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/).' returned: success type: list elements: dict @@ -73,7 +71,7 @@ scaleway_volume_info: "volume_type": "l_ssd" } ] -''' +""" from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import (