kitchen-azurerm 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b127c1a7e5d1c197dde573ce77d5e9900fe2297d12e5d8cbcd4d6d1e328ccc
-  data.tar.gz: d59c1a55f910f415a271a4818a8879a16e06dff3192d3d3a64d5ce1c32313e6c
+  metadata.gz: a47e2282b156031bc220f784b2fc11d9e689450a1681bcab96e00edf4c40d075
+  data.tar.gz: 69d729b824fdb55d6849dcd602be3729079bb12db1f51b729d9f1b4635df5c73
 SHA512:
-  metadata.gz: 1e21e9a0cce3a113f9d6fd9206a9272282eb1d54c637e2c9f5b629a42ccbf144889355d18db7127a7693e088d8056005139cdf142e3232ed70870c72b23db3f0
-  data.tar.gz: '0690d8abddf2c745c7631e463e7479299a0e1e8a83af57caca797e8555a840bc0559c383d7d703b35c7bb7ec4c65b7556a15e95cf2b4582c153f8e45d0dd97e9'
+  metadata.gz: f18774a15ca7ee6b741ebb1a07f8e0e9d684a1253424c3a8d5589f029eacab23bf6e647264e05bbcebaf1401b3182a3c20cf1ce74ef80c4b349880971efa1ee1
+  data.tar.gz: '059138541c0d19ffc591fad58292eececc2f70e1b4dfca5a3a5352c7a612b240505e28e34966132b413fdb74331dfd4fd0b607716c8fec0630157fb4bb69ca84'

data/README.md

@@ -1,6 +1,7 @@
 # kitchen-azurerm
 
