F5Networks / f5-cloud-failover-extension

F5 Cloud Failover Extension
Apache License 2.0
15 stars 2 forks source link

Documentation: example IAM role for AWS instructions is bad #144

Closed mikeoleary closed 5 months ago

mikeoleary commented 5 months ago

Do you already have an issue opened with F5 support?

No, customer called their account team for support

Description

If a customer copies and pastes the IAM role from this documentation, they are going to have invalid JSON

CFE troubleshooting is hard so anything to make this easier would be great.

Environment information

For bugs, enter the following information:

#

mikeshimkus commented 5 months ago

Hi @mikeoleary, I just created issue EC-518 for tracking this work.

mikeshimkus commented 5 months ago

@mikeoleary Updated the docs to show a valid JSON policy instead of the role config: https://clouddocs.f5.com/products/extensions/f5-cloud-failover/latest/userguide/aws.html#iam-role-example-declaration

LMK if this helps.

mikeoleary commented 5 months ago

thank you @mikeshimkus , this looks like it will help. For now, I think this is the best I can ask for. I'll close this issue.