diff --git a/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx b/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx index 206e55abae..f7a46f1121 100644 --- a/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx +++ b/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx @@ -104,13 +104,13 @@ export AWS_PROFILE=org-management Configure your Prowler API key: ```bash -export PROWLER_API_KEY="pk_your-api-key-here" +export PROWLER_API_KEY="pk_example-api-key" ``` To create an API key: -1. Log into Prowler Cloud or Prowler App -2. Navigate to **Profile** → **Account** +1. Log in to Prowler Cloud or Prowler App +2. Click **Profile** → **Account** 3. Click **Create API Key** 4. Provide a descriptive name and optionally set an expiration date 5. Copy the generated API key (it will only be shown once) @@ -278,8 +278,8 @@ python aws_org_generator.py \ - 1. Log into the AWS management account - 2. Navigate to CloudFormation → StackSets + 1. Log in to the AWS management account + 2. Open CloudFormation → StackSets 3. Create a new StackSet using the [Prowler role template](https://github.com/prowler-cloud/prowler/blob/master/permissions/templates/cloudformation/prowler-scan-role.yml) 4. Deploy to all organizational units 5. Use a unique external ID (e.g., `prowler-org-2024-abc123`) @@ -340,7 +340,7 @@ python aws_org_generator.py \ ```bash # Set Prowler API key - export PROWLER_API_KEY="pk_your-api-key-here" + export PROWLER_API_KEY="pk_example-api-key" # Run bulk provisioning with connection testing python prowler_bulk_provisioning.py aws-org-accounts.yaml @@ -493,7 +493,7 @@ grep "role_arn:" aws-org-accounts.yaml | head -5 grep "provider: aws" aws-org-accounts.yaml | wc -l ``` -## Where to go next? +## Next Steps diff --git a/docs/user-guide/tutorials/bulk-provider-provisioning.mdx b/docs/user-guide/tutorials/bulk-provider-provisioning.mdx index 456b781836..5c8ff3ecbc 100644 --- a/docs/user-guide/tutorials/bulk-provider-provisioning.mdx +++ b/docs/user-guide/tutorials/bulk-provider-provisioning.mdx @@ -43,13 +43,13 @@ pip install -r requirements.txt Configure your Prowler API key: ```bash -export PROWLER_API_KEY="pk_your-api-key-here" +export PROWLER_API_KEY="pk_example-api-key" ``` To create an API key: -1. Log into Prowler Cloud or Prowler App -2. Navigate to **Profile** → **Account** +1. Log in to Prowler Cloud or Prowler App +2. Click **Profile** → **Account** 3. Click **Create API Key** 4. Provide a descriptive name and optionally set an expiration date 5. Copy the generated API key (it will only be shown once) diff --git a/util/prowler-bulk-provisioning/README.md b/util/prowler-bulk-provisioning/README.md index 26f1879fa1..4cdb020e21 100644 --- a/util/prowler-bulk-provisioning/README.md +++ b/util/prowler-bulk-provisioning/README.md @@ -52,10 +52,10 @@ This two-step approach follows the Prowler API design where providers and their 3. Get your Prowler API key: - **Prowler Cloud:** Create an API key at https://api.prowler.com - **Self-hosted Prowler App:** Create an API key in your local instance - - Navigate to **Profile** → **Account** → **Create API Key** + - Click **Profile** → **Account** → **Create API Key** ```bash - export PROWLER_API_KEY="pk_your-api-key-here" + export PROWLER_API_KEY="pk_example-api-key" ``` For detailed instructions on creating API keys, see: https://docs.prowler.com/user-guide/providers/prowler-app-api-keys @@ -82,7 +82,7 @@ Before using the AWS Organizations generator, deploy the ProwlerRole across all 2. Generate YAML configuration for all organization accounts: ```bash - python aws_org_generator.py -o aws-accounts.yaml --external-id your-external-id + python aws_org_generator.py -o aws-accounts.yaml --external-id example-external-id ``` 3. Run bulk provisioning: @@ -147,7 +147,7 @@ python aws_org_generator.py -o aws-accounts.yaml \ ### Environment Variables ```bash -export PROWLER_API_KEY="pk_your-api-key-here" +export PROWLER_API_KEY="pk_example-api-key" export PROWLER_API_BASE="https://api.prowler.com/api/v1" # Optional, defaults to Prowler Cloud ``` @@ -315,8 +315,8 @@ The Prowler API supports the following authentication methods for GCP: # OR inline: # inline_json: # type: "service_account" - # project_id: "your-project" - # private_key_id: "key-id" + # project_id: "example-project" + # private_key_id: "example-key-id" # private_key: "-----BEGIN PRIVATE KEY-----\n..." # client_email: "service-account@project.iam.gserviceaccount.com" # client_id: "1234567890"