mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
3ba00d5a07
Clean up doc fragments a bit (#7551)
Clean up doc fragments a bit.
(cherry picked from commit a88f6f56c7)
Co-authored-by: Felix Fontein <felix@fontein.de>
65 lines
2.2 KiB
Python
65 lines
2.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2018, Huawei Inc.
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# HWC doc fragment.
|
|
DOCUMENTATION = '''
|
|
options:
|
|
identity_endpoint:
|
|
description:
|
|
- The Identity authentication URL.
|
|
type: str
|
|
required: true
|
|
user:
|
|
description:
|
|
- The user name to login with.
|
|
- Currently only user names are supported, and not user IDs.
|
|
type: str
|
|
required: true
|
|
password:
|
|
description:
|
|
- The password to login with.
|
|
type: str
|
|
required: true
|
|
domain:
|
|
description:
|
|
- The name of the Domain to scope to (Identity v3).
|
|
- Currently only domain names are supported, and not domain IDs.
|
|
type: str
|
|
required: true
|
|
project:
|
|
description:
|
|
- The name of the Tenant (Identity v2) or Project (Identity v3).
|
|
- Currently only project names are supported, and not project IDs.
|
|
type: str
|
|
required: true
|
|
region:
|
|
description:
|
|
- The region to which the project belongs.
|
|
type: str
|
|
id:
|
|
description:
|
|
- The ID of resource to be managed.
|
|
type: str
|
|
notes:
|
|
- For authentication, you can set identity_endpoint using the
|
|
E(ANSIBLE_HWC_IDENTITY_ENDPOINT) environment variable.
|
|
- For authentication, you can set user using the
|
|
E(ANSIBLE_HWC_USER) environment variable.
|
|
- For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) environment
|
|
variable.
|
|
- For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment
|
|
variable.
|
|
- For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment
|
|
variable.
|
|
- For authentication, you can set region using the E(ANSIBLE_HWC_REGION) environment variable.
|
|
- Environment variables values will only be used if the playbook values are
|
|
not set.
|
|
'''
|