README.md in kitchen-vra-1.1.0 vs README.md in kitchen-vra-1.2.0
- old
+ new
@@ -50,16 +50,18 @@
Other options that you can set include:
* **lease_days**: number of days to request for a lease, if your catalog item / blueprint requires it
* **request_timeout**: amount of time, in seconds, to wait for a vRA request to complete. Default is 600 seconds.
+ * **server_ready_retries**: Number of times to retry the "waiting for server to be ready" check. In some cases, this will error out immediately due to DNS propagation issues, etc. Setting this to a number greater than 0 will retry the `wait_until_ready` method with a growing sleep in between each attempt. Defaults to 1. Set to 0 to disable any retrying of the `wait_until_ready` method.
* **cpus**: number of CPUs the host should have
* **memory**: amount of RAM, in MB, the host should have
* **requested_for**: the vRA login ID to list as the owner of this resource. Defaults to the vRA username configured in the `driver` section.
* **subtenant_id**: the Business Group ID to list as the owner. This is required if the catalog item is a shared/global item; we are unable to determine the subtenant_id from the catalog, and vRA requires it to be set on every request.
- * **private_key_path**: path to the SSH private key to use when logging in. Defaults to '~/.ssh/id_rsa' or '~/.ssh/id_dsa', preferring the RSA key. Only applies to instances where SSH transport is used (i.e. does not apply to Windows hosts with the WinRM transport configured).
+ * **private_key_path**: path to the SSH private key to use when logging in. Defaults to '~/.ssh/id_rsa' or '~/.ssh/id_dsa', preferring the RSA key. Only applies to instances where SSH transport is used; i.e., does not apply to Windows hosts with the WinRM transport configured.
* **use_dns**: Defaults to `false`. Set to `true` if vRA doesn't manage vm ip addresses. This will cause kitchen to attempt to connect via hostname.
+ * **extra_parameters**: a hash of other data to set on a catalog request, most notably custom properties. Allows updates to existing properties on the blueprint as well as the addition of new properties. The vRA REST API expects 'provider-' appended to the front of a property name; each key in the hash is the property name, and the value is a another hash containing the value data type and the value itself.
These settings can be set globally under the top-level `driver` section, or they can be set on each platform, which allows you to set globals and then override them. For example, this configuration would set the CPU count to 1 except on the "large" platform:
```yaml
driver:
@@ -68,13 +70,27 @@
platforms:
- name: small
driver:
catalog_id: 8a189191-fea6-43eb-981e-ee0fa40f8f57
+ extra_parameters:
+ provider-mycustompropname:
+ type: string
+ value: smallvalue
+ provider-Vrm.DataCenter.Location:
+ type: string
+ value: Non-Prod
- name: large
driver:
catalog_id: 1d7c6122-18fa-4ed6-bd13-8a33b6c6ed50
cpus: 2
+ extra_parameters:
+ provider-mycustompropname:
+ type: string
+ value: largevalue
+ provider-Vrm.DataCenter.Location:
+ type: string
+ value: Prod
```
## License and Authors
Author:: Chef Partner Engineering (<partnereng@chef.io>)