sensu.sensu_go.etcd_replicator модуль — Управление репликаторами Sensu Go etcd

Примечание

Этот модуль входит в коллекцию sensu.sensu_go (версия 1.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.etcd_replicator.

Добавлена в sensu.sensu_go 1.9.0

Описание
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление или удаление репликатора Sensu etcd.
Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/etcdreplicators/.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

python >= 2.7

Параметры

Параметр	Комментарии
api_version строка	Версия Sensu API ресурса для репликации.
auth словарь	Параметры аутентификации. Можно задавать каждый из них и через переменные окружения.
api_key строка добавлен в sensu.sensu_go 1.3.0	Ключ API, который необходимо использовать при аутентификации. Если он не задан, будет проверено значение переменной среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Для получения дополнительной информации о ключе API, обратитесь к официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path путь добавлен в sensu.sensu_go 1.5.0	Путь к пакету сертификатов CA, который должен использоваться для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать пакет сертификатов CA, используемый Python. Также этот параметр можно задать через переменную среды SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если он не задан, будет проверено значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: `"P@ssw0rd!"`
url строка	Местоположение API бэкенда Sensu. Если он не задан, будет проверено значение переменной среды SENSU_URL. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если он не задан, будет проверено значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: `"admin"`
verify логическое добавлен в sensu.sensu_go 1.5.0	Флаг, управляющий проверкой сертификатов. Если вы используете самоподписанные сертификаты, вы можете установить этот параметр в значение `false`. ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самоподписанные сертификаты в рабочей среде, используйте параметр auth.ca_path. Также этот параметр можно задать через переменную среды SENSU_VERIFY. Варианты: `false` `true` ← (по умолчанию)
ca_cert строка	Путь к сертификату CA в формате PEM, который используется для TLS-аутентификации клиента. Требуется, если insecure имеет значение `false`.
cert строка	Путь к сертификату в формате PEM, который используется для TLS-аутентификации клиента. Этот сертификат необходим для безопасного взаимодействия клиента. Требуется, если insecure имеет значение `false`.
insecure логическое	Отключить транспортную безопасность. Устанавливать в `true` только в средах разработки и экспериментов. Варианты: `false` ← (по умолчанию) `true`
key строка	Путь к файлу ключа в формате PEM, связанному с сертификатом для TLS-аутентификации клиента. Этот ключ и соответствующий сертификат необходимы для безопасного взаимодействия клиента. Требуется, если insecure имеет значение `false`.
name строка / обязательно	Имя ресурса Sensu. Это имя (в сочетании с пространством имён, если применимо) однозначно идентифицирует ресурс, с которым работает Ansible. Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его в соответствии со спецификацией в задаче. Обратитесь к спецификации атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
namespace строка	Пространство имен для ограничения репликации. Если вы не указываете пространство имен, все пространства имен для данного ресурса будут скопированы.
replication_interval целое число	Интервал, с которым будет реплицироваться ресурс. В секундах.
resource строка	Имя ресурса для репликации. Список всех ресурсов доступен по адресу https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#resources. Требуется, если state имеет значение `present`.
state строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (по умолчанию) `"absent"`
url список / элементы=строка	URL-адреса целевого кластера. Требуется, если state имеет значение `present`.

См. также

sensu.sensu_go.etcd_replicator_info: Список доступных репликаторов Sensu Go etcd.

Примеры

- name: Create a minimal replicator
  sensu.sensu_go.etcd_replicator:
    name: cluster_role_replicator
    ca_cert: /etc/sensu/certs/ca.pem
    cert: /etc/sensu/certs/cert.pem
    key: /etc/sensu/certs/key.pem
    url: https://sensu.alpha.example.com:2379
    resource: ClusterRole

- name: Create an insecure minimal replicator
  sensu.sensu_go.etcd_replicator:
    name: role_replicator
    insecure: true
    url:
      - https://sensu.beta.example.com:2379
      - https://sensu.gamma.example.com:2379
    resource: Role

- name: Create a replicator with all parameters set
  sensu.sensu_go.etcd_replicator:
    name: role_binding_replicator
    ca_cert: /etc/sensu/certs/ca.pem
    cert: /etc/sensu/certs/cert.pem
    key: /etc/sensu/certs/key.pem
    insecure: false
    url: https://127.0.0.1:2379
    api_version: core/v2
    resource: RoleBinding
    namespace: default
    replication_interval_seconds: 30

- name: Delete a replicator
  sensu.sensu_go.etcd_replicator:
    name: my_replicator
    state: absent

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
object словарь	Объект, представляющий репликатор Sensu etcd. Возвращено: success Пример: `{"api_version": "core/v2", "ca_cert": "/etc/sensu/certs/ca.pem", "cert": "/etc/sensu/certs/cert.pem", "insecure": false, "key": "/etc/sensu/certs/key.pem", "metadata": {"created_by": "admin", "name": "cluster-role-replicator"}, "namespace": "", "replication_interval_seconds": 30, "resource": "ClusterRole", "url": "https://sensu.alpha.example.com:2379"}`

Ключ

Описание

object

словарь

Объект, представляющий репликатор Sensu etcd.

Возвращено: success

Пример: {"api_version": "core/v2", "ca_cert": "/etc/sensu/certs/ca.pem", "cert": "/etc/sensu/certs/cert.pem", "insecure": false, "key": "/etc/sensu/certs/key.pem", "metadata": {"created_by": "admin", "name": "cluster-role-replicator"}, "namespace": "", "replication_interval_seconds": 30, "resource": "ClusterRole", "url": "https://sensu.alpha.example.com:2379"}

Авторы

Tadej Borovsak (@tadeboro)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/etcd_replicator_module.html