mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-05-07 13:53:15 +00:00
Migrate openstack modules as a collection
Migrate accordin to Ansible guidelines [1[]] and tool migrate.py [2] Also fixed ALL ansible-test sanity issues Add pep8 and linter job with runs ansible-test sanity test. [1] https://etherpad.openstack.org/p/openstack-ansible-modules [2] https://github.com/ansible-community/collection_migration Change-Id: Ib2b1c8f23aacfca95304132bfe5c4cdedbea0520
This commit is contained in:
Sagi Shnaidman
214
plugins/modules/os_project.py
Normal file
214
plugins/modules/os_project.py
Normal file
@@ -0,0 +1,214 @@
|
||||
#!/usr/bin/python
|
||||
# Copyright (c) 2015 IBM Corporation
|
||||
# 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: os_project
|
||||
short_description: Manage OpenStack Projects
|
||||
author: "Alberto Gireud (@agireud)"
|
||||
description:
|
||||
- Manage OpenStack Projects. Projects can be created,
|
||||
updated or deleted using this module. A project will be updated
|
||||
if I(name) matches an existing project and I(state) is present.
|
||||
The value for I(name) cannot be updated without deleting and
|
||||
re-creating the project.
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name for the project
|
||||
required: true
|
||||
description:
|
||||
description:
|
||||
- Description for the project
|
||||
domain_id:
|
||||
description:
|
||||
- Domain id to create the project in if the cloud supports domains.
|
||||
aliases: ['domain']
|
||||
enabled:
|
||||
description:
|
||||
- Is the project enabled
|
||||
type: bool
|
||||
default: 'yes'
|
||||
state:
|
||||
description:
|
||||
- Should the resource be present or absent.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
availability_zone:
|
||||
description:
|
||||
- Ignored. Present for backwards compatibility
|
||||
requirements:
|
||||
- "python >= 2.7"
|
||||
- "openstacksdk"
|
||||
|
||||
extends_documentation_fragment:
|
||||
- openstack.cloud.openstack
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Create a project
|
||||
- os_project:
|
||||
cloud: mycloud
|
||||
endpoint_type: admin
|
||||
state: present
|
||||
name: demoproject
|
||||
description: demodescription
|
||||
domain_id: demoid
|
||||
enabled: True
|
||||
|
||||
# Delete a project
|
||||
- os_project:
|
||||
cloud: mycloud
|
||||
endpoint_type: admin
|
||||
state: absent
|
||||
name: demoproject
|
||||
'''
|
||||
|
||||
|
||||
RETURN = '''
|
||||
project:
|
||||
description: Dictionary describing the project.
|
||||
returned: On success when I(state) is 'present'
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description: Project ID
|
||||
type: str
|
||||
sample: "f59382db809c43139982ca4189404650"
|
||||
name:
|
||||
description: Project name
|
||||
type: str
|
||||
sample: "demoproject"
|
||||
description:
|
||||
description: Project description
|
||||
type: str
|
||||
sample: "demodescription"
|
||||
enabled:
|
||||
description: Boolean to indicate if project is enabled
|
||||
type: bool
|
||||
sample: True
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import (openstack_full_argument_spec,
|
||||
openstack_module_kwargs,
|
||||
openstack_cloud_from_module)
|
||||
|
||||
|
||||
def _needs_update(module, project):
|
||||
keys = ('description', 'enabled')
|
||||
for key in keys:
|
||||
if module.params[key] is not None and module.params[key] != project.get(key):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def _system_state_change(module, project):
|
||||
state = module.params['state']
|
||||
if state == 'present':
|
||||
if project is None:
|
||||
changed = True
|
||||
else:
|
||||
if _needs_update(module, project):
|
||||
changed = True
|
||||
else:
|
||||
changed = False
|
||||
|
||||
elif state == 'absent':
|
||||
if project is None:
|
||||
changed = False
|
||||
else:
|
||||
changed = True
|
||||
|
||||
return changed
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = openstack_full_argument_spec(
|
||||
name=dict(required=True),
|
||||
description=dict(required=False, default=None),
|
||||
domain_id=dict(required=False, default=None, aliases=['domain']),
|
||||
enabled=dict(default=True, type='bool'),
|
||||
state=dict(default='present', choices=['absent', 'present'])
|
||||
)
|
||||
|
||||
module_kwargs = openstack_module_kwargs()
|
||||
module = AnsibleModule(
|
||||
argument_spec,
|
||||
supports_check_mode=True,
|
||||
**module_kwargs
|
||||
)
|
||||
|
||||
name = module.params['name']
|
||||
description = module.params['description']
|
||||
domain = module.params.get('domain_id')
|
||||
enabled = module.params['enabled']
|
||||
state = module.params['state']
|
||||
|
||||
sdk, cloud = openstack_cloud_from_module(module)
|
||||
try:
|
||||
if domain:
|
||||
try:
|
||||
# We assume admin is passing domain id
|
||||
dom = cloud.get_domain(domain)['id']
|
||||
domain = dom
|
||||
except Exception:
|
||||
# If we fail, maybe admin is passing a domain name.
|
||||
# Note that domains have unique names, just like id.
|
||||
try:
|
||||
dom = cloud.search_domains(filters={'name': domain})[0]['id']
|
||||
domain = dom
|
||||
except Exception:
|
||||
# Ok, let's hope the user is non-admin and passing a sane id
|
||||
pass
|
||||
|
||||
if domain:
|
||||
project = cloud.get_project(name, domain_id=domain)
|
||||
else:
|
||||
project = cloud.get_project(name)
|
||||
|
||||
if module.check_mode:
|
||||
module.exit_json(changed=_system_state_change(module, project))
|
||||
|
||||
if state == 'present':
|
||||
if project is None:
|
||||
project = cloud.create_project(
|
||||
name=name, description=description,
|
||||
domain_id=domain,
|
||||
enabled=enabled)
|
||||
changed = True
|
||||
else:
|
||||
if _needs_update(module, project):
|
||||
project = cloud.update_project(
|
||||
project['id'], description=description,
|
||||
enabled=enabled)
|
||||
changed = True
|
||||
else:
|
||||
changed = False
|
||||
module.exit_json(changed=changed, project=project)
|
||||
|
||||
elif state == 'absent':
|
||||
if project is None:
|
||||
changed = False
|
||||
else:
|
||||
cloud.delete_project(project['id'])
|
||||
changed = True
|
||||
module.exit_json(changed=changed)
|
||||
|
||||
except sdk.exceptions.OpenStackCloudException as e:
|
||||
module.fail_json(msg=e.message, extra_data=e.extra_data)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in New Issue
Block a user