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

Примечание

Этот плагин является частью коллекции google.cloud (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install google.cloud.

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

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

Обзор

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

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно		Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
clusters список / элементы=словарь			Массив кластеров. Максимально 4.
	default_storage_type строка		Тип хранилища, используемый этим кластером для обслуживания таблиц родительского экземпляра, если явно не переопределён. Некоторые допустимые значения: "STORAGE_TYPE_UNSPECIFIED", "SSD", "HDD"
	location строка		Расположение узлов и хранилища этого кластера. Для лучшей производительности клиенты должны располагаться как можно ближе к этому кластеру. В настоящее время поддерживаются только зоны, поэтому значения должны иметь вид `projects/<проект>/locations/<зона>`.
	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 строка		Варианты: present ← absent	Требуется ли существование данного объекта в GCP
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_bigtable_instance_module.html