Skip to content

Commit 6f5ccff

Browse files
committed
Minor documentation updates
1 parent e87f333 commit 6f5ccff

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ This role adds support for these features.
1818
- Sets the hostname.
1919
- Adds one or more ssh public keys and/or a password for the default user "ubuntu" so that Ansible can connect to the new machine.
2020
- Optionally adjusts the hardware, e.g. number of CPUs or memory, see [vmware_guest](https://docs.ansible.com/ansible/latest/modules/vmware_guest_module.html#parameters) for possible customizations.
21-
- Optionally sets VM notes and/or VM [Configuration Parameters](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.hostclient.doc/GUID-8C639077-FF16-4D5D-9A7A-E16902CE00C2.html).
22-
- Optionally sets VM [Custom Attributes](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-73606C4C-763C-4E27-A1DA-032E4C46219D.html)
21+
- Optionally sets VM notes (annotations), VM [configuration file parameters](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.hostclient.doc/GUID-8C639077-FF16-4D5D-9A7A-E16902CE00C2.html) and/or VM [custom attributes](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-73606C4C-763C-4E27-A1DA-032E4C46219D.html).
2322
- Disk size may be increased (defaults to 10GB), additional disks may be created and added.
2423
- Optionally changes the dynamic IP address to a static one (taken either from the playbook or from DNS).
2524
- The VM is turned on and can be used in the same playbook that invoked this role.
@@ -32,7 +31,7 @@ Requirements
3231

3332
To use this role, you need
3433

35-
- a VMware vSphere environment where the VM will be deployed.
34+
- a vSphere environment where the VM will be deployed.
3635
- Credentials for the vCenter server of that environment with appropriate permissions, see below.
3736
- an OVA file, e.g. [ubuntu-18.04-server-cloudimg-amd64.ova](https://cloud-images.ubuntu.com/releases/18.04/release/ubuntu-18.04-server-cloudimg-amd64.ova) on the control machine.
3837

@@ -100,7 +99,7 @@ Role Variables
10099
- User defined network mappings can be specified with `networks`, see [vmware_deploy_ovf](https://docs.ansible.com/ansible/latest/modules/vmware_deploy_ovf_module.html#parameters) for semantics.
101100
- VM notes can be set with `annotation`.
102101
To use this feature, the VMware permission `Virtual Machine > Configuration > Set annotation` is required.
103-
- To set VM configuration parameters, supply `advanced_settings` with a list of dicts as shown in the example playbook.
102+
- To set VM configuration file parameters, supply `advanced_settings` with a list of dicts as shown in the example playbook.
104103
- To set VM custom attributes, supply `customvalues` with a list of dicts as show in the example playbook. Note that new custom values will not be created, they should exist in vCenter prior to deploying.
105104

106105
To use a static IP address, use the following keys in the dictionary `static_ip`:
@@ -115,17 +114,17 @@ To use a static IP address, use the following keys in the dictionary `static_ip`
115114

116115
As the VMs do not exist yet, the ssh server's key is unknown.
117116
In order to connect to the new VMs, you need to turn off ssh host key checking.
118-
If you plan to repeatedly create VMs with the same FQDNs, ssh should not store the fingerprints in the _known_hosts_ file.
117+
If you plan to frequently recreate VMs with the same FQDNs, ssh should not store the fingerprints in the _known_hosts_ file.
119118

120-
Therefore the recommended host/group variables are:
119+
Therefore, the recommended host/group variables are:
121120

122121
ansible_user=ubuntu
123122
ansible_ssh_extra_args=-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null
124123

125124
Dependencies
126125
------------
127126

128-
None.
127+
This role does not depend on other roles.
129128

130129
Example Playbook
131130
----------------

0 commit comments

Comments
 (0)