search

miasma-rb / miasma-aws

Miasma AWS API
Other
8 stars 8 forks source link

Improve doc/readme for attribute values #63

Open mwiczynski-cartera opened 5 years ago

mwiczynski-cartera commented 5 years ago

I am using sfn to run commands against aws. In the readme it mentions that aws_iam_instance_profile can be included to use iam instance profile. It does not say that you should include something like aws_iam_instance_profile true. If you just include aws_iam_instance_profile then you will get an error like:

[FATAL]: The security token included in the request is invalid.
[ERROR]: The security token included in the request is invalid.

Adding debug flag to sfn to try get more details as well. That didn't give any clearer indication that attribute was not configured correctly:

D, [2019-05-14T10:38:59.469386 #14931] DEBUG -- miasma.aws.orchestration: running custom setup configuration updates
D, [2019-05-14T10:38:59.469555 #14931] DEBUG -- miasma.aws.orchestration: loading aws configuration profile: default
D, [2019-05-14T10:38:59.469626 #14931] DEBUG -- miasma.aws.orchestration: loading aws credentials profile: default
D, [2019-05-14T10:38:59.469661 #14931] DEBUG -- miasma.aws.orchestration: loading aws credentials profile: 
D, [2019-05-14T10:38:59.469877 #14931] DEBUG -- miasma.aws.orchestration: running after setup configuration updates

For someone that does not have a strong ruby background it may not be clear that the line in .sfn file should include true. Please add a little more detail to the readme to include true/false/whatever for attributes/settings that do not take some sort of string value. Thanks.