mirror of
https://github.com/ansible/awx.git
synced 2026-01-11 10:00:01 -03:30
55a7591f89
Bump migrations and delete some files Resolve remaining conflicts Fix requirements Flake8 fixes Prefer devel changes for schema Use correct versions Remove sso connected stuff Update to modern actions and collection fixes Remove unwated alias Version problems in actions Fix more versioning problems Update warning string Messed it up again Shorten exception More removals Remove pbr license Remove tests deleted in devel Remove unexpected files Remove some content missed in the rebase Use sleep_task from devel Restore devel live conftest file Add in settings that got missed Prefer devel version of collection test Finish repairing .github path Remove unintended test file duplication Undo more unintended file additions
371 lines
13 KiB
Python
371 lines
13 KiB
Python
#!/usr/bin/python
|
|
# coding: utf-8 -*-
|
|
|
|
|
|
# (c) 2020, John Westcott IV <john.westcott.iv@redhat.com>
|
|
# 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
|
|
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: schedule
|
|
author: "John Westcott IV (@john-westcott-iv)"
|
|
short_description: create, update, or destroy Automation Platform Controller schedules.
|
|
description:
|
|
- Create, update, or destroy Automation Platform Controller schedules. See
|
|
U(https://www.ansible.com/tower) for an overview.
|
|
options:
|
|
rrule:
|
|
description:
|
|
- A value representing the schedules iCal recurrence rule.
|
|
- See rrule plugin for help constructing this value
|
|
required: False
|
|
type: str
|
|
name:
|
|
description:
|
|
- Name of this schedule.
|
|
required: True
|
|
type: str
|
|
new_name:
|
|
description:
|
|
- Setting this option will change the existing name (looked up via the name field.
|
|
required: False
|
|
type: str
|
|
description:
|
|
description:
|
|
- Optional description of this schedule.
|
|
required: False
|
|
type: str
|
|
execution_environment:
|
|
description:
|
|
- Execution Environment name, ID, or named URL applied as a prompt, assuming job template prompts for execution environment
|
|
type: str
|
|
extra_data:
|
|
description:
|
|
- Specify C(extra_vars) for the template.
|
|
required: False
|
|
type: dict
|
|
forks:
|
|
description:
|
|
- Forks applied as a prompt, assuming job template prompts for forks
|
|
type: int
|
|
instance_groups:
|
|
description:
|
|
- List of Instance Group names, IDs, or named URLs applied as a prompt, assuming job template prompts for instance groups
|
|
type: list
|
|
elements: str
|
|
inventory:
|
|
description:
|
|
- Inventory name, ID, or named URL applied as a prompt, assuming job template prompts for inventory
|
|
required: False
|
|
type: str
|
|
job_slice_count:
|
|
description:
|
|
- Job Slice Count applied as a prompt, assuming job template prompts for job slice count
|
|
type: int
|
|
labels:
|
|
description:
|
|
- List of labels applied as a prompt, assuming job template prompts for labels
|
|
type: list
|
|
elements: str
|
|
credentials:
|
|
description:
|
|
- List of credential names, IDs, or named URLs applied as a prompt, assuming job template prompts for credentials
|
|
type: list
|
|
elements: str
|
|
scm_branch:
|
|
description:
|
|
- Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
|
|
required: False
|
|
type: str
|
|
timeout:
|
|
description:
|
|
- Timeout applied as a prompt, assuming job template prompts for timeout
|
|
type: int
|
|
job_type:
|
|
description:
|
|
- The job type to use for the job template.
|
|
required: False
|
|
type: str
|
|
choices:
|
|
- 'run'
|
|
- 'check'
|
|
job_tags:
|
|
description:
|
|
- Comma separated list of the tags to use for the job template.
|
|
required: False
|
|
type: str
|
|
skip_tags:
|
|
description:
|
|
- Comma separated list of the tags to skip for the job template.
|
|
required: False
|
|
type: str
|
|
limit:
|
|
description:
|
|
- A host pattern to further constrain the list of hosts managed or affected by the playbook
|
|
required: False
|
|
type: str
|
|
diff_mode:
|
|
description:
|
|
- Enable diff mode for the job template.
|
|
required: False
|
|
type: bool
|
|
verbosity:
|
|
description:
|
|
- Control the output level Ansible produces as the playbook runs. 0 - Normal, 1 - Verbose, 2 - More Verbose, 3 - Debug, 4 - Connection Debug.
|
|
required: False
|
|
type: int
|
|
choices:
|
|
- 0
|
|
- 1
|
|
- 2
|
|
- 3
|
|
- 4
|
|
- 5
|
|
unified_job_template:
|
|
description:
|
|
- Name, ID, or named URL of unified job template to schedule. Used to look up an already existing schedule.
|
|
required: False
|
|
type: str
|
|
organization:
|
|
description:
|
|
- The organization name, ID, or named URL the unified job template exists in.
|
|
- Used for looking up the unified job template, not a direct model field.
|
|
type: str
|
|
enabled:
|
|
description:
|
|
- Enables processing of this schedule.
|
|
required: False
|
|
type: bool
|
|
state:
|
|
description:
|
|
- Desired state of the resource.
|
|
choices: ["present", "absent", "exists"]
|
|
default: "present"
|
|
type: str
|
|
extends_documentation_fragment: awx.awx.auth
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Build a schedule for Demo Job Template
|
|
schedule:
|
|
name: "{{ sched1 }}"
|
|
state: present
|
|
unified_job_template: "Demo Job Template"
|
|
rrule: "DTSTART:20191219T130551Z RRULE:FREQ=WEEKLY;INTERVAL=1;COUNT=1"
|
|
register: result
|
|
|
|
- name: Build the same schedule using the rrule plugin
|
|
schedule:
|
|
name: "{{ sched1 }}"
|
|
state: present
|
|
unified_job_template: "Demo Job Template"
|
|
rrule: "{{ query('awx.awx.schedule_rrule', 'week', start_date='2019-12-19 13:05:51') | first }}"
|
|
register: result
|
|
|
|
- name: Build a complex schedule for every day except sunday using the rruleset plugin
|
|
schedule:
|
|
name: "{{ sched1 }}"
|
|
state: present
|
|
unified_job_template: "Demo Job Template"
|
|
rrule: "{{ query(awx.awx.schedule_rruleset, '2022-04-30 10:30:45', rules=rrules, timezone='UTC' ) | first }}"
|
|
vars:
|
|
rrules:
|
|
- frequency: 'day'
|
|
interval: 1
|
|
- frequency: 'day'
|
|
interval: 1
|
|
byweekday: 'sunday'
|
|
include: false
|
|
|
|
- name: Delete 'my_schedule' schedule for my_workflow
|
|
schedule:
|
|
name: "my_schedule"
|
|
state: absent
|
|
unified_job_template: my_workflow
|
|
'''
|
|
|
|
from ..module_utils.controller_api import ControllerAPIModule
|
|
|
|
|
|
def main():
|
|
# Any additional arguments that are not fields of the item can be added here
|
|
argument_spec = dict(
|
|
rrule=dict(),
|
|
name=dict(required=True),
|
|
new_name=dict(),
|
|
description=dict(),
|
|
execution_environment=dict(type='str'),
|
|
extra_data=dict(type='dict'),
|
|
forks=dict(type='int'),
|
|
instance_groups=dict(type='list', elements='str'),
|
|
inventory=dict(),
|
|
job_slice_count=dict(type='int'),
|
|
labels=dict(type='list', elements='str'),
|
|
timeout=dict(type='int'),
|
|
credentials=dict(type='list', elements='str'),
|
|
scm_branch=dict(),
|
|
job_type=dict(choices=['run', 'check']),
|
|
job_tags=dict(),
|
|
skip_tags=dict(),
|
|
limit=dict(),
|
|
diff_mode=dict(type='bool'),
|
|
verbosity=dict(type='int', choices=[0, 1, 2, 3, 4, 5]),
|
|
unified_job_template=dict(),
|
|
organization=dict(),
|
|
enabled=dict(type='bool'),
|
|
state=dict(choices=['present', 'absent', 'exists'], default='present'),
|
|
)
|
|
|
|
# Create a module for ourselves
|
|
module = ControllerAPIModule(argument_spec=argument_spec)
|
|
|
|
# Extract our parameters
|
|
rrule = module.params.get('rrule')
|
|
name = module.params.get('name')
|
|
new_name = module.params.get("new_name")
|
|
description = module.params.get('description')
|
|
execution_environment = module.params.get('execution_environment')
|
|
extra_data = module.params.get('extra_data')
|
|
forks = module.params.get('forks')
|
|
instance_groups = module.params.get('instance_groups')
|
|
inventory = module.params.get('inventory')
|
|
job_slice_count = module.params.get('job_slice_count')
|
|
labels = module.params.get('labels')
|
|
timeout = module.params.get('timeout')
|
|
credentials = module.params.get('credentials')
|
|
scm_branch = module.params.get('scm_branch')
|
|
job_type = module.params.get('job_type')
|
|
job_tags = module.params.get('job_tags')
|
|
skip_tags = module.params.get('skip_tags')
|
|
limit = module.params.get('limit')
|
|
diff_mode = module.params.get('diff_mode')
|
|
verbosity = module.params.get('verbosity')
|
|
unified_job_template = module.params.get('unified_job_template')
|
|
organization = module.params.get('organization')
|
|
enabled = module.params.get('enabled')
|
|
state = module.params.get('state')
|
|
|
|
# Attempt to look up the related items the user specified (these will fail the module if not found)
|
|
inventory_id = None
|
|
if inventory:
|
|
inventory_id = module.resolve_name_to_id('inventories', inventory)
|
|
search_fields = {}
|
|
sched_search_fields = {}
|
|
if organization:
|
|
search_fields['organization'] = module.resolve_name_to_id('organizations', organization)
|
|
unified_job_template_id = None
|
|
if unified_job_template:
|
|
search_fields['name'] = unified_job_template
|
|
unified_job_template_id = module.get_one('unified_job_templates', **{'data': search_fields})['id']
|
|
sched_search_fields['unified_job_template'] = unified_job_template_id
|
|
|
|
# Attempt to look up an existing item based on the provided data
|
|
existing_item = module.get_one('schedules', name_or_id=name, check_exists=(state == 'exists'), **{'data': sched_search_fields})
|
|
|
|
if state == 'absent':
|
|
# If the state was absent we can let the module delete it if needed, the module will handle exiting from this
|
|
module.delete_if_needed(existing_item)
|
|
|
|
# We need to clear out the name from the search fields so we can use name_or_id in the following searches
|
|
if 'name' in search_fields:
|
|
del search_fields['name']
|
|
|
|
# Create the data that gets sent for create and update
|
|
new_fields = {}
|
|
if execution_environment is not None:
|
|
if execution_environment == '':
|
|
new_fields['execution_environment'] = ''
|
|
else:
|
|
ee = module.get_one('execution_environments', name_or_id=execution_environment, **{'data': search_fields})
|
|
if ee is None:
|
|
ee2 = module.get_one('execution_environments', name_or_id=execution_environment)
|
|
if ee2 is None or ee2['organization'] is not None:
|
|
module.fail_json(msg='could not find execution_environment entry with name {0}'.format(execution_environment))
|
|
else:
|
|
new_fields['execution_environment'] = ee2['id']
|
|
else:
|
|
new_fields['execution_environment'] = ee['id']
|
|
|
|
association_fields = {}
|
|
|
|
if credentials is not None:
|
|
association_fields['credentials'] = []
|
|
for item in credentials:
|
|
association_fields['credentials'].append(module.resolve_name_to_id('credentials', item))
|
|
|
|
# We need to clear out the organization from the search fields the searches for labels and instance_groups doesnt support it and won't be needed anymore
|
|
if 'organization' in search_fields:
|
|
del search_fields['organization']
|
|
|
|
if labels is not None:
|
|
association_fields['labels'] = []
|
|
for item in labels:
|
|
label_id = module.get_one('labels', name_or_id=item, **{'data': search_fields})
|
|
if label_id is None:
|
|
module.fail_json(msg='Could not find label entry with name {0}'.format(item))
|
|
else:
|
|
association_fields['labels'].append(label_id['id'])
|
|
|
|
if instance_groups is not None:
|
|
association_fields['instance_groups'] = []
|
|
for item in instance_groups:
|
|
instance_group_id = module.get_one('instance_groups', name_or_id=item, **{'data': search_fields})
|
|
if instance_group_id is None:
|
|
module.fail_json(msg='Could not find instance_group entry with name {0}'.format(item))
|
|
else:
|
|
association_fields['instance_groups'].append(instance_group_id['id'])
|
|
|
|
if rrule is not None:
|
|
new_fields['rrule'] = rrule
|
|
new_fields['name'] = new_name if new_name else (module.get_item_name(existing_item) if existing_item else name)
|
|
if description is not None:
|
|
new_fields['description'] = description
|
|
if extra_data is not None:
|
|
new_fields['extra_data'] = extra_data
|
|
if inventory is not None:
|
|
new_fields['inventory'] = inventory_id
|
|
if scm_branch is not None:
|
|
new_fields['scm_branch'] = scm_branch
|
|
if job_type is not None:
|
|
new_fields['job_type'] = job_type
|
|
if job_tags is not None:
|
|
new_fields['job_tags'] = job_tags
|
|
if skip_tags is not None:
|
|
new_fields['skip_tags'] = skip_tags
|
|
if limit is not None:
|
|
new_fields['limit'] = limit
|
|
if diff_mode is not None:
|
|
new_fields['diff_mode'] = diff_mode
|
|
if verbosity is not None:
|
|
new_fields['verbosity'] = verbosity
|
|
if unified_job_template is not None:
|
|
new_fields['unified_job_template'] = unified_job_template_id
|
|
if enabled is not None:
|
|
new_fields['enabled'] = enabled
|
|
if forks is not None:
|
|
new_fields['forks'] = forks
|
|
if job_slice_count is not None:
|
|
new_fields['job_slice_count'] = job_slice_count
|
|
if timeout is not None:
|
|
new_fields['timeout'] = timeout
|
|
|
|
# If the state was present and we can let the module build or update the existing item, this will return on its own
|
|
module.create_or_update_if_needed(
|
|
existing_item,
|
|
new_fields,
|
|
endpoint='schedules',
|
|
item_type='schedule',
|
|
associations=association_fields,
|
|
)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|