Руководство по Microsoft Azure

Ansible включает набор модулей для взаимодействия с Azure Resource Manager, предоставляя вам инструменты для лёгкого создания и управления инфраструктурой в облаке Microsoft Azure.

Требования

Использование модулей Azure Resource Manager требует установки определённых модулей Azure SDK на хосте, на котором работает Ansible.

$ pip install ansible[azure]

Если вы используете Ansible из исходного кода, вы можете установить зависимости из корневой директории репозитория Ansible.

$ pip install .[azure]

Вы также можете напрямую запустить Ansible в Azure Cloud Shell, где Ansible уже предварительно установлен.

Авторизация в Azure

Для использования модулей Azure Resource Manager требуется авторизация в API Azure. Вы можете выбрать одну из двух стратегий авторизации:

• Имя пользователя/пароль Active Directory
• Учётные данные сервисного принципала

Следуйте инструкциям для выбранной вами стратегии, затем перейдите к Предоставление учетных данных модулям Azure для получения инструкций по фактическому использованию модулей и авторизации в API Azure.

Использование сервисного принципала

Сейчас есть подробный официальный учебник, описывающий создание сервисного принципала.

После прохождения учебника у вас будет:

• Ваш идентификатор клиента, который можно найти в поле «идентификатор клиента» на странице «Настройка» вашего приложения в портале Azure
• Ваш секретный ключ, сгенерированный при создании приложения. После создания вы не сможете отобразить ключ. Если вы потеряли ключ, вам необходимо создать новый на странице «Настройка» приложения.
• И, наконец, идентификатор клиента. Это UUID (например, ABCDEFGH-1234-ABCD-1234-ABCDEFGHIJKL), указывающий на AD, содержащий ваше приложение. Вы найдёте его в URL, доступном в портале Azure, или в разделе «отобразить конечные точки» любого URL.

Использование имени пользователя/пароля Active Directory

Для создания имени пользователя/пароля Active Directory:

• Подключитесь к классическому порталу Azure с вашей учетной записью администратора
• Создайте пользователя в вашей стандартной AAD. НЕ нужно активировать многофакторную аутентификацию
• Перейдите в Настройки - Администраторы
• Нажмите Добавить и введите адрес электронной почты нового пользователя.
• Установите флажок для подписки, с которой вы хотите протестировать этого пользователя.
• Войдите в Azure Portal с этим новым пользователем, чтобы изменить временный пароль на новый. Вы не сможете использовать временный пароль для входа в систему с помощью OAuth.

Предоставление учетных данных модулям Azure

Модули предлагают несколько способов предоставления ваших учетных данных. Для инструмента CI/CD, такого как Ansible Tower или Jenkins, вы, скорее всего, захотите использовать переменные окружения. Для разработки на локальном компьютере вы можете сохранить свои учетные данные в файле в вашей домашней директории. Конечно, вы всегда можете передавать учетные данные в качестве параметров задаче в плейбуке. Порядок приоритетов: параметры, затем переменные окружения, и, наконец, файл, найденный в вашей домашней директории.

Использование переменных окружения

Для передачи учетных данных сервисного принципала через среду, определите следующие переменные:

• AZURE_CLIENT_ID
• AZURE_SECRET
• AZURE_SUBSCRIPTION_ID
• AZURE_TENANT

Для передачи учетных данных имени пользователя/пароля Active Directory через среду, определите следующие переменные:

• AZURE_AD_USER
• AZURE_PASSWORD
• AZURE_SUBSCRIPTION_ID

Хранение в файле

При работе в среде разработки может быть желательно хранить учетные данные в файле. Модули будут искать учетные данные в $HOME/.azure/credentials. Этот файл имеет формат ini. Он будет выглядеть следующим образом:

[default]
subscription_id=xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
client_id=xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
secret=xxxxxxxxxxxxxxxxx
tenant=xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Можно хранить несколько наборов учетных данных в файле credentials, создавая несколько разделов. Каждый раздел рассматривается как профиль. Модули автоматически ищут профиль [default]. Определите AZURE_PROFILE в среде или передайте параметр профиля, чтобы указать определённый профиль.

Передача в качестве параметров

Если вы хотите передать учетные данные в качестве параметров задаче, используйте следующие параметры для сервисного принципала:

• client_id
• secret
• subscription_id
• tenant

Или передайте следующие параметры для имени пользователя/пароля Active Directory:

• ad_user
• password
• subscription_id

Другие облачные среды

Чтобы использовать облако Azure, отличное от стандартного облака (например, Azure China Cloud, Azure US Government Cloud, Azure Stack), передайте аргумент «cloud_environment» модулям, настройте его в профиле учетных данных или установите переменную окружения «AZURE_CLOUD_ENVIRONMENT». Значение представляет собой имя облака, определённое в Azure Python SDK (например, «AzureChinaCloud», «AzureUSGovernment»; по умолчанию «AzureCloud»), или URL Azure для обнаружения метаданных (для Azure Stack).

Создание виртуальных машин

