From 03dfa3816d1b211b4b78b920205d8650f3a1bb6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20Mart=C3=ADn?= Date: Wed, 27 May 2026 17:26:50 +0200 Subject: [PATCH] docs: fix alerts/import-findings URLs and pricing note (#11378) --- README.md | 2 +- action.yml | 4 ++-- docs/docs.json | 12 ++++++++++-- docs/user-guide/cookbooks/cicd-pipeline.mdx | 6 +++--- docs/user-guide/cookbooks/kubernetes-in-cluster.mdx | 6 +++--- .../{prowler-app-alerts.mdx => prowler-alerts.mdx} | 2 +- .../tutorials/prowler-app-github-action.mdx | 4 ++-- docs/user-guide/tutorials/prowler-app-rbac.mdx | 2 +- ...port-findings.mdx => prowler-import-findings.mdx} | 2 +- 9 files changed, 24 insertions(+), 16 deletions(-) rename docs/user-guide/tutorials/{prowler-app-alerts.mdx => prowler-alerts.mdx} (97%) rename docs/user-guide/tutorials/{prowler-app-import-findings.mdx => prowler-import-findings.mdx} (99%) diff --git a/README.md b/README.md index ad28c81e3d..41ad716c2b 100644 --- a/README.md +++ b/README.md @@ -293,7 +293,7 @@ python prowler-cli.py -v # ๐Ÿ›ก๏ธ GitHub Action -The official **Prowler GitHub Action** runs Prowler scans in your GitHub workflows using the official [`prowlercloud/prowler`](https://hub.docker.com/r/prowlercloud/prowler) Docker image. Scans run on any [supported provider](https://docs.prowler.com/user-guide/providers/), with optional [`--push-to-cloud`](https://docs.prowler.com/user-guide/tutorials/prowler-app-import-findings) to send findings to Prowler Cloud and optional SARIF upload so findings show up in the repo's **Security โ†’ Code scanning** tab and as inline PR annotations. +The official **Prowler GitHub Action** runs Prowler scans in your GitHub workflows using the official [`prowlercloud/prowler`](https://hub.docker.com/r/prowlercloud/prowler) Docker image. Scans run on any [supported provider](https://docs.prowler.com/user-guide/providers/), with optional [`--push-to-cloud`](https://docs.prowler.com/user-guide/tutorials/prowler-import-findings) to send findings to Prowler Cloud and optional SARIF upload so findings show up in the repo's **Security โ†’ Code scanning** tab and as inline PR annotations. ```yaml name: Prowler IaC Scan diff --git a/action.yml b/action.yml index a93c67d4e8..2be0649402 100644 --- a/action.yml +++ b/action.yml @@ -22,7 +22,7 @@ inputs: required: false default: json-ocsf push-to-cloud: - description: Push scan findings to Prowler Cloud. Requires the PROWLER_CLOUD_API_KEY environment variable. See https://docs.prowler.com/user-guide/tutorials/prowler-app-import-findings#using-the-cli + description: Push scan findings to Prowler Cloud. Requires the PROWLER_CLOUD_API_KEY environment variable. See https://docs.prowler.com/user-guide/tutorials/prowler-import-findings#using-the-cli required: false default: "false" flags: @@ -299,7 +299,7 @@ runs: echo "" echo "**Get started in 3 steps:**" echo "1. Create an account at [cloud.prowler.com](https://cloud.prowler.com)" - echo "2. Generate a Prowler Cloud API key ([docs](https://docs.prowler.com/user-guide/tutorials/prowler-app-import-findings#using-the-cli))" + echo "2. Generate a Prowler Cloud API key ([docs](https://docs.prowler.com/user-guide/tutorials/prowler-import-findings#using-the-cli))" echo "3. Add \`PROWLER_CLOUD_API_KEY\` to your GitHub secrets and set \`push-to-cloud: true\` on this action" echo "" echo "See [prowler.com/pricing](https://prowler.com/pricing) for plan details." diff --git a/docs/docs.json b/docs/docs.json index 8c3c79e8be..836ff50513 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -124,8 +124,8 @@ "user-guide/tutorials/prowler-app-rbac", "user-guide/tutorials/prowler-app-multi-tenant", "user-guide/tutorials/prowler-app-api-keys", - "user-guide/tutorials/prowler-app-import-findings", - "user-guide/tutorials/prowler-app-alerts", + "user-guide/tutorials/prowler-import-findings", + "user-guide/tutorials/prowler-alerts", { "group": "Mutelist", "expanded": true, @@ -576,6 +576,14 @@ { "source": "/contact", "destination": "/support" + }, + { + "source": "/user-guide/tutorials/prowler-app-import-findings", + "destination": "/user-guide/tutorials/prowler-import-findings" + }, + { + "source": "/user-guide/tutorials/prowler-app-alerts", + "destination": "/user-guide/tutorials/prowler-alerts" } ] } diff --git a/docs/user-guide/cookbooks/cicd-pipeline.mdx b/docs/user-guide/cookbooks/cicd-pipeline.mdx index ee7d49eb91..a88513d901 100644 --- a/docs/user-guide/cookbooks/cicd-pipeline.mdx +++ b/docs/user-guide/cookbooks/cicd-pipeline.mdx @@ -6,7 +6,7 @@ title: 'Run Prowler in CI/CD and Send Findings to Prowler Cloud' For new projects, use the official [Prowler GitHub Action](/user-guide/tutorials/prowler-app-github-action) โ€” a Docker-based reusable action that runs scans, optionally pushes findings to Prowler Cloud, and uploads SARIF results to GitHub Code Scanning. The GitHub Actions examples below document the legacy pip-based flow. -This cookbook demonstrates how to integrate Prowler into CI/CD pipelines so that security scans run automatically and findings are sent to Prowler Cloud via [Import Findings](/user-guide/tutorials/prowler-app-import-findings). Examples cover GitHub Actions and GitLab CI. +This cookbook demonstrates how to integrate Prowler into CI/CD pipelines so that security scans run automatically and findings are sent to Prowler Cloud via [Import Findings](/user-guide/tutorials/prowler-import-findings). Examples cover GitHub Actions and GitLab CI. ## Prerequisites @@ -19,7 +19,7 @@ This cookbook demonstrates how to integrate Prowler into CI/CD pipelines so that Prowler CLI provides the `--push-to-cloud` flag, which uploads scan results directly to Prowler Cloud after a scan completes. Combined with the `PROWLER_CLOUD_API_KEY` environment variable, this enables fully automated ingestion without manual file uploads. -For full details on the flag and API, refer to the [Import Findings](/user-guide/tutorials/prowler-app-import-findings) documentation. +For full details on the flag and API, refer to the [Import Findings](/user-guide/tutorials/prowler-import-findings) documentation. The examples in this guide use AWS as the target provider, but the same approach applies to any provider supported by Prowler (Azure, GCP, Kubernetes, and others). Replace `prowler aws` with the desired provider command (e.g., `prowler gcp`, `prowler azure`) and configure the corresponding credentials in the CI/CD environment. @@ -195,7 +195,7 @@ By default, Prowler exits with a non-zero code when it finds failing checks. Thi * **GitLab CI**: Add `allow_failure: true` to the job -Ingestion failures (e.g., network issues reaching Prowler Cloud) do not affect the Prowler exit code. The scan completes normally and only a warning is emitted. See [Import Findings troubleshooting](/user-guide/tutorials/prowler-app-import-findings#troubleshooting) for details. +Ingestion failures (e.g., network issues reaching Prowler Cloud) do not affect the Prowler exit code. The scan completes normally and only a warning is emitted. See [Import Findings troubleshooting](/user-guide/tutorials/prowler-import-findings#troubleshooting) for details. ### Caching Prowler Installation diff --git a/docs/user-guide/cookbooks/kubernetes-in-cluster.mdx b/docs/user-guide/cookbooks/kubernetes-in-cluster.mdx index 765bcf9313..661eeb17da 100644 --- a/docs/user-guide/cookbooks/kubernetes-in-cluster.mdx +++ b/docs/user-guide/cookbooks/kubernetes-in-cluster.mdx @@ -2,7 +2,7 @@ title: 'Run Kubernetes In-Cluster and Send Findings to Prowler Cloud' --- -This cookbook walks through deploying Prowler inside a Kubernetes cluster on a recurring schedule and automatically sending findings to Prowler Cloud via [Import Findings](/user-guide/tutorials/prowler-app-import-findings). By the end, security scan results from the cluster appear in Prowler Cloud without any manual file uploads. +This cookbook walks through deploying Prowler inside a Kubernetes cluster on a recurring schedule and automatically sending findings to Prowler Cloud via [Import Findings](/user-guide/tutorials/prowler-import-findings). By the end, security scan results from the cluster appear in Prowler Cloud without any manual file uploads. ## Prerequisites @@ -181,7 +181,7 @@ Once the job completes and findings are pushed: 2. Open the "Scans" section to verify the ingestion job status 3. Browse findings under the Kubernetes provider -For details on the ingestion workflow and status tracking, refer to the [Import Findings](/user-guide/tutorials/prowler-app-import-findings) documentation. +For details on the ingestion workflow and status tracking, refer to the [Import Findings](/user-guide/tutorials/prowler-import-findings) documentation. ## Tips and Troubleshooting @@ -204,4 +204,4 @@ For details on the ingestion workflow and status tracking, refer to the [Import --namespace prowler-ns ``` -* **Failed uploads**: If the push to Prowler Cloud fails, the scan still completes and findings are saved locally in the container. Check the [Import Findings troubleshooting section](/user-guide/tutorials/prowler-app-import-findings#troubleshooting) for common error messages. +* **Failed uploads**: If the push to Prowler Cloud fails, the scan still completes and findings are saved locally in the container. Check the [Import Findings troubleshooting section](/user-guide/tutorials/prowler-import-findings#troubleshooting) for common error messages. diff --git a/docs/user-guide/tutorials/prowler-app-alerts.mdx b/docs/user-guide/tutorials/prowler-alerts.mdx similarity index 97% rename from docs/user-guide/tutorials/prowler-app-alerts.mdx rename to docs/user-guide/tutorials/prowler-alerts.mdx index f607844f97..3fa49f84ff 100644 --- a/docs/user-guide/tutorials/prowler-app-alerts.mdx +++ b/docs/user-guide/tutorials/prowler-alerts.mdx @@ -10,7 +10,7 @@ import { VersionBadge } from "/snippets/version-badge.mdx" Alerts notify recipients by email when security findings match saved filter conditions. Use Alerts to track high-priority findings, monitor specific providers or services, and keep teams informed about scan results that match defined criteria. -This feature is available exclusively in **Prowler Cloud** with a paid subscription. +This feature is available exclusively in **Prowler Cloud** and **Prowler Enterprise** with a [paid subscription](https://prowler.com/pricing). ## Prerequisites diff --git a/docs/user-guide/tutorials/prowler-app-github-action.mdx b/docs/user-guide/tutorials/prowler-app-github-action.mdx index 5b80511b89..c874a37164 100644 --- a/docs/user-guide/tutorials/prowler-app-github-action.mdx +++ b/docs/user-guide/tutorials/prowler-app-github-action.mdx @@ -18,7 +18,7 @@ Source: [`prowler-cloud/prowler`](https://github.com/prowler-cloud/prowler) ยท M | `provider` | yes | โ€” | Cloud provider to scan (`aws`, `azure`, `gcp`, `github`, `kubernetes`, `iac`, `cloudflare`, etc.) | | `image-tag` | no | `stable` | Docker image tag โ€” `stable` (latest release), `latest` (master, not stable), or `` (pinned). See [available tags](https://hub.docker.com/r/prowlercloud/prowler/tags). | | `output-formats` | no | `json-ocsf` | Output format(s) for scan results. Space-separated (e.g. `sarif json-ocsf`) | -| `push-to-cloud` | no | `false` | Push findings to [Prowler Cloud](/user-guide/tutorials/prowler-app-import-findings). When `true`, `PROWLER_CLOUD_API_KEY` is auto-forwarded | +| `push-to-cloud` | no | `false` | Push findings to [Prowler Cloud](/user-guide/tutorials/prowler-import-findings). When `true`, `PROWLER_CLOUD_API_KEY` is auto-forwarded | | `flags` | no | `""` | Additional CLI flags (e.g. `--severity critical high`). Values with spaces can be quoted: `--resource-tag 'Environment=My Server'` | | `extra-env` | no | `""` | Space-, newline-, or comma-separated list of env var **names** to forward to the container (see [Authentication](#authentication)) | | `upload-sarif` | no | `false` | Upload SARIF results to GitHub Code Scanning | @@ -43,7 +43,7 @@ Source: [`prowler-cloud/prowler`](https://github.com/prowler-cloud/prowler) ยท M ### Push findings to Prowler Cloud -Send scan results directly to [Prowler Cloud](/user-guide/tutorials/prowler-app-import-findings) for centralized visibility, compliance tracking, and team collaboration. +Send scan results directly to [Prowler Cloud](/user-guide/tutorials/prowler-import-findings) for centralized visibility, compliance tracking, and team collaboration. ```yaml - uses: prowler-cloud/prowler@5.25 diff --git a/docs/user-guide/tutorials/prowler-app-rbac.mdx b/docs/user-guide/tutorials/prowler-app-rbac.mdx index cccbbc27cc..c6319591cf 100644 --- a/docs/user-guide/tutorials/prowler-app-rbac.mdx +++ b/docs/user-guide/tutorials/prowler-app-rbac.mdx @@ -239,7 +239,7 @@ To grant all administrative permissions, select the **Grant all admin permission The following permissions are available exclusively in **Prowler Cloud**: -**Manage Ingestions:** Submit and manage findings ingestion jobs via the API. Required to upload OCSF scan results using the `--push-to-cloud` CLI flag or the ingestion endpoints. See [Import Findings](/user-guide/tutorials/prowler-app-import-findings) for details. +**Manage Ingestions:** Submit and manage findings ingestion jobs via the API. Required to upload OCSF scan results using the `--push-to-cloud` CLI flag or the ingestion endpoints. See [Import Findings](/user-guide/tutorials/prowler-import-findings) for details. **Manage Billing:** Access and manage billing settings, subscription plans, and payment methods. diff --git a/docs/user-guide/tutorials/prowler-app-import-findings.mdx b/docs/user-guide/tutorials/prowler-import-findings.mdx similarity index 99% rename from docs/user-guide/tutorials/prowler-app-import-findings.mdx rename to docs/user-guide/tutorials/prowler-import-findings.mdx index 9f1002c2a9..d4c8f8a74d 100644 --- a/docs/user-guide/tutorials/prowler-app-import-findings.mdx +++ b/docs/user-guide/tutorials/prowler-import-findings.mdx @@ -10,7 +10,7 @@ import { VersionBadge } from "/snippets/version-badge.mdx" Findings Ingestion enables uploading OCSF (Open Cybersecurity Schema Framework) scan results to Prowler Cloud. This feature supports importing findings from Prowler CLI output files that use the [Detection Finding](https://schema.ocsf.io/classes/detection_finding) class. -This feature is available exclusively in **Prowler Cloud** with a paid subscription. +This feature is available exclusively in **Prowler Cloud** and **Prowler Enterprise** with a [paid subscription](https://prowler.com/pricing). ## OCSF Detection Finding format