Skip to content

docs(cloud-tests): align AWS, Azure, GCP guides with actual flow#2661

Merged
tofikwest merged 3 commits intomainfrom
docs/cloud-tests-accuracy
Apr 24, 2026
Merged

docs(cloud-tests): align AWS, Azure, GCP guides with actual flow#2661
tofikwest merged 3 commits intomainfrom
docs/cloud-tests-accuracy

Conversation

@tofikwest
Copy link
Copy Markdown
Contributor

@tofikwest tofikwest commented Apr 24, 2026

Summary

Rewrites the three Cloud Tests provider guides (and the index) so they match what the product actually does. The current docs describe flows that no longer exist — most critically they walk users through creating AWS access keys and uploading a GCP service account JSON, neither of which the product supports.

Code references verified against packages/integration-platform/src/manifests/{aws,azure,gcp} and apps/app/src/app/(app)/[orgId]/cloud-tests/components/*SetupGuide.tsx before writing.

What changed

  • AWS — cross-account IAM role + External ID via AWS CloudShell script. Replaces the old IAM user + access key walkthrough. Fixes the malformed capabilities table and the "Azure" references left in the Support section by an earlier copy-paste.
  • Azure — Microsoft OAuth is now documented as the primary flow; the service principal flow is preserved as an alternative for tenants that restrict user OAuth consent. Required roles updated to Reader + Security Reader + Monitoring Reader (the manifest requires all three).
  • GCP — Google OAuth with auto-setup of required APIs and the roles/securitycenter.findingsViewer grant. Removes the outdated service-account JSON key flow (the product does not accept JSON keys).
  • Index — fixes broken links that pointed to /integrations/{aws,azure,gcp} instead of /cloud-tests/{aws,azure,gcp}, and adds a capability matrix and CardGroup for the three providers.

Style

All four pages use Mintlify components already used elsewhere in packages/docs (<Steps>, <Note>, <Accordion>, <CardGroup>) so rendering is consistent with the rest of the site.

Test plan

  • Preview the Mintlify site locally (cd packages/docs && mintlify dev) and confirm AWS / Azure / GCP / index all render
  • Click through every internal link on the Cloud Tests index and the three provider pages
  • Confirm <Steps>, <Note>, <Accordion>, and <CardGroup> components render correctly
  • Confirm nothing in the three guides contradicts the in-product connect wizards (AwsSetupGuide / AzureSetupGuide / GcpSetupGuide)

🤖 Generated with Claude Code


Summary by cubic

Aligned AWS, Azure, GCP Cloud Tests docs with the actual OAuth/role-based flows and read‑only access model. Removes outdated key-based setups, adds clearer setup steps, service scopes, and troubleshooting to reduce setup friction.

  • Refactors

    • AWS: Cross-account IAM role with External ID via CloudShell; read-only SecurityAudit + ViewOnlyAccess with small inline policies; optional CompAI-Remediator; steps create CompAI-Auditor; adds “What gets scanned,” per‑service toggles, security model, and troubleshooting.
    • Azure: Microsoft OAuth as primary, service principal as alternative; requires Reader + Security Reader + Monitoring Reader; scoped to one subscription per connection; adds auto checks in setup, services overview, security model, and troubleshooting.
    • GCP: Google OAuth pulling from Security Command Center; auto‑setup enables SCC, Cloud Resource Manager, and Service Usage APIs; requires org‑level roles/securitycenter.findingsViewer; project selection in setup; removes service‑account JSON key flow; adds services overview, security model, and troubleshooting.
    • Index: Adds provider cards, an authorization summary table, common capabilities, and “Next steps”; routes to /cloud-tests/*.
  • Bug Fixes

    • Fixed broken links from /integrations/* to /cloud-tests/*.
    • Corrected the AWS capabilities table and removed stray “Azure” references in the AWS Support section.

Written for commit f47de49. Summary will update on new commits.

…n flow

Rewrites the Cloud Tests docs so they match the real product:

- AWS: cross-account IAM role + External ID via AWS CloudShell script;
  replaces the old (incorrect) IAM user + access key walkthrough and
  fixes the malformed capabilities table and the copy-paste "Azure"
  references in the Support section.
- Azure: Microsoft OAuth as the primary flow with the service principal
  flow preserved as an alternative; updates required roles to
  Reader + Security Reader + Monitoring Reader.
- GCP: Google OAuth with auto-setup of required APIs and IAM roles;
  removes the outdated service-account JSON key flow.
- Index: fixes broken links that pointed to /integrations/* instead of
  /cloud-tests/*, and adds a capability matrix and CardGroup for the
  three providers.

All four pages now use the Mintlify components (`<Steps>`, `<Note>`,
`<Accordion>`, `<CardGroup>`) already used elsewhere in the docs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
app Ready Ready Preview, Comment Apr 24, 2026 2:13pm
comp-framework-editor Ready Ready Preview, Comment Apr 24, 2026 2:13pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
portal Skipped Skipped Apr 24, 2026 2:13pm

Request Review

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
CompAI 🟢 Ready View Preview Apr 24, 2026, 2:00 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 4 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="packages/docs/cloud-tests/azure.mdx">

<violation number="1" location="packages/docs/cloud-tests/azure.mdx:132">
P3: Inconsistent casing: `User_impersonation` here should be `user_impersonation` (lowercase) to match the earlier reference and the actual Azure scope name.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review, or fix all with cubic.

Comment thread packages/docs/cloud-tests/azure.mdx
@tofikwest tofikwest merged commit ef14a46 into main Apr 24, 2026
10 checks passed
@tofikwest tofikwest deleted the docs/cloud-tests-accuracy branch April 24, 2026 14:16
@claudfuen
Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 3.33.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants