Skip to content
README.md 5.34 KiB
Newer Older
Michael Kennedy's avatar
Michael Kennedy committed
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
| <a name="requirement_kubectl"></a> [kubectl](#requirement\_kubectl) | ~> 1.14.0 |
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | ~> 2.21.0 |
| <a name="requirement_volterra"></a> [volterra](#requirement\_volterra) | ~> 0.11.20 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_null"></a> [null](#provider\_null) | n/a |
| <a name="provider_volterra"></a> [volterra](#provider\_volterra) | ~> 0.11.20 |

## Modules

No modules.

## Resources

| Name | Type |
|------|------|
| [null_resource.synthetic_monitor_dns](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
| [null_resource.synthetic_monitor_http](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
| [volterra_api_credential.vk8s_cred](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/api_credential) | resource |
| [volterra_app_firewall.af](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/app_firewall) | resource |
| [volterra_app_setting.as](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/app_setting) | resource |
| [volterra_app_type.at](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/app_type) | resource |
| [volterra_healthcheck.monitor](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/healthcheck) | resource |
| [volterra_namespace.vk8s_namespace](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/namespace) | resource |
| [volterra_origin_pool.origin_pool](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/origin_pool) | resource |
| [volterra_tcp_loadbalancer.tcp_lb](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/tcp_loadbalancer) | resource |
| [volterra_user_identification.ui](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/user_identification) | resource |
| [volterra_virtual_k8s.vk8s](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/virtual_k8s) | resource |
| [volterra_virtual_site.virtual_site](https://registry.terraform.io/providers/volterraedge/volterra/latest/docs/resources/virtual_site) | resource |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_api_p12_file"></a> [api\_p12\_file](#input\_api\_p12\_file) | Tenant API credentials - https://docs.cloud.f5.com/docs/how-to/volterra-automation-tools/apis#authentication | `string` | n/a | yes |
| <a name="input_api_url"></a> [api\_url](#input\_api\_url) | Tenancy API Endpoint - https://docs.cloud.f5.com/docs/how-to/volterra-automation-tools/apis | `string` | n/a | yes |
| <a name="input_app_fqdn"></a> [app\_fqdn](#input\_app\_fqdn) | Application FrontEnd HTTP FQDN | `string` | n/a | yes |
| <a name="input_base"></a> [base](#input\_base) | Deployment base prefix tag | `string` | n/a | yes |
| <a name="input_bot_defense_region"></a> [bot\_defense\_region](#input\_bot\_defense\_region) | botdefense region | `string` | `"US"` | no |
| <a name="input_cred_expiry_days"></a> [cred\_expiry\_days](#input\_cred\_expiry\_days) | Credential life-cycle (days) | `number` | `89` | no |
| <a name="input_enable_bot_defense"></a> [enable\_bot\_defense](#input\_enable\_bot\_defense) | Enable bot defense | `bool` | `false` | no |
| <a name="input_enable_client_side_defense"></a> [enable\_client\_side\_defense](#input\_enable\_client\_side\_defense) | Enable client side defenses | `bool` | `false` | no |
| <a name="input_enable_synthetic_monitors"></a> [enable\_synthetic\_monitors](#input\_enable\_synthetic\_monitors) | Enable Synthetic monitoring | `bool` | `false` | no |
| <a name="input_lb_port"></a> [lb\_port](#input\_lb\_port) | Load Balancer TCP Port | `number` | n/a | yes |
| <a name="input_virtual_site_selector"></a> [virtual\_site\_selector](#input\_virtual\_site\_selector) | Virtual Sites | `list` | <pre>[<br>  "ves.io/siteName in (ves-io-ny8-nyc, ves-io-wes-sea)"<br>]</pre> | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_app_url"></a> [app\_url](#output\_app\_url) | Domain VIP to access the vk8s app |
| <a name="output_virtual_site"></a> [virtual\_site](#output\_virtual\_site) | Virtual site for the vk8s |
| <a name="output_vk8s_kubecfg"></a> [vk8s\_kubecfg](#output\_vk8s\_kubecfg) | kubeconfig for vk8s |
| <a name="output_vk8s_kubecfg_client_cert"></a> [vk8s\_kubecfg\_client\_cert](#output\_vk8s\_kubecfg\_client\_cert) | cluster cert value from vk8s kubeconfig |
| <a name="output_vk8s_kubecfg_client_key"></a> [vk8s\_kubecfg\_client\_key](#output\_vk8s\_kubecfg\_client\_key) | client key value from vk8s kubeconfig |
| <a name="output_vk8s_kubecfg_cluster_ca"></a> [vk8s\_kubecfg\_cluster\_ca](#output\_vk8s\_kubecfg\_cluster\_ca) | cluster ca value from vk8s kubeconfig |
| <a name="output_vk8s_kubecfg_host"></a> [vk8s\_kubecfg\_host](#output\_vk8s\_kubecfg\_host) | host value from kubeconfig |
| <a name="output_vk8s_namespace"></a> [vk8s\_namespace](#output\_vk8s\_namespace) | Namespace created for this vk8s |