mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-03-27 14:03:03 +00:00
e4be201f20
With "extends_documentation_fragment: ['openstack.cloud.openstack']" it is not necessary to list required Python libraries in section 'requirements' of DOCUMENTATION docstring in modules. Ansible will merge requirements from doc fragments and DOCUMENTATION docstring which previously resulted in duplicates such as in server module [0]: * openstacksdk * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 When removing the 'requirements' section from server module, then Ansible will list openstacksdk once only: * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 To see what documentation Ansible will produce for server module run: ansible-doc --type module openstack.cloud.server [0] https://docs.ansible.com/ansible/latest/collections/openstack/\ cloud/server_module.html Change-Id: Ia53c2c34436c7a72080602f5699e82d20f677b8b
60 lines
1.3 KiB
Python
60 lines
1.3 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: auth
|
|
short_description: Retrieve an auth token
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Retrieve an auth token from an OpenStack Cloud
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Authenticate to the cloud and retrieve the service catalog
|
|
openstack.cloud.auth:
|
|
cloud: rax-dfw
|
|
|
|
- name: Show service catalog
|
|
debug:
|
|
var: service_catalog
|
|
'''
|
|
|
|
RETURN = '''
|
|
auth_token:
|
|
description: Openstack API Auth Token
|
|
returned: success
|
|
type: str
|
|
service_catalog:
|
|
description: A dictionary of available API endpoints
|
|
returned: success
|
|
type: dict
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class AuthModule(OpenStackModule):
|
|
argument_spec = dict()
|
|
module_kwargs = dict()
|
|
|
|
def run(self):
|
|
self.exit_json(
|
|
changed=False,
|
|
ansible_facts=dict(
|
|
auth_token=self.conn.auth_token,
|
|
service_catalog=self.conn.service_catalog))
|
|
|
|
|
|
def main():
|
|
module = AuthModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|