diff --git a/FAQS.md b/FAQS.md index ebc159e..ee1906c 100644 --- a/FAQS.md +++ b/FAQS.md @@ -1,15 +1,25 @@ # Frequently Asked Questions -## "I have many repositories that need this action, but creating a SAML Provider in AWS per-repository won't scale. What should I do?" +## I now have a slew of `saml-to.yml` files across many repositories, and it's quite repetitive. -### Option 1 (Less Secure) +If you have multiple SAML.to files across many repositiories, they can be consolidated into one configuration file in a single repository in your GitHub Organization. It can be used delegate access to other repositories. + +Need more info on this? [Message us on Gitter](https://gitter.im/saml-to/assume-aws-role-action). + +## I have many repositories that need this action, but creating a SAML Provider in AWS per-repository won't scale. If all repositories need access to the same role, make a new "Shared Provider" (sans the Repository Name) and place that in the various `saml-to.yml` configuration files. -Need more info on this? [Message us on Gitter](https://gitter.im/saml-to/assume-aws-role-action). +### Step 1 - Create a "Shared Provider" + +![Add a Provider](./assets/faq/add-provider.png) + +1. When creating a provider, set the name to something generic, but unique to your AWS account. In this example, it's named as `saml.to`. + +1. Download your [`IdP Metadata`](https://saml.to/metadata) for your organization from SAML.to. -### Option 2 (More Secure) +### Step 2 - Update each of the `saml-to.yml` file(s) to use the "Shared Provider" -[SAML.to](https://saml.to) allows you to consolidate many `saml-to.yml` configuration files into a single file in a centralized repository. +![saml-to.yml config](./assets/faq/update-config.png) -We're happy to walk you though this process, so [message us on Gitter](https://gitter.im/saml-to/assume-aws-role-action). +1. Change the `https://aws.amazon.com/SAML/Attributes/Role` to use the name of the "Shared Provider" diff --git a/assets/faq/add-provider.png b/assets/faq/add-provider.png new file mode 100644 index 0000000..7fdeecf Binary files /dev/null and b/assets/faq/add-provider.png differ diff --git a/assets/faq/update-config.png b/assets/faq/update-config.png new file mode 100644 index 0000000..88cf0b6 Binary files /dev/null and b/assets/faq/update-config.png differ