mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-23 20:29:08 +00:00
4fa82b9617
* Make all doc fragments private. * Make all plugin utils private. * Make all module utils private. * Reformat. * Changelog fragment. * Update configs and ignores. * Adjust unit test names.
57 lines
1.4 KiB
Python
57 lines
1.4 KiB
Python
# Copyright (c) 2020 FERREIRA Christophe <christophe.ferreira@cnaf.fr>
|
|
# 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
|
|
|
|
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
|
|
# Do not use this from other collections or standalone plugins/modules!
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment:
|
|
# Standard files documentation fragment
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
host:
|
|
description:
|
|
- FQDN of Nomad server.
|
|
required: true
|
|
type: str
|
|
port:
|
|
description:
|
|
- Port of Nomad server.
|
|
type: int
|
|
default: 4646
|
|
version_added: 8.0.0
|
|
use_ssl:
|
|
description:
|
|
- Use TLS/SSL connection.
|
|
type: bool
|
|
default: true
|
|
timeout:
|
|
description:
|
|
- Timeout (in seconds) for the request to Nomad.
|
|
type: int
|
|
default: 5
|
|
validate_certs:
|
|
description:
|
|
- Enable TLS/SSL certificate validation.
|
|
type: bool
|
|
default: true
|
|
client_cert:
|
|
description:
|
|
- Path of certificate for TLS/SSL.
|
|
type: path
|
|
client_key:
|
|
description:
|
|
- Path of certificate's private key for TLS/SSL.
|
|
type: path
|
|
namespace:
|
|
description:
|
|
- Namespace for Nomad.
|
|
type: str
|
|
token:
|
|
description:
|
|
- ACL token for authentication.
|
|
type: str
|
|
"""
|