Skip to content

Commit

Permalink
Merge pull request #51943 from mchugh19/doc_updates
Browse files Browse the repository at this point in the history
minor corrections to documentation
  • Loading branch information
twangboy authored Mar 21, 2019
2 parents 524e858 + 4ca486c commit be3c96e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 36 deletions.
6 changes: 3 additions & 3 deletions salt/engines/logentries.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
engines:
- logentries:
endpoint: data.logentries.com
port: 10000
token: 057af3e2-1c05-47c5-882a-5cd644655dbf
endpoint: data.logentries.com
port: 10000
token: 057af3e2-1c05-47c5-882a-5cd644655dbf
The 'token' can be obtained from the Logentries service.
Expand Down
6 changes: 3 additions & 3 deletions salt/engines/logstash_engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
engines:
- logstash:
host: log.my_network.com
port: 5959
proto: tcp
host: log.my_network.com
port: 5959
proto: tcp
:depends: logstash
'''
Expand Down
34 changes: 4 additions & 30 deletions salt/modules/boto_ssm.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,15 @@
'''
Connection module for Amazon SSM
:configuration: This module accepts explicit ssm credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More Information available at:
:configuration: This module uses IAM roles assigned to the instance through
Instance Profiles. Dynamic credentials are then automatically obtained
from AWS API and no further configuration is necessary. More Information
available at:
.. code-block:: text
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 or
in the minion's config file:
.. code-block:: yaml
ssm.keyid: GKTADJGHEIQSXMKKRBJ08H
ssm.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
A region may also be specified in the configuration:
.. code-block:: yaml
ssm.region: us-east-1
If a region is not specified, the default is us-east-1.
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:
.. code-block:: yaml
myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
:depends: boto3
'''
# Import Python libs
Expand Down

0 comments on commit be3c96e

Please sign in to comment.