-[![Gem Version](https://badge.fury.io/rb/kitchen-azurerm.svg)](http://badge.fury.io/rb/kitchen-azurerm) ![CI](https://github.com/test-kitchen/kitchen-azurerm/workflows/CI/badge.svg?branch=master)
+[![Gem Version](https://badge.fury.io/rb/kitchen-azurerm.svg)](https://badge.fury.io/rb/kitchen-azurerm)
+![CI](https://github.com/test-kitchen/kitchen-azurerm/workflows/CI/badge.svg?branch=master)
 
 **kitchen-azurerm** is a driver for the popular test harness [Test Kitchen](http://kitchen.ci) that allows Microsoft Azure resources to be provisioned before testing. This driver uses the new Microsoft Azure Resource Management REST API via the [azure-sdk-for-ruby](https://github.com/azure/azure-sdk-for-ruby).
 
@@ -76,9 +77,276 @@ wsus-windows-2019   Azurerm  ChefZero     Inspec    Winrm      <Not Created>  <N
 wsus-windows-2016   Azurerm  ChefZero     Inspec    Winrm      <Not Created>  <None>
 ```
 
-### .kitchen.yml example 1 - Linux/Ubuntu
+### Driver Properties
 
-Here's an example ```.kitchen.yml``` file that provisions an Ubuntu Server, using Chef Zero as the provisioner and SSH as the transport. Note that if the key does not exist at the specified location, it will be created. Also note that if ```ssh_key``` is supplied, Test Kitchen will use this in preference to any default/configured passwords that are supplied.
+The following properties are able to be specified in the `driver` section of the Test Kitchen configuration:
+
+#### subscription_id (required)
+
+* _string_ : Reads string from `ENV["AZURE_SUBSCRIPTION_ID"]` or must be specified if not present in `ENV`.
+  * Default Value: `ENV["AZURE_SUBSCRIPTION_ID"]`
+
+#### azure_environment
+
+* _string_ : Name of Azure environment to use.
+
+#### machine_size (required)
+
+* _string_ : Machine size to use for instances created.
+
+#### location (required)
+
+* _string_ : Azure location to use, example `"Central US"`
+
+#### azure_resource_group_prefix
+
+* _string_ : Prefix to use for the resource group configuration which will be created.
+  * Default Value: `"kitchen-"`
+
+#### azure_resource_group_suffix
+
+* _string_ : Optional suffix to append to resource group name.
+  * Default Value: `""`
+
+#### azure_resource_group_name
+
+* _string_ : Optional override for base name of the Azure Resource group which is created, uses prefix and suffix.
+  * Default Value: `""`
+
+#### explicit_resource_group_name
+
+* _string_ : Optional explicit resource group name, does not use `azure_resource_group_prefix`/`azure_resource_group_suffix`
+  * Default Value: `""`
+
+#### destroy_explicit_resource_group
+
+* _boolean_ : Used for cleanup with `explicit_resource_group_name`
+  * Default Value: `true`
+
+#### destroy_explicit_resource_group_tags
+
+* _boolean_ : Used for cleanup with `explicit_resource_group_name`
+  * Default Value: `true`
+
+#### destroy_resource_group_contents
+
+* _boolean_ : Can be used when you want to destroy the resources within a resource group without destroying the resource group itself. For example, the following configuration options used in combination would use an existing resource group (or create one if it doesn't exist) and will destroy the contents of the resource group in the ```kitchen destroy``` phase. If you wish to destroy the empty resource group created after you empty the resource group with this flag you can now set the ```destroy_explicit_resource_group``` to "true" to destroy the empty resource group.
+  * Default Value: `false`
+
+#### resource_group_tags
+
+* _hash_ : Optional hash of tags to pass to resource group
+
+  ```yaml
+  driver:
+    name: azurerm
+    resource_group_tags:
+      tag1: tag1value
+  ```
+
+#### image_urn
+
+* _string_ : Image URN to use for vm creation. List can be found using `az` cli - [https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cli-ps-findimage#list-popular-images]
+  * Default Value: `"Canonical:UbuntuServer:14.04.3-LTS:latest"`
+
+#### image_url
+
+* _string_ : (unmanaged disks only) can be used to specify a custom vhd
+  * This VHD must be in the same storage account as the disks of the VM, therefore ```existing_storage_account_blob_url``` must also be set and ```use_managed_disks``` must be set to false.
+
+#### image_id
+
+* _string_ : (managed disks only) can be used to specify an image by id (managed disk). This works only with managed disks.
+
+#### use_ephemeral_osdisk
+
+* _boolean_ : Optional flag to use ephermeal disk for instances.
+  * Default Value: `false`
+
+#### os_disk_size_gb
+
+* _string_ : Optional override of os disk size for instances.
+
+#### os_type
+
+* _string_ : Should be specified when os type is not `linux`
+  * Default Value: `"linux"`
+
+#### custom_data
+
+* _string_ : Optional custom data which may be specified for instances [https://docs.microsoft.com/en-us/azure/virtual-machines/custom-data].
+  * Value can be a file or the data itself, this module handles base64 encoding for you.
+
+#### username
+
+* _string_ : Username to use for connecting to instances.
+  * Default Value: `"azure"`
+
+#### password
+
+* _string_ : Optional password to use for connecting to instances.
+  * Default Value: `SecureRandom.base64(25)` (Randomly generated 24 digit password)
+
+#### vm_name
+
+* _string_ : Optional name for vm instances to create.
+  * Default Value: `"tk-#{SecureRandom.hex(6)[0..11]}"` (Randomly generated 12 character name prefixed with `tk-`)
+
+#### nic_name
+
+* _string_ : Optional name to provide for nic, if not specified then nic name will be `"nic-#{config[:vm_name]}"`.
+
+#### vnet_id
+
+* _string_ : Optional `vnet` to provide.  If no `vnet` is chosen then public IP will be assigned using default values.
+
+#### subnet_id
+
+* _string_ : Optional subnet to provide, should be used with `vnet_id`.
+
+#### public_ip
+
+* _boolean_ : Option to specify if a public IP should be assigned.  In default configuration if all other options are left at default then a public IP _will_ be assigned, due to `vnet_id` having no value.
+  * Default Value: `false`
+
+#### public_ip_sku
+
+* _string_ : Optional string to change the SKU of allocated public IP address.  Defaults to `Basic`.
+  * Default Value: `"Basic"`
+
+#### storage_account_type
+
+* _string_ : Optional storage account type.
+  * Default Value: `"Standard_LRS"`
+
+#### existing_storage_account_blob_url
+
+* _string_ : Used with private image specification, the URL of the existing storage account (blob) (without container)
+
+#### existing_storage_account_container
+
+* _string_ : Used with private image specification, the Container Name for OS Images (blob)
+
+#### boot_diagnostics_enabled
+
+* _boolean_ : Whether to enable (true) or disable (false) boot diagnostics. Default: true (requires Standard storage).
+  * Default Value: `true`
+
+#### winrm_powershell_script
+
+* _string_ : By default on Windows machines, a PowerShell script runs that enables WinRM over the SSL transport, for Basic, Negotiate and CredSSP connections. To supply your own PowerShell script (e.g. to enable HTTP), use the `winrm_powershell_script` parameter. Windows 2008 R2 example:
+
+    ```yaml
+    platforms:
+    - name: windows2008-r2
+        driver_config:
+        image_urn: MicrosoftWindowsServer:WindowsServer:2008-R2-SP1:latest
+        winrm_powershell_script: |-
+            winrm quickconfig -q
+            winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="512"}'
+            winrm set winrm/config '@{MaxTimeoutms="1800000"}'
+            winrm set winrm/config/service '@{AllowUnencrypted="true"}'
+            winrm set winrm/config/service/auth '@{Basic="true"}'
+
+    ```
+
+#### pre_deployment_template
+
+* _string_ : Optional path to name of pre-deployment template to use.
+
+#### pre_deployment_parameters
+
+* _hash_ : Optional parameters to pass to pre-deployment template.
+
+#### post_deployment_template
+
+* _string_ : Optional path to name of post-deployment template to use.
+
+#### post_deployment_parameters
+
+* _hash_ : Optional parameters to pass to post-deployment template.
+
+#### plan
+
+* _hash_ : Optional JSON object which allows you to define plan information when creating VMs from Marketplace images. Please refer to [Deploy an image with Marketplace terms](https://aka.ms/azuremarketplaceapideployment) for more details. Not all Marketplace images support programmatic deployment, and support is controlled by the image publisher.
+
+#### vm_tags
+
+* _hash_ : Optional hash of vm tags to populate.
+
+#### use_managed_disks
+
+* _boolean_ : Must be set to `true` to use `data_disks` property.
+  * Default Value: `true`
+
+#### data_disks
+
+* _array_ : Additional disks to configure for instances.
+
+    ```yaml
+    platforms:
+    - name: windows2016-noformat
+    driver:
+        image_urn: MicrosoftWindowsServer:WindowsServer:2016-Datacenter:latest
+        data_disks:
+        - lun: 0
+            disk_size_gb: 128
+        - lun: 1
+            disk_size_gb: 128
+        - lun: 2
+            disk_size_gb: 128
+    ```
+
+#### format_data_disks
+
+* _boolean_ : Run format operations on attached data disks
+  * Default Value: `false`
+
+#### format_data_disks_powershell_script
+
+* _boolean_ : Customize the content of format operations for attached `data_disks`
+  * Default Value: `false`
+
+#### system_assigned_identity
+
+* _boolean_ : Whether to enable system assigned identity for the vm.
+  * Default Value: `false`
+
+#### user_assigned_identities
+
+* _hash_ : An object whose keys are resource IDs for user identities to associate with the Virtual Machine and whose values are empty objects, or empty to disable user assigned
+identities.
+
+#### deployment_sleep
+
+* _string_ : Time in seconds to sleep at the end of deployment before fetching details.
+  * Default Value: `10`
+
+#### secret_url
+
+* _string_ : used with connecting to Azure Key Vault
+
+#### vault_name
+
+* _string_ : used with connecting to Azure Key Vault
+
+#### vault_resource_group
+
+* _string_ : used with connecting to Azure Key Vault
+
+#### azure_api_retries
+
+* _string_ : Number of times to retry connections to Azure API.
+  * Default Value: `5`
+
+#### use_fqdn_hostname
+
+* _boolean_ : When true, Kitchen will use the FQDN that is assigned to the Virtual Machine. When false, kitchen will use the public IP address of the machine. This may overcome issues with Corporate firewalls or VPNs blocking Public IP addresses.
+  * Default Value: `false`
+
+### kitchen.yml example 1 - Linux/Ubuntu
+
+Here's an example ```kitchen.yml``` file that provisions an Ubuntu Server, using Chef Zero as the provisioner and SSH as the transport. Note that if the key does not exist at the specified location, it will be created. Also note that if ```ssh_key``` is supplied, Test Kitchen will use this in preference to any default/configured passwords that are supplied.
 
 ```yaml
 ---
@@ -102,8 +370,6 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchentesting::default]
     attributes:
 ```
 
@@ -115,9 +381,9 @@ Concurrent execution of create/converge/destroy is supported via the --concurren
 
 Where n is the number of threads to create. Note that any failure (e.g. an AzureOperationError) will cause the whole test to fail, though resources already in creation will continue to be created.
 
-### .kitchen.yml example 2 - Windows
+### kitchen.yml example 2 - Windows
 
-Here's a further example ```.kitchen.yml``` file that will provision a Windows Server 2019 [smalldisk] instance, using WinRM as the transport. An [ephemeral os disk](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks) is used. The resource created in Azure will enable itself for remote access at deployment time (it does this by customizing the machine at provisioning time) and tags the Azure Resource Group with metadata using the ```resource_group_tags``` property. Notice that the ```vm_tags``` and ```resource_group_tags``` properties use a simple ```key : value``` structure per line:
+Here's a further example ```kitchen.yml``` file that will provision a Windows Server 2019 [smalldisk] instance, using WinRM as the transport. An [ephemeral os disk](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks) is used. The resource created in Azure will enable itself for remote access at deployment time (it does this by customizing the machine at provisioning time) and tags the Azure Resource Group with metadata using the ```resource_group_tags``` property. Notice that the ```vm_tags``` and ```resource_group_tags``` properties use a simple ```key : value``` structure per line:
 
 ```yaml
 ---
@@ -145,12 +411,10 @@ platforms:
       name: winrm
 suites:
   - name: default
-    run_list:
-      - recipe[kitchentesting::default]
     attributes:
 ```
 
-### .kitchen.yml example 3 - "pre-deployment" ARM template
+### kitchen.yml example 3 - "pre-deployment" ARM template
 
 The following example introduces the ```pre_deployment_template``` and ```pre_deployment_parameters``` properties in the configuration file.
 You can use this capability to execute an ARM template containing Azure resources to provision before the system under test is created.
@@ -224,7 +488,7 @@ Example predeploy.json:
 }
 ```
 
-### .kitchen.yml example 4 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios)
+### kitchen.yml example 4 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios)
 
 The following example introduces the ```vnet_id``` and ```subnet_id``` properties under "driver" in the configuration file. This can be applied at the top level, or per platform.
 You can use this capability to create the VM on an existing virtual network and subnet created in a different resource group.
@@ -254,12 +518,46 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchen-azurerm-demo::default]
     attributes:
 ```
 
-### .kitchen.yml example 5 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios) with Private Managed Image
+### kitchen.yml example 5 - deploy VM to existing virtual network/subnet with a Standard SKU public IP (use for ExpressRoute/VPN scenarios)
+
+The following example introduces the ```vnet_id``` and ```subnet_id``` properties under "driver" in the configuration file. This can be applied at the top level, or per platform.
+You can use this capability to create the VM on an existing virtual network and subnet created in a different resource group.
+
+This enables scenarios that require a Standard SKU public IP resource, for example when a NAT gateway is present on the target subnet.
+
+
+```yaml
+---
+driver:
+  name: azurerm
+  subscription_id: 'your-azure-subscription-id-here'
+  location: 'West Europe'
+  machine_size: 'Standard_D1'
+
+transport:
+  ssh_key: ~/.ssh/id_kitchen-azurerm
+
+provisioner:
+  name: chef_zero
+
+platforms:
+  - name: ubuntu-1404
+    driver:
+      image_urn: Canonical:UbuntuServer:14.04.4-LTS:latest
+      vnet_id: /subscriptions/b6e7eee9-YOUR-GUID-HERE-03ab624df016/resourceGroups/pendrica-infrastructure/providers/Microsoft.Network/virtualNetworks/pendrica-arm-vnet
+      subnet_id: subnet-10.1.0
+	  public_ip: true
+	  public_ip_sku: Standard
+
+suites:
+  - name: default
+    attributes:
+```
+
+### kitchen.yml example 6 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios) with Private Managed Image
 
 This example is the same as above, but uses a private managed image to provision the vm.
 
@@ -289,12 +587,10 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchen-azurerm-demo::default]
     attributes:
 ```
 
-### .kitchen.yml example 6 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios) with Private Classic OS Image
+### kitchen.yml example 7 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios) with Private Classic OS Image
 
 This example a classic Custom VM Image (aka a VHD file) is used. As the Image VHD must be in the same storage account then the disk of the instance, the os disk is created in an existing image account.
 
@@ -332,12 +628,10 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchen-azurerm-demo::default]
     attributes:
 ```
 
-### .kitchen.yml example 7 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios) with Private Classic OS Image and providing custom data and extra large os disk
+### kitchen.yml example 8 - deploy VM to existing virtual network/subnet (use for ExpressRoute/VPN scenarios) with Private Classic OS Image and providing custom data and extra large os disk
 
 This is the same as above, but uses custom data to customize the instance.
 
@@ -377,12 +671,10 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchen-azurerm-demo::default]
     attributes:
 ```
 
-### .kitchen.yml example 8 - Windows 2016 VM with additional data disks
+### kitchen.yml example 9 - Windows 2016 VM with additional data disks
 
 This example demonstrates how to add 3 additional Managed data disks to a Windows Server 2016 VM. Not supported with legacy (pre-managed disk) storage accounts.
 
@@ -414,12 +706,10 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchentesting::default]
     attributes:
 ```
 
-### .kitchen.yml example 9 - "post-deployment" ARM template with MSI authentication
+### kitchen.yml example 10 - "post-deployment" ARM template with MSI authentication
 
 The following example introduces the ```post_deployment_template``` and ```post_deployment_parameters``` properties in the configuration file.
 You can use this capability to execute an ARM template containing Azure resources to provision after the system under test is created.
@@ -451,8 +741,6 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchen-azurerm-demo::default]
     attributes:
 ```
 
@@ -505,7 +793,7 @@ Example postdeploy.json to enable MSI extention on VM:
 }
 ```
 
-### .kitchen.yml example 10 - Enabling Managed Service Identities
+### kitchen.yml example 11 - Enabling Managed Service Identities
 
 This example demonstrates how to enable a System Assigned Identity and User Assigned Identities on a Kitchen VM.
 Any combination of System and User assigned identities may be enabled, and multiple User Assigned Identities can be supplied.
@@ -536,12 +824,10 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchentesting::default]
     attributes:
 ```
 
