Руководство. Как хранить секреты виртуальных машин в Azure Key Vault с использованием Ansible

Статья
06/08/2023

При работе с этим кратким руководством вы создадите и получите секреты из хранилища ключей Azure с помощью Ansible.

Важно!

Для выполнения примеров сборников схем из этой статьи требуется Ansible 2.9 (или последующей версии).

Вы узнаете, как выполнять следующие задачи:

Создание экземпляра хранилища ключей Azure
Создание хранилища секретов в хранилище ключей Azure
Получение секретов из хранилища ключей Azure с помощью Ansible

Необходимые компоненты

Подписка Azure. Если у вас нет подписки Azure, создайте бесплатную учетную запись, прежде чем начинать работу.

Субъект-служба Azure: создайте субъект-службу, записав следующие значения: appId, displayName, password и tenant.

Установите Ansible: выполните одно из указанных ниже действий.
- Установите и настройте Ansible на виртуальной машине Linux.
- Настройте Azure Cloud Shell

Создание хранилища ключей Azure

Ansible требуется группа ресурсов, в которой будут развертываться ваши ресурсы.

Создайте сборник схем Ansible с именем create_kv.yml и добавьте следующую задачу, чтобы создать группу ресурсов:

---
- name: Create Azure key vault
  hosts: localhost
  connection: local
  tasks:

  - name: Create resource group
    azure_rm_resourcegroup:
      name: ansible-kv-test-rg
      location: eastus

Определите необходимые переменные для идентификатора клиента, идентификатора объекта субъекта-службы и имени хранилища.
```
---
vars:
  tenant_id: <tenantId>
  object_id: <servicePrincipalObjectId>
  vault_name: <vaultName>
```
Замените <tenantId>, <servicePrincipalObjectId> и <vaultName> соответствующими значениями. objectId используется для предоставления доступа к секретам в хранилище ключей.

Ключевой момент:
- Имена хранилища ключей Azure должны быть глобально уникальными. Доступ к самому хранилищу ключей, а также ключам и секретам внутри него осуществляется через URI https://{vault-name}.vault.azure.net.

Настройте экземпляр хранилища ключей Azure, добавив задачу create_kv.yml.

---
- name: Create key vault instance
  azure_rm_keyvault:
    resource_group: ansible-kv-test-rg
    vault_name: "{{ vault_name }}"
    enabled_for_deployment: yes
    vault_tenant: "{{ tenant_id }}"
    sku:
      name: standard
    access_policies:
      - tenant_id: "{{ tenant_id }}"
        object_id: "{{ object_id }}"
        secrets:
          - get
          - list
          - set
          - delete

Запустите сборник схем create_kv.yml.

ansible-playbook create_kv.yml

PLAY [localhost] *******************************************************************************************************

TASK [Gathering Facts] *************************************************************************************************
ok: [localhost]

TASK [Create resource group] *******************************************************************************************
ok: [localhost]

TASK [Create key vault instance] ************************************************************************************
ok: [localhost]

PLAY RECAP *************************************************************************************************************
localhost                  : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

Завершение создания сборника схем хранилища ключей Azure

В этом разделе приведен полный пример сборника схем Ansible для создания хранилища ключей Azure.

- hosts: localhost
  connection: local

  vars:
    tenant_id: <tenantId>
    object_id: <servicePrincipalObjectId>
    vault_name: <vaultName>

  tasks:
  - name: Create resource group 
    azure_rm_resourcegroup:
      name: ansible-kv-test-rg
      location: eastus

  - name: Create instance of Key Vault
    azure_rm_keyvault:
      resource_group: ansible-kv-test-rg
      vault_name: "{{ vault_name }}"
      enabled_for_deployment: yes
      vault_tenant: "{{ tenant_id }}"
      sku:
        name: standard
      access_policies:
        - tenant_id: "{{ tenant_id }}"
          object_id: "{{ object_id }}"
          secrets:
            - get
            - list
            - set
            - delete

Создание секрета в хранилище ключей

Чтобы создать секрет, вам потребуется универсальный код ресурса (URI) хранилища ключей.

