Spec-Zone.ru › Ansible 2.8

azure_rm_autoscale – Управление настройками автоматического масштабирования Azure

Новое в версии 2.7.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Создание и удаление настроек автоматического масштабирования.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не служебным принципалом.
adfs_authority_url
строка
добавлено в 2.6
URL-адрес полномочий Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственных полномочий ADFS.
api_profile
строка
добавлено в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags
булево
    Варианты:
  • нет
  • да ←
Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам.
При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
строка
добавлено в 2.5
    Варианты:
  • авто
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto если переменная не определена.
auto будет следовать порядку приоритета параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.
При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.
Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.
msi было добавлено в Ansible 2.6.
cert_validation_mode
строка
добавлено в 2.5
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор Azure-клиента. Используется при аутентификации с помощью служебного принципала.
cloud_environment
строка
добавлено в 2.4
 По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки конечного доступа для обнаружения метаданных (необходимо для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
enabled
булево
    Варианты:
  • нет
  • да ←
Указывает, включена ли автоматическая масштабирование для ресурса.
location
-
Расположение ресурса.
name
- / обязательно
Имя ресурса.
notifications
-
Коллекция уведомлений.
custom_emails
-
Список пользовательских электронных адресов. Это значение может быть пустым или нулевым, в этом случае этот атрибут будет проигнорирован.
send_to_subscription_administrator
булево
    Варианты:
  • нет
  • да
Указывает, нужно ли отправлять электронное письмо администратору подписки.
send_to_subscription_co_administrators
булево
    Варианты:
  • нет
  • да
Указывает, нужно ли отправлять электронное письмо соадминистраторам подписки.
webhooks
-
Список webhook-уведомлений URI службы.
password
-
Пароль пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не служебным принципалом.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
profiles
-
Коллекция профилей автоматического масштабирования, которые определяют различные параметры масштабирования для различных периодов времени.
Можно указать не более 20 профилей.
count
- / обязательно
Количество экземпляров, которое будет установлено, если метрики недоступны для оценки.
Значение по умолчанию используется только если текущее количество экземпляров меньше значения по умолчанию.
fixed_date_end
-
Конкретная дата и время окончания для профиля.
Этот элемент не используется, если используется элемент Повторение.
fixed_date_start
-
Конкретная дата и время начала для профиля.
Этот элемент не используется, если используется элемент Повторение.
fixed_date_timezone
-
Конкретная часовая зона даты и времени для профиля.
Этот элемент не используется, если используется элемент Повторение.
max_count
-
Максимальное количество экземпляров для ресурса.
Фактическое максимальное количество экземпляров ограничено доступными ядрами в подписке.
min_count
-
Минимальное количество экземпляров для ресурса.
name
- / обязательно
Имя профиля.
recurrence_days
-
Дни повторяющихся времён, в которые начинается этот профиль.
Этот элемент не используется, если используется элемент FixedDate.
recurrence_frequency
-
    Варианты:
  • Нет ←
  • Секунда
  • Минута
  • Час
  • День
  • Неделя
  • Месяц
  • Год
Как часто должен вступать в силу график профиля.
Если это значение Week, это означает, что в каждой неделе будет один и тот же набор профилей.
Этот элемент не используется, если используется элемент FixedDate.
recurrence_hours
-
Часы повторяющихся времён, в которые начинается этот профиль.
Этот элемент не используется, если используется элемент FixedDate.
recurrence_mins
-
Минуты повторяющихся времён, в которые начинается этот профиль.
Этот элемент не используется, если используется элемент FixedDate.
END_OF_DOCUMENT_MARKER
recurrence_timezone
-
Временная зона повторяющихся временных интервалов, с которых начинается этот профиль.
Этот элемент не используется, если используется элемент FixedDate.
rules
-
Коллекция правил, которые предоставляют триггеры и параметры для действия масштабирования.
Можно указать не более 10 правил.
cooldown
-
Время ожидания (в минутах) с момента последнего действия масштабирования, прежде чем произойдёт это действие.
Должно быть от 1 до 10080.
direction
-
    Выборы:
  • Увеличение
  • Уменьшение
Указывает, увеличивает или уменьшает действие масштабирования количество экземпляров.
metric_name
- / обязательно
Название метрики, определяющей, за чем следит правило.
metric_resource_uri
-
Идентификатор ресурса, за которым следит правило.
operator
-
    Выборы:
  • Равно
  • Не равно
  • Больше ←
  • Больше или равно
  • Меньше
  • Меньше или равно
Оператор, используемый для сравнения данных метрики и порога.
statistic
-
    Выборы:
  • Среднее ←
  • Мин
  • Макс
  • Сумма
Как метрики из нескольких экземпляров объединяются.
threshold
-
По умолчанию:
70
Порог метрики, который запускает действие масштабирования.
time_aggregation
-
    Выборы:
  • Среднее ←
  • Минимум
  • Максимум
  • Сумма
  • Количество
Как данные, которые собираются, должны объединяться во времени.
time_grain
- / обязательно
Гранularity (минуты) метрик, за которыми следит правило.
Должно быть одним из предопределенных значений, возвращаемых из определений метрик для метрики.
Должно быть между 1 и 720.
time_window
- / обязательно
Диапазон времени (в минутах), в течение которого собираются данные экземпляров.
Это значение должно быть больше, чем задержка при сборе метрик, которая может варьироваться от ресурса к ресурсу.
Должно быть между 5 и 720.
type
-
    Выборы:
  • PercentChangeCount
  • ExactCount
  • ChangeCount
Тип действия, который должен произойти, когда срабатывает правило масштабирования.
value
-
Количество экземпляров, участвующих в действии масштабирования.
Это значение должно быть 1 или больше.
resource_group
- / обязательно
Группа ресурсов ресурса.
secret
строка
Секретный ключ клиента Azure. Используется при аутентификации с помощью принципала службы.
state
-
    Выборы:
  • present ←
  • absent
Утверждение состояния виртуальной сети. Используйте present для создания или обновления и absent для удаления.
subscription_id
строка
Ваш идентификатор подписки Azure.
tags
словарь
Словарь пар строка:строка для назначения в качестве метаданных объекту.
Метаданные теги объекта будут обновлены всеми предоставленными значениями.
Чтобы удалить теги, установите параметр append_tags в значение false.
target
-
Идентификатор ресурса, к которому нужно применить параметры автоматического масштабирования.
Он может быть строкой идентификатора ресурса.
Также он может быть словарем, содержащим name, subscription_id, namespace, types, resource_group ресурса.
tenant
строка
Идентификатор Azure-аренды. Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед выполнением задач или плана с az login.
  • Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
  • Для аутентификации через принципал службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход в Azure CLI
Как войти в систему с помощью команды az login.

Примеры

- name: Create an auto scale
  azure_rm_autoscale:
      target: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"
      enabled: true
      profiles:
      - count: '1'
        recurrence_days:
        - Monday
        name: Auto created scale condition
        recurrence_timezone: China Standard Time
        recurrence_mins:
        - '0'
        min_count: '1'
        max_count: '1'
        recurrence_frequency: Week
        recurrence_hours:
        - '18'
      name: scale
      resource_group: myResourceGroup

- name: Create an auto scale with complicated profile
  azure_rm_autoscale:
      target: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets
               /myVmss"
      enabled: true
      profiles:
      - count: '1'
        recurrence_days:
        - Monday
        name: Auto created scale condition 0
        rules:
        - Time_aggregation: Average
          time_window: 10
          direction: Increase
          metric_name: Percentage CPU
          metric_resource_uri: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtua
                                lMachineScaleSets/vmss"
          value: '1'
          threshold: 70
          cooldown: 5
          time_grain: 1
          statistic: Average
          operator: GreaterThan
          type: ChangeCount
        max_count: '1'
        recurrence_mins:
        - '0'
        min_count: '1'
        recurrence_timezone: China Standard Time
        recurrence_frequency: Week
        recurrence_hours:
        - '6'
      notifications:
      - email_admin: True
        email_co_admin: False
        custom_emails:
        - yuwzho@microsoft.com
      name: scale
      resource_group: myResourceGroup

- name: Delete an Azure Auto Scale Setting
  azure_rm_autoscale:
    state: absent
    resource_group: myResourceGroup
    name: scale

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ Возвращаемое Описание
state
словарь
 всегда
Текущее состояние ресурса.

Пример:
{'changed': False, 'enabled': True, 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.insights/autoscalesettings/scale', 'location': 'eastus', 'name': 'scale', 'notifications': [{'custom_emails': ['yuwzho@microsoft.com'], 'send_to_subscription_administrator': True, 'send_to_subscription_co_administrators': False, 'webhooks': []}], 'profiles': [{'count': '1', 'max_count': '1', 'min_count': '1', 'name': 'Автоматически созданное условие масштабирования 0', 'recurrence_days': ['Понедельник'], 'recurrence_frequency': 'Неделя', 'recurrence_hours': ['6'], 'recurrence_mins': ['0'], 'recurrence_timezone': 'Китайское стандартное время', 'rules': [{'cooldown': 5.0, 'direction': 'Увеличение', 'metric_name': 'Процент использования ЦП', 'metric_resource_uri': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsof t.Compute/virtualMachineScaleSets/MyVmss', 'operator': 'Больше', 'statistic': 'Среднее', 'threshold': 70.0, 'time_aggregation': 'Среднее', 'time_grain': 1.0, 'time_window': 10.0, 'type': 'ChangeCount', 'value': '1'}]}], 'target': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScale Sets/myVmss'}


Статус

  • Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Yuwei Zhou (@yuwzho)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_autoscale_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API