mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-23 20:44:00 -07:00
8f8a0e1d7c
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.17) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.12) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.7) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* Adjust all __future__ imports: for i in $(grep -REl "__future__.*absolute_import" plugins/ tests/); do sed -e 's/from __future__ import .*/from __future__ import annotations/g' -i $i; done * Remove all UTF-8 encoding specifications for Python source files: for i in $(grep -REl '[-][*]- coding: utf-8 -[*]-' plugins/ tests/); do sed -e '/^# -\*- coding: utf-8 -\*-/d' -i $i; done * Remove __metaclass__ = type: for i in $(grep -REl '__metaclass__ = type' plugins/ tests/); do sed -e '/^__metaclass__ = type/d' -i $i; done
55 lines
1.3 KiB
Python
55 lines
1.3 KiB
Python
# Copyright (c) Ansible project
|
|
# 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 annotations
|
|
|
|
|
|
class ModuleDocFragment:
|
|
# Common parameters for Consul modules
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
host:
|
|
description:
|
|
- Host of the Consul agent.
|
|
default: localhost
|
|
type: str
|
|
port:
|
|
type: int
|
|
description:
|
|
- The port on which the consul agent is running.
|
|
default: 8500
|
|
scheme:
|
|
description:
|
|
- The protocol scheme on which the Consul agent is running. Defaults to V(http) and can be set to V(https) for secure
|
|
connections.
|
|
default: http
|
|
type: str
|
|
validate_certs:
|
|
type: bool
|
|
description:
|
|
- Whether to verify the TLS certificate of the Consul agent.
|
|
default: true
|
|
ca_path:
|
|
description:
|
|
- The CA bundle to use for https connections.
|
|
type: str
|
|
"""
|
|
|
|
TOKEN = r"""
|
|
options:
|
|
token:
|
|
description:
|
|
- The token to use for authorization.
|
|
type: str
|
|
"""
|
|
|
|
ACTIONGROUP_CONSUL = r"""
|
|
options: {}
|
|
attributes:
|
|
action_group:
|
|
description: Use C(group/community.general.consul) in C(module_defaults) to set defaults for this module.
|
|
support: full
|
|
membership:
|
|
- community.general.consul
|
|
"""
|