ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-23 02:41:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

s[a-c]*: normalize docs (#9353)

Browse source 
* s[a-c]*: normalize docs

* Apply suggestions from code review

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

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-26 09:16:10 +13:00 • committed by GitHub
parent 825e0ee377
commit 70b62ed745
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
29 changed files with 336 additions and 382 deletions
Download patch file Download diff file Expand all files Collapse all files

29
plugins/modules/scaleway_user_data.py
View file

@ -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