Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googlecloudplatform/terraform-google-analytics-lakehouse

Deploys a Lakehouse Architecture Solution
https://github.com/googlecloudplatform/terraform-google-analytics-lakehouse

cft-terraform data-analytics

Last synced: 15 days ago
JSON representation

Deploys a Lakehouse Architecture Solution

Awesome Lists containing this project

README

        

# terraform-google-lakehouse

## Description
### tagline
This is an auto-generated module.

### detailed
This module was generated from [terraform-google-module-template](https://github.com/terraform-google-modules/terraform-google-module-template/), which by default generates a module that simply creates a GCS bucket. As the module develops, this README should be updated.

The resources/services/activations/deletions that this module will create/trigger are:

- Create a GCS bucket with the provided name

### preDeploy
To deploy this blueprint you must have an active billing account and billing permissions.

## Documentation
- [Create an Analytics Lakehouse](https://cloud.google.com/architecture/big-data-analytics/analytics-lakehouse)

## Usage

Basic usage of this module is as follows:

```hcl
module "analytics_lakehouse" {
source = "../.."

project_id = var.project_id
region = "us-central1"
force_destroy = true

}
```

Functional examples are included in the
[examples](./examples/) directory.

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| enable\_apis | Whether or not to enable underlying apis in this solution. . | `string` | `true` | no |
| force\_destroy | Whether or not to protect GCS resources from deletion when solution is modified or changed. | `string` | `false` | no |
| labels | A map of labels to apply to contained resources. | `map(string)` |

{
"analytics-lakehouse": true
}
| no |
| project\_id | Google Cloud Project ID | `string` | n/a | yes |
| public\_data\_bucket | Public Data bucket for access | `string` | `"data-analytics-demos"` | no |
| region | Google Cloud Region | `string` | `"us-central1"` | no |
| use\_case\_short | Short name for use case | `string` | `"lakehouse"` | no |

## Outputs

| Name | Description |
|------|-------------|
| bigquery\_editor\_url | The URL to launch the BigQuery editor |
| lakehouse\_colab\_url | The URL to launch the in-console tutorial for the Analytics Lakehouse solution |
| lookerstudio\_report\_url | The URL to create a new Looker Studio report displays a sample dashboard for data analysis |
| neos\_tutorial\_url | The URL to launch the in-console tutorial for the Analytics Lakehouse solution |
| workflow\_return\_project\_setup | Output of the project setup workflow |

## Requirements

These sections describe requirements for using this module.

### Software

The following dependencies must be available:

- [Terraform][terraform] >= v0.13
- [Terraform Provider for GCP][terraform-provider-gcp] plugin ~> v4.56

### Service Account

A service account with the following roles must be used to provision
the resources of this module:

- Storage Admin: `roles/storage.admin`

The [Project Factory module][project-factory-module] and the
[IAM module][iam-module] may be used in combination to provision a
service account with the necessary roles applied.

### APIs

A project with the following APIs enabled must be used to host the
resources of this module:

- Google Cloud Storage JSON API: `storage-api.googleapis.com`

The [Project Factory module][project-factory-module] can be used to
provision a project with the necessary APIs enabled.

## Contributing

Refer to the [contribution guidelines](./CONTRIBUTING.md) for
information on contributing to this module.

[iam-module]: https://registry.terraform.io/modules/terraform-google-modules/iam/google
[project-factory-module]: https://registry.terraform.io/modules/terraform-google-modules/project-factory/google
[terraform-provider-gcp]: https://www.terraform.io/docs/providers/google/index.html
[terraform]: https://www.terraform.io/downloads.html

## Security Disclosures

Please see our [security disclosure process](./SECURITY.md).