Add a section about switching between IAM and SSO and more#252
Add a section about switching between IAM and SSO and more#252diego-ojeda-binbash merged 1 commit intomasterfrom
Conversation
…ference to IAM being the default method supported by Leverage
WalkthroughAdds a new “Switching between AWS IAM and AWS IAM Identity Center (AWS IIC)” section with troubleshooting and revised “Next Steps” in credentials docs, and rephrases wording in GPG identities docs to reference the base-identities layer and IAM module for encrypted credential management. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/user-guide/ref-architecture-aws/credentials.md (1)
12-14: Clarify guidance and make link text descriptiveLink text like “here” and “this guide” violates our accessibility/docs standards (see markdownlint MD059) and makes the navigation harder for readers. The phrase “plus other things to make it work” is also vague; we should either spell out the remaining steps or explicitly point back to the configuration guide sections that list them. Please rephrase with descriptive anchors and concrete guidance. For example:
-1. ... as explained [here](/user-guide/ref-architecture-aws/features/sso/configuration/). You'll need to set MFA to false ... configure SSO variables in the common.tfvars file, plus other things to make it work. +1. ... as explained in the [AWS IAM Identity Center configuration guide](/user-guide/ref-architecture-aws/features/sso/configuration/). You'll need to set `MFA=false` in [build.env](/user-guide/leverage-cli/extending-leverage/build.env), configure the SSO variables in `common.tfvars`, and apply the remaining account and permission-set settings documented in that guide. -2. ... going through [this guide](/user-guide/ref-architecture-aws/features/identities/identities/#setting-up-user-credentials) ... +2. ... going through the [IAM user credential setup guide](/user-guide/ref-architecture-aws/features/identities/identities/#setting-up-user-credentials) ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/user-guide/ref-architecture-aws/credentials.md(1 hunks)docs/user-guide/ref-architecture-aws/features/identities/gpg.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
Edit and maintain documentation content as Markdown files under docs/
Files:
docs/user-guide/ref-architecture-aws/credentials.mddocs/user-guide/ref-architecture-aws/features/identities/gpg.md
{docs/**/*.md,*.md}
📄 CodeRabbit inference engine (.cursor/rules/doc-binbash-leverage.mdc)
{docs/**/*.md,*.md}: Follow binbash Leverage terminology and architectural concepts as defined in this rule file across all documentation content
Always reference official sources (linked docs and repositories) as the primary truth
Align recommendations with the AWS Well-Architected Framework
Consider the multi-layer architecture (Network, Security, Shared, Apps) when providing guidance
Account for the multi-account organizational structure (Management, Security, Shared, Apps/Workloads)
Prefer using existing Terraform/OpenTofu modules from the Leverage library before custom solutions (Module-First)
Emphasize security by design, compliance, and governance in recommendations
Provide practical, actionable, and tested implementation guidance
Show concrete Leverage CLI commands for operations and workflows
For architecture topics, reference specific documentation sections and established patterns from the reference architecture
For architecture topics, consider layer dependencies and account boundaries
For module usage, reference module documentation, examples, and the Makefile module list for versions
For module usage, follow established naming and tagging conventions
For CLI operations, reference credential management and Docker-based execution context, and include troubleshooting tips
For troubleshooting, cover common credential/config issues, layer dependencies, account setup, and CLI version compatibility
Reference the provided essential resources and repositories when guiding users (Leverage docs site, core repos, PyPI package)
Files:
docs/user-guide/ref-architecture-aws/credentials.mddocs/user-guide/ref-architecture-aws/features/identities/gpg.md
{mkdocs.yml,docs/**/*.md}
📄 CodeRabbit inference engine (.cursor/rules/doc-binbash-leverage.mdc)
{mkdocs.yml,docs/**/*.md}: Maintain consistency with existing documentation structure and navigation
Organize content according to the documented sections (Concepts, Try Leverage, User Guide, How It Works, Work With Us, Key Feature Documentation)
Files:
docs/user-guide/ref-architecture-aws/credentials.mddocs/user-guide/ref-architecture-aws/features/identities/gpg.md
🪛 markdownlint-cli2 (0.18.1)
docs/user-guide/ref-architecture-aws/credentials.md
12-12: Link text should be descriptive
(MD059, descriptive-link-text)
What?
References