1b38b7c500
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: I727ed95ee480bb644b5a533f6a9526973677064c
47 lines
1016 B
Python
47 lines
1016 B
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# 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 = r'''
|
|
---
|
|
module: auth
|
|
short_description: Retrieve auth token from OpenStack cloud
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Retrieve auth token from OpenStack cloud
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Authenticate to cloud and return auth token
|
|
openstack.cloud.auth:
|
|
cloud: rax-dfw
|
|
'''
|
|
|
|
RETURN = r'''
|
|
auth_token:
|
|
description: Openstack API Auth Token
|
|
returned: success
|
|
type: str
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class AuthModule(OpenStackModule):
|
|
def run(self):
|
|
self.exit_json(changed=False,
|
|
auth_token=self.conn.auth_token)
|
|
|
|
|
|
def main():
|
|
module = AuthModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|