Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arpith-f5 committed Sep 27, 2024
1 parent 795f4cb commit c4c0a47
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 9 deletions.
22 changes: 17 additions & 5 deletions website/docs/d/nginx_deployment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@ In addition to the Arguments listed above - the following Attributes are exporte

* `automatic_upgrade_channel` - The automatic upgrade channel for this NGINX deployment.

* `nginx_app_protect` - A `nginx_app_protect` block as defined below.
* `web_application_firewall_settings` - A `web_application_firewall_settings` block as defined below.

* `web_application_firewall_statuts` - A `web_application_firewall_status` block as defined below.

* `tags` - A mapping of tags assigned to the NGINX Deployment.

Expand Down Expand Up @@ -121,12 +123,22 @@ An `auto_scale_profile` block exports the following:

---

A `nginx_app_protect` block exports the following:
A `web_application_firewall_settings` block exports the following:

* `web_application_firewall_settings` - A `web_application_firewall_settings` block as defined below.
* `activation_state` - Whether WAF is enabled/disabled for this NGINX Deployment. Use 'Enabled' to enable WAF and 'Disabled' to disable it.

---

A `web_application_firewall_status` block exports the following:

* `attack_signatures_package` - Indicates the version of the attack signatures package used by NGINX App Protect.

* `bot_signatures_package` - Indicates the version of the bot signatures package used by NGINX App Protect.

* `threat_campaigns_package` - Indicates the version of the threat campaigns package used by NGINX App Protect.

* `component_versions` - Indicates the version of the WAF Engine and Nginx WAF Module used by NGINX App Protect.

A `web_application_firewall_settings` block exports the following:
* `activation_state` - Whether WAF is enabled/disabled for this NGINX Deployment.

## Timeouts

Expand Down
23 changes: 19 additions & 4 deletions website/docs/r/nginx_deployment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ The following arguments are supported:

* `automatic_upgrade_channel` - (Optional) Specify the automatic upgrade channel for the NGINX deployment. Defaults to `stable`. The possible values are `stable` and `preview`.

* `web_application_firewall_settings` - (Optional) A `web_application_firewall_settings` blocks as defined below.

* `tags` - (Optional) A mapping of tags which should be assigned to the NGINX Deployment.

---
Expand Down Expand Up @@ -170,12 +172,11 @@ An `auto_scale_profile` block supports the following:

-> **NOTE:** If you're using autoscaling with deployments created before v4.0, you may need to use [Terraform's `ignore_changes` functionality](https://www.terraform.io/language/meta-arguments/lifecycle#ignore_changes) to ignore changes to the `capacity` field.

A `nginx_app_protect` block exports the following:
---

* `web_application_firewall_settings` - (Required) A `web_application_firewall_settings` block as defined below.
A `web_application_firewall_settings` - block supports the following:

A `web_application_firewall_settings` block exports the following:
* `activation_state` - (Optional) Whether WAF is enabled/disabled for this NGINX Deployment.
* `activation_state` - (Required) Whether WAF is enabled/disabled for this NGINX Deployment. Use 'Enabled' to enable WAF and 'Disabled' to disable it.

## Attributes Reference

Expand All @@ -187,6 +188,20 @@ In addition to the Arguments listed above - the following Attributes are exporte

* `nginx_version` - The version of deployed NGINX.

* `web_application_firewall_status` - A `web_application_firewall_status` block as defined below:

---

A `web_application_firewall_status` - block supports the following:

* `attack_signatures_package` - Indicates the version of the attack signatures package used by NGINX App Protect.

* `bot_signatures_package` - Indicates the version of the bot signatures package used by NGINX App Protect.

* `threat_campaigns_package` - Indicates the version of the threat campaigns package used by NGINX App Protect.

* `component_versions` - Indicates the version of the WAF Engine and Nginx WAF Module used by NGINX App Protect.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:
Expand Down

0 comments on commit c4c0a47

Please sign in to comment.