Add documentation for userdata_renderer

This commit is contained in:
Erik Johnson 2017-03-31 10:23:44 -05:00
parent 9ee2dcfc2d
commit 111188742a
4 changed files with 42 additions and 4 deletions

View file

@ -1351,6 +1351,22 @@ The renderer to use on the minions to render the state data.
renderer: yaml_jinja
.. conf_master:: userdata_renderer
``userdata_renderer``
---------------------
.. versionadded:: 2016.11.4
Default: ``jinja``
The renderer to use for templating userdata files in salt-cloud, if the
``userdata_renderer`` is not set in the cloud profile.
.. code-block:: yaml
userdata_renderer: jinja
.. conf_master:: jinja_trim_blocks
``jinja_trim_blocks``

View file

@ -354,6 +354,13 @@ functionality was added to Salt in the 2015.5.0 release.
# Pass userdata to the instance to be created
userdata_file: /etc/salt/my-userdata-file
.. note::
As of the 2016.11.0 release, this file can be templated, and as of the
2016.11.4 release, the renderer(s) used can be specified in the cloud
profile using the ``userdata_renderer`` option. If this option is not set
in the cloud profile, salt-cloud will fall back to the
:conf_master:`userdata_renderer` master configuration option.
EC2 allows a location to be set for servers to be deployed in. Availability
zones exist inside regions, and may be added to increase specificity.

View file

@ -154,3 +154,10 @@ cloud-init if available.
.. code-block:: yaml
userdata_file: /etc/salt/cloud-init/packages.yml
.. note::
As of the 2016.11.0 release, this file can be templated, and as of the
2016.11.4 release, the renderer(s) used can be specified in the cloud
profile using the ``userdata_renderer`` option. If this option is not set
in the cloud profile, salt-cloud will fall back to the
:conf_master:`userdata_renderer` master configuration option.

View file

@ -75,10 +75,18 @@ profile configuration as `userdata_file`. For instance:
userdata_file: /etc/salt/windows-firewall.ps1
If you are using WinRM on EC2 the HTTPS port for the WinRM service must also be enabled
in your userdata. By default EC2 Windows images only have insecure HTTP enabled. To
enable HTTPS and basic authentication required by pywinrm consider the following
userdata example:
.. note::
As of the 2016.11.0 release, this file can be templated, and as of the
2016.11.4 release, the renderer(s) used can be specified in the cloud
profile using the ``userdata_renderer`` option. If this option is not set
in the cloud profile, salt-cloud will fall back to the
:conf_master:`userdata_renderer` master configuration option.
If you are using WinRM on EC2 the HTTPS port for the WinRM service must also be
enabled in your userdata. By default EC2 Windows images only have insecure HTTP
enabled. To enable HTTPS and basic authentication required by pywinrm consider
the following userdata example:
.. code-block:: powershell