https://github.com/osinfra-io/terraform-google-storage-bucket
Terraform example module for Google Cloud Platform Storage bucket.
https://github.com/osinfra-io/terraform-google-storage-bucket
google-cloud-platform infrastructure-as-code osinfra terraform terraform-child-module
Last synced: 9 months ago
JSON representation
Terraform example module for Google Cloud Platform Storage bucket.
- Host: GitHub
- URL: https://github.com/osinfra-io/terraform-google-storage-bucket
- Owner: osinfra-io
- License: gpl-2.0
- Created: 2022-10-29T14:38:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T00:38:18.000Z (10 months ago)
- Last Synced: 2025-02-13T01:29:13.058Z (10 months ago)
- Topics: google-cloud-platform, infrastructure-as-code, osinfra, terraform, terraform-child-module
- Language: HCL
- Homepage: https://www.osinfra.io
- Size: 116 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# 
Google Cloud Platform - Storage Bucket Terraform Module
**[GitHub Actions](https://github.com/osinfra-io/terraform-google-storage-bucket/actions):**
[](https://github.com/osinfra-io/terraform-google-storage-bucket/actions/workflows/test.yml) [](https://github.com/osinfra-io/terraform-google-storage-bucket/actions/workflows/dependabot.yml)
**[Infracost](https://www.infracost.io):**
[](https://dashboard.infracost.io/org/osinfra-io/repos/00c5bd62-c59f-44f6-8583-5632a43182fd?tab=settings)
💵 Monthly estimates based on Infracost baseline costs.
## Repository Description
Terraform **example** module for a Google Cloud Platform storage bucket.
> [!NOTE]
> We do not recommend consuming this module like you might a [public module](https://registry.terraform.io/browse/modules). It is a baseline, something you can fork, potentially maintain, and modify to fit your organization's needs. Using public modules vs. writing your own has various [drivers and trade-offs](https://docs.osinfra.io/fundamentals/architecture-decision-records/adr-0003) that your organization should evaluate.
## 🔩 Usage
> [!TIP]
> You can check the [tests/fixtures](tests/fixtures) directory for example configurations. These fixtures set up the system for testing by providing all the necessary initial code, thus creating good examples on which to base your configurations.
## 
Development
Our focus is on the core fundamental practice of platform engineering, Infrastructure as Code.
>Open Source Infrastructure (as Code) is a development model for infrastructure that focuses on open collaboration and applying relative lessons learned from software development practices that organizations can use internally at scale. - [Open Source Infrastructure (as Code)](https://www.osinfra.io)
To avoid slowing down stream-aligned teams, we want to open up the possibility for contributions. The Open Source Infrastructure (as Code) model allows team members external to the platform team to contribute with only a slight increase in cognitive load. This section is for developers who want to contribute to this repository, describing the tools used, the skills, and the knowledge required, along with Terraform documentation.
See the documentation for setting up a local development environment [here](https://docs.osinfra.io/fundamentals/development-setup).
### 🛠️ Tools
- [checkov](https://github.com/bridgecrewio/checkov)
- [infracost](https://github.com/infracost/infracost)
- [pre-commit](https://github.com/pre-commit/pre-commit)
- [pre-commit-terraform](https://github.com/antonbabenko/pre-commit-terraform)
- [terraform-docs](https://github.com/terraform-docs/terraform-docs)
### 📋 Skills and Knowledge
Links to documentation and other resources required to develop and iterate in this repository successfully.
- [storage bucket](https://cloud.google.com/storage/docs/buckets)
### 🔍 Tests
All tests are [mocked](https://developer.hashicorp.com/terraform/language/tests/mocking) allowing us to test the module without creating infrastructure or requiring credentials. The trade-offs are acceptable in favor of speed and simplicity. In a Terraform test, a mocked provider or resource will generate fake data for all computed attributes that would normally be provided by the underlying provider APIs.
```none
cd fixtures/default
```
```none
terraform init
```
```none
terraform test
```
## 📓 Terraform Documentation
> A child module automatically inherits default (un-aliased) provider configurations from its parent. The provider versions below are informational only and do **not** need to align with the provider configurations from its parent.
### Requirements
No requirements.
### Providers
| Name | Version |
|------|---------|
| [google](#provider\_google) | 6.20.0 |
### Modules
No modules.
### Resources
| Name | Type |
|------|------|
| [google_storage_bucket.this](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket) | resource |
### Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [default\_kms\_key\_name](#input\_default\_kms\_key\_name) | The name of the Cloud KMS key that will be used to encrypt objects inserted into this bucket | `string` | `null` | no |
| [force\_destroy](#input\_force\_destroy) | When deleting a bucket, this boolean option will delete all contained objects | `bool` | `false` | no |
| [labels](#input\_labels) | A map of key/value pairs to assign to the resources being created | `map(string)` | `{}` | no |
| [location](#input\_location) | The location the storage bucket will be created in | `string` | n/a | yes |
| [name](#input\_name) | The name of the storage bucket | `any` | n/a | yes |
| [project](#input\_project) | The ID of the project in which the resource belongs | `string` | n/a | yes |
| [public\_access\_prevention](#input\_public\_access\_prevention) | The public access prevention configuration for the bucket | `string` | `"enforced"` | no |
| [storage\_class](#input\_storage\_class) | The Storage Class of the new bucket. Supported values include: STANDARD, MULTI\_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE | `string` | `"STANDARD"` | no |
| [versioning](#input\_versioning) | The bucket's Versioning configuration | `bool` | `true` | no |
### Outputs
| Name | Description |
|------|-------------|
| [name](#output\_name) | Bucket name |
| [url](#output\_url) | Bucket URL |