Skip to content

Conversation

@HugoPBrito
Copy link
Member

Context

Expands the GCP provider docs so the Service Account Key File Path mirrors the workflow security teams should actually follow when provisioning least-privilege identities for prowler, also adding missing permissions.

Description

  • Rewrote docs/user-guide/providers/gcp/authentication.mdx to provide full motivation for service-account usage, add role-preparation guidance, and document each wizard step (role creation, account creation, role binding, key generation, key handling).
  • Added the supporting screenshots under docs/user-guide/providers/gcp/img/ (roles-section.png, prowler-role.png, service-account-page.png, create-service-account.png, service-account-permissions.png, create-new-key.png, json-key.png) and linked them inline so readers can visually confirm they are in the right console view.
  • Highlighted the specific storage.buckets.getIamPolicy permission inside the ProwlerRole example to match the captured UI and make the least‑privilege requirement explicit.
  • No code or dependency changes; docs-only update.

Steps to review

  1. npm run docs:dev (or your preferred docs preview) and open /user-guide/providers/gcp/authentication.
  2. Scroll to Service Account Key File and confirm the new context paragraphs, numbered steps, and command snippets read cleanly and follow the project voice guidelines.
  3. Verify each embedded image renders (especially the seven new files under docs/user-guide/providers/gcp/img/) and that alt text matches the screenshot context.
  4. If desired, lint links/static assets with make lint-docs to ensure no broken references were introduced.

Checklist

UI

  • All issue/task requirements work as expected on the UI
  • Screenshots/Video of the functionality flow (if applicable) - Mobile (X < 640px)
  • Screenshots/Video of the functionality flow (if applicable) - Table (640px > X < 1024px)
  • Screenshots/Video of the functionality flow (if applicable) - Desktop (X > 1024px)
  • Ensure new entries are added to CHANGELOG.md, if applicable.

API

  • Verify if API specs need to be regenerated.
  • Check if version updates are required (e.g., specs, Poetry, etc.).
  • Ensure new entries are added to CHANGELOG.md, if applicable.

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@HugoPBrito HugoPBrito requested a review from a team as a code owner November 13, 2025 10:19
@github-actions
Copy link
Contributor

github-actions bot commented Nov 13, 2025

Conflict Markers Resolved

All conflict markers have been successfully resolved in this pull request.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 13, 2025

✅ All necessary CHANGELOG.md files have been updated.

andoniaf
andoniaf previously approved these changes Nov 13, 2025
@HugoPBrito HugoPBrito merged commit 4579268 into master Nov 18, 2025
30 checks passed
@HugoPBrito HugoPBrito deleted the PROWLER-376-update-documentation-with-gcp-permissions branch November 18, 2025 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants