gcp_spanner_instance_facts – Сбор фактов для экземпляра GCP
Новая версия 2.8.
Описание
- Сбор фактов для экземпляра GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей доступа. | |
| service_account_contents строка | Строка, представляющая содержимое JSON-файла учетной записи сервиса. Не следует передавать это значение в виде словаря, а в виде строки с точным содержимым файла service account json (действительный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON-учетной записи сервиса, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в конфигурации playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a instance facts"
gcp_spanner_instance_facts:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны в документации. Ниже представлены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| items сложный тип | всегда | Список элементов | |
| config строка | успех | Название конфигурации экземпляра (аналогичное, но не идентичное региону), определяющее географическое расположение и репликацию баз данных в этом экземпляре. Определяет, где хранятся данные. Значения обычно имеют вид `regional-europe-west1`, `us-central` и т.д. Для получения актуального списка см. [Раздел конфигурации в документации](https://cloud.google.com/spanner/docs/instances). | |
| displayName строка | успех | Дескриптивное имя этого экземпляра, как оно отображается в пользовательских интерфейсах. Должно быть уникальным для проекта и иметь длину от 4 до 30 символов. | |
| labels словарь | успех | Объект, содержащий список пар «ключ»: «значение». Пример: { "name": "ключ", "mass": "1.3кг", "count": "3" }. | |
| name строка | успех | Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Длина имени должна составлять от 6 до 30 символов. | |
| nodeCount целое число | успех | Количество узлов, выделенных для этого экземпляра. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [предварительный просмотр]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_spanner_instance_facts_module.html
