Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
imrannayer committed Apr 20, 2024
1 parent 037e84c commit 4bc303a
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 9 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# Cloud Armor Terraform Module
This module makes it easy to setup [Cloud Armor Security Policy](https://cloud.google.com/armor/docs/cloud-armor-overview#security_policies) with Security rules. There are `five` type of rules you can create in each policy:
This module makes it easy to setup [Cloud Armor global Security Policy](https://cloud.google.com/armor/docs/cloud-armor-overview#security_policies) with Security rules. You can attach the global Security Policy policy to backend services exposed by the following load balancer types:
- Global external Application Load Balancer (HTTP/HTTPS)
- Classic Application Load Balancer (HTTP/HTTPS)
- Global external proxy Network Load Balancer (TCP/SSL)
- Classic proxy Network Load Balancer (TCP/SSL)

There are `five` type of rules you can create in each policy:
1) [Pre-Configured Rules](#pre_configured_rules): These are based on [pre-configured waf rules](https://cloud.google.com/armor/docs/waf-rules).
2) [Security Rules](#security_rules): Allow or Deny traffic from list of IP addresses or IP adress ranges.
3) [Custom Rules](#custom_rules): You can create your own rules using [Common Expression Language (CEL)](https://cloud.google.com/armor/docs/rules-language-reference).
4) [Threat Intelligence Rules](#threat_intelligence_rules): Add Rules based on [threat intelligence](https://cloud.google.com/armor/docs/threat-intelligence). [Managed protection plus](https://cloud.google.com/armor/docs/managed-protection-overview) subscription is needed to use this feature.
5) [Automatically deploy Adaptive Protection Suggested Rules](#adaptive_protection_auto_deploy); When enable module will create a rule for automatically deploying the suggested rules that [Adaptive Protection generates](https://cloud.google.com/armor/docs/adaptive-protection-auto-deploy).


NOTE: For `external passthrough Network Load Balancers`, `protocol forwarding` and `VMs with public IP addresses` create [network Edge Security policy](https://cloud.google.com/armor/docs/security-policy-overview#network-edge-policies) using [advanced network DDoS protection](./modules/advanced-network-ddos-protection/) and [network edge security policy](./modules/network-edge-security-policy/) sub-modules.


## Compatibility

This module is meant for use with Terraform 1.3+ and tested using Terraform 1.3+. If you find incompatibilities using Terraform >=1.3, please open an issue.
Expand Down
4 changes: 2 additions & 2 deletions examples/advanced-network-ddos-protection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ terraform apply

| Name | Description |
|------|-------------|
| adv\_ddos\_protection\_policies | n/a |
| network\_edge\_security\_services | n/a |
| adv\_ddos\_protection\_policies | Advanced Network DDoS protection Security policies created |
| network\_edge\_security\_services | Network edge security services created |

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6 changes: 4 additions & 2 deletions examples/advanced-network-ddos-protection/outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
*/

output "adv_ddos_protection_policies" {
value = module.advanced_network_ddos_protection.adv_ddos_protection_policies
value = module.advanced_network_ddos_protection.adv_ddos_protection_policies
description = "Advanced Network DDoS protection Security policies created"
}

output "network_edge_security_services" {
value = module.advanced_network_ddos_protection.network_edge_security_services
value = module.advanced_network_ddos_protection.network_edge_security_services
description = "Network edge security services created"
}
2 changes: 1 addition & 1 deletion examples/network-edge-security-policy/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Enable Cloud Armor Network Edge Security Policy

This example creates network edge security policy with policy rules. Feature is only availalable to projects enrolled in [Cloud Armor Enterprise](https://cloud.google.com/armor/docs/armor-enterprise-overview) with [Advanced network DDoS protection](https://cloud.google.com/armor/docs/advanced-network-ddos#activate-advanced-ddos-protection) enabled. You can use [example](../advanced-network-ddos-protection/) to deploy advanced newtork ddos protection.
This example creates network edge security policy with policy rules. Feature is only availalable to projects enrolled in [Cloud Armor Enterprise](https://cloud.google.com/armor/docs/armor-enterprise-overview) with [Advanced network DDoS protection](https://cloud.google.com/armor/docs/advanced-network-ddos#activate-advanced-ddos-protection) enabled. You can use [example](../advanced-network-ddos-protection/) sub-module to deploy advanced newtork ddos protection.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion modules/network-edge-security-policy/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Cloud Armor Terraform Module
# Cloud Armor Terraform Module for Network Edge Security Policy
This module creates [network edge security policy](https://cloud.google.com/armor/docs/network-edge-policies) in specified region. Network edge security policy is only availalable to projects enrolled in [Cloud Armor Enterprise](https://cloud.google.com/armor/docs/armor-enterprise-overview) with [Advanced network DDoS protection](https://cloud.google.com/armor/docs/advanced-network-ddos#activate-advanced-ddos-protection) enabled. You can use [this](../advanced-network-ddos-protection/) sub-module to deploy `advanced network ddos protection `.

You can attch network edge security policy to [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network), [protocol forwarding](https://cloud.google.com/load-balancing/docs/protocol-forwarding), or VMs with public IP addresses. Network edge security policy supports [byte offset filtering](https://cloud.google.com/armor/docs/network-edge-policies#byte-offset). This module creates security policy of type `CLOUD_ARMOR_NETWORK` optionally attach security policy rules to the policy.
Expand Down
4 changes: 2 additions & 2 deletions modules/network-edge-security-policy/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/terraform-google-cloud-armor:advanced-network-ddos-protection/v2.1.0"
module_name = "blueprints/terraform/terraform-google-cloud-armor:network-edge-security-policy/v2.1.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/terraform-google-cloud-armor:advanced-network-ddos-protection/v2.1.0"
module_name = "blueprints/terraform/terraform-google-cloud-armor:network-edge-security-policy/v2.1.0"
}
}

0 comments on commit 4bc303a

Please sign in to comment.