Skip to content

Commit

Permalink
Fix Optional and Required fields for resouces
Browse files Browse the repository at this point in the history
ref: #229
  • Loading branch information
Abhinav Grover committed Nov 16, 2023
1 parent d78faa9 commit 7623354
Show file tree
Hide file tree
Showing 18 changed files with 144 additions and 140 deletions.
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,12 @@ provider "volterra" {

* `api_p12_file` - API credential p12 file path. Either api p12 file or (`api_cert` and `api_key`) must be given. This can also be sourced from `VOLT_API_P12_FILE` env variable. When using api_p12_file, password for the p12 file must be passed as the environment variable `VES_P12_PASSWORD` (`String`).

* `api_cert` - API certificate file path. `api_cert` and `api_key` combo must be given. This can also be sourced from `VOLT_API_CERT` env variable (`String`).
* `api_cert` - API certificate file path. `api_cert`, `api_key` and `api_ca_cert` trio must be given. This can also be sourced from `VOLT_API_CERT` env variable (`String`).

* `api_key` - API certificate private key file path. This can also be sourced from `VOLT_API_KEY` env variable (`String`).

* `api_ca_cert` - API CA certificate file path. This can also be sourced from `VOLT_API_CA_CERT` env variable (`String`).

* `url` - (Required) Tenant API url file path. This can also be sourced from `VOLT_API_URL` env variable (`String`).

* `timeout` - Volterra api call timeout, by default its 20 seconds. This can also be sourced from `VOLT_API_TIMEOUT` env variable (`String`).
2 changes: 2 additions & 0 deletions docs/resources/volterra_advertise_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Argument Reference

`port` - (Optional) Port to advertise. (`Int`).

`port_ranges` - (Optinal) Each port range consists of a single port or two ports separated by "-". (`String`).

`protocol` - (Optional) Protocol to advertise. (`String`).

`public_ip` - (Optional) This field is mutually exclusive with where and address fields.. See [ref](#ref) below for details.
Expand Down
16 changes: 8 additions & 8 deletions docs/resources/volterra_app_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,15 +158,15 @@ Common attributes for the rule including name and description..

The custom data detection config specifies targets, scopes & the pattern to be detected..

`any_domain` - (Required) The rule will apply for all domains. (bool).
`any_domain` - (Optional) The rule will apply for all domains. (bool).

`specific_domain` - (Required) For example: api.example.com (`String`).
`specific_domain` - (Optional) For example: api.example.com (`String`).

`key_pattern` - (Required) Search for pattern across all field names in the specified sections.. See [Key Pattern ](#key-pattern) below for details.
`key_pattern` - (Optional) Search for pattern across all field names in the specified sections.. See [Key Pattern ](#key-pattern) below for details.

`key_value_pattern` - (Required) Search for specific field and value patterns in the specified sections.. See [Key Value Pattern ](#key-value-pattern) below for details.
`key_value_pattern` - (Optional) Search for specific field and value patterns in the specified sections.. See [Key Value Pattern ](#key-value-pattern) below for details.

`value_pattern` - (Required) Search for pattern across all field values in the specified sections.. See [Value Pattern ](#value-pattern) below for details.
`value_pattern` - (Optional) Search for pattern across all field values in the specified sections.. See [Value Pattern ](#value-pattern) below for details.

`all_request_sections` - (Optional) x-displayName: "All Request" (bool).

Expand All @@ -176,13 +176,13 @@ The custom data detection config specifies targets, scopes & the pattern to be d

`custom_sections` - (Optional) x-displayName: "Custom Sections". See [Custom Sections ](#custom-sections) below for details.

`any_target` - (Required) The rule will be applied for all requests on this LB. (bool).
`any_target` - (Optional) The rule will be applied for all requests on this LB. (bool).

`api_endpoint_target` - (Required) The rule is applied only for the specified api endpoints.. See [Api Endpoint Target ](#api-endpoint-target) below for details.
`api_endpoint_target` - (Optional) The rule is applied only for the specified api endpoints.. See [Api Endpoint Target ](#api-endpoint-target) below for details.

`api_group` - (Optional) Custom groups can be created if user tags paths or operations with "x-volterra-api-group" extensions inside swaggers. (`String`).

`base_path` - (Required) The rule is applied only for the requests matching the specified base path. (`String`).
`base_path` - (Optional) The rule is applied only for the requests matching the specified base path. (`String`).

### Sensitive Data Detection Rules

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/volterra_cdn_loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Disable Caching of content from the origin.

Cache Options.

`cache_rules` - (Required) Rules are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs.. See [Cache Rules ](#cache-rules) below for details.
`cache_rules` - (Optional) Rules are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs.. See [Cache Rules ](#cache-rules) below for details.

`default_cache_action` - (Required) Default value for Cache action.. See [Default Cache Action ](#default-cache-action) below for details.

Expand Down Expand Up @@ -325,7 +325,7 @@ CDN Distribution serving content over HTTP.

`port` - (Optional) HTTP port to Listen. (`Int`).

`port_ranges` - (Required) Each port range consists of a single port or two ports separated by "-". (`String`).
`port_ranges` - (Optional) Each port range consists of a single port or two ports separated by "-". (`String`).

### Https

Expand Down
68 changes: 34 additions & 34 deletions docs/resources/volterra_http_loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -597,9 +597,9 @@ If request matches any of these rules, skipping second category rules..

`client_matcher` - (Optional) Conditions related to the origin of the request, such as client IP, TLS fingerprint, etc.. See [Client Matcher ](#client-matcher) below for details.

`any_domain` - (Required) The rule will apply for all domains. (bool).
`any_domain` - (Optional) The rule will apply for all domains. (bool).

`specific_domain` - (Required) For example: api.example.com (`String`).
`specific_domain` - (Optional) For example: api.example.com (`String`).

`metadata` - (Required) Common attributes for the rule including name and description.. See [Metadata ](#metadata) below for details.

Expand Down Expand Up @@ -631,9 +631,9 @@ For API groups, refer to API Definition which includes API groups derived from u

`client_matcher` - (Optional) Conditions related to the origin of the request, such as client IP, TLS fingerprint, etc.. See [Client Matcher ](#client-matcher) below for details.

`any_domain` - (Required) The rule will apply for all domains. (bool).
`any_domain` - (Optional) The rule will apply for all domains. (bool).

`specific_domain` - (Required) For example: api.example.com (`String`).
`specific_domain` - (Optional) For example: api.example.com (`String`).

`metadata` - (Required) Common attributes for the rule including name and description.. See [Metadata ](#metadata) below for details.

Expand Down Expand Up @@ -811,11 +811,11 @@ Define rules to block IP Prefixes or AS numbers..

`actions` - (Optional) Actions that should be taken when client identifier matches the rule (`List of Strings`).

`as_number` - (Required) RFC 6793 defined 4-byte AS number (`Int`).
`as_number` - (Optional) RFC 6793 defined 4-byte AS number (`Int`).

`http_header` - (Required) Request header name and value pairs. See [Http Header ](#http-header) below for details.
`http_header` - (Optional) Request header name and value pairs. See [Http Header ](#http-header) below for details.

`ip_prefix` - (Required) IPv4 prefix string. (`String`).
`ip_prefix` - (Optional) IPv4 prefix string. (`String`).

`user_identifier` - (Optional) Identify user based on user identifier. User identifier value needs to be copied from security event. (`String`).

Expand Down Expand Up @@ -1193,9 +1193,9 @@ Define manual mitigation rules to block L7 DDos attacks..

`block` - (Optional) Block user for a duration determined by the expiration time (bool).

`ddos_client_source` - (Required) Combination of Region, ASN and TLS Fingerprints. See [Ddos Client Source ](#ddos-client-source) below for details.
`ddos_client_source` - (Optional) Combination of Region, ASN and TLS Fingerprints. See [Ddos Client Source ](#ddos-client-source) below for details.

`ip_prefix_list` - (Required) IPv4 prefix string.. See [Ip Prefix List ](#ip-prefix-list) below for details.
`ip_prefix_list` - (Optional) IPv4 prefix string.. See [Ip Prefix List ](#ip-prefix-list) below for details.

### Default Captcha Challenge Parameters

Expand Down Expand Up @@ -1267,9 +1267,9 @@ Origin Pools used when no route is specified (default route).

`endpoint_subsets` - (Optional) upstream origin pool which match this metadata will be selected for load balancing (`String`).

`cluster` - (Required) More flexible, advanced feature control with cluster. See [ref](#ref) below for details.
`cluster` - (Optional) More flexible, advanced feature control with cluster. See [ref](#ref) below for details.

`pool` - (Required) Simple, commonly used pool parameters with origin pool. See [ref](#ref) below for details.
`pool` - (Optional) Simple, commonly used pool parameters with origin pool. See [ref](#ref) below for details.

`priority` - (Optional) made active as per the increasing priority. (`Int`).

Expand Down Expand Up @@ -1739,7 +1739,7 @@ HTTP Load Balancer..

`port` - (Optional) HTTP port to Listen. (`Int`).

`port_ranges` - (Required) Each port range consists of a single port or two ports separated by "-". (`String`).
`port_ranges` - (Optional) Each port range consists of a single port or two ports separated by "-". (`String`).

### Http1 Config

Expand Down Expand Up @@ -1801,7 +1801,7 @@ User is responsible for managing DNS to this load balancer..

`port` - (Optional) HTTPS port to Listen. (`Int`).

`port_ranges` - (Required) Each port range consists of a single port or two ports separated by "-". (`String`).
`port_ranges` - (Optional) Each port range consists of a single port or two ports separated by "-". (`String`).

`append_server_name` - (Optional) If header value is already present, it is not overwritten and passed as-is. (`String`).

Expand Down Expand Up @@ -1843,7 +1843,7 @@ or a DNS CNAME record should be created in your DNS provider's portal..

`port` - (Optional) HTTPS port to Listen. (`Int`).

`port_ranges` - (Required) Each port range consists of a single port or two ports separated by "-". (`String`).
`port_ranges` - (Optional) Each port range consists of a single port or two ports separated by "-". (`String`).

`append_server_name` - (Optional) If header value is already present, it is not overwritten and passed as-is. (`String`).

Expand Down Expand Up @@ -2031,9 +2031,9 @@ Specify origin server with K8s service name and site information.

`vk8s_networks` - (Optional) origin server are on vK8s network on the site (bool).

`service_name` - (Required) Both namespace and cluster-id are optional. (`String`).
`service_name` - (Optional) Both namespace and cluster-id are optional. (`String`).

`service_selector` - (Required) discovery has to happen. This implicit label is added to service_selector. See [Service Selector ](#service-selector) below for details.
`service_selector` - (Optional) discovery has to happen. This implicit label is added to service_selector. See [Service Selector ](#service-selector) below for details.

`site_locator` - (Required) Site or Virtual site where this origin server is located. See [Site Locator ](#site-locator) below for details.

Expand Down Expand Up @@ -2227,11 +2227,11 @@ No mitigation actions..

x-displayName: "Custom Fall Through Rule List".

`action_block` - (Required) Block the request and issue an API security event (bool).
`action_block` - (Optional) Block the request and issue an API security event (bool).

`action_report` - (Required) Continue processing the request and issue an API security event (bool).
`action_report` - (Optional) Continue processing the request and issue an API security event (bool).

`action_skip` - (Required) Continue processing the request (bool).
`action_skip` - (Optional) Continue processing the request (bool).

`api_endpoint` - (Optional) The API endpoint (Path + Method) which this validation applies to. See [Api Endpoint ](#api-endpoint) below for details.

Expand Down Expand Up @@ -2411,9 +2411,9 @@ List of Origin Pools.

`endpoint_subsets` - (Optional) upstream origin pool which match this metadata will be selected for load balancing (`String`).

`cluster` - (Required) More flexible, advanced feature control with cluster. See [ref](#ref) below for details.
`cluster` - (Optional) More flexible, advanced feature control with cluster. See [ref](#ref) below for details.

`pool` - (Required) Simple, commonly used pool parameters with origin pool. See [ref](#ref) below for details.
`pool` - (Optional) Simple, commonly used pool parameters with origin pool. See [ref](#ref) below for details.

`priority` - (Optional) made active as per the increasing priority. (`Int`).

Expand Down Expand Up @@ -2847,15 +2847,15 @@ Secret Value of the HTTP header..

The custom data detection config specifies targets, scopes & the pattern to be detected..

`any_domain` - (Required) The rule will apply for all domains. (bool).
`any_domain` - (Optional) The rule will apply for all domains. (bool).

`specific_domain` - (Required) For example: api.example.com (`String`).
`specific_domain` - (Optional) For example: api.example.com (`String`).

`key_pattern` - (Required) Search for pattern across all field names in the specified sections.. See [Key Pattern ](#key-pattern) below for details.
`key_pattern` - (Optional) Search for pattern across all field names in the specified sections.. See [Key Pattern ](#key-pattern) below for details.

`key_value_pattern` - (Required) Search for specific field and value patterns in the specified sections.. See [Key Value Pattern ](#key-value-pattern) below for details.
`key_value_pattern` - (Optional) Search for specific field and value patterns in the specified sections.. See [Key Value Pattern ](#key-value-pattern) below for details.

`value_pattern` - (Required) Search for pattern across all field values in the specified sections.. See [Value Pattern ](#value-pattern) below for details.
`value_pattern` - (Optional) Search for pattern across all field values in the specified sections.. See [Value Pattern ](#value-pattern) below for details.

`all_request_sections` - (Optional) x-displayName: "All Request" (bool).

Expand All @@ -2865,13 +2865,13 @@ The custom data detection config specifies targets, scopes & the pattern to be d

`custom_sections` - (Optional) x-displayName: "Custom Sections". See [Custom Sections ](#custom-sections) below for details.

`any_target` - (Required) The rule will be applied for all requests on this LB. (bool).
`any_target` - (Optional) The rule will be applied for all requests on this LB. (bool).

`api_endpoint_target` - (Required) The rule is applied only for the specified api endpoints.. See [Api Endpoint Target ](#api-endpoint-target) below for details.
`api_endpoint_target` - (Optional) The rule is applied only for the specified api endpoints.. See [Api Endpoint Target ](#api-endpoint-target) below for details.

`api_group` - (Optional) Custom groups can be created if user tags paths or operations with "x-volterra-api-group" extensions inside swaggers. (`String`).

`base_path` - (Required) The rule is applied only for the requests matching the specified base path. (`String`).
`base_path` - (Optional) The rule is applied only for the requests matching the specified base path. (`String`).

### Sensitive Data Detection Rules

Expand All @@ -2893,9 +2893,9 @@ For matching also specific endpoints you can use the API endpoint rules set bell

`base_path` - (Required) Prefix of the request path. (`String`).

`any_domain` - (Required) The rule will apply for all domains. (bool).
`any_domain` - (Optional) The rule will apply for all domains. (bool).

`specific_domain` - (Required) The rule will apply for a specific domain. (`String`).
`specific_domain` - (Optional) The rule will apply for a specific domain. (`String`).

`inline_rate_limiter` - (Optional) Specify rate values for the rule.. See [Inline Rate Limiter ](#inline-rate-limiter) below for details.

Expand Down Expand Up @@ -3203,11 +3203,11 @@ Define rules to skip processing of one or more features such as WAF, Bot Defense

`actions` - (Optional) Actions that should be taken when client identifier matches the rule (`List of Strings`).

`as_number` - (Required) RFC 6793 defined 4-byte AS number (`Int`).
`as_number` - (Optional) RFC 6793 defined 4-byte AS number (`Int`).

`http_header` - (Required) Request header name and value pairs. See [Http Header ](#http-header) below for details.
`http_header` - (Optional) Request header name and value pairs. See [Http Header ](#http-header) below for details.

`ip_prefix` - (Required) IPv4 prefix string. (`String`).
`ip_prefix` - (Optional) IPv4 prefix string. (`String`).

`user_identifier` - (Optional) Identify user based on user identifier. User identifier value needs to be copied from security event. (`String`).

Expand Down
16 changes: 8 additions & 8 deletions docs/resources/volterra_nfv_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ External service type is Endpoint service.

`automatic_vip` - (Optional) System will automatically select a VIP (bool).

`configured_vip` - (Required) Enter IP address for the default VIP (`String`).
`configured_vip` - (Optional) Enter IP address for the default VIP (`String`).

`custom_tcp_ports` - (Optional) select custom tcp ports. See [Custom Tcp Ports ](#custom-tcp-ports) below for details.

Expand All @@ -485,9 +485,9 @@ Virtual F5 BigIP service to be deployed on AWS.

`endpoint_service` - (Optional) External service type is Endpoint service. See [Endpoint Service ](#endpoint-service) below for details.

`byol_image` - (Required) Select the BigIp bring your own license image to be used for this service. See [Byol Image ](#byol-image) below for details.
`byol_image` - (Optional) Select the BigIp bring your own license image to be used for this service. See [Byol Image ](#byol-image) below for details.

`market_place_image` - (Required) Select the BigIp pay as you go image to be used for this service. See [Market Place Image ](#market-place-image) below for details.
`market_place_image` - (Optional) Select the BigIp pay as you go image to be used for this service. See [Market Place Image ](#market-place-image) below for details.

`nodes` - (Required) Specify how and where the service nodes are spawned. See [Nodes ](#nodes) below for details.

Expand Down Expand Up @@ -571,9 +571,9 @@ User given public and private SSH keys.

Select the BigIp pay as you go image to be used for this service.

`AWAFPayG200Mbps` - (Required) F5 Advanced WAF with LTM, IPI, and Threat Campaigns (PAYG, 200Mbps) (bool).
`AWAFPayG200Mbps` - (Optional) F5 Advanced WAF with LTM, IPI, and Threat Campaigns (PAYG, 200Mbps) (bool).

`AWAFPayG3Gbps` - (Required) F5 Advanced WAF with LTM, IPI, and Threat Campaigns (PAYG, 3Gbps) (bool).
`AWAFPayG3Gbps` - (Optional) F5 Advanced WAF with LTM, IPI, and Threat Campaigns (PAYG, 3Gbps) (bool).

### Medium Security

Expand Down Expand Up @@ -623,9 +623,9 @@ Specify how and where the service nodes are spawned.

Palo Alto Networks VM-Series Firewall to be deployed on AWS Cloud.

`pan_ami_bundle1` - (Required) VM-Series Next-Generation Firewall Bundle 1 (bool).
`pan_ami_bundle1` - (Optional) VM-Series Next-Generation Firewall Bundle 1 (bool).

`pan_ami_bundle2` - (Required) VM-Series Next-Generation Firewall Bundle 2 (bool).
`pan_ami_bundle2` - (Optional) VM-Series Next-Generation Firewall Bundle 2 (bool).

`aws_tgw_site` - (Required) Select AWS transit gateway site. See [ref](#ref) below for details.

Expand All @@ -639,7 +639,7 @@ Palo Alto Networks VM-Series Firewall to be deployed on AWS Cloud.

`auto_setup` - (Optional) Auto Setup API Access & Users. With this firewall api access and given admin user will be auto setup. See [Auto Setup ](#auto-setup) below for details.

`ssh_key` - (Required) its corresponding ssh private key. (`String`).
`ssh_key` - (Optional) its corresponding ssh private key. (`String`).

`tags` - (Optional) It helps to manage, identify, organize, search for, and filter resources in AWS console. (`String`).

Expand Down
Loading

0 comments on commit 7623354

Please sign in to comment.