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

linode: PEP8 compliancy and doc fixes (#30922)

Browse source 
This PR includes:
- PEP8 compliancy fixes
- Documentation fixes
This commit is contained in:
Dag Wieers 2017-09-26 15:48:08 +02:00 committed by ansibot
parent 9aa1da23f0
commit c3707aaf37
2 changed files with 116 additions and 130 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

237
lib/ansible/modules/cloud/linode/linode.py
View file

@ -1,137 +1,117 @@
#!/usr/bin/python #!/usr/bin/python
# Copyright: Ansible Project # Copyright: Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'], 'status': ['preview'],
'supported_by': 'community'} 'supported_by': 'community'}
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: linode module: linode
short_description: create / delete / stop / restart an instance in Linode Public Cloud short_description: Manage instances on the Linode Public Cloud
description: description:
- creates / deletes a Linode Public Cloud instance and optionally waits for it to be 'running'. - Manage Linode Public Cloud instances and optionally wait for it to be 'running'.
version_added: "1.3" version_added: "1.3"
options: options:
state: state:
description: description:
- Indicate desired state of the resource - Indicate desired state of the resource
choices: ['present', 'active', 'started', 'absent', 'deleted', 'stopped', 'restarted'] choices: [ absent, active, deleted, present, restarted, started, stopped ]
default: present default: present
api_key: api_key:
description: description:
- Linode API key - Linode API key
default: null
name: name:
description: description:
- Name to give the instance (alphanumeric, dashes, underscore) - Name to give the instance (alphanumeric, dashes, underscore).
- To keep sanity on the Linode Web Console, name is prepended with LinodeID_ - To keep sanity on the Linode Web Console, name is prepended with C(LinodeID_).
default: null
displaygroup: displaygroup:
description: description:
- Add the instance to a Display Group in Linode Manager - Add the instance to a Display Group in Linode Manager.
default: null
version_added: "2.3" version_added: "2.3"
linode_id: linode_id:
description: description:
- Unique ID of a linode server - Unique ID of a linode server
aliases: [ 'lid' ] aliases: [ lid ]
default: null
additional_disks: additional_disks:
description: > description:
List of dictionaries for creating additional disks that are added to the Linode configuration settings. - List of dictionaries for creating additional disks that are added to the Linode configuration settings.
Dictionary takes Size, Label, Type. Size is in MB. - Dictionary takes Size, Label, Type. Size is in MB.
default: null
version_added: "2.3" version_added: "2.3"
alert_bwin_enabled: alert_bwin_enabled:
description: description:
- Set status of bandwidth in alerts. - Set status of bandwidth in alerts.
default: null type: bool
choices: [ "True", "False" ]
version_added: "2.3" version_added: "2.3"
alert_bwin_threshold: alert_bwin_threshold:
description: description:
- Set threshold in MB of bandwidth in alerts. - Set threshold in MB of bandwidth in alerts.
default: null
version_added: "2.3" version_added: "2.3"
alert_bwout_enabled: alert_bwout_enabled:
description: description:
- Set status of bandwidth out alerts. - Set status of bandwidth out alerts.
default: null type: bool
choices: [ "True", "False" ]
version_added: "2.3" version_added: "2.3"
alert_bwout_threshold: alert_bwout_threshold:
description: description:
- Set threshold in MB of bandwidth out alerts. - Set threshold in MB of bandwidth out alerts.
default: null
version_added: "2.3" version_added: "2.3"
alert_bwquota_enabled: alert_bwquota_enabled:
description: description:
- Set status of bandwidth quota alerts as percentage of network transfer quota. - Set status of bandwidth quota alerts as percentage of network transfer quota.
default: null type: bool
choices: [ "True", "False" ]
version_added: "2.3" version_added: "2.3"
alert_bwquota_threshold: alert_bwquota_threshold:
description: description:
- Set threshold in MB of bandwidth quota alerts. - Set threshold in MB of bandwidth quota alerts.
default: null
version_added: "2.3" version_added: "2.3"
alert_cpu_enabled: alert_cpu_enabled:
description: description:
- Set status of receiving CPU usage alerts. - Set status of receiving CPU usage alerts.
default: null type: bool
choices: [ "True", "False" ]
version_added: "2.3" version_added: "2.3"
alert_cpu_threshold: alert_cpu_threshold:
description: description:
- Set percentage threshold for receiving CPU usage alerts. Each CPU core adds 100% to total. - Set percentage threshold for receiving CPU usage alerts. Each CPU core adds 100% to total.
default: null
version_added: "2.3" version_added: "2.3"
alert_diskio_enabled: alert_diskio_enabled:
description: description:
- Set status of receiving disk IO alerts. - Set status of receiving disk IO alerts.
default: null type: bool
choices: [ "True", "False" ]
version_added: "2.3" version_added: "2.3"
alert_diskio_threshold: alert_diskio_threshold:
description: description:
- Set threshold for average IO ops/sec over 2 hour period. - Set threshold for average IO ops/sec over 2 hour period.
default: null
version_added: "2.3" version_added: "2.3"
backupweeklyday: backupweeklyday:
description: description:
- Integer value for what day of the week to store weekly backups. - Integer value for what day of the week to store weekly backups.
default: null
version_added: "2.3" version_added: "2.3"
plan: plan:
description: description:
- plan to use for the instance (Linode plan) - plan to use for the instance (Linode plan)
default: null
payment_term: payment_term:
description: description:
- payment term to use for the instance (payment term in months) - payment term to use for the instance (payment term in months)
default: 1 default: 1
choices: [1, 12, 24] choices: [ 1, 12, 24 ]
password: password:
description: description:
- root password to apply to a new server (auto generated if missing) - root password to apply to a new server (auto generated if missing)
default: null
private_ip: private_ip:
description: description:
- Add private IPv4 address when Linode is created. - Add private IPv4 address when Linode is created.
type: bool
default: "no" default: "no"
choices: [ "yes", "no" ]
version_added: "2.3" version_added: "2.3"
ssh_pub_key: ssh_pub_key:
description: description:
- SSH public key applied to root user - SSH public key applied to root user
default: null
swap: swap:
description: description:
- swap size in MB - swap size in MB
@ -139,21 +119,18 @@ options:
distribution: distribution:
description: description:
- distribution to use for the instance (Linode Distribution) - distribution to use for the instance (Linode Distribution)
default: null
datacenter: datacenter:
description: description:
- datacenter to create an instance in (Linode Datacenter) - datacenter to create an instance in (Linode Datacenter)
default: null
kernel_id: kernel_id:
description: description:
- kernel to use for the instance (Linode Kernel) - kernel to use for the instance (Linode Kernel)
default: null
version_added: "2.4" version_added: "2.4"
wait: wait:
description: description:
- wait for the instance to be in state 'running' before returning - wait for the instance to be in state C(running) before returning
type: bool
default: "no" default: "no"
choices: [ "yes", "no" ]
wait_timeout: wait_timeout:
description: description:
- how long before wait gives up, in seconds - how long before wait gives up, in seconds
@ -161,21 +138,22 @@ options:
watchdog: watchdog:
description: description:
- Set status of Lassie watchdog. - Set status of Lassie watchdog.
type: bool
default: "True" default: "True"
choices: [ "True", "False" ]
version_added: "2.2" version_added: "2.2"
requirements: requirements:
- "python >= 2.6" - python >= 2.6
- "linode-python" - linode-python
- "pycurl" - pycurl
author: "Vincent Viallet (@zbal)" author:
- Vincent Viallet (@zbal)
notes: notes:
- LINODE_API_KEY env variable can be used instead - C(LINODE_API_KEY) env variable can be used instead.
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Create a server with a private IP Address - name: Create a server with a private IP Address
- local_action: linode:
module: linode module: linode
api_key: 'longStringFromLinodeApi' api_key: 'longStringFromLinodeApi'
name: linode-test1 name: linode-test1
@ -189,10 +167,10 @@ EXAMPLES = '''
wait: yes wait: yes
wait_timeout: 600 wait_timeout: 600
state: present state: present
delegate_to: localhost
# Fully configure new server - name: Fully configure new server
- local_action: linode:
module: linode
api_key: 'longStringFromLinodeApi' api_key: 'longStringFromLinodeApi'
name: linode-test1 name: linode-test1
plan: 4 plan: 4
@ -224,10 +202,10 @@ EXAMPLES = '''
- {Label: 'disk1', Size: 2500, Type: 'raw'} - {Label: 'disk1', Size: 2500, Type: 'raw'}
- {Label: 'newdisk', Size: 2000} - {Label: 'newdisk', Size: 2000}
watchdog: True watchdog: True
delegate_to: localhost
# Ensure a running server (create if missing) - name: Ensure a running server (create if missing)
- local_action: linode:
module: linode
api_key: 'longStringFromLinodeApi' api_key: 'longStringFromLinodeApi'
name: linode-test1 name: linode-test1
linode_id: 12345678 linode_id: 12345678
@ -240,30 +218,31 @@ EXAMPLES = '''
wait: yes wait: yes
wait_timeout: 600 wait_timeout: 600
state: present state: present
delegate_to: localhost
# Delete a server - name: Delete a server
- local_action: linode:
module: linode
api_key: 'longStringFromLinodeApi' api_key: 'longStringFromLinodeApi'
name: linode-test1 name: linode-test1
linode_id: 12345678 linode_id: 12345678
state: absent state: absent
delegate_to: localhost
# Stop a server - name: Stop a server
- local_action: linode:
module: linode
api_key: 'longStringFromLinodeApi' api_key: 'longStringFromLinodeApi'
name: linode-test1 name: linode-test1
linode_id: 12345678 linode_id: 12345678
state: stopped state: stopped
delegate_to: localhost
# Reboot a server - name: Reboot a server
- local_action: linode:
module: linode
api_key: 'longStringFromLinodeApi' api_key: 'longStringFromLinodeApi'
name: linode-test1 name: linode-test1
linode_id: 12345678 linode_id: 12345678
state: restarted state: restarted
delegate_to: localhost
''' '''
import os import os
@ -303,6 +282,7 @@ def randompass():
p = lower + upper + number + punct p = lower + upper + number + punct
return ''.join(random.sample(p, len(p))) return ''.join(random.sample(p, len(p)))
def getInstanceDetails(api, server): def getInstanceDetails(api, server):
''' '''
Return the details of an instance, populating IPs, etc. Return the details of an instance, populating IPs, etc.
@ -327,6 +307,7 @@ def getInstanceDetails(api, server):
'ip_id': ip['IPADDRESSID']}) 'ip_id': ip['IPADDRESSID']})
return instance return instance
def linodeServers(module, api, state, name, def linodeServers(module, api, state, name,
displaygroup, plan, additional_disks, distribution, displaygroup, plan, additional_disks, distribution,
datacenter, kernel_id, linode_id, payment_term, password, datacenter, kernel_id, linode_id, payment_term, password,
@ -378,19 +359,18 @@ def linodeServers(module, api, state, name,
# Update linode Label to match name # Update linode Label to match name
api.linode_update(LinodeId=linode_id, Label='%s_%s' % (linode_id, name)) api.linode_update(LinodeId=linode_id, Label='%s_%s' % (linode_id, name))
# Update Linode with Ansible configuration options # Update Linode with Ansible configuration options
api.linode_update(LinodeId=linode_id, api.linode_update(LinodeId=linode_id, LPM_DISPLAYGROUP=displaygroup, WATCHDOG=watchdog, **kwargs)
LPM_DISPLAYGROUP=displaygroup, WATCHDOG=watchdog, **kwargs)
# Save server # Save server
servers = api.linode_list(LinodeId=linode_id) servers = api.linode_list(LinodeId=linode_id)
except Exception as e: except Exception as e:
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
#Add private IP to Linode # Add private IP to Linode
if private_ip: if private_ip:
try: try:
res = api.linode_ip_addprivate(LinodeID=linode_id) res = api.linode_ip_addprivate(LinodeID=linode_id)
except Exception as e: except Exception as e:
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
if not disks: if not disks:
for arg in (name, linode_id, distribution): for arg in (name, linode_id, distribution):
@ -435,7 +415,7 @@ def linodeServers(module, api, state, name,
jobs.append(res['JobID']) jobs.append(res['JobID'])
except Exception as e: except Exception as e:
# TODO: destroy linode ? # TODO: destroy linode ?
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
if not configs: if not configs:
for arg in (name, linode_id, distribution): for arg in (name, linode_id, distribution):
@ -478,7 +458,7 @@ def linodeServers(module, api, state, name,
Disklist=disks_list, Label='%s config' % name) Disklist=disks_list, Label='%s config' % name)
configs = api.linode_config_list(LinodeId=linode_id) configs = api.linode_config_list(LinodeId=linode_id)
except Exception as e: except Exception as e:
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
# Start / Ensure servers are running # Start / Ensure servers are running
for server in servers: for server in servers:
@ -503,12 +483,11 @@ def linodeServers(module, api, state, name,
time.sleep(5) time.sleep(5)
if wait and wait_timeout <= time.time(): if wait and wait_timeout <= time.time():
# waiting took too long # waiting took too long
module.fail_json(msg = 'Timeout waiting on %s (lid: %s)' % module.fail_json(msg='Timeout waiting on %s (lid: %s)' % (server['LABEL'], server['LINODEID']))
(server['LABEL'], server['LINODEID']))
# Get a fresh copy of the server details # Get a fresh copy of the server details
server = api.linode_list(LinodeId=server['LINODEID'])[0] server = api.linode_list(LinodeId=server['LINODEID'])[0]
if server['STATUS'] == -2: if server['STATUS'] == -2:
module.fail_json(msg = '%s (lid: %s) failed to boot' % module.fail_json(msg='%s (lid: %s) failed to boot' %
(server['LABEL'], server['LINODEID'])) (server['LABEL'], server['LINODEID']))
# From now on we know the task is a success # From now on we know the task is a success
# Build instance report # Build instance report
@ -530,7 +509,7 @@ def linodeServers(module, api, state, name,
module.fail_json(msg='linode_id is required for stopped state') module.fail_json(msg='linode_id is required for stopped state')
if not servers: if not servers:
module.fail_json(msg = 'Server (lid: %s) not found' % (linode_id)) module.fail_json(msg='Server (lid: %s) not found' % (linode_id))
for server in servers: for server in servers:
instance = getInstanceDetails(api, server) instance = getInstanceDetails(api, server)
@ -538,7 +517,7 @@ def linodeServers(module, api, state, name,
try: try:
res = api.linode_shutdown(LinodeId=linode_id) res = api.linode_shutdown(LinodeId=linode_id)
except Exception as e: except Exception as e:
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
instance['status'] = 'Stopping' instance['status'] = 'Stopping'
changed = True changed = True
else: else:
@ -550,14 +529,14 @@ def linodeServers(module, api, state, name,
module.fail_json(msg='linode_id is required for restarted state') module.fail_json(msg='linode_id is required for restarted state')
if not servers: if not servers:
module.fail_json(msg = 'Server (lid: %s) not found' % (linode_id)) module.fail_json(msg='Server (lid: %s) not found' % (linode_id))
for server in servers: for server in servers:
instance = getInstanceDetails(api, server) instance = getInstanceDetails(api, server)
try: try:
res = api.linode_reboot(LinodeId=server['LINODEID']) res = api.linode_reboot(LinodeId=server['LINODEID'])
except Exception as e: except Exception as e:
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
instance['status'] = 'Restarting' instance['status'] = 'Restarting'
changed = True changed = True
instances.append(instance) instances.append(instance)
@ -568,7 +547,7 @@ def linodeServers(module, api, state, name,
try: try:
api.linode_delete(LinodeId=server['LINODEID'], skipChecks=True) api.linode_delete(LinodeId=server['LINODEID'], skipChecks=True)
except Exception as e: except Exception as e:
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
instance['status'] = 'Deleting' instance['status'] = 'Deleting'
changed = True changed = True
instances.append(instance) instances.append(instance)
@ -579,43 +558,43 @@ def linodeServers(module, api, state, name,
module.exit_json(changed=changed, instances=instances) module.exit_json(changed=changed, instances=instances)
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec = dict( argument_spec=dict(
state = dict(default='present', choices=['active', 'present', 'started', state=dict(type='str', default='present',
'deleted', 'absent', 'stopped', choices=['absent', 'active', 'deleted', 'present', 'restarted', 'started', 'stopped']),
'restarted']), api_key=dict(type='str', no_log=True),
api_key = dict(no_log=True), name=dict(type='str'),
name = dict(type='str'), alert_bwin_enabled=dict(type='bool'),
alert_bwin_enabled = dict(type='bool', default=None), alert_bwin_threshold=dict(type='int'),
alert_bwin_threshold = dict(type='int', default=None), alert_bwout_enabled=dict(type='bool'),
alert_bwout_enabled = dict(type='bool', default=None), alert_bwout_threshold=dict(type='int'),
alert_bwout_threshold = dict(type='int', default=None), alert_bwquota_enabled=dict(type='bool'),
alert_bwquota_enabled = dict(type='bool', default=None), alert_bwquota_threshold=dict(type='int'),
alert_bwquota_threshold = dict(type='int', default=None), alert_cpu_enabled=dict(type='bool'),
alert_cpu_enabled = dict(type='bool', default=None), alert_cpu_threshold=dict(type='int'),
alert_cpu_threshold = dict(type='int', default=None), alert_diskio_enabled=dict(type='bool'),
alert_diskio_enabled = dict(type='bool', default=None), alert_diskio_threshold=dict(type='int'),
alert_diskio_threshold = dict(type='int', default=None), backupsenabled=dict(type='int'),
backupsenabled = dict(type='int', default=None), backupweeklyday=dict(type='int'),
backupweeklyday = dict(type='int', default=None), backupwindow=dict(type='int'),
backupwindow = dict(type='int', default=None), displaygroup=dict(type='str', default=''),
displaygroup = dict(type='str', default=''), plan=dict(type='int'),
plan = dict(type='int'), additional_disks=dict(type='list'),
additional_disks= dict(type='list'), distribution=dict(type='int'),
distribution = dict(type='int'), datacenter=dict(type='int'),
datacenter = dict(type='int'), kernel_id=dict(type='int'),
kernel_id = dict(type='int'), linode_id=dict(type='int', aliases=['lid']),
linode_id = dict(type='int', aliases=['lid']), payment_term=dict(type='int', default=1, choices=[1, 12, 24]),
payment_term = dict(type='int', default=1, choices=[1, 12, 24]), password=dict(type='str', no_log=True),
password = dict(type='str', no_log=True), private_ip=dict(type='bool'),
private_ip = dict(type='bool'), ssh_pub_key=dict(type='str'),
ssh_pub_key = dict(type='str'), swap=dict(type='int', default=512),
swap = dict(type='int', default=512), wait=dict(type='bool', default=True),
wait = dict(type='bool', default=True), wait_timeout=dict(default=300),
wait_timeout = dict(default=300), watchdog=dict(type='bool', default=True),
watchdog = dict(type='bool', default=True), ),
)
) )
if not HAS_PYCURL: if not HAS_PYCURL:
@ -655,13 +634,21 @@ def main():
wait_timeout = int(module.params.get('wait_timeout')) wait_timeout = int(module.params.get('wait_timeout'))
watchdog = int(module.params.get('watchdog')) watchdog = int(module.params.get('watchdog'))
kwargs = {} kwargs = dict()
check_items = {'alert_bwin_enabled': alert_bwin_enabled, 'alert_bwin_threshold': alert_bwin_threshold, check_items = dict(
'alert_bwout_enabled': alert_bwout_enabled, 'alert_bwout_threshold': alert_bwout_threshold, alert_bwin_enabled=alert_bwin_enabled,
'alert_bwquota_enabled': alert_bwquota_enabled, 'alert_bwquota_threshold': alert_bwquota_threshold, alert_bwin_threshold=alert_bwin_threshold,
'alert_cpu_enabled': alert_cpu_enabled, 'alert_cpu_threshold': alert_cpu_threshold, alert_bwout_enabled=alert_bwout_enabled,
'alert_diskio_enabled': alert_diskio_enabled, 'alert_diskio_threshold': alert_diskio_threshold, alert_bwout_threshold=alert_bwout_threshold,
'backupweeklyday': backupweeklyday, 'backupwindow': backupwindow} alert_bwquota_enabled=alert_bwquota_enabled,
alert_bwquota_threshold=alert_bwquota_threshold,
alert_cpu_enabled=alert_cpu_enabled,
alert_cpu_threshold=alert_cpu_threshold,
alert_diskio_enabled=alert_diskio_enabled,
alert_diskio_threshold=alert_diskio_threshold,
backupweeklyday=backupweeklyday,
backupwindow=backupwindow,
)
for key, value in check_items.items(): for key, value in check_items.items():
if value is not None: if value is not None:
@ -672,14 +659,14 @@ def main():
try: try:
api_key = os.environ['LINODE_API_KEY'] api_key = os.environ['LINODE_API_KEY']
except KeyError as e: except KeyError as e:
module.fail_json(msg = 'Unable to load %s' % e.message) module.fail_json(msg='Unable to load %s' % e.message)
# setup the auth # setup the auth
try: try:
api = linode_api.Api(api_key) api = linode_api.Api(api_key)
api.test_echo() api.test_echo()
except Exception as e: except Exception as e:
module.fail_json(msg = '%s' % e.value[0]['ERRORMESSAGE']) module.fail_json(msg='%s' % e.value[0]['ERRORMESSAGE'])
linodeServers(module, api, state, name, linodeServers(module, api, state, name,
displaygroup, plan, displaygroup, plan,

1
test/sanity/pep8/legacy-files.txt
View file

@ -98,7 +98,6 @@ lib/ansible/modules/cloud/google/gce_pd.py
lib/ansible/modules/cloud/google/gce_tag.py lib/ansible/modules/cloud/google/gce_tag.py
lib/ansible/modules/cloud/google/gcpubsub.py lib/ansible/modules/cloud/google/gcpubsub.py
lib/ansible/modules/cloud/google/gcspanner.py lib/ansible/modules/cloud/google/gcspanner.py
lib/ansible/modules/cloud/linode/linode.py
lib/ansible/modules/cloud/lxc/lxc_container.py lib/ansible/modules/cloud/lxc/lxc_container.py
lib/ansible/modules/cloud/lxd/lxd_container.py lib/ansible/modules/cloud/lxd/lxd_container.py
lib/ansible/modules/cloud/lxd/lxd_profile.py lib/ansible/modules/cloud/lxd/lxd_profile.py