Создайте еще один сборник схем с именем create_kv_secret.yml. Скопируйте в него следующий код:
```
---
- hosts: localhost
  connection: local

  tasks:

  - name: Get Key Vault by name
    azure_rm_keyvault_info:
      resource_group: ansible-kv-test-rg
      name: <vaultName>
    register: keyvault

  - name: set KeyVault uri fact
    set_fact: keyvaulturi="{{ keyvault['keyvaults'][0]['vault_uri'] }}"

  - name: Create a secret
    azure_rm_keyvaultsecret:
      secret_name: adminPassword
      secret_value: <secretValue>
      keyvault_uri: "{{ keyvaulturi }}"
```
Замените <vaultName> именем хранилища ключей, а <secretValue> — значением секрета.

Ключевой момент:
- Модули azure_rm_keyvault_info и set_facts регистрируют универсальный код ресурса (URI) хранилища ключей в качестве переменной. Затем эта переменная передается в модуль azure_rm_keyvaultsecret для создания секрета.

Запустите сборник схем create_kv_secret.yml.

ansible-playbook create_kv_secret.yml

PLAY [localhost] *******************************************************************************************************

TASK [Gathering Facts] *************************************************************************************************
ok: [localhost]

TASK [Get Key Vault by name] *******************************************************************************************
ok: [localhost]

TASK [set KeyVault uri fact] *******************************************************************************************
ok: [localhost]

TASK [Create a secret] *************************************************************************************************
ok: [localhost]

PLAY RECAP *************************************************************************************************************
localhost                  : ok=4    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

Получите секреты из хранилища ключей.

С помощью секретов, хранящихся в хранилище ключей Azure, можно заполнять переменные Ansible.

Создайте новый сборник схем get_kv_secrets.yml для получения секретов хранилища ключей с помощью Ansible.

Ansible 2.9 с azure_preview_modules

---
- hosts: localhost
  connection: local
  roles: 
    -  { role: azure.azure_preview_modules }

  vars:
    tenant_id: <tenantId>
    vault_name: <vaultName>
    secret_name: adminPassword
    client_id: <servicePrincipalApplicationId>
    client_secret: <servicePrincipalSecret>

  tasks:
  - name: Get Key Vault by name
    azure_rm_keyvault_info:
      resource_group: ansible-kv-test-rg
      name: "{{ vault_name }}"
    register: keyvault

  - name: Set key vault URI fact
    set_fact: keyvaulturi="{{ keyvault['keyvaults'][0]['vault_uri'] }}"

  - name: Set key vault secret fact
    set_fact: secretValue={{ lookup('azure_keyvault_secret',secret_name,vault_url=keyvaulturi, client_id=client_id, secret=client_secret, tenant_id=tenant_id) }}

  - name: Output key vault secret
    debug:
      msg: "{{ secretValue }}"

Замените <tenantId>, <vaultName>, <servicePrincipalApplicationId> и <servicePrincipalSecret> соответствующими значениями.

Дополнительные сведения о azure_preview_modules см. на странице Ansible Galaxy.

Ansible 2.10 с azure.azcollection

---
- hosts: localhost
  connection: local
  collections:
    - azure.azcollection

  vars:
    vault_name: ansible-kv-test-01
    secret_name: adminPassword

  tasks:

  - name: Get Key Vault by name
    azure_rm_keyvault_info:
      resource_group: ansible-kv-test-rg
      name: "{{ vault_name }}"
    register: keyvault

  - name: Set key vault URI fact
    set_fact: keyvaulturi="{{ keyvault['keyvaults'][0]['vault_uri'] }}"

  - name: Get secret value
    azure_rm_keyvaultsecret_info:
      vault_uri: "{{ keyvaulturi }}"
      name: "{{ secret_name }}"
    register: kvSecret

  - name: set secret fact
    set_fact: secretValue="{{ kvSecret['secrets'][0]['secret'] }}"

  - name: Output key vault secret
    debug: 
      msg="{{ secretValue }}"

Замените <vaultName> соответствующим значением.

Дополнительные сведения о azcollection см. в статье Коллекция Ansible для Azure.

Запустите сборник схем get-secret-value.yml.
```
ansible-playbook get-secret-value.yml
```
```
TASK [Output key vault secret] *************************************************
ok: [localhost] => {
    "msg": "<plainTextPassword>"
}
```
Подтвердите, что выходные данные, заменившие <plainTextPassword>, являются обычным текстовым значением секрета, ранее созданного в хранилище ключей Azure.

