Модуль google.cloud.gcp_bigtable_instance — Создаёт экземпляр GCP

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

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

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

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

Обзор
Требования
Параметры
Примеры
Возвращаемые значения

Обзор

Коллекция таблиц Bigtable и ресурсов, которые их обслуживают. Все таблицы в экземпляре обслуживаются со всех кластеров в экземпляре.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
clusters список / элементы=словарь	Массив кластеров. Максимальное количество 4.
default_storage_type строка	Тип хранилища, используемый этим кластером для обслуживания таблиц родительского экземпляра, если явное переопределение отсутствует. Некоторые допустимые значения: «STORAGE_TYPE_UNSPECIFIED», «SSD», «HDD»
location строка	Расположение, где находятся узлы и хранилище этого кластера. Для наилучшей производительности клиенты должны находиться как можно ближе к этому кластеру. В настоящее время поддерживаются только зоны, поэтому значения должны иметь вид `projects/<project>/locations/<zone>`.
name строка	Уникальное имя кластера.
serve_nodes целое число	Количество узлов, выделенных для этого кластера. Больше узлов обеспечивают более высокую пропускную способность и более стабильную производительность.
display_name строка	Дескриптивное имя этого экземпляра, которое отображается в пользовательских интерфейсах. Может быть изменено в любое время, но должно быть уникальным для избежания путаницы.
env_type строка	Указывает, в какой среде Ansible вы выполняете этот модуль. Это значение не должно устанавливаться, если вы не знаете, что делаете. Это только изменяет строку User Agent для всех запросов API.
labels словарь	Метки — это гибкий и лёгкий механизм для организации ресурсов облака в группы, которые отражают организационные потребности и стратегии развертывания клиента. Они могут использоваться для фильтрации ресурсов и агрегирования метрик.
name строка	Уникальное имя экземпляра.
project строка	Проект Google Cloud Platform для использования.
scopes список / элементы=строка	Массив используемых областей видимости
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если serviceaccount выбран в качестве типа.
state строка	Существует ли данный объект в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
type строка	Тип экземпляра. По умолчанию `PRODUCTION`. Некоторые допустимые значения: «TYPE_UNSPECIFIED», «PRODUCTION», «DEVELOPMENT»

Примеры

- name: create a instance
  google.cloud.gcp_bigtable_instance:
    name: my-instance
    display_name: My Test Cluster
    clusters:
    - name: mycluster
      location: projects/test_project/locations/us-central1-a
      serve_nodes: 1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
clusters сложный	Массив кластеров. Максимальное количество 4. Возвращено: успешно
defaultStorageType строка	Тип хранилища, используемый этим кластером для обслуживания таблиц родительского экземпляра, если явно не переопределён. Возвращено: успешно
location строка	Расположение, где находятся узлы и хранилище этого кластера. Для лучшей производительности клиенты должны располагаться как можно ближе к этому кластеру. В настоящее время поддерживаются только зоны, поэтому значения должны иметь вид `projects/<project>/locations/<zone>`. Возвращено: успешно
name строка	Уникальное имя кластера. Возвращено: успешно
serveNodes целое число	Количество узлов, выделенных для этого кластера. Большее количество узлов обеспечивает более высокую пропускную способность и более стабильную производительность. Возвращено: успешно
state строка	Текущее состояние кластера. Возвращено: успешно
displayName строка	Описание имени экземпляра для отображения в пользовательском интерфейсе. Можно изменять в любое время, но следует сохранять уникальность для избежания путаницы. Возвращено: успешно
labels словарь	Метки — гибкий и лёгкий механизм для группирования ресурсов облака в группы, которые отражают организационные потребности и стратегии развертывания клиента. Они могут использоваться для фильтрации ресурсов и агрегирования метрик. Возвращено: успешно
name строка	Уникальное имя экземпляра. Возвращено: успешно
state строка	Текущее состояние экземпляра. Возвращено: успешно
type строка	Тип экземпляра. По умолчанию `PRODUCTION`. Возвращено: успешно

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на сборку

© 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/google/cloud/gcp_bigtable_instance_module.html