-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OSDOCS-19838: add external id feature #112301
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jldohmann
wants to merge
1
commit into
openshift:main
Choose a base branch
from
jldohmann:OSDOCS-19557
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * rosa_hcp/rosa-hcp-quickstart-guide.adoc | ||
| // * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id="rosa-hcp-sts-external-id_{context}"] | ||
| = About external ID | ||
|
|
||
| [role="_abstract"] | ||
| An external ID functions as a distinct cryptographic handshake embedded within your {product-title} account-wide roles, blocking unauthorized third-party access. | ||
|
|
||
| During cluster creation, you might be asked to supply an external ID. An external ID allows Red{nbsp}Hat to safely log in to your {aws} account by using an IAM role in a secure manner. This serves as a strict tenant-isolation safeguard that prevents cross-account identity spoofing, ensuring that no one else can trigger automation against your AWS infrastructure. | ||
|
|
||
| When Red{nbsp}Hat's automation plane issues an `sts:AssumeRole` API call to your account to manage cluster resources, it must present this exact identifier. If the string does not match the condition block defined in your AWS IAM trust relationship, AWS automatically blocks the request. This ensures Red{nbsp}Hat's automation can only access your environment when explicitly acting on behalf of your organization. | ||
|
|
||
| When you assign an external ID, it is applied to both the Support IAM role and the Installer IAM role, through their associated trust policies: | ||
|
jldohmann marked this conversation as resolved.
|
||
|
|
||
| * Support role: when Red{nbsp}Hat Site Reliability Engineers (SREs) need to perform diagnostic, maintenance or any other support function, they assume this role. | ||
| + | ||
| .Example support trust policy with an external ID `sts_hcp_support_trust_policy.json` | ||
| [source,json] | ||
| ---- | ||
| { | ||
| "Version": "2012-10-17", | ||
| "Statement": [ | ||
| { | ||
| "Effect": "Allow", | ||
| "Principal": { | ||
| "AWS": "arn:aws:iam::710019948333:role/RH-Technical-Support-15234082" | ||
| }, | ||
| "Action": "sts:AssumeRole", | ||
| "Condition": { | ||
| "StringEquals": { | ||
| "sts:ExternalID": "<external_id>" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ---- | ||
| + | ||
| * Installer role: when {cluster-manager-first} (OCM) automation needs to provision, scale or delete core cluster infrastructure, it assumes this role. | ||
| + | ||
| .Example installer trust policy with an external ID `sts_hcp_installer_trust_policy.json` | ||
| [source,json] | ||
| ---- | ||
| { | ||
| "Version": "2012-10-17", | ||
| "Statement": [ | ||
| { | ||
| "Effect": "Allow", | ||
| "Principal": { | ||
| "AWS": "arn:aws:iam::710019948333:role/RH-Managed-OpenShift-Installer" | ||
| }, | ||
| "Action": "sts:AssumeRole", | ||
| "Condition": { | ||
| "StringEquals": { | ||
| "sts:ExternalID": "<external_id>" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ---- | ||
|
|
||
| .Additional resources | ||
| * link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html#id_roles_third-party_example[Example scenario using an external ID.] | ||
| * link:https://aws.amazon.com/blogs/apn/securely-using-external-id-for-accessing-aws-accounts-owned-by-others/[Securely using external ID for accessing AWS accounts owned by others.] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.