saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update Azure ARM docs

Browse source
This commit is contained in:
Joseph Hall 2017-04-06 09:43:19 -06:00
parent cb9dcb1e1b
commit 08d071bc68
1 changed files with 61 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
doc/topics/cloud/azurearm.rst
View file

@ -200,6 +200,10 @@ win_password
Required for Windows. The password to use to log into the newly-created Windows
VM to install Salt.
win_installer
-------------
Required for Windows. The path to the Salt installer to be uploaded.
resource_group
--------------
Required. The resource group that all VM resources (VM, network interfaces,
@ -211,6 +215,20 @@ Optional. If specified, then the VM will be connected to the network resources
in this group, rather than the group that it was created in. The VM interfaces
and IPs will remain in the configured ``resource_group`` with the VM.
network
-------
Required. The virtual network that the VM will be spun up in.
subnet
------
Optional. The subnet inside the virtual network that the VM will be spun up in.
Default is ``default``.
iface_name
----------
Optional. The name to apply to the VM's network interface. If not supplied, the
value will be set to ``<VM name>-iface0``.
cleanup_disks
-------------
Optional. Default is ``False``. If set to ``True``, disks will be cleaned up
@ -236,14 +254,37 @@ to be recreated with the same name and network settings. If you would like
interfaces and IPs to be deleted when their associated VM is deleted, set this
to ``True``.
custom_data
-----------
Any custom cloud data that needs to be specified. How this data is used depends
on the operating system and image that is used. For instance, Linux images that
use ``cloud-init`` will import this data for use with that program. Some
Windows images will create a file with a copy of this data, and others will
ignore it. If a Windows image creates a file, then the location will depend
upon the version of Windows.
userdata
--------
Optional. Any custom cloud data that needs to be specified. How this data is
used depends on the operating system and image that is used. For instance,
Linux images that use ``cloud-init`` will import this data for use with that
program. Some Windows images will create a file with a copy of this data, and
others will ignore it. If a Windows image creates a file, then the location
will depend upon the version of Windows. This will be ignored if the
``userdata_file`` is specified.
userdata_file
-------------
Optional. The path to a file to be read and submitted to Azure as user data.
How this is used depends on the operating system that is being deployed. If
used, any ``userdata`` setting will be ignored.
wait_for_ip_timeout
-------------------
Optional. Default is ``600``. When waiting for a VM to be created, Salt Cloud
will attempt to connect to the VM's IP address until it starts responding. This
setting specifies the maximum time to wait for a response.
wait_for_ip_interval
--------------------
Optional. Default is ``10``. How long to wait between attempts to connect to
the VM's IP.
wait_for_ip_interval_multiplier
-------------------------------
Optional. Default is ``1``. Increase the interval by this multiplier after
each request; helps with throttling.
expire_publisher_cache
----------------------
@ -327,6 +368,18 @@ seconds (1 hour). If you need the subnet cache to be updated at a different
frequency, change this setting. Setting it to ``0`` will turn off the subnet
cache.
Other Options
=============
Other options relevant to Azure ARM.
storage_account
---------------
Required for actions involving an Azure storage account.
storage_key
-----------
Required for actions involving an Azure storage account.
Show Instance
=============
This action is a thin wrapper around ``--full-query``, which displays details on