Существует два способа создания виртуальной машины, оба из которых используют модуль azure_rm_virtualmachine. Мы можем либо создать хранилище, сетевой интерфейс, группу безопасности и общедоступный IP-адрес и передать имена этих объектов в модуль в качестве параметров, либо позволить модулю выполнить работу за нас и принять значения по умолчанию.

Создание отдельных компонентов

Доступен модуль Azure, который поможет вам создать хранилище, виртуальную сеть, подсеть, сетевой интерфейс, группу безопасности и общедоступный IP-адрес. Вот полный пример создания каждого из них и передачи имён в модуль azure_rm_virtualmachine в конце:

- name: Create storage account
  azure_rm_storageaccount:
    resource_group: Testing
    name: testaccount001
    account_type: Standard_LRS

- name: Create virtual network
  azure_rm_virtualnetwork:
    resource_group: Testing
    name: testvn001
    address_prefixes: "10.10.0.0/16"

- name: Add subnet
  azure_rm_subnet:
    resource_group: Testing
    name: subnet001
    address_prefix: "10.10.0.0/24"
    virtual_network: testvn001

- name: Create public ip
  azure_rm_publicipaddress:
    resource_group: Testing
    allocation_method: Static
    name: publicip001

- name: Create security group that allows SSH
  azure_rm_securitygroup:
    resource_group: Testing
    name: secgroup001
    rules:
      - name: SSH
        protocol: Tcp
        destination_port_range: 22
        access: Allow
        priority: 101
        direction: Inbound

- name: Create NIC
  azure_rm_networkinterface:
    resource_group: Testing
    name: testnic001
    virtual_network: testvn001
    subnet: subnet001
    public_ip_name: publicip001
    security_group: secgroup001

- name: Create virtual machine
  azure_rm_virtualmachine:
    resource_group: Testing
    name: testvm001
    vm_size: Standard_D1
    storage_account: testaccount001
    storage_container: testvm001
    storage_blob: testvm001.vhd
    admin_username: admin
    admin_password: Password!
    network_interfaces: testnic001
    image:
      offer: CentOS
      publisher: OpenLogic
      sku: '7.1'
      version: latest

Каждый из модулей Azure предоставляет различные параметры. Не все параметры продемонстрированы в приведенном выше примере. Для получения дополнительной информации и примеров см. каждый отдельный модуль.

Создание виртуальной машины с параметрами по умолчанию

Если вы просто хотите создать виртуальную машину без указания всех подробностей, вы можете сделать это. Единственное ограничение заключается в том, что вам понадобится виртуальная сеть с одной подсетью в вашей группе ресурсов. Предполагая, что у вас уже есть виртуальная сеть с существующей подсетью, вы можете запустить следующую команду для создания ВМ:

azure_rm_virtualmachine:
  resource_group: Testing
  name: testvm10
  vm_size: Standard_D1
  admin_username: chouseknecht
  ssh_password: false
  ssh_public_keys: "{{ ssh_keys }}"
  image:
    offer: CentOS
    publisher: OpenLogic
    sku: '7.1'
    version: latest

Скрипт динамического инвентаризации

Если вы не знакомы со скриптами динамической инвентаризации Ansible, ознакомьтесь со статьей Вступление в динамическую инвентаризацию.

Скрипт инвентаризации Azure Resource Manager называется azure_rm.py. Он аутентифицируется с API Azure точно так же, как модули Azure, что означает, что вы либо определите те же переменные окружения, что описаны выше в Использование переменных окружения, создайте файл $HOME/.azure/credentials (также описано выше в Хранение в файле), или передайте параметры командной строки. Чтобы увидеть доступные параметры командной строки, выполните следующее:

$ ./ansible/contrib/inventory/azure_rm.py --help

Как и все скрипты динамической инвентаризации, скрипт можно выполнить напрямую, передать в качестве параметра команде ansible или передать напрямую в ansible-playbook с помощью опции -i. Независимо от того, как он выполняется, скрипт генерирует JSON, представляющий все хосты, найденные в вашей подписке Azure. Вы можете сузить его до хостов, найденных только в определённом наборе групп ресурсов Azure, или даже до одного конкретного хоста.

Для каждого хоста скрипт инвентаризации предоставляет следующие переменные хоста:

{
  "ansible_host": "XXX.XXX.XXX.XXX",
  "computer_name": "computer_name2",
  "fqdn": null,
  "id": "/subscriptions/subscription-id/resourceGroups/galaxy-production/providers/Microsoft.Compute/virtualMachines/object-name",
  "image": {
    "offer": "CentOS",
    "publisher": "OpenLogic",
    "sku": "7.1",
    "version": "latest"
  },
  "location": "westus",
  "mac_address": "00-00-5E-00-53-FE",
  "name": "object-name",
  "network_interface": "interface-name",
  "network_interface_id": "/subscriptions/subscription-id/resourceGroups/galaxy-production/providers/Microsoft.Network/networkInterfaces/object-name1",
  "network_security_group": null,
  "network_security_group_id": null,
  "os_disk": {
    "name": "object-name",
    "operating_system_type": "Linux"
  },
  "plan": null,
  "powerstate": "running",
  "private_ip": "172.26.3.6",
  "private_ip_alloc_method": "Static",
  "provisioning_state": "Succeeded",
  "public_ip": "XXX.XXX.XXX.XXX",
  "public_ip_alloc_method": "Static",
  "public_ip_id": "/subscriptions/subscription-id/resourceGroups/galaxy-production/providers/Microsoft.Network/publicIPAddresses/object-name",
  "public_ip_name": "object-name",
  "resource_group": "galaxy-production",
  "security_group": "object-name",
  "security_group_id": "/subscriptions/subscription-id/resourceGroups/galaxy-production/providers/Microsoft.Network/networkSecurityGroups/object-name",
  "tags": {
    "db": "mysql"
  },
  "type": "Microsoft.Compute/virtualMachines",
  "virtual_machine_size": "Standard_DS4"
}

