ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

multiple scaleway modules: fixed markups in doc (#5766)

Browse source 
* multiple scaleway modules: fixed markups in doc

* Update plugins/modules/scaleway_ip.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/scaleway_volume.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/scaleway_private_network.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/scaleway_security_group.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/scaleway_security_group_rule.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/scaleway_sshkey.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* further docs adjustments

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2023-01-13 09:02:25 +13:00 committed by GitHub
parent b9ac2dcda5
commit 317f79ff1f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 55 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/modules/scaleway_compute_private_network.py
View file

@ -92,7 +92,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
scaleway_compute_private_network: scaleway_compute_private_network:
description: Information on the VPC. description: Information on the VPC.
returned: success when C(state=present) returned: success when I(state=present)
type: dict type: dict
sample: sample:
{ {

12
plugins/modules/scaleway_database_backup.py
View file

@ -19,7 +19,7 @@ short_description: Scaleway database backups management module
version_added: 1.2.0 version_added: 1.2.0
author: Guillaume Rodriguez (@guillaume_ro_fr) author: Guillaume Rodriguez (@guillaume_ro_fr)
description: 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: extends_documentation_fragment:
- community.general.scaleway - community.general.scaleway
options: options:
@ -58,7 +58,7 @@ options:
description: description:
- Name used to identify the database backup. - Name used to identify the database backup.
- Required for C(present) state. - Required for C(present) state.
- Ignored when C(state=absent), C(state=exported) or C(state=restored). - Ignored when I(state=absent), I(state=exported) or I(state=restored).
type: str type: str
required: false required: false
@ -66,7 +66,7 @@ options:
description: description:
- Name used to identify the database. - Name used to identify the database.
- Required for C(present) and C(restored) states. - Required for C(present) and C(restored) states.
- Ignored when C(state=absent) or C(state=exported). - Ignored when I(state=absent) or I(state=exported).
type: str type: str
required: false required: false
@ -74,14 +74,14 @@ options:
description: description:
- UUID of the instance associated to the database backup. - UUID of the instance associated to the database backup.
- Required for C(present) and C(restored) states. - Required for C(present) and C(restored) states.
- Ignored when C(state=absent) or C(state=exported). - Ignored when I(state=absent) or I(state=exported).
type: str type: str
required: false required: false
expires_at: expires_at:
description: description:
- Expiration datetime of the database backup (ISO 8601 format). - Expiration datetime of the database backup (ISO 8601 format).
- Ignored when C(state=absent), C(state=exported) or C(state=restored). - Ignored when I(state=absent), I(state=exported) or I(state=restored).
type: str type: str
required: false required: false
@ -139,7 +139,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
metadata: metadata:
description: Backup metadata. description: Backup metadata.
returned: when C(state=present), C(state=exported) or C(state=restored) returned: when I(state=present), I(state=exported) or I(state=restored)
type: dict type: dict
sample: { sample: {
"metadata": { "metadata": {

2
plugins/modules/scaleway_image_info.py
View file

@ -26,7 +26,7 @@ options:
region: region:
type: str type: str
description: description:
- Scaleway compute zone - Scaleway compute zone.
required: true required: true
choices: choices:
- ams1 - ams1

4
plugins/modules/scaleway_ip.py
View file

@ -88,8 +88,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
data: data:
description: This is only present when C(state=present) description: This is only present when I(state=present).
returned: when C(state=present) returned: when I(state=present)
type: dict type: dict
sample: { sample: {
"ips": [ "ips": [

14
plugins/modules/scaleway_lb.py
View file

@ -29,19 +29,19 @@ options:
name: name:
type: str type: str
description: description:
- Name of the load-balancer - Name of the load-balancer.
required: true required: true
description: description:
type: str type: str
description: description:
- Description of the load-balancer - Description of the load-balancer.
required: true required: true
organization_id: organization_id:
type: str type: str
description: description:
- Organization identifier - Organization identifier.
required: true required: true
state: state:
@ -56,7 +56,7 @@ options:
region: region:
type: str type: str
description: description:
- Scaleway zone - Scaleway zone.
required: true required: true
choices: choices:
- nl-ams - nl-ams
@ -68,7 +68,7 @@ options:
elements: str elements: str
default: [] default: []
description: description:
- List of tags to apply to the load-balancer - List of tags to apply to the load-balancer.
wait: wait:
description: description:
@ -79,14 +79,14 @@ options:
wait_timeout: wait_timeout:
type: int type: int
description: 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 required: false
default: 300 default: 300
wait_sleep_time: wait_sleep_time:
type: int type: int
description: 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 required: false
default: 3 default: 3
''' '''

4
plugins/modules/scaleway_organization_info.py
View file

@ -20,7 +20,7 @@ author:
options: options:
api_url: api_url:
description: description:
- Scaleway API URL - Scaleway API URL.
default: 'https://account.scaleway.com' default: 'https://account.scaleway.com'
aliases: ['base_url'] aliases: ['base_url']
extends_documentation_fragment: extends_documentation_fragment:
@ -42,7 +42,7 @@ EXAMPLES = r'''
RETURN = r''' RETURN = r'''
--- ---
scaleway_organization_info: scaleway_organization_info:
description: Response from Scaleway API description: Response from Scaleway API.
returned: success returned: success
type: list type: list
elements: dict elements: dict

5
plugins/modules/scaleway_private_network.py
View file

@ -18,8 +18,7 @@ short_description: Scaleway private network management
version_added: 4.5.0 version_added: 4.5.0
author: Pascal MANGIN (@pastral) author: Pascal MANGIN (@pastral)
description: description:
- This module manages private network on Scaleway account - "This module manages private network on Scaleway account (U(https://developer.scaleway.com))."
(U(https://developer.scaleway.com)).
extends_documentation_fragment: extends_documentation_fragment:
- community.general.scaleway - community.general.scaleway
@ -88,7 +87,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
scaleway_private_network: scaleway_private_network:
description: Information on the VPC. description: Information on the VPC.
returned: success when C(state=present) returned: success when I(state=present)
type: dict type: dict
sample: sample:
{ {

7
plugins/modules/scaleway_security_group.py
View file

@ -18,8 +18,7 @@ module: scaleway_security_group
short_description: Scaleway Security Group management module short_description: Scaleway Security Group management module
author: Antoine Barbare (@abarbare) author: Antoine Barbare (@abarbare)
description: description:
- This module manages Security Group on Scaleway account - "This module manages Security Group on Scaleway account U(https://developer.scaleway.com)."
U(https://developer.scaleway.com).
extends_documentation_fragment: extends_documentation_fragment:
- community.general.scaleway - community.general.scaleway
@ -105,8 +104,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
data: data:
description: This is only present when C(state=present) description: This is only present when I(state=present).
returned: when C(state=present) returned: when I(state=present)
type: dict type: dict
sample: { sample: {
"scaleway_security_group": { "scaleway_security_group": {

19
plugins/modules/scaleway_security_group_rule.py
View file

@ -18,8 +18,7 @@ module: scaleway_security_group_rule
short_description: Scaleway Security Group Rule management module short_description: Scaleway Security Group Rule management module
author: Antoine Barbare (@abarbare) author: Antoine Barbare (@abarbare)
description: description:
- This module manages Security Group Rule on Scaleway account - "This module manages Security Group Rule on Scaleway account U(https://developer.scaleway.com)."
U(https://developer.scaleway.com)
extends_documentation_fragment: extends_documentation_fragment:
- community.general.scaleway - community.general.scaleway
requirements: requirements:
@ -53,7 +52,7 @@ options:
protocol: protocol:
type: str type: str
description: description:
- Network protocol to use - Network protocol to use.
choices: choices:
- TCP - TCP
- UDP - UDP
@ -62,20 +61,20 @@ options:
port: port:
description: description:
- Port related to the rule, null value for all the ports - Port related to the rule, null value for all the ports.
required: true required: true
type: int type: int
ip_range: ip_range:
type: str type: str
description: description:
- IPV4 CIDR notation to apply to the rule - IPV4 CIDR notation to apply to the rule.
default: 0.0.0.0/0 default: 0.0.0.0/0
direction: direction:
type: str type: str
description: description:
- Rule direction - Rule direction.
choices: choices:
- inbound - inbound
- outbound - outbound
@ -84,7 +83,7 @@ options:
action: action:
type: str type: str
description: description:
- Rule action - Rule action.
choices: choices:
- accept - accept
- drop - drop
@ -93,7 +92,7 @@ options:
security_group: security_group:
type: str type: str
description: description:
- Security Group unique identifier - Security Group unique identifier.
required: true required: true
''' '''
@ -113,8 +112,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
data: data:
description: This is only present when C(state=present) description: This is only present when I(state=present).
returned: when C(state=present) returned: when I(state=present)
type: dict type: dict
sample: { sample: {
"scaleway_security_group_rule": { "scaleway_security_group_rule": {

9
plugins/modules/scaleway_sshkey.py
View file

@ -19,8 +19,7 @@ module: scaleway_sshkey
short_description: Scaleway SSH keys management module short_description: Scaleway SSH keys management module
author: Remy Leone (@remyleone) author: Remy Leone (@remyleone)
description: description:
- This module manages SSH keys on Scaleway account - "This module manages SSH keys on Scaleway account U(https://developer.scaleway.com)."
U(https://developer.scaleway.com)
extends_documentation_fragment: extends_documentation_fragment:
- community.general.scaleway - community.general.scaleway
@ -42,7 +41,7 @@ options:
api_url: api_url:
type: str type: str
description: description:
- Scaleway API URL - Scaleway API URL.
default: 'https://account.scaleway.com' default: 'https://account.scaleway.com'
aliases: ['base_url'] aliases: ['base_url']
''' '''
@ -67,8 +66,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
data: data:
description: This is only present when C(state=present) description: This is only present when I(state=present).
returned: when C(state=present) returned: when I(state=present)
type: dict type: dict
sample: { sample: {
"ssh_public_keys": [ "ssh_public_keys": [

10
plugins/modules/scaleway_user_data.py
View file

@ -19,8 +19,8 @@ module: scaleway_user_data
short_description: Scaleway user_data management module short_description: Scaleway user_data management module
author: Remy Leone (@remyleone) author: Remy Leone (@remyleone)
description: description:
- "This module manages user_data on compute instances on Scaleway." - This module manages user_data on compute instances on Scaleway.
- "It can be used to configure cloud-init for instance" - It can be used to configure cloud-init for instance.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.scaleway - community.general.scaleway
@ -30,20 +30,20 @@ options:
server_id: server_id:
type: str type: str
description: description:
- Scaleway Compute instance ID of the server - Scaleway Compute instance ID of the server.
required: true required: true
user_data: user_data:
type: dict type: dict
description: description:
- User defined data. Typically used with C(cloud-init). - User defined data. Typically used with C(cloud-init).
- Pass your cloud-init script here as a string - Pass your C(cloud-init) script here as a string.
required: false required: false
region: region:
type: str type: str
description: description:
- Scaleway compute zone - Scaleway compute zone.
required: true required: true
choices: choices:
- ams1 - ams1

27
plugins/modules/scaleway_volume.py
View file

@ -18,8 +18,7 @@ module: scaleway_volume
short_description: Scaleway volumes management module short_description: Scaleway volumes management module
author: Henryk Konsek (@hekonsek) author: Henryk Konsek (@hekonsek)
description: description:
- This module manages volumes on Scaleway account - "This module manages volumes on Scaleway account U(https://developer.scaleway.com)."
U(https://developer.scaleway.com)
extends_documentation_fragment: extends_documentation_fragment:
- community.general.scaleway - community.general.scaleway
@ -28,7 +27,7 @@ options:
state: state:
type: str type: str
description: description:
- Indicate desired state of the volume. - Indicate desired state of the volume.
default: present default: present
choices: choices:
- present - present
@ -36,7 +35,7 @@ options:
region: region:
type: str type: str
description: description:
- Scaleway region to use (for example par1). - Scaleway region to use (for example par1).
required: true required: true
choices: choices:
- ams1 - ams1
@ -50,25 +49,25 @@ options:
name: name:
type: str type: str
description: description:
- Name used to identify the volume. - Name used to identify the volume.
required: true required: true
project: project:
type: str type: str
description: description:
- Scaleway project ID to which volume belongs. - Scaleway project ID to which volume belongs.
version_added: 4.3.0 version_added: 4.3.0
organization: organization:
type: str type: str
description: description:
- ScaleWay organization ID to which volume belongs. - ScaleWay organization ID to which volume belongs.
size: size:
type: int type: int
description: description:
- Size of the volume in bytes. - Size of the volume in bytes.
volume_type: volume_type:
type: str type: str
description: description:
- Type of the volume (for example 'l_ssd'). - Type of the volume (for example 'l_ssd').
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -91,8 +90,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
data: data:
description: This is only present when C(state=present) description: This is only present when I(state=present).
returned: when C(state=present) returned: when I(state=present)
type: dict type: dict
sample: { sample: {
"volume": { "volume": {
@ -100,9 +99,9 @@ data:
"id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd", "id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd",
"name": "volume-0-3", "name": "volume-0-3",
"project": "000a115d-2852-4b0a-9ce8-47f1134ba95a", "project": "000a115d-2852-4b0a-9ce8-47f1134ba95a",
"server": null, "server": null,
"size": 10000000000, "size": 10000000000,
"volume_type": "l_ssd" "volume_type": "l_ssd"
} }
} }
''' '''