チュートリアル: Azure Key Vault で Ansible を使用して VM シークレットを格納する

[アーティクル]
06/08/2023

このクイックスタートでは、Ansible を使用して Azure キーコンテナーからシークレットを作成して取得します。

重要

この記事のサンプルプレイブックを実行するには、Ansible 2.9 (以降) が必要です。

この記事では、次のことについて説明します。

Azure キーコンテナーインスタンスを作成する
Azure キーコンテナーにシークレットストアを作成する
Ansible を使用して Azure キーコンテナーからシークレットを取得する

前提条件

Azure サブスクリプション:Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

Azure サービスプリンシパル: サービスプリンシパルを作成して、appId、displayName、password、および tenant の値をメモします。

Ansible のインストール: 次のいずれかのオプションを実行します。
- Linux 仮想マシンに Ansible をインストールして構成する
- Azure Cloud Shell を構成する

Azure Key Vault を作成する

Ansible では、ご利用のリソースをデプロイするリソースグループが必要です。

create_kv.yml という名前の Ansible プレイブックを作成し、リソースグループを作成するための次のタスクを追加します。

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

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

テナント ID、サービスプリンシパルオブジェクト ID、コンテナー名に対応する必須の変数を定義します。
```
---
vars:
  tenant_id: <tenantId>
  object_id: <servicePrincipalObjectId>
  vault_name: <vaultName>
```
<tenantId>、<servicePrincipalObjectId>、<vaultName> を適切な値に置き換えます。 objectId は、キーコンテナー内のシークレットへのアクセスを許可するために使用されます。

キーポイント:
- Azure キーコンテナー名は、グローバルに一意である必要があります。キーコンテナーとその中に含まれているキー/シークレットには、https://{vault-name}.vault.azure.net URI を使用してアクセスします。

create_kv.yml タスクを追加して、Azure キーコンテナーインスタンスを構成します。

---
- 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 キーコンテナーを作成するプレイブック全体

このセクションには、Azure キーコンテナーを作成するサンプル Ansible プレイブック全体を示します。

- 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

キーコンテナーでシークレットを作成する

シークレットを作成する前に、keyvault 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 の詳細については、「Azure 向け Ansible コレクション」を参照してください。

プレイブック get-secret-value.yml を実行します。
```
ansible-playbook get-secret-value.yml
```
```
TASK [Output key vault secret] *************************************************
ok: [localhost] => {
    "msg": "<plainTextPassword>"
}
```
<plainTextPassword> の位置に示される出力が、Azure キーコンテナーで以前に作成されたシークレットのプレーンテキスト値であることを確認してください。

サンプル Ansible プレイブック全体

このセクションには、キーコンテナーシークレットを使用して Azure Windows VM を構成するサンプル Ansible プレイブック全体を示します。

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

次のステップ

Azure 上の Ansible

チュートリアル: Azure Key Vault で Ansible を使用して VM シークレットを格納する

前提条件

Azure Key Vault を作成する

Azure キーコンテナーを作成するプレイブック全体

キーコンテナーでシークレットを作成する

キーコンテナーからシークレットを取得する

サンプル Ansible プレイブック全体

リソースをクリーンアップする

次のステップ

フィードバック

フィードバック

その他のリソース

チュートリアル: Azure Key Vault で Ansible を使用して VM シークレットを格納する

前提条件

Azure Key Vault を作成する

Azure キー コンテナーを作成するプレイブック全体

キー コンテナーでシークレットを作成する

キー コンテナーからシークレットを取得する

サンプル Ansible プレイブック全体

リソースをクリーンアップする

次のステップ

フィードバック

フィードバック

その他のリソース

Azure キーコンテナーを作成するプレイブック全体

キーコンテナーでシークレットを作成する

キーコンテナーからシークレットを取得する