google.cloud.gcp_bigtable_instance – Создаёт экземпляр GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для его установки используйте: 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 строка / обязательно |
| Тип используемых учетных данных. | |
| 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 | |
| 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 сложный | success | Массив кластеров. Максимальное количество 4. | |
| defaultStorageType строка | success | Тип хранилища, используемого этим кластером для обслуживания таблиц родительского экземпляра, если явно не переопределён. | |
| location строка | success | Расположение узлов и хранилища этого кластера. Для лучшей производительности клиенты должны располагаться как можно ближе к этому кластеру. В настоящее время поддерживаются только зоны, поэтому значения должны иметь вид `projects/<project>/locations/<zone>`. | |
| name строка | success | Уникальное имя кластера. | |
| serveNodes целое число | success | Количество узлов, выделенных этому кластеру. Большее количество узлов обеспечивает более высокую пропускную способность и более стабильную производительность. | |
| state строка | success | Текущее состояние кластера. | |
| displayName строка | success | Дескриптивное имя для этого экземпляра, отображаемое в пользовательских интерфейсах. Можно изменить в любое время, но следует сохранять уникальность в глобальном масштабе, чтобы избежать путаницы. | |
| labels словарь | success | Метки — это гибкий и легкий механизм для группирования ресурсов облака в группы, которые отражают потребности организации клиента и стратегии развертывания. Их можно использовать для фильтрации ресурсов и агрегирования метрик. | |
| name строка | success | Уникальное имя экземпляра. | |
| state строка | success | Текущее состояние экземпляра. | |
| type строка | success | Тип экземпляра. По умолчанию `PRODUCTION`. | |
Авторы
- 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.10/collections/google/cloud/gcp_bigtable_instance_module.html