Självstudie: Använda Azure Key Vault för att lagra VM-hemligheter med Ansible

Artikel
06/08/2023

I den här snabbstarten skapar och hämtar du hemligheter från Azure Key Vault med Ansible.

Viktigt!

Ansible 2.9 (eller senare) krävs för att köra exempelspelböckerna i den här artikeln.

I den här artikeln kan du se hur du:

Skapa en Azure Key Vault-instans
Skapa ett hemligt arkiv i Azure Key Vault
Hämta hemligheter från Azure Key Vault med Ansible

Förutsättningar

Azure-prenumeration: Om du inte har någon Azure-prenumeration kan du skapa ett kostnadsfritt konto innan du börjar.

Azure-tjänstens huvudnamn: Skapa ett huvudnamn för tjänsten och anteckna följande värden: appId, displayName, lösenord och klientorganisation.

Installera Ansible: Gör något av följande alternativ:
- Installera och konfigurera Ansible på en virtuell Linux-dator
- Konfigurera Azure Cloud Shell

Skapa ett Azure-nyckelvalv

Ansible behöver en resursgrupp för att distribuera dina resurser i.

Skapa en Ansible-spelbok med namnet create_kv.yml lägg till följande uppgift för att skapa en resursgrupp:

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

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

Definiera de variabler som krävs för klientorganisations-ID, objekt-ID för tjänstens huvudnamn och valvnamn.
```
---
vars:
  tenant_id: <tenantId>
  object_id: <servicePrincipalObjectId>
  vault_name: <vaultName>
```
Ersätt <tenantId>, <servicePrincipalObjectId>och <vaultName> med lämpliga värden. ObjectId används för att ge åtkomst till hemligheter i nyckelvalvet.

nyckelpunkt:
- Namn på Azure-nyckelvalv måste vara globalt unika. Nyckelvalvet och nycklar/hemligheter i det nås via https://{vault-name}.vault.azure.net URI.

Konfigurera Azure Key Vault-instansen genom att lägga till uppgiften 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 Kör spelboken.

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

Slutför skapande av Spelbok för Azure Key Vault

I det här avsnittet visas hela ansible-exempelspelboken för att skapa ett Azure-nyckelvalv.

- 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

Skapa en hemlighet i key vault

Innan hemligheten kan skapas behöver du keyvault-URI:n.

Skapa en annan spelbok med namnet create_kv_secret.yml. Kopiera följande kod till spelboken:

---
- 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 }}"

Ersätt <vaultName> med namnet på ditt nyckelvalv och <secretValue> med värdet för hemligheten.

Nyckelpunkt:

Modulerna azure_rm_keyvault_info och set_facts registrerar nyckelvalvets URI som en variabel. Variabeln skickas sedan till modulen azure_rm_keyvaultsecret för att skapa hemligheten.

create_kv_secret.yml Kör spelboken.

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

Hämta hemligheter från key vault

Hemligheter som lagras i Azure Key Vault kan användas för att fylla i Ansible-variabler.

Skapa en ny spelbok med namnet get_kv_secrets.yml för att hämta key vault-hemligheter med Ansible.

Ansible 2.9 med 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 }}"

Ersätt <tenantId>, <vaultName>, <servicePrincipalApplicationId>och <servicePrincipalSecret> med lämpliga värden.

Mer information om azure_preview_modulesfinns på sidan Ansible Galaxy .

Ansible 2.10 med 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 }}"

Ersätt <vaultName> med lämpligt värde.

Mer information om azcollectionfinns i Ansible-samlingen för Azure.

get-secret-value.yml Kör spelboken.

ansible-playbook get-secret-value.yml

TASK [Output key vault secret] *************************************************
ok: [localhost] => {
    "msg": "<plainTextPassword>"
}

Bekräfta att utdata som har ersatts <plainTextPassword> är oformaterad text för hemligheten som tidigare skapades i Azure Key Vault.

Fullständigt Ansible-spelboksexempel

I det här avsnittet visas hela ansible-exempelspelboken för att konfigurera en virtuell Azure Windows-dator med hjälp av en nyckelvalvshemlighet.

---
- 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

Ersätt <key_vault_uri> och <key_vault_secret_name> med lämpliga värden.

Rensa resurser

Spara följande kod som delete_rg.yml.

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

Kör spelboken med kommandot ansible-playbook . Ersätt platshållaren med namnet på den resursgrupp som ska tas bort. Alla resurser i resursgruppen tas bort.
```
ansible-playbook delete_rg.yml --extra-vars "name=<resource_group>"
```
Viktiga punkter:
- På grund av variabeln register och debug avsnittet i spelboken visas resultatet när kommandot har slutförts.

Kör az group delete för att ta bort resursgruppen. Alla resurser i resursgruppen tas bort.
```
az group delete --name <resource_group>
```
Kontrollera att resursgruppen har tagits bort med hjälp av az group show.
```
az group show --name <resource_group>
```

Kör Remove-AzResourceGroup för att ta bort resursgruppen. Alla resurser i resursgruppen tas bort.
```
Remove-AzResourceGroup -Name <resource_group>
```
Kontrollera att resursgruppen har tagits bort med hjälp av Get-AzResourceGroup.
```
Get-AzResourceGroup -Name <resource_group>
```

Nästa steg

Ansible i Azure