-### .kitchen.yml example 11 - deploy VM with key vault certificate
+### kitchen.yml example 12 - deploy VM with key vault certificate
 
 This following example introduces ```secret_url```, ```vault_name```, and ```vault_resource_group``` properties under "driver" in the configuration file. You can use this capability to create a VM with a specified key vault certificate.
 
@@ -567,8 +853,6 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[kitchentesting::default]
     attributes:
 ```
 
@@ -578,7 +862,7 @@ Starting with v0.9.0 this driver has support for Azure Government and Sovereign
 
 Note that the ```use_managed_disks``` option should be set to false until supported by AzureUSGovernment.
 
-### Example .kitchen.yml for Azure US Government cloud
+### Example kitchen.yml for Azure US Government cloud
 
 ```yaml
 ---
@@ -605,8 +889,6 @@ platforms:
 
 suites:
   - name: default
-    run_list:
-      - recipe[vmtesting::default]
 ```
 
 ### How to retrieve the image_urn
@@ -644,70 +926,6 @@ data:    Canonical  UbuntuServer  15.10-DAILY        15.10.201509220  westeurope
 info:    vm image list command OK
 ```
 
-### Additional parameters that can be specified in your `kitchen.yml` or added to your personal `kitchen.local.yml`
-
-* Note that the ```driver``` section can also take explicit values for ```username``` and ```password```. Otherwise, the default username is "azure" and the password is a randomly generated 24 character password that can be found in your local kitchen state file (typically `.kitchen/<instance-name>.yml`) if you require it for any reason.
-
-* The ```storage_account_type``` parameter defaults to 'Standard_LRS' and allows you to switch to premium storage (e.g. 'Premium_LRS')
-
-* The ```enable_boot_diagnostics``` parameter defaults to 'true' and allows you to switch off boot diagnostics in case you are using premium storage.
-
-* The optional ```vm_tags``` parameter allows you to define key:value pairs to tag VMs with on creation.
-
-* The optional ```plan``` parameter allows you to define plan information when creating VMs from Marketplace images. Please refer to [Deploy an image with Marketplace terms](https://aka.ms/azuremarketplaceapideployment) for more details. Not all Marketplace images support programmatic deployment, and support is controlled by the image publisher.
-
-* Managed disks are now enabled by default, to use the Storage account set ```use_managed_disks``` (default: true).
-
-* The ```image_url``` (unmanaged disks only) parameter can be used to specify a custom vhd (This VHD must be in the same storage account as the disks of the VM, therefore ```existing_storage_account_blob_url``` must also be set and ```use_managed_disks``` must be set to false)
-
-* The ```image_id``` (managed disks only) parameter can be used to specify an image by id (managed disk). This works only with managed disks.
-
-* The ```existing_storage_account_blob_url``` can be specified to specify an url to an existing storage account (needed for ```image_url```)
-
-* The ```custom_data``` parameter can be used to specify custom data to provide to the instance. This can be a file or the data itself. This module handles base64 encoding for you.
-
-* The ```os_disk_size_gb``` parameter can be used to specify a custom os disk size.
-
-* The ```azure_resource_group_prefix``` and ```azure_resource_group_suffix``` can be used to further disambiguate Azure resource group names created by the driver.
-
-* The ```explicit_resource_group_name``` and ```destroy_explicit_resource_group``` (default: "true") parameters can be used in scenarios where you are provided a pre-created Resource Group. Example usage: ```explicit_resource_group_name: kitchen-<%= ENV["USERNAME"] %>```. The ```destroy_explicit_resource_group``` option can now be used after using the ```destroy_resource_group_contents``` option creates an empty resource group to destroy the resource group previously created.
-
-* The ```destroy_resource_group_contents``` (default: "false") parameter can be used when you want to destroy the resources within a resource group without destroying the resource group itself. For example, the following configuration options used in combination would use an existing resource group (or create one if it doesn't exist) and will destroy the contents of the resource group in the ```kitchen destroy``` phase. If you wish to destroy the empty resource group created after you empty the resource group with this flag you can now set the ```destroy_explicit_resource_group``` to "true" to destroy the empty resource group. 
-
-* The ```destroy_explicit_resource_group_tags``` (default: "true") parameter can be used when you want to remove tags associated with an explicit resource group. The default setting is set to "true" to remain consistent with previous behavior. This should be used in combination with an ```explicit_resource_group_name``` and will be honored during the ```kitchen destroy``` phase.
-
-```yaml
----
-driver:
-  explicit_resource_group_name: stuart-rg-demo-001
-  destroy_explicit_resource_group: false
-  destroy_resource_group_contents: true
-```
-
-* The ```use_ephemeral_osdisk``` (default: false) parameter can be used if you wish to use [ephemeral OS disk functionality](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks).
-
-* The ```secret_url```, ```vault_name```, and ```vault_resource_group``` parameters can be used to deploy VM with specified key vault certificate.
-
-* The ```use_fqdn_hostname``` (default: "false") parameter can be used to determine how kitchen communicates with the Virtual Machine. When true, Kitchen will use the FQDN that is assigned to the Virtual Machine. When false, kitchen will use the public IP address of the machine. This may overcome issues with Corporate firewalls or VPNs blocking Public IP addresses.
-
-## Enabling alternative WinRM configurations
-
-* By default on Windows machines, a PowerShell script runs that enables WinRM over the SSL transport, for Basic, Negotiate and CredSSP connections. To supply your own PowerShell script (e.g. to enable HTTP), use the `winrm_powershell_script` parameter. Windows 2008 R2 example:
-
-```yaml
-platforms:
-  - name: windows2008-r2
-    driver_config:
-      image_urn: MicrosoftWindowsServer:WindowsServer:2008-R2-SP1:latest
-      winrm_powershell_script: |-
-        winrm quickconfig -q
-        winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="512"}'
-        winrm set winrm/config '@{MaxTimeoutms="1800000"}'
-        winrm set winrm/config/service '@{AllowUnencrypted="true"}'
-        winrm set winrm/config/service/auth '@{Basic="true"}'
-
-```
-
 ## Contributing
 
 Contributions to the project are welcome via submitting Pull Requests.
@@ -724,7 +942,7 @@ Stuart Preston
 
 ## License and Copyright
 
-Copyright 2015-2020, Chef Software, Inc.
+Copyright 2015-2021, Chef Software, Inc.
 
 ```
 Licensed under the Apache License, Version 2.0 (the "License");

data/lib/kitchen/driver/azurerm.rb

@@ -84,9 +84,7 @@ module Kitchen
         SecureRandom.base64(25)
       end
 
-      default_config(:vm_name) do |_config|
-        "vm"
-      end
+      default_config :vm_name, nil
 
       default_config(:nic_name) do |_config|
         ""
@@ -208,6 +206,10 @@ module Kitchen
         ENV["AZURE_SUBSCRIPTION_ID"]
       end
 
+      default_config(:public_ip_sku) do |_config|
+        "Basic"
+      end
+
       default_config(:azure_api_retries) do |_config|
         5
       end
@@ -238,12 +240,18 @@ module Kitchen
           deployment_parameters[:adminPassword] = config[:password]
         end
 
+        deployment_parameters[:publicIPSKU] = config[:public_ip_sku]
+
+        if config[:public_ip_sku] == "Standard"
+          deployment_parameters[:publicIPAddressType] = "Static"
+        end
+
         if config[:subscription_id].to_s == ""
           raise "A subscription_id config value was not detected and kitchen-azurerm cannot continue. Please check your kitchen.yml configuration. Exiting."
         end
 
         if config[:nic_name].to_s == ""
-          vmnic = "nic-#{config[:vm_name]}"
+          vmnic = "nic-#{state[:vm_name]}"
         else
           vmnic = config[:nic_name]
         end
@@ -366,9 +374,10 @@ module Kitchen
       # @return [Hash] Updated Hash of state values.
       def validate_state(state = {})
         state[:uuid] = SecureRandom.hex(8) unless existing_state_value?(state, :uuid)
+        state[:vm_name] = config[:vm_name] || "tk-#{state[:uuid][0..11]}" unless existing_state_value?(state, :vm_name)
         state[:server_id] = "vm#{state[:uuid]}" unless existing_state_value?(state, :server_id)
         state[:azure_resource_group_name] = azure_resource_group_name unless existing_state_value?(state, :azure_resource_group_name)
-        %i{subscription_id vm_name azure_environment use_managed_disks}.each do |config_element|
+        %i{subscription_id azure_environment use_managed_disks}.each do |config_element|
           state[config_element] = config[config_element] unless existing_state_value?(state, config_element)
         end
         state.delete(:password) unless instance.transport[:ssh_key].nil?
@@ -727,10 +736,10 @@ module Kitchen
 
       def virtual_machine_deployment_template
         if config[:vnet_id] == ""
-          virtual_machine_deployment_template_file("public.erb", vm_tags: vm_tag_string(config[:vm_tags]), use_managed_disks: config[:use_managed_disks], image_url: config[:image_url], existing_storage_account_blob_url: config[:existing_storage_account_blob_url], image_id: config[:image_id], existing_storage_account_container: config[:existing_storage_account_container], custom_data: config[:custom_data], os_disk_size_gb: config[:os_disk_size_gb], data_disks_for_vm_json: data_disks_for_vm_json, use_ephemeral_osdisk: config[:use_ephemeral_osdisk], ssh_key: instance.transport[:ssh_key], plan_json: plan_json)
+          virtual_machine_deployment_template_file("public.erb", vm_tags: vm_tag_string(config[:vm_tags]), use_managed_disks: config[:use_managed_disks], image_url: config[:image_url], storage_account_type: config[:storage_account_type], existing_storage_account_blob_url: config[:existing_storage_account_blob_url], image_id: config[:image_id], existing_storage_account_container: config[:existing_storage_account_container], custom_data: config[:custom_data], os_disk_size_gb: config[:os_disk_size_gb], data_disks_for_vm_json: data_disks_for_vm_json, use_ephemeral_osdisk: config[:use_ephemeral_osdisk], ssh_key: instance.transport[:ssh_key], plan_json: plan_json)
         else
           info "Using custom vnet: #{config[:vnet_id]}"
-          virtual_machine_deployment_template_file("internal.erb", vnet_id: config[:vnet_id], subnet_id: config[:subnet_id], public_ip: config[:public_ip], vm_tags: vm_tag_string(config[:vm_tags]), use_managed_disks: config[:use_managed_disks], image_url: config[:image_url], existing_storage_account_blob_url: config[:existing_storage_account_blob_url], image_id: config[:image_id], existing_storage_account_container: config[:existing_storage_account_container], custom_data: config[:custom_data], os_disk_size_gb: config[:os_disk_size_gb], data_disks_for_vm_json: data_disks_for_vm_json, use_ephemeral_osdisk: config[:use_ephemeral_osdisk], ssh_key: instance.transport[:ssh_key], plan_json: plan_json)
+          virtual_machine_deployment_template_file("internal.erb", vnet_id: config[:vnet_id], subnet_id: config[:subnet_id], public_ip: config[:public_ip], vm_tags: vm_tag_string(config[:vm_tags]), use_managed_disks: config[:use_managed_disks], image_url: config[:image_url], storage_account_type: config[:storage_account_type], existing_storage_account_blob_url: config[:existing_storage_account_blob_url], image_id: config[:image_id], existing_storage_account_container: config[:existing_storage_account_container], custom_data: config[:custom_data], os_disk_size_gb: config[:os_disk_size_gb], data_disks_for_vm_json: data_disks_for_vm_json, use_ephemeral_osdisk: config[:use_ephemeral_osdisk], ssh_key: instance.transport[:ssh_key], public_ip_sku: config[:public_ip_sku], plan_json: plan_json)
         end
       end
 

data/templates/internal.erb

@@ -40,6 +40,20 @@
                 "description": "Unique DNS Name for the Public IP used to access the Virtual Machine."
             }
         },
+        "publicIPSKU": {
+            "type": "string",
+            "defaultValue": "Basic",
+            "metadata": {
+                "description": "SKU name for the Public IP used to access the Virtual Machine."
+            }
+        },
+        "publicIPAddressType": {
+            "type": "string",
+            "defaultValue": "Dynamic",
+            "metadata": {
+                "description": "SKU name for the Public IP used to access the Virtual Machine."
+            }
+        },
         <%- unless os_disk_size_gb.to_s.empty?  -%>
         "osDiskSizeGb": {
             "type": "int",
@@ -165,7 +179,7 @@
         },
         "storageAccountType": {
             "type": "string",
-            "defaultValue": "Standard_LRS",
+            "defaultValue": "<%= storage_account_type %>",
             "metadata": {
                 "description": "The type of storage to use (e.g. Standard_LRS or Premium_LRS)."
             }
@@ -201,7 +215,6 @@
         "subnetPrefix": "10.0.0.0/24",
         "storageAccountType": "[parameters('storageAccountType')]",
         "publicIPAddressName": "publicip",
-        "publicIPAddressType": "Dynamic",
         "vmStorageAccountContainerName": "vhds",
         "vmName": "[parameters('vmName')]",
         "vmSize": "[parameters('vmSize')]",
@@ -242,12 +255,15 @@
         <%- end -%>
         <%- if public_ip -%>
         {
-            "apiVersion": "2015-05-01-preview",
+            "apiVersion": "2017-08-01",
             "type": "Microsoft.Network/publicIPAddresses",
             "name": "[variables('publicIPAddressName')]",
             "location": "[variables('location')]",
+            "sku": {
+              "name": "[parameters('publicIPSKU')]"
+            },
             "properties": {
-                "publicIPAllocationMethod": "[variables('publicIPAddressType')]",
+                "publicIPAllocationMethod": "[parameters('publicIPAddressType')]",
                 "dnsSettings": {
                     "domainNameLabel": "[parameters('dnsNameForPublicIP')]"
                 }
@@ -343,12 +359,12 @@
                     },
                     <%- end -%>
                     <%- if use_ephemeral_osdisk -%>
-                    "osDisk": { 
-                        "diffDiskSettings": { 
-                             "option": "Local" 
-                        }, 
-                        "caching": "ReadOnly", 
-                        "createOption": "FromImage" 
+                    "osDisk": {
+                        "diffDiskSettings": {
+                             "option": "Local"
+                        },
+                        "caching": "ReadOnly",
+                        "createOption": "FromImage"
                     }
                     <%- elsif use_managed_disks -%>
                     "osDisk": {
@@ -356,6 +372,9 @@
                         <%- unless os_disk_size_gb.to_s.empty? -%>
                         "diskSizeGB": "[parameters('osDiskSizeGB')]",
                         <%- end -%>
+                        "managedDisk": {
+                            "storageAccountType": "[parameters('storageAccountType')]"
+                        },
                         "createOption": "FromImage"
                     }
                     <%- else -%>

data/templates/public.erb

@@ -163,9 +163,23 @@
                 "description": "The nic name created inside of the resource group."
             }
         },
+        "publicIPSKU": {
+            "type": "string",
+            "defaultValue": "Basic",
+            "metadata": {
+                "description": "SKU name for the Public IP used to access the Virtual Machine."
+            }
+        },
+        "publicIPAddressType": {
+            "type": "string",
+            "defaultValue": "Dynamic",
+            "metadata": {
+                "description": "SKU name for the Public IP used to access the Virtual Machine."
+            }
+        },
         "storageAccountType": {
             "type": "string",
-            "defaultValue": "Standard_LRS",
+            "defaultValue": "<%= storage_account_type %>",
             "metadata": {
                 "description": "The type of storage to use (e.g. Standard_LRS or Premium_LRS)."
             }
@@ -201,7 +215,6 @@
         "subnetPrefix": "10.0.0.0/24",
         "storageAccountType": "[parameters('storageAccountType')]",
         "publicIPAddressName": "publicip",
-        "publicIPAddressType": "Dynamic",
         "vmStorageAccountContainerName": "vhds",
         "vmName": "[parameters('vmName')]",
         "vmSize": "[parameters('vmSize')]",
@@ -213,7 +226,7 @@
     "resources": [
         {
             "apiVersion": "2017-05-10",
-            "name": "pid-18d63047-6cdf-4f34-beed-62f01fc73fc2", 
+            "name": "pid-18d63047-6cdf-4f34-beed-62f01fc73fc2",
             "type": "Microsoft.Resources/deployments",
             "properties": {
                 "mode": "Incremental",
@@ -241,16 +254,19 @@
         <%- end -%>
         <%- end -%>
         {
-            "apiVersion": "2015-05-01-preview",
+            "apiVersion": "2017-08-01",
             "type": "Microsoft.Network/publicIPAddresses",
             "name": "[variables('publicIPAddressName')]",
             "location": "[variables('location')]",
             "properties": {
-                "publicIPAllocationMethod": "[variables('publicIPAddressType')]",
+                "publicIPAllocationMethod": "[parameters('publicIPAddressType')]",
                 "dnsSettings": {
                     "domainNameLabel": "[parameters('dnsNameForPublicIP')]"
                 }
             },
+            "sku": {
+              "name": "[parameters('publicIPSKU')]"
+            },
             "tags": {
                 <%= vm_tags unless vm_tags.empty? %>
             }
@@ -362,12 +378,12 @@
                     },
                     <%- end -%>
                     <%- if use_ephemeral_osdisk -%>
-                    "osDisk": { 
-                        "diffDiskSettings": { 
-                             "option": "Local" 
-                        }, 
-                        "caching": "ReadOnly", 
-                        "createOption": "FromImage" 
+                    "osDisk": {
+                        "diffDiskSettings": {
+                             "option": "Local"
+                        },
+                        "caching": "ReadOnly",
+                        "createOption": "FromImage"
                     }
                     <%- elsif use_managed_disks -%>
                     "osDisk": {
@@ -375,6 +391,9 @@
                         <%- unless os_disk_size_gb.to_s.empty? -%>
                         "diskSizeGB": "[parameters('osDiskSizeGB')]",
                         <%- end -%>
+                        "managedDisk": {
+                            "storageAccountType": "[parameters('storageAccountType')]"
+                        },
                         "createOption": "FromImage"
                     }
                     <%- else -%>
@@ -405,7 +424,7 @@
                     }
                     <%- end -%>
                     <%- unless data_disks_for_vm_json.nil? -%>
-                      ,"dataDisks": 
+                      ,"dataDisks":
                           <%= data_disks_for_vm_json %>
                     <%- end -%>
                 },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-azurerm
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Stuart Preston
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_network
@@ -110,90 +110,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11.0'
-- !ruby/object:Gem::Dependency
-  name: chefstyle
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rspec-mocks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rspec-expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 description: Test Kitchen driver for the Microsoft Azure Resource Manager (ARM) API
 email:
 - stuart@chef.io
@@ -220,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Test Kitchen driver for Azure Resource Manager.