Skip to content

Commit 047b2d0

Browse files
Add more info about safety in GCP Service Extensions (#29942)
* Add more info about safety * sync both pages * fix formatting * Apply suggestions from code review minor formatting edits * Apply suggestions from code review --------- Co-authored-by: Michael Cretzman <58786311+michaelcretzman@users.noreply.github.com>
1 parent ac20575 commit 047b2d0

File tree

2 files changed

+41
-5
lines changed

2 files changed

+41
-5
lines changed

content/en/security/application_security/setup/gcp/service-extensions.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can enable App and API Protection (AAP) with GCP Service Extensions within G
3535
- In your GCP project, you have either the project `owner` or `editor` role, or the relevant Compute Engine IAM roles: `compute.instanceAdmin.v1` (to create instances) and `compute.networkAdmin` (to set up load balancing).
3636
- A GCP project with a Cloud Load Balancer is configured for your services. The Cloud Load Balancer must be one of the [Application Load Balancers that supports Traffic Callouts][3].
3737
- Compute Engine API and Network Services API are enabled:
38-
38+
3939
```bash
4040
gcloud services enable compute.googleapis.com networkservices.googleapis.com
4141
```
@@ -58,7 +58,7 @@ To set up the App and API Protection Service Extension in your GCP environment,
5858
</div>
5959

6060
2. Add the VM to an unmanaged instance group.
61-
61+
6262
Specify `http:80` and `grpc:443` (or your configured values) for the port mappings of the instance group.
6363

6464
3. Create a backend service with the following settings:
@@ -81,8 +81,21 @@ To set up the App and API Protection Service Extension in your GCP environment,
8181
1. To send all traffic to the extension, insert `true` in the **Match condition**.
8282
2. For **Programability type**, select `Callouts`.
8383
3. Select the backend service you created in the previous step.
84-
4. Select all **Events** from the list where you want App and API Protection to run detection (Request Headers and Response Headers are **required**).
84+
4. Select only **Events** from the list where you want App and API Protection to run detection (Request Headers and Response Headers are **required**).
85+
5. Optionally, enable the `fail_open` to still allow the traffic to pass through if the service extension fails or times out.
86+
87+
<br>
88+
<div class="alert alert-warning">
89+
<strong>Note:</strong> By default, if the service extension fails or times out, the proxy will return a 500 error. To prevent this, enable the <code>fail_open</code> setting. When enabled, request or response processing continues without error even if the extension fails, ensuring your application remains available.
90+
</div>
8591

92+
<div class="alert alert-info">
93+
<p><strong>Notes:</strong></p>
94+
<ul>
95+
<li>Currently, the service extension doesn't process request bodies. If you select request and response body events in the extension chain events, the service extension does not inspect the request body. For more information, see <a href="#limitations">Limitations</a>.</li>
96+
<li>If you select the <code>Request Body</code> and <code>Response Body</code> events, processing time will increase as the service extension needs to transfer and analyze these bodies. <strong>Adjust your timeout</strong> settings to accommodate the additional processing time.</li>
97+
</ul>
98+
</div>
8699
</br>
87100

88101
{{% appsec-getstarted-2-plusrisk %}}
@@ -481,7 +494,7 @@ The GCP Service Extensions have the following limitations:
481494

482495
## Using AAP without APM tracing
483496

484-
If you want to use Application & API Protection without APM tracing functionality, you can deploy with tracing disabled:
497+
If you want to use App and API Protection without APM tracing functionality, you can deploy with tracing disabled:
485498

486499
1. Configure your tracing library with the `DD_APM_TRACING_ENABLED=false` environment variable in addition to the `DD_APPSEC_ENABLED=true` environment variable.
487500
2. This configuration will reduce the amount of APM data sent to Datadog to the minimum required by App and API Protection products.

content/en/security/application_security/setup/standalone/gcp-service-extensions.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,21 @@ To set up the App and API Protection Service Extension in your GCP environment,
7979
1. To send all traffic to the extension, insert `true` in the **Match condition**.
8080
2. For **Programability type**, select `Callouts`.
8181
3. Select the backend service you created in the previous step.
82-
4. Select all **Events** from the list where you want App and API Protection to run detection (Request Headers and Response Headers are **required**).
82+
4. Select only **Events** from the list where you want App and API Protection to run detection (Request Headers and Response Headers are **required**).
83+
5. Optionally, enable the `fail_open` to still allow the traffic to pass through if the service extension fails or times out.
8384

85+
<br>
86+
<div class="alert alert-warning">
87+
<strong>Note:</strong> By default, if the service extension fails or times out, the proxy will return a 500 error. To prevent this, enable the <code>fail_open</code> setting. When enabled, request or response processing continues without error even if the extension fails, ensuring your application remains available.
88+
</div>
89+
90+
<div class="alert alert-info">
91+
<p><strong>Notes:</strong></p>
92+
<ul>
93+
<li>Currently, the service extension doesn't process request bodies. If you select request and response body events in the extension chain events, the service extension does not inspect the request body. For more information, see <a href="#limitations">Limitations</a>.</li>
94+
<li>If you select the <code>Request Body</code> and <code>Response Body</code> events, processing time will increase as the service extension needs to transfer and analyze these bodies. <strong>Adjust your timeout</strong> settings to accommodate the additional processing time.</li>
95+
</ul>
96+
</div>
8497
</br>
8598

8699
{{% appsec-getstarted-2-plusrisk %}}
@@ -477,6 +490,16 @@ The GCP Service Extensions have the following limitations:
477490

478491
* The request body is not inspected, regardless of its content type.
479492

493+
## Using AAP without APM tracing
494+
495+
If you want to use App and API Protection without APM tracing functionality, you can deploy with tracing disabled:
496+
497+
1. Configure your tracing library with the `DD_APM_TRACING_ENABLED=false` environment variable in addition to the `DD_APPSEC_ENABLED=true` environment variable.
498+
2. This configuration will reduce the amount of APM data sent to Datadog to the minimum required by App and API Protection products.
499+
500+
For more details, see [Standalone App and API Protection][standalone_billing_guide].
501+
[standalone_billing_guide]: /security/application_security/guide/standalone_application_security/
502+
480503
## Further Reading
481504

482505
{{< partial name="whats-next/whats-next.html" >}}

0 commit comments

Comments
 (0)