valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 00:55:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
cded9ac01d
salt/doc/topics/cloud/vmware.rst
Alexander Backlund 759c8863d1 Merge branch 'vmware-standalone-esxi' of https://github.com/alxbse/salt into vmware-standalone-esxi 
Conflicts:
	doc/topics/cloud/vmware.rst
	salt/cloud/clouds/vmware.py
2015-09-24 07:22:06 -04:00

546 lines
18 KiB
ReStructuredText
Raw Blame History

===========================
Getting Started With VMware
===========================
.. versionadded:: 2015.5.4
**Author**: Nitin Madhok <nmadhok@clemson.edu>
The VMware cloud module allows you to manage VMware ESX, ESXi, and vCenter.
Dependencies
============
The vmware module for Salt Cloud requires the ``pyVmomi`` package, which is
available at PyPI:
https://pypi.python.org/pypi/pyvmomi
This package can be installed using `pip` or `easy_install`:
.. code-block:: bash
pip install pyvmomi
easy_install pyvmomi
Configuration
=============
The VMware cloud module needs the vCenter or ESXi URL, username and password to be
set up in the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/vmware.conf``:
.. code-block:: yaml
my-vmware-config:
driver: vmware
user: 'DOMAIN\user'
password: 'verybadpass'
url: '10.20.30.40'
vcenter01:
driver: vmware
user: 'DOMAIN\user'
password: 'verybadpass'
url: 'vcenter01.domain.com'
protocol: 'https'
port: 443
vcenter02:
driver: vmware
user: 'DOMAIN\user'
password: 'verybadpass'
url: 'vcenter02.domain.com'
protocol: 'http'
port: 80
.. note::
Optionally, ``protocol`` and ``port`` can be specified if the vCenter
server is not using the defaults. Default is ``protocol: https`` and
``port: 443``.
.. note::
.. versionchanged:: 2015.8.0
The ``provider`` parameter in cloud provider definitions was renamed to ``driver``. This
change was made to avoid confusion with the ``provider`` parameter that is used in cloud profile
definitions. Cloud provider definitions now use ``driver`` to refer to the Salt cloud module that
provides the underlying functionality to connect to a cloud host, while cloud profiles continue
to use ``provider`` to refer to provider configurations that you define.
.. _vmware-cloud-profile:
Profiles
========
Set up an initial profile at ``/etc/salt/cloud.profiles`` or
``/etc/salt/cloud.profiles.d/vmware.conf``:
.. code-block:: yaml
vmware-centos6.5:
provider: vcenter01
clonefrom: test-vm
## Optional arguments
num_cpus: 4
memory: 8GB
devices:
cd:
CD/DVD drive 1:
device_type: datastore_iso_file
iso_path: "[nap004-1] vmimages/tools-isoimages/linux.iso"
CD/DVD drive 2:
device_type: client_device
mode: atapi
CD/DVD drive 3:
device_type: client_device
mode: passthrough
disk:
Hard disk 1:
size: 30
Hard disk 2:
size: 20
Hard disk 3:
size: 5
network:
Network adapter 1:
name: 10.20.30-400-Test
switch_type: standard
ip: 10.20.30.123
gateway: [10.20.30.110]
subnet_mask: 255.255.255.128
domain: mycompany.com
Network adapter 2:
name: 10.30.40-500-Dev-DHCP
adapter_type: e1000
switch_type: distributed
Network adapter 3:
name: 10.40.50-600-Prod
adapter_type: vmxnet3
switch_type: distributed
ip: 10.40.50.123
gateway: [10.40.50.110]
subnet_mask: 255.255.255.128
domain: mycompany.com
scsi:
SCSI controller 1:
type: lsilogic
SCSI controller 2:
type: lsilogic_sas
bus_sharing: virtual
SCSI controller 3:
type: paravirtual
bus_sharing: physical
ide:
IDE controller 1
domain: mycompany.com
dns_servers:
- 123.127.255.240
- 123.127.255.241
- 123.127.255.242
resourcepool: Resources
cluster: Prod
datastore: HUGE-DATASTORE-Cluster
folder: Development
datacenter: DC1
host: c4212n-002.domain.com
template: False
power_on: True
extra_config:
mem.hotadd: 'yes'
guestinfo.foo: bar
guestinfo.domain: foobar.com
guestinfo.customVariable: customValue
deploy: True
private_key: /root/.ssh/mykey.pem
ssh_username: cloud-user
password: veryVeryBadPassword
minion:
master: 123.127.193.105
file_map:
/path/to/local/custom/script: /path/to/remote/script
/path/to/local/file: /path/to/remote/file
/srv/salt/yum/epel.repo: /etc/yum.repos.d/epel.repo
hardware_version: 10
image: centos64Guest
``provider``
Enter the name that was specified when the cloud provider config was created.
``clonefrom``
Enter the name of the VM/template to clone from. If not specified, the VM will be created
without cloning.
``num_cpus``
Enter the number of vCPUS that you want the VM/template to have. If not specified,
the current VM/template\'s vCPU count is used.
``memory``
Enter the memory size (in MB or GB) that you want the VM/template to have. If
not specified, the current VM/template\'s memory size is used. Example
``memory: 8GB`` or ``memory: 8192MB``.
``devices``
Enter the device specifications here. Currently, the following devices can be
created or reconfigured:
cd
Enter the CD/DVD drive specification here. If the CD/DVD drive doesn\'t exist,
it will be created with the specified configuration. If the CD/DVD drive
already exists, it will be reconfigured with the specifications. The following
options can be specified per CD/DVD drive:
device_type
Specify how the CD/DVD drive should be used. Currently supported types are
``client_device`` and ``datastore_iso_file``. Default is
``device_type: client_device``
iso_path
Enter the path to the iso file present on the datastore only if
``device_type: datastore_iso_file``. The syntax to specify this is
``iso_path: "[datastoreName] vmimages/tools-isoimages/linux.iso"``. This
field is ignored if ``device_type: client_device``
mode
Enter the mode of connection only if ``device_type: client_device``. Currently
supported modes are ``passthrough`` and ``atapi``. This field is ignored if
``device_type: datastore_iso_file``. Default is ``mode: passthrough``
controller
Specify IDE controller on which to attach the drive. Must be specified when
creating both a controller and a drive at the same time.
disk
Enter the disk specification here. If the hard disk doesn\'t exist, it will
be created with the provided size. If the hard disk already exists, it will
be expanded if the provided size is greater than the current size of the disk.
size
Enter the size of disk
controller
Enter the controller on which to attach the disk. Must be specified when
creating both a controller and a disk at the same time.
network
Enter the network adapter specification here. If the network adapter doesn\'t
exist, a new network adapter will be created with the specified network name,
type and other configuration. If the network adapter already exists, it will
be reconfigured with the specifications. The following additional options can
be specified per network adapter (See example above):
name
Enter the network name you want the network adapter to be mapped to.
adapter_type
Enter the network adapter type you want to create. Currently supported
types are ``vmxnet``, ``vmxnet2``, ``vmxnet3``, ``e1000`` and ``e1000e``.
If no type is specified, by default ``vmxnet3`` will be used.
switch_type
Enter the type of switch to use. This decides whether to use a standard
switch network or a distributed virtual portgroup. Currently supported
types are ``standard`` for standard portgroups and ``distributed`` for
distributed virtual portgroups.
ip
Enter the static IP you want the network adapter to be mapped to. If the
network specified is DHCP enabled, you do not have to specify this.
gateway
Enter the gateway for the network as a list. If the network specified
is DHCP enabled, you do not have to specify this.
subnet_mask
Enter the subnet mask for the network. If the network specified is DHCP
enabled, you do not have to specify this.
domain
Enter the domain to be used with the network adapter. If the network
specified is DHCP enabled, you do not have to specify this.
scsi
Enter the SCSI adapter specification here. If the SCSI adapter doesn\'t exist,
a new SCSI adapter will be created of the specified type. If the SCSI adapter
already exists, it will be reconfigured with the specifications. The following
additional options can be specified per SCSI adapter:
type
Enter the SCSI adapter type you want to create. Currently supported
types are ``lsilogic``, ``lsilogic_sas`` and ``paravirtual``. Type must
be specified when creating a new SCSI adapter.
bus_sharing
Specify this if sharing of virtual disks between virtual machines is desired.
The following can be specified:
virtual
Virtual disks can be shared between virtual machines on the same server.
physical
Virtual disks can be shared between virtual machines on any server.
no
Virtual disks cannot be shared between virtual machines.
ide
Specify to add a IDE adapter.
``domain``
Enter the global domain name to be used for DNS. If not specified and if the VM name
is a FQDN, ``domain`` is set to the domain from the VM name. Default is ``local``.
``dns_servers``
Enter the list of DNS servers to use in order of priority.
``resourcepool``
Enter the name of the resourcepool to which the new virtual machine should be
attached. This determines what compute resources will be available to the clone.
.. note::
- For a clone operation from a virtual machine, it will use the same
resourcepool as the original virtual machine unless specified.
- For a clone operation from a template to a virtual machine, specifying
either this or cluster is required. If both are specified, the resourcepool
value will be used.
- For a clone operation to a template, this argument is ignored.
``cluster``
Enter the name of the cluster whose resource pool the new virtual machine should
be attached to.
.. note::
- For a clone operation from a virtual machine, it will use the same cluster\'s
resourcepool as the original virtual machine unless specified.
- For a clone operation from a template to a virtual machine, specifying either
this or resourcepool is required. If both are specified, the resourcepool
value will be used.
- For a clone operation to a template, this argument is ignored.
``datastore``
Enter the name of the datastore or the datastore cluster where the virtual machine
should be located on physical storage. If not specified, the current datastore is
used.
.. note::
- If you specify a datastore cluster name, DRS Storage recommendation is
automatically applied.
- If you specify a datastore name, DRS Storage recommendation is disabled.
``folder``
Enter the name of the folder that will contain the new virtual machine.
.. note::
- For a clone operation from a VM/template, the new VM/template will be added
to the same folder that the original VM/template belongs to unless specified.
- If both folder and datacenter are specified, the folder value will be used.
``datacenter``
Enter the name of the datacenter that will contain the new virtual machine.
.. note::
- For a clone operation from a VM/template, the new VM/template will be added
to the same folder that the original VM/template belongs to unless specified.
- If both folder and datacenter are specified, the folder value will be used.
``host``
Enter the name of the target host where the virtual machine should be registered.
If not specified:
.. note::
- If resource pool is not specified, current host is used.
- If resource pool is specified, and the target pool represents a stand-alone
host, the host is used.
- If resource pool is specified, and the target pool represents a DRS-enabled
cluster, a host selected by DRS is used.
- If resource pool is specified and the target pool represents a cluster without
DRS enabled, an InvalidArgument exception be thrown.
``template``
Specifies whether the new virtual machine should be marked as a template or not.
Default is ``template: False``.
``power_on``
Specifies whether the new virtual machine should be powered on or not. If
``template: True`` is set, this field is ignored. Default is ``power_on: True``.
``extra_config``
Specifies the additional configuration information for the virtual machine. This
describes a set of modifications to the additional options. If the key is already
present, it will be reset with the new value provided. Otherwise, a new option is
added. Keys with empty values will be removed.
``deploy``
Specifies if salt should be installed on the newly created VM. Default is ``True``
so salt will be installed using the bootstrap script. If ``template: True`` or
``power_on: False`` is set, this field is ignored and salt will not be installed.
``private_key``
Specify the path to the private key to use to be able to ssh to the VM.
``ssh_username``
Specify the username to use in order to ssh to the VM. Default is ``root``
``password``
Specify a password to use in order to ssh to the VM. If ``private_key`` is
specified, you do not need to specify this.
``minion``
Specify custom minion configuration you want the salt minion to have. A good example
would be to specify the ``master`` as the IP/DNS name of the master.
``file_map``
Specify file/files you want to copy to the VM before the bootstrap script is run
and salt is installed. A good example of using this would be if you need to put
custom repo files on the server in case your server will be in a private network
and cannot reach external networks.
``hardware_version``
Specify the virtual hardware version for the vm/template that is supported by the
host.
``image``
Specify the guest id of the VM. For a full list of supported values see the
VMware vSphere documentation:
http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
.. note::
- For a clone operation, this argument is ignored.
Cloning a VM
=============
Cloning is the easiest and preferred way to work with VMs in the VMware driver.
.. note::
- Cloning operations are unsupported on standalone ESXi hosts, a vCenter is required.
A minimal profile:
.. code-block:: yaml
my-minimal-clone:
provider: my-vcenter
clonefrom: 'clone-me'
When cloning all profile configuration is optional and everything that is set
specifies what is supposed to be different or added to the clone.
A disk example:
.. code-block:: yaml
my-disk-example:
provider: my-vcenter
clonefrom: 'clone-me'
devices:
disk:
Hard disk 1:
size: 30
Depending on the configuration of the VM that is to be cloned, the disk in the resulting clone will differ.
- If the VM has no disk named 'Hard disk 1' an empty disk with the specified size will be added to the clone.
- If the VM has a disk named 'Hard disk 1' and the size specified is larger than the original, a copy of the disk with the size specified will be added to the clone.
- If the VM has a disk named 'Hard disk 1' and the size specified is small than the original, a copy of the disk with the original size will be added to the clone.
Cloning a template
==================
Cloning a template works much like cloning a VM with the exception that a resource pool or cluster must be
specified where the clone is to be created.
A minimal example:
.. code-block:: yaml
my-template-clone:
provider: my-vcenter
clonefrom: 'my-template'
resourcepool: Resources
Creating a VM
=============
.. versionadded:: Boron
Creating a VM from scratch generally means that more settings must be specified in the profile
since there is nothing to copy settings from.
.. note::
Unlike most cloud drivers using prepared images, creating VMs needs an installation method
that requires no interaction. For example a preseeded ISO, a kickstart URL or network PXE boot.
A minimal profile:
.. code-block:: yaml
my-minimal-profile:
provider: my-esxi-host
datastore: datastore1
resourcepool: Resources
folder: vm
While the above example contains the only required settings when creating a VM the resulting
VM only has 1 VCPU, 32MB of RAM and has no storage or networking.
A full example:
.. code-block:: yaml
my-working-example:
provider: my-esxi-host
datastore: datastore1
resourcepool: Resources
folder: vm
num_cpus: 2
memory: 8GB
image: debian7_64Guest
devices:
scsi:
SCSI controller 0:
type: lsiLogic_sas
ide:
IDE controller 0
disk:
Hard disk 0:
controller: 'SCSI controller 0'
size: 20
cd:
CD/DVD drive 0:
controller: 'IDE controller 0'
device_type: datastore_iso_file
iso_path: '[datastore1] debian-8-with-preseed.iso'
network:
Network adapter 0:
name: 'VM Network'
swith_type: standard
.. note::
While ``image`` is not required when creating a VM it is recommended to
specify it. Depending on VMware version an exact match might not
be available, in those cases the closest match should be used.
See the above example where a Debian 8 VM is created using the Debian 7
``image``.
Reference in New Issue View Git Blame Copy Permalink