Завершение примера сборника схем Ansible

В этом разделе приведен полный пример сборника схем Ansible для настройки виртуальной машины Azure Windows с помощью секрета хранилища ключей.

---
- name: Create Azure VM
  hosts: localhost
  connection: local
  gather_facts: false
  collections:
    - azure.azcollection

  vars:
    vault_uri: <key_vault_uri>
    secret_name: <key_vault_secret_name>

  tasks:

  - name: Get latest version of a secret
    azure_rm_keyvaultsecret_info:
      vault_uri: "{{ vault_uri }}"
      name: "{{ secret_name }}"
    register: kvSecret

  - name: Set secret fact
    set_fact: secret_value="{{ kvSecret['secrets'][0]['secret'] }}"

  - name: Create resource group
    azure_rm_resourcegroup:
      name: myResourceGroup
      location: eastus

  - name: Create virtual network
    azure_rm_virtualnetwork:
      resource_group: myResourceGroup
      name: vNet
      address_prefixes: "10.0.0.0/16"

  - name: Add subnet
    azure_rm_subnet:
      resource_group: myResourceGroup
      name: subnet
      address_prefix: "10.0.1.0/24"
      virtual_network: vNet

  - name: Create public IP address
    azure_rm_publicipaddress:
      resource_group: myResourceGroup
      allocation_method: Static
      name: pip
    register: output_ip_address

  - name: Output public IP
    debug:
      msg: "The public IP is {{ output_ip_address.state.ip_address }}"
  
  - name: Create Network Security Group
    azure_rm_securitygroup:
      resource_group: myResourceGroup
      name: networkSecurityGroup
      rules:
        - name: 'allow_rdp'
          protocol: Tcp
          destination_port_range: 3389
          access: Allow
          priority: 1001
          direction: Inbound

  - name: Create a network interface
    azure_rm_networkinterface:
      name: nic
      resource_group: myResourceGroup
      virtual_network: vNet
      subnet_name: subnet
      security_group: networkSecurityGroup
      ip_configurations:
        - name: default
          public_ip_address_name: pip
          primary: True

  - name: Create VM
    azure_rm_virtualmachine:
      resource_group: myResourceGroup
      name: win-vm
      vm_size: Standard_DS1_v2
      admin_username: azureuser
      admin_password: "{{ secret_value }}"
      network_interfaces: nic
      os_type: Windows
      image:
          offer: WindowsServer
          publisher: MicrosoftWindowsServer
          sku: 2019-Datacenter
          version: latest
    no_log: true

Замените <key_vault_uri> и <key_vault_secret_name> соответствующими значениями.

Очистка ресурсов

Сохраните следующий код как delete_rg.yml.

---
- hosts: localhost
  tasks:
    - name: Deleting resource group - "{{ name }}"
      azure_rm_resourcegroup:
        name: "{{ name }}"
        state: absent
      register: rg
    - debug:
        var: rg

Чтобы запустить сборник схем, выполните команду ansible-playbook. Замените заполнитель именем удаляемой группы ресурсов. В указанной группе ресурсов будут удалены все ресурсы.
```
ansible-playbook delete_rg.yml --extra-vars "name=<resource_group>"
```
Основные моменты:
- В связи с наличием переменной register и раздела debug в сборнике схем результаты будут отображены после завершения команды.

Чтобы удалить группу ресурсов, выполните команду az group delete. В указанной группе ресурсов будут удалены все ресурсы.
```
az group delete --name <resource_group>
```
Убедитесь, что группа ресурсов была удалена, с помощью команды az group show.
```
az group show --name <resource_group>
```

Чтобы удалить группу ресурсов, выполните командлет Remove-AzResourceGroup. В указанной группе ресурсов будут удалены все ресурсы.
```
Remove-AzResourceGroup -Name <resource_group>
```
Убедитесь, что группа ресурсов была удалена, выполнив командлет Get-AzResourceGroup.
```
Get-AzResourceGroup -Name <resource_group>
```

Следующие шаги

Документация по Ansible в Azure

Поделиться через