cloud-foundation-fabric/modules/datafusion/README.md

69 lines
3.5 KiB
Markdown
Raw Normal View History

# Google Cloud Data Fusion Module
This module allows simple management of ['Google Data Fusion'](https://cloud.google.com/data-fusion) instances. It supports creating Basic or Enterprise, public or private instances.
## Examples
## Auto-managed IP allocation
```hcl
module "datafusion" {
2022-12-16 03:53:56 -08:00
source = "./fabric/modules/datafusion"
name = "my-datafusion"
region = "europe-west1"
project_id = "my-project"
network = "my-network-name"
# TODO: remove the following line
firewall_create = false
}
# tftest modules=1 resources=3
```
### Externally managed IP allocation
```hcl
module "datafusion" {
source = "./fabric/modules/datafusion"
name = "my-datafusion"
region = "europe-west1"
project_id = "my-project"
network = "my-network-name"
ip_allocation_create = false
ip_allocation = "10.0.0.0/22"
}
# tftest modules=1 resources=3
```
<!-- BEGIN TFDOC -->
## Variables
| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
2022-01-22 04:34:35 -08:00
| [name](variables.tf#L63) | Name of the DataFusion instance. | <code>string</code> | ✓ | |
| [network](variables.tf#L68) | Name of the network in the project with which the tenant project will be peered for executing pipelines in the form of projects/{project-id}/global/networks/{network}. | <code>string</code> | ✓ | |
2022-01-22 04:34:35 -08:00
| [project_id](variables.tf#L85) | Project ID. | <code>string</code> | ✓ | |
| [region](variables.tf#L90) | DataFusion region. | <code>string</code> | ✓ | |
| [description](variables.tf#L21) | DataFuzion instance description. | <code>string</code> | | <code>&#34;Terraform managed.&#34;</code> |
| [enable_stackdriver_logging](variables.tf#L27) | Option to enable Stackdriver Logging. | <code>bool</code> | | <code>false</code> |
| [enable_stackdriver_monitoring](variables.tf#L33) | Option to enable Stackdriver Monitorig. | <code>bool</code> | | <code>false</code> |
| [firewall_create](variables.tf#L39) | Create Network firewall rules to enable SSH. | <code>bool</code> | | <code>true</code> |
| [ip_allocation](variables.tf#L45) | Ip allocated for datafusion instance when not using the auto created one and created outside of the module. | <code>string</code> | | <code>null</code> |
| [ip_allocation_create](variables.tf#L51) | Create Ip range for datafusion instance. | <code>bool</code> | | <code>true</code> |
| [labels](variables.tf#L57) | The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs. | <code>map&#40;string&#41;</code> | | <code>&#123;&#125;</code> |
| [network_peering](variables.tf#L73) | Create Network peering between project and DataFusion tenant project. | <code>bool</code> | | <code>true</code> |
| [private_instance](variables.tf#L79) | Create private instance. | <code>bool</code> | | <code>true</code> |
| [type](variables.tf#L95) | Datafusion Instance type. It can be BASIC or ENTERPRISE (default value). | <code>string</code> | | <code>&#34;ENTERPRISE&#34;</code> |
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [id](outputs.tf#L17) | Fully qualified instance id. | |
2022-01-22 04:34:35 -08:00
| [ip_allocation](outputs.tf#L22) | IP range reserved for Data Fusion instance in case of a private instance. | |
| [resource](outputs.tf#L27) | DataFusion resource. | |
| [service_account](outputs.tf#L32) | DataFusion Service Account. | |
| [service_endpoint](outputs.tf#L37) | DataFusion Service Endpoint. | |
| [version](outputs.tf#L42) | DataFusion version. | |
<!-- END TFDOC -->