Модуль google.cloud.gcp_bigtable_instance — создание экземпляра GCP

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
clusters list / элементы=dictionary	Массив кластеров. Максимум 4.
default_storage_type string	Тип хранилища, используемого этим кластером для обслуживания таблиц родительского экземпляра, если он не переопределен явно. Допустимые варианты: “STORAGE_TYPE_UNSPECIFIED”, “SSD”, “HDD”
location string	Расположение узлов и хранилища этого кластера. Для оптимальной производительности клиенты должны находиться как можно ближе к кластеру. В настоящее время поддерживаются только зоны, поэтому значения должны иметь формат `projects/<project>/locations/<zone>`.
name string	Уникальное имя кластера.
serve_nodes integer	Количество узлов, выделенных этому кластеру. Большее количество узлов обеспечивает более высокую пропускную способность и стабильную производительность.
display_name string	Понятное имя экземпляра, отображаемое в пользовательских интерфейсах. Его можно изменить в любое время, но во избежание путаницы оно должно быть уникальным в глобальном масштабе.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для запросов API.
labels dictionary	Метки — это гибкий и простой механизм организации облачных ресурсов в группы, соответствующие организационным потребностям и стратегиям развертывания клиента. Их можно использовать для фильтрации ресурсов и агрегирования метрик.
name string	Уникальное имя экземпляра.
project string	Проект Google Cloud Platform, который будет использоваться.
scopes list / элементы=string	Массив используемых областей доступа
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы: словарь или строка JSON, представляющая его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
type string	Тип экземпляра. По умолчанию — `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 complex	Массив кластеров. Максимум 4. Возвращается: при успехе
defaultStorageType string	Тип хранилища, используемого этим кластером для обслуживания таблиц родительского экземпляра, если он не переопределен явно. Возвращается: при успехе
location string	Расположение узлов и хранилища этого кластера. Для оптимальной производительности клиенты должны находиться как можно ближе к кластеру. В настоящее время поддерживаются только зоны, поэтому значения должны иметь формат `projects/<project>/locations/<zone>`. Возвращается: при успехе
name string	Уникальное имя кластера. Возвращается: при успехе
serveNodes integer	Количество узлов, выделенных этому кластеру. Большее количество узлов обеспечивает более высокую пропускную способность и стабильную производительность. Возвращается: при успехе
state string	Текущее состояние кластера. Возвращается: при успехе
displayName string	Понятное имя экземпляра, отображаемое в пользовательских интерфейсах. Его можно изменить в любое время, но во избежание путаницы оно должно быть уникальным в глобальном масштабе. Возвращается: при успехе
labels dictionary	Метки — это гибкий и простой механизм организации облачных ресурсов в группы, соответствующие организационным потребностям и стратегиям развертывания клиента. Их можно использовать для фильтрации ресурсов и агрегирования метрик. Возвращается: при успехе
name string	Уникальное имя экземпляра. Возвращается: при успехе
state string	Текущее состояние экземпляра. Возвращается: при успехе
type string	Тип экземпляра. По умолчанию — `PRODUCTION`. Возвращается: при успехе

Авторы

Google Inc. (@googlecloudplatform)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_bigtable_instance_module.html