docs: add warnings about client secret authentication in multiple mon… - #2043
Conversation
📝 WalkthroughWalkthroughDocumentation now warns that client-secret authentication is unsuitable for long-term automation, noting expiration and manual rotation or variable updates, and recommends workload identity federation where possible across current and versioned guides. ChangesClient Secret Guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@website/docs/sections/create-entra-client-secret.md`:
- Around line 3-5: Replace the grammatically incorrect phrase in the shared
warning text with “we recommend using workload identity federation when
possible” across all listed documentation sites:
website/docs/sections/create-entra-client-secret.md lines 3-5;
website/docs/monitoring/azure-devops.md lines 259-261;
website/docs/monitoring/bitbucket.md lines 55-57;
website/docs/monitoring/github.md lines 257-259;
website/docs/monitoring/gitlab.md lines 271-273; and the corresponding versioned
files under website/versioned_docs/version-2.2.0 at the specified line ranges.
Keep the remainder of each warning unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 4bec6c31-c4f9-434d-a422-e428b8b57074
📒 Files selected for processing (10)
website/docs/monitoring/azure-devops.mdwebsite/docs/monitoring/bitbucket.mdwebsite/docs/monitoring/github.mdwebsite/docs/monitoring/gitlab.mdwebsite/docs/sections/create-entra-client-secret.mdwebsite/versioned_docs/version-2.2.0/monitoring/azure-devops.mdwebsite/versioned_docs/version-2.2.0/monitoring/bitbucket.mdwebsite/versioned_docs/version-2.2.0/monitoring/github.mdwebsite/versioned_docs/version-2.2.0/monitoring/gitlab.mdwebsite/versioned_docs/version-2.2.0/sections/create-entra-client-secret.md
Updated warning message for clarity and consistency.
Corrected the spelling of 'prefer' to 'preferred' in the warning section.
SamErde
left a comment
There was a problem hiding this comment.
Great addition! These just need a typo fixed (prefer --> preferred) and/or consider the suggested change from Code Rabbit AI.
Updates the repeated client-secret warning text across monitoring guides and shared section docs (including versioned 2.2.0 pages) to correct grammar and wording: replacing “it´s prefer” with “we recommend.” This keeps authentication guidance consistent and clearer.
Replace awkward phrasing with clearer recommendation language in the Azure DevOps docs.
|
Thanks @SamErde - I feel it was a missing part 🤣 Should be there now. |
This pull request updates the documentation for all supported CI/CD platforms to include a warning about the risks of using client secret authentication for automation. The warning advises users to prefer workload identity federation over client secrets due to security and maintenance concerns.
Documentation updates to authentication guidance:
Create a client secretstep-by-step guides to include the same warning for additional visibility.version-2.2.0) documentation to ensure consistency for all users.📑 Description
Closes none - updates to docs only
✅ Checks
/powershell/tests/pester.ps1locally.ℹ️ Additional Information
How to Contribute
🏗️ Read our full contributing guide for the Maester project.
🧪 We also have additional instructions and a checklist for creating tests.
Join us at the Maester repository discussions or Entra Discord for more help and conversations!
While you wait for a review, why not spread some Maester love on social media? Thank you! 💖
Summary by CodeRabbit