© Copyright 2024, Intel Corporation

This example creates an Azure Virtual Machine on Intel Icelake CPU on Linux Operating System. The virtual machine is created on an Intel Icelake Standard_D2_v5 by default.

As you configure your application's environment, choose the configurations for your infrastructure that matches your application's requirements. In this example, the virtual machine is using a preconfigured network interface, subnet, and resource group and has an additional option to enable boot diagnostics. The tags Name, Owner and Duration are added to the virtual machine when it is created.

This collection included 2 roles and 3 playbooks.

Role:- Ansible roles are a way to reuse and organize your Ansible code. They are self-contained units that contain all the files and configuration needed to automate a specific task. Roles are defined using a directory structure with specific directories for tasks, variables, files, templates, and other artifacts. This structure makes it easy to find and reuse code, and it also makes it easy to extend behaviour of roles.

To use a role in an Ansible playbook, you simply need to list it in the roles section of the playbook. Ansible will then automatically load the role and execute its tasks.

For this module, There are 2 roles.

1. azure_rhel_vm_multi_disks - It creates multiple disks on an Azure virtual machine on Intel Icelake CPU on Linux Operating System
2. azure_rhel_vm_spot_vm creates a Spot Azure Virtual Machine on Intel Icelake CPU on Linux Operating System

** **Playbook:- An Ansible playbook is a YAML file that describes the tasks, are composed of a series of plays, which are groups of tasks that are executed in a specific order. Each play defines a set of tasks that should be executed on a specific group of hosts. Playbooks can also include variables, which can be used to store data that is used by the tasks. This makes it easy to reuse playbooks for different environments and configurations. for this module. For this module, There are 3 playbooks, Where

1. Playbook intel_azure_linux_vm.yml - Used to creates an Azure Virtual Machine on Intel Icelake CPU on Linux Operating System, it uses Terraform module terraform-intel-azure-linux-vm and being called by Ansible module community.general.terraform
2. Playbook intel_azure_rhel_vm_multi_disks.yml - It executes role called azure_rhel_vm_multi_disks
3. Playbook intel_azure_rhel_vm_spot_vm.yml - It executes role called azure_rhel_vm_spot_vm

.
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── galaxy.yml
├── playbooks
│   ├── intel_azure_linux_vm.yml
│   ├── intel_azure_rhel_vm_multi_disks.yml
│   └── intel_azure_rhel_vm_spot_vm.yml
├── README.md
├── requirements.txt
├── requirements.yml
├── roles
│   ├── azure_rhel_vm_multi_disks
│   │   ├── defaults
│   │   │   └── main.yml
│   │   ├── files
│   │   ├── handlers
│   │   │   └── main.yml
│   │   ├── meta
│   │   │   └── main.yml
│   │   ├── README.md
│   │   ├── tasks
│   │   │   ├── download_tf_module.yml
│   │   │   ├── main.yml
│   │   │   ├── managed_disk.yml
│   │   │   ├── output.yml
│   │   │   ├── read_tfstate.yml
│   │   │   └── vm.yml
│   │   ├── templates
│   │   ├── tests
│   │   │   ├── inventory
│   │   │   └── test.yml
│   │   └── vars
│   │       └── main.yml
│   └── azure_rhel_vm_spot_vm
│       ├── defaults
│       │   └── main.yml
│       ├── files
│       ├── handlers
│       │   └── main.yml
│       ├── meta
│       │   └── main.yml
│       ├── README.md
│       ├── tasks
│       │   ├── download_tf_module.yml
│       │   ├── main.yml
│       │   ├── output.yml
│       │   └── rhel_vm.yml
│       ├── templates
│       ├── tests
│       │   ├── inventory
│       │   └── test.yml
│       └── vars
│           └── main.yml
└── security.md

1. Download and Install Azure CLI: https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=dnf
2. Authenticate Azure CLI: https://learn.microsoft.com/en-us/cli/azure/reference-index?view=azure-cli-latest#az-login

