Skip to content

Commit

Permalink
Add Default API Alerts
Browse files Browse the repository at this point in the history
  • Loading branch information
joshw123 committed Dec 5, 2024
1 parent c5e5406 commit 2693d88
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions modules/project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ This module implements the creation and management of one GCP project including
- [VPC Service Controls](#vpc-service-controls)
- [Project Related Outputs](#project-related-outputs)
- [Managing project related configuration without creating it](#managing-project-related-configuration-without-creating-it)
- [tftest inventory=data.yaml e2e](#tftest-inventorydatayaml-e2e)
- [API Alerts](#api-alerts)
- [Files](#files)
- [Variables](#variables)
- [Outputs](#outputs)
<!-- END TOC -->

## Basic Project Creation
Expand Down Expand Up @@ -1356,6 +1359,9 @@ module "bucket" {
id = "${var.prefix}-bucket"
}
# tftest inventory=data.yaml e2e
```

## API Alerts
There are events within Google Cloud that should be monitored and alerted on to ensure that you are aware of any potential security issues.
These actions are typically seen in cases of security breaches, or potential security breaches, although they can be genuine actions that are not security related, but are still important to monitor.
Expand All @@ -1368,9 +1374,12 @@ These events are typically
- VPC Network Changes
- Cloud Storage IAM Permission Changes
- SQL Instances Configuration Changes
Although you may not use the services listed above, such as SQL, it is still important to monitor these events for compliance purposes
To enable these alerts by default on all projects created, it is recommended to default the variable `enable_default_api_alerts` within `variables.tf` to true,
You will also need to set the `default_api_alerts_email` variable to the email address that will receive these alerts


Although you may not use the services listed above, such as SQL, it is still important to monitor these events for compliance purposes

To enable these alerts by default on all projects created, it is recommended to default the variable `enable_default_api_alerts` within `variables.tf` to true, You will also need to set the `default_api_alerts_email` variable to the email address that will receive these alerts

You can alternatively enable these alerts on a per-project basis by setting the variable `enable_api_alerts` to true on the module, along with the `default_api_alerts_email` variable
```terraform
module "project" {
Expand All @@ -1387,9 +1396,6 @@ module "project" {
}
```

# tftest inventory=data.yaml e2e
```
<!-- TFDOC OPTS files:1 -->
<!-- BEGIN TFDOC -->
## Files
Expand Down

0 comments on commit 2693d88

Please sign in to comment.