google.cloud.gcp_compute_resource_policy – Создаёт политику GCP ResourcePolicy
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_compute_resource_policy.
Обзор
- Политика, которая может быть прикреплена к ресурсу для указания или планирования действий с этим ресурсом.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||||
|---|---|---|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | ||||
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API. | |||||
| group_placement_policy словарь | Политика создания снимков постоянных дисков. | |||||
| availability_domain_count целое число | Количество областей доступности, по которым будут распределяться экземпляры. Если два экземпляра находятся в разных областях доступности, они не будут размещены в одной сети с низкой задержкой. | |||||
| collocation строка | Collocation определяет, следует ли размещать виртуальные машины в одной области доступности в одной сети с низкой задержкой. Укажите `COLLOCATED`, чтобы включить collocation. Может быть указан только вместе с `vm_count`. Если виртуальные машины создаются с политикой COLLOCATED, тогда ровно `vm_count` виртуальных машин должны быть созданы одновременно с прикрепленной политикой ресурсов. Некоторые допустимые значения включают: "COLLOCATED" | |||||
| vm_count целое число | Количество виртуальных машин в группе размещения. | |||||
| name строка / обязательно | Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя ресурса должно содержать от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])`?, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |||||
| project строка | Проект Google Cloud Platform для использования. | |||||
| region строка / обязательно | Регион, в котором находится политика ресурсов. | |||||
| scopes список / элементы=строка | Массив используемых областей | |||||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, которая его представляет. | |||||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |||||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип выбран как serviceaccount. | |||||
| snapshot_schedule_policy словарь | Политика создания снимков постоянных дисков. | |||||
| retention_policy словарь | Политика удержания, применяемая к созданным этой политикой ресурсов снимкам. | |||||
| max_retention_days целое число / обязательно | Максимальный срок хранения снимка. | |||||
| on_source_disk_delete строка | По умолчанию: "KEEP_AUTO_SNAPSHOTS" | Определяет поведение запланированных снимков при удалении исходного диска. Некоторые допустимые значения включают: "KEEP_AUTO_SNAPSHOTS", "APPLY_RETENTION_POLICY" | ||||
| schedule словарь / обязательно | Содержит один из `hourlySchedule`, `dailySchedule` или `weeklySchedule`. | |||||
| daily_schedule словарь | Политика будет выполняться каждые n-е суток в указанное время. | |||||
| days_in_cycle целое число / обязательно | Количество дней между снимками. | |||||
| start_time строка / обязательно | Время в формате UTC, которое разрешается к одному из 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, как 13:00-5, так и 08:00 являются допустимыми. | |||||
| hourly_schedule словарь | Политика будет выполняться каждые n-е часов, начиная с указанного времени. | |||||
| hours_in_cycle целое число / обязательно | Количество часов между снимками. | |||||
| start_time строка / обязательно | Время начала операций в окне. Оно должно быть в формате часов "HH:MM", где HH : [00-23] и MM : [00] по Гринвичу. например: 21:00. | |||||
| weekly_schedule словарь | Позволяет указать время создания снимка для каждого дня недели. | |||||
| day_of_weeks список / элементы=словарь / обязательно | Может содержать до семи (по одному на каждый день недели) временных промежутков для снимков. | |||||
| day строка / обязательно | День недели для создания снимка. Например, MONDAY. Некоторые допустимые значения включают: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" | |||||
| start_time строка / обязательно | Время начала операций в окне. Должно быть в формате "HH:MM", где HH : [00-23] и MM : [00-00] по Гринвичу. | |||||
| snapshot_properties словарь | Свойства, с которыми создаются снимки, такие как метки. | |||||
| guest_flush логическое значение |
| Выполнять ли снимок «с учетом гостя»? | ||||
| labels словарь | Набор пар «ключ-значение». | |||||
| storage_locations список / элементы=строка | Расположение ведра Cloud Storage для хранения автоматического снимка (региональное или многорегиональное). | |||||
| state строка |
| Должен ли заданный объект существовать в GCP? | ||||
Примеры
- name: create a resource policy
google.cloud.gcp_compute_resource_policy:
name: test_object
region: us-central1
snapshot_schedule_policy:
schedule:
daily_schedule:
days_in_cycle: 1
start_time: '04:00'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны в данном разделе, ниже указаны поля, уникальные для этого модуля:
| Ключевые значения | Возвращаемое значение | Описание | ||||
|---|---|---|---|---|---|---|
| groupPlacementPolicy сложный | успех | Политика создания снимков постоянных дисков. | ||||
| availabilityDomainCount целое число | успех | Количество областей доступности, по которым будут распределены экземпляры. Если два экземпляра находятся в разных областях доступности, они не будут помещены в одну низкозадержную сеть. | ||||
| collocation строка | успех | Collocation определяет, следует ли размещать виртуальные машины в одной области доступности в одной низкозадержной сети. Укажите `COLLOCATED`, чтобы включить collocation. Может быть указано только с `vm_count`. Если вычислительные экземпляры создаются с политикой COLLOCATED, тогда ровно `vm_count` экземпляров должны быть созданы одновременно с прикрепленной политикой ресурсов. | ||||
| vmCount целое число | успех | Количество виртуальных машин в этой группе размещения. | ||||
| name строка | успех | Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя ресурса должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])`?, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | ||||
| region строка | успех | Регион, в котором находится политика ресурсов. | ||||
| snapshotSchedulePolicy сложный | успех | Политика создания снимков постоянных дисков. | ||||
| retentionPolicy сложный | успех | Политика удержания, применяемая к снимкам, созданным этой политикой ресурсов. | ||||
| maxRetentionDays целое число | успех | Максимальный срок хранения снимка. | ||||
| onSourceDiskDelete строка | успех | Определяет поведение запланированных снимков при удалении исходного диска. | ||||
| schedule сложный | успех | Содержит одну из `hourlySchedule`, `dailySchedule` или `weeklySchedule`. | ||||
| dailySchedule сложный | успех | Политика будет выполняться каждые n-й день в указанное время. | ||||
| daysInCycle целое число | успех | Количество дней между снимками. | ||||
| startTime строка | успех | Это должно быть в формате UTC, который соответствует одному из 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, 13:00-5 и 08:00 являются допустимыми. | ||||
| hourlySchedule сложный | успех | Политика будет выполняться каждые n-й час, начиная с указанного времени. | ||||
| hoursInCycle целое число | успех | Количество часов между снимками. | ||||
| startTime строка | успех | Время в пределах окна для начала операций. Он должен быть в формате часов "HH:MM", где HH : [00-23] и MM : [00] GMT. Например: 21:00. | ||||
| weeklySchedule сложный | успех | Позволяет указать время снимка для каждого дня недели. | ||||
| dayOfWeeks сложный | успех | Может содержать до семи (по одному для каждого дня недели) временных значений для снимка. | ||||
| day строка | успех | День недели для создания снимка. Например, ПОНЕДЕЛЬНИК. | ||||
| startTime строка | успех | Время в пределах окна для начала операций. Он должен быть в формате "HH:MM", где HH : [00-23] и MM : [00-00] GMT. | ||||
| snapshotProperties сложный | успех | Свойства, с помощью которых создаются снимки, такие как метки. | ||||
| guestFlush булево | успех | Выполняется ли снимок с учетом гостевой системы. | ||||
| labels словарь | успех | Набор пар ключ-значение. | ||||
| storageLocations список / элементы=строка | успех | Расположение ведра Cloud Storage для хранения автоматического снимка (региональное или многорегиональное). | ||||
Авторы
- 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_resource_policy_module.html
