google.cloud.gcp_compute_reservation – Создаёт резервацию GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_reservation.
Описание
- Представляет ресурс резервирования. Резервирование гарантирует выделение ресурсов в определённой зоне, даже если зарезервированные виртуальные машины не запущены.
- Резервирование применяется только к виртуальным машинам Compute Engine, Cloud Dataproc и Google Kubernetes Engine. Резервирование не применяется к
f1-microилиg1-smallтипам машин, предварительно зарезервированным виртуальным машинам, узлам с эксклюзивным теннантом или другим службам, не перечисленным выше, таким как Cloud SQL и Dataflow.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |||
| description строка | Необязательное описание этого ресурса. | ||||
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API. | ||||
| name строка / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна составлять 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||||
| project строка | Проект Google Cloud Platform, который будет использоваться. | ||||
| scopes список / элементы=строка | Массив используемых областей видимости | ||||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, представленное либо в виде словаря, либо как строка JSON, его представляющая. | ||||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана учетная запись службы. | ||||
| specific_reservation словарь / обязательно | Резервирование экземпляров с конкретными форматами машин. | ||||
| count целое число / обязательно | Количество выделенных ресурсов. | ||||
| instance_properties словарь / обязательно | Свойства экземпляра для резервирования. | ||||
| guest_accelerators список / элементы=словарь | Тип и количество ускорителей гостевой среды. | ||||
| accelerator_count целое число / обязательно | Количество карт ускорителей гостевой среды, подключённых к этому экземпляру. | ||||
| accelerator_type строка / обязательно | Полный или частичный URL типа ускорителя, который необходимо подключить к этому экземпляру. Например: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100`. Если вы создаёте шаблон экземпляра, укажите только имя ускорителя. | ||||
| local_ssds список / элементы=словарь | Объём локального SSD для резервирования с каждым экземпляром. Это резервирует диски типа `local-ssd`. | ||||
| disk_size_gb целое число / обязательно | Размер диска в ГБ (двоичная система). | ||||
| interface строка | Значение по умолчанию: "SCSI" | Интерфейс диска для подключения этого диска. Некоторые допустимые значения: "SCSI", "NVME" | |||
| machine_type строка / обязательно | Имя типа машины для резервирования. | ||||
| min_cpu_platform строка | Минимальная платформа процессора для резервирования. Например, `"Intel Skylake"`. См. https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones для получения информации о доступных платформах процессоров. | ||||
| specific_reservation_required логическое значение |
"false" | При значении true, только виртуальные машины, нацеленные на это резервирование по имени, могут использовать это резервирование. В противном случае, им могут воспользоваться виртуальные машины с настройкой для любого резервирования. По умолчанию false. | |||
| state строка |
| Необходимо ли данному объекту существовать в GCP | |||
| zone строка / обязательно | Зона, в которой создаётся резервирование. | ||||
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/reservations
- Резервирование зональных ресурсов: https://cloud.google.com/compute/docs/instances/reserving-zonal-resources
- для аутентификации можно установить service_account_file с помощью переменной среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a reservation
google.cloud.gcp_compute_reservation:
name: test_object
zone: us-central1-a
specific_reservation:
count: 1
instance_properties:
min_cpu_platform: Intel Cascade Lake
machine_type: n2-standard-2
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| commitment string | success | Полный или частичный URL родительского обязательства. Это поле отображается для бронирований, привязанных к обязательству. | |||
| creationTimestamp string | success | Маркер создания в формате RFC3339. | |||
| description string | success | Необязательное описание этого ресурса. | |||
| id integer | success | Уникальный идентификатор ресурса. | |||
| name string | success | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |||
| specificReservation complex | success | Бронирование для экземпляров с конкретными форматами машин. | |||
| count integer | success | Количество выделенных ресурсов. | |||
| instanceProperties complex | success | Свойства экземпляра для бронирования. | |||
| guestAccelerators complex | success | Тип и количество ускорителей гостя. | |||
| acceleratorCount integer | success | Количество карт ускорителей гостя, доступных для этого экземпляра. | |||
| acceleratorType string | success | Полный или частичный URL типа ускорителя для подключения к этому экземпляру. Например: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100` Если вы создаете шаблон экземпляра, укажите только имя ускорителя. | |||
| localSsds complex | success | Количество локальных SSD для резервирования с каждым экземпляром. Это резервирует диски типа `local-ssd`. | |||
| diskSizeGb integer | success | Размер диска в GB (в двоичной системе). | |||
| interface string | success | Интерфейс диска для подключения этого диска. | |||
| machineType string | success | Имя типа машины для резервирования. | |||
| minCpuPlatform string | success | Минимальная платформа процессора для резервирования. Например, `"Intel Skylake"`. См. https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones для получения информации о доступных платформах процессоров. | |||
| inUseCount integer | success | Количество используемых экземпляров. | |||
| specificReservationRequired boolean | success | Если установлено в значение true, то только виртуальные машины, нацеленные на это бронирование по имени, могут использовать это бронирование. В противном случае, им может быть использовано бронирование с любым соответствием. По умолчанию false. | |||
| status string | success | Статус бронирования. | |||
| zone string | success | Зона, в которой выполняется бронирование. | |||
Авторы
- 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_compute_reservation_module.html
