6.1.0

library/decort_jwt.py

@@ -1,86 +1,10 @@
 #!/usr/bin/python
-#
-# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
-#
-# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
-#
 
-#
-# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
-#
-
-ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
-                    'supported_by': 'community'}
-
-DOCUMENTATION = '''
+DOCUMENTATION = r'''
 ---
 module: decort_jwt
-short_description: Obtain access token to be used for authentication to DECORT cloud controller
-description:
-     - Obtain JWT (JSON Web Token) from the specified Oauth2 provider. This JWT can be used in subsequent DECS modules'
-       invocations to authenticate them to the DECS cloud controller.
-version_added: "2.4"
-author: "Sergey Shubin (sergey.shubin@digitalenergy.online)"
-notes:
-     - Environment variables can be used to pass parameters to the module (see options below for details).
-     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
-     - 'If you register module output as I(my_jwt), the JWT value is accessed as I(my_jwt.jwt)'
-requirements:
-     - python >= 2.6
-     - PyJWT module
-     - requests module
-     - decort_utils utility library (module)
-     - DECORT cloud platform version 3.6.1 or higher
-options:
-    app_id:
-        description:
-        - 'Application ID for authenticating to the Oauth2 provider specified in I(oauth2_url).'
-        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
-           environment variable.'
-        required: no
-    app_secret:
-        description:
-        - 'Application API secret used for authenticating to the Oauth2 provider specified in I(oauth2_url).'
-        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
-           environment variable.'
-        required: no
-    oauth2_url:
-        description:
-        - 'URL of the oauth2 authentication provider to obtain JWT from.'
-        - If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.
-    validity:
-        description:
-        - Validity of the JWT in seconds. Default value is 3600 (one hour).
-        required: no
-    verify_ssl:
-        description:
-        - 'Controls SSL verification mode when making API calls to DECS controller. Set it to False if you
-         want to disable SSL certificate verification.'
-        - `Intended use case is when you run module in a trusted environment that uses self-signed certificates. 
-         Note that disabling SSL verification in any other scenario can lead to security issues, so please use 
-         with caution.'
-        default: True
-        required: no
-'''
 
-EXAMPLES = '''
-- name: Obtain JWT and store it as my_jwt for authenticating subsequent task to DECORT cloud controller
-  decort_jwt:
-    app_id: "{{ my_app_id }}"
-    app_secret: "{{ my_app_secret }}"
-    oauth2_url: https://sso.decs.online
-    delegate_to: localhost
-    register: my_jwt
-'''
-
-RETURN = '''
-jwt:
-    description: JSON Web Token that can be used to access DECS cloud controller
-    returned: always
-    type: string
-    sample: None
+description: See L(Module Documentation,https://repository.basistech.ru/BASIS/decort-ansible/wiki/Home).
 '''
 
 import requests
@@ -88,6 +12,7 @@ import requests
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.basic import env_fallback
 
+
 def decort_jwt_parameters():
     """Build and return a dictionary of parameters expected by decort_jwt module in a form accepted
     by AnsibleModule utility class"""