Improving docs for boto_elasticache state

This commit is contained in:
Nitin Madhok 2014-07-07 16:09:43 -04:00
parent 775d09625d
commit 213a7dfa84

View File

@ -12,23 +12,26 @@ Note: This module currently only supports creation and deletion of
elasticache resources and will not modify clusters when their configuration elasticache resources and will not modify clusters when their configuration
changes in your state files. changes in your state files.
This module uses boto, which can be installed via package, or pip. This module uses ``boto``, which can be installed via package, or pip.
This module accepts explicit elasticache credentials but can also utilize This module accepts explicit elasticache credentials but can also utilize
IAM roles assigned to the instance trough Instance Profiles. Dynamic IAM roles assigned to the instance trough Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:: configuration is necessary. More Information available `here
<http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html>`_.
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html If IAM roles are not used you need to specify them either in a pillar file or
in the minion's config file:
If IAM roles are not used you need to specify them either in a pillar or .. code-block:: yaml
in the minion's config file::
elasticache.keyid: GKTADJGHEIQSXMKKRBJ08H elasticache.keyid: GKTADJGHEIQSXMKKRBJ08H
elasticache.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs elasticache.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
It's also possible to specify key, keyid and region via a profile, either It's also possible to specify ``key``, ``keyid`` and ``region`` via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config: passed in as a dict, or as a string to pull from pillars or minion config:
.. code-block:: yaml
myprofile: myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H keyid: GKTADJGHEIQSXMKKRBJ08H