Группы хостов

По умолчанию хосты сгруппированы по:

• azure (все хосты)
• наименование расположения
• наименование группы ресурсов
• наименование группы безопасности
• ключ тега
• ключ тега_значение

Вы можете управлять группами хостов и выбором хостов, определив переменные среды или создав файл azure_rm.ini в текущей рабочей директории.

ПРИМЕЧАНИЕ: Файл .ini будет иметь приоритет над переменными среды.

ПРИМЕЧАНИЕ: Имя файла .ini — это имя базовой части скрипта инвентаризации (т.е. «azure_rm») с расширением «.ini». Это позволяет копировать, переименовывать и настраивать скрипт инвентаризации и иметь соответствующие файлы .ini в одной и той же директории.

Управление группировкой с помощью следующих переменных, определённых в среде:

• AZURE_GROUP_BY_RESOURCE_GROUP=yes
• AZURE_GROUP_BY_LOCATION=yes
• AZURE_GROUP_BY_SECURITY_GROUP=yes
• AZURE_GROUP_BY_TAG=yes

Выберите хосты в определённых группах ресурсов, назначив список, разделённый запятыми:

• AZURE_RESOURCE_GROUPS=resource_group_a,resource_group_b

Выберите хосты для определённого ключа тега, назначив список ключей тегов, разделённых запятыми:

• AZURE_TAGS=key1,key2,key3

Выберите хосты для определённых расположений, назначив список расположений, разделённых запятыми:

• AZURE_LOCATIONS=eastus,eastus2,westus

Или выберите хосты для определённых пар ключ:значение тегов, назначив список пар ключ:значение, разделённых запятыми:

• AZURE_TAGS=key1:value1,key2:value2

Если вам не нужно значение powerstate, вы можете улучшить производительность, отключив получение powerstate:

• AZURE_INCLUDE_POWERSTATE=no

Пример файла azure_rm.ini включен вместе со скриптом инвентаризации в contrib/inventory. Файл .ini будет содержать следующее:

[azure]
# Control which resource groups are included. By default all resources groups are included.
# Set resource_groups to a comma separated list of resource groups names.
#resource_groups=

# Control which tags are included. Set tags to a comma separated list of keys or key:value pairs
#tags=

# Control which locations are included. Set locations to a comma separated list of locations.
#locations=

# Include powerstate. If you don't need powerstate information, turning it off improves runtime performance.
# Valid values: yes, no, true, false, True, False, 0, 1.
include_powerstate=yes

# Control grouping with the following boolean flags. Valid values: yes, no, true, false, True, False, 0, 1.
group_by_resource_group=yes
group_by_location=yes
group_by_security_group=yes
group_by_tag=yes

Примеры

Вот несколько примеров использования скрипта инвентаризации:

# Execute /bin/uname on all instances in the Testing resource group
$ ansible -i azure_rm.py Testing -m shell -a "/bin/uname -a"

# Use the inventory script to print instance specific information
$ ./ansible/contrib/inventory/azure_rm.py --host my_instance_host_name --resource-groups=Testing --pretty

# Use the inventory script with ansible-playbook
$ ansible-playbook -i ./ansible/contrib/inventory/azure_rm.py test_playbook.yml

Вот простой плейбук для тестирования скрипта инвентаризации Azure:

- name: Test the inventory script
  hosts: azure
  connection: local
  gather_facts: no
  tasks:
    - debug: msg="{{ inventory_hostname }} has powerstate {{ powerstate }}"

Вы можете выполнить плейбук примерно так:

$ ansible-playbook -i ./ansible/contrib/inventory/azure_rm.py test_azure_inventory.yml

Отключение проверки сертификатов на конечных точках Azure

Когда присутствует прокси-сервер HTTPS или используется Azure Stack, может потребоваться отключить проверку сертификатов для конечных точек Azure в модулях Azure. Это не рекомендуется с точки зрения безопасности, но может потребоваться, если хранилище системных CA не может быть изменено для включения необходимого сертификата CA. Проверка сертификатов может управляться путем задания значения «cert_validation_mode» в профиле учетных данных, через переменную среды «AZURE_CERT_VALIDATION_MODE» или путем передачи аргумента «cert_validation_mode» любому модулю Azure. Значение по умолчанию — «validate»; установка значения на «ignore» предотвратит всю проверку сертификатов. Аргумент модуля имеет приоритет над значением в профиле учетных данных, которое имеет приоритет над значением в переменной среды.