1. Case 1:- When user's needs can be met with the default configuration, and they want to install a collection from Ansible Galaxy to the default location (as a third-party collection), it is recommended to use the following command:

       ansible-galaxy  collection install <ansible-intel-azure-linux-vm>
   

2. Case 2:- When user's needs can't be met with the default configuration, wants to extend/modify existing configuration and flow, They can install collection using Ansible Galaxy in user's define location Use below approaches

   1. ansible-galaxy  collection install -p <local path> <ansible-intel-azure-linux-vm>
      

      Note: collection will download collection, you can remove as per need

   2. Download source and Copy role directory to your Ansible boilerplate from GitHub (Used to extended behavior of role)

      git clone https://github.com/OTCShare2/ansible-intel-azure-linux-vm.git
      cd ansible-intel-azure-linux-vm
      cp -r role/azure_rhel_vm_multi_disks /<your project path>/
      

Note:

1. Install requirements using requirements.txt and requirements.yml, Use below command:

   pip3 install -r requirements.txt
   ansible-galaxy install -r requirements.yml

2. Above role requires Terraform as we are executing terraform module terraform-intel-azure-linux-vm using Ansible module called community.general.terraform

Use playbook to execute Terraform module terraform-intel-azure-linux-vm using Ansible module community.general.terraform as below

- hosts: localhost
  vars:
    terraform_source: https://github.com/intel/terraform-intel-azure-linux-vm.git
  tasks:
    - set_fact:
        terraform_module_download_path: '/home/{{ansible_env.USER}}/terraform/main/intel_azure_linux_vm/'

    - name: Clone a github repository
      git:
        repo: '{{ terraform_source }}'
        dest: '{{ terraform_module_download_path }}'
        clone: yes
        update: yes
        version: main

    - name: Azure linux vm
      community.general.terraform:
        project_path: '{{ terraform_module_download_path }}'
        state: present
        force_init: true
        complex_vars: true
        # for additional variables
        # https://github.com/intel/terraform-intel-azure-linux-vm/blob/main/variables.tf
        variables:
          azurerm_resource_group_name: "rg-intel-29112023"
          azurerm_virtual_network_name: "vnet1"
          virtual_network_resource_group_name: "rg-intel-29112023"
          virtual_machine_size: "Standard_D2s_v3"
          azurerm_subnet_name: "default"
          admin_password: "Password@123"
          tags:
            owner: [email protected]
            duration: 1
      register: vm_output

    - debug:
        var: vm_output

Use below Command:

ansible-playbook intel_azure_linux_vm.yml

- name: Azure linux vm
  community.general.terraform:
    project_path: '{{ terraform_module_download_path }}'
    state: planned
    force_init: true
    complex_vars: true
    # for additional variables
    # https://github.com/intel/terraform-intel-azure-linux-vm/blob/main/variables.tf
    variables:
      azurerm_resource_group_name: "rg-intel-29112023"
      admin_password: "Password@123"
  register: vm_output

- name: Azure linux vm
  community.general.terraform:
    project_path: '{{ terraform_module_download_path }}'
    state: present
    force_init: true
    complex_vars: true
    # for additional variables
    # https://github.com/intel/terraform-intel-azure-linux-vm/blob/main/variables.tf
    variables:
      azurerm_resource_group_name: "rg-intel-29112023"
      admin_password: "Password@123"
  register: vm_output

- name: Azure linux vm
  community.general.terraform:
    project_path: '{{ terraform_module_download_path }}'
    state: absent
    force_init: true
    complex_vars: true
    # for additional variables
    # https://github.com/intel/terraform-intel-azure-linux-vm/blob/main/variables.tf
    variables:
      azurerm_resource_group_name: "rg-intel-29112023"
      admin_password: "Password@123"
  register: vm_output

object({
    identity_ids = optional(list(string))
    principal_id = optional(string)
    tentant_id   = optional(string)
    type         = optional(string, "SystemAssigned")
  })