Skip to content

Commit ebb76a5

Browse files
authored
Fix identity docs for Leapp and workflow steps (#793)
1 parent def81c0 commit ebb76a5

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

docs/layers/identity/deploy.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
2020
| ----------------------------- | ------------------------------------------- |
2121
| Install requirements | |
2222
| Vendor components | `atmos workflow vendor -f identity` |
23-
| Prepare AWS SSO | Click Ops |
23+
| [Setup Identity Center](/layers/identity/aws-sso/) | Click Ops |
2424
| Add your SAML provider | Click Ops |
2525
| Deploy identity components | `atmos workflow deploy/all -f identity` |
2626
| Reconfigure Terraform Backend | `atmos workflow deploy/tfstate -f baseline` |
@@ -37,6 +37,21 @@ These components are expected to be used together to provide fine-grained role d
3737

3838
<Steps>
3939

40+
<Step>
41+
### <StepNumber/> Vendor Identity Components
42+
43+
Pull the Identity components into your local repository.
44+
45+
<AtmosWorkflow workflow="vendor" fileName="identity" />
46+
</Step>
47+
48+
<Step>
49+
### <StepNumber/> Setup Identity Center
50+
51+
Follow the [Setup Identity Center](/layers/identity/aws-sso/) guide to enable AWS IAM Identity Center and connect your IdP.
52+
</Step>
53+
54+
4055
<Step>
4156
### <StepNumber/> Deploy Identity Components
4257
Deploy these components across all accounts by running the following command. Note that if any users or groups are

docs/layers/identity/docs/aws-access-control.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The `$AWS_CONFIG_FILE` (by default, `$HOME/.aws/config`) contains _profiles_ tha
2828
</dd>
2929
</dl>
3030

31-
You should only use Leapp (or `aws sso login`) to log into Primary profiles. Once logged into a Primary profile, any tool should be able to use that profile or any Derived profile simply by specifying which profile to use (usually by setting the AWS_PROFILE environment variable via `export AWS_PROFILE=profile-name` or via a command-line flag, configuration string, or configuration file, such as in the case of `kubectl` where it is specified via the `users.user.exec.env` section of the `$KUBECONFIG` file).
31+
In the Cloud Posse reference architecture you must use Leapp to log into Primary profiles. Once logged into a Primary profile, any tool can use that profile or any Derived profile simply by specifying which profile to use (usually by setting the AWS_PROFILE environment variable via `export AWS_PROFILE=profile-name` or via a command-line flag, configuration string, or configuration file, such as in the case of `kubectl` where it is specified via the `users.user.exec.env` section of the `$KUBECONFIG` file).
3232

3333
<Note title="Watch out!">
3434
The AWS documentation and examples are confusing. In this scenario, it is important that you _do not include_ `mfa_serial` _in the Derived profile configuration_. The use case for having `mfa_serial` in the Derived profile is if you did not use MFA to authenticate to your Primary profile. In that (rare) case, the Derived profile really turns into a sort of Primary profile, because it is responsible for providing a credential (the MFA token) that the source profile does not have. That is when you need `mfa_serial` in the Derived profile and when you should put it in Leapp instead of just the `$AWS_CONFIG_FILE`.

0 commit comments

Comments
 (0)