f1acc92864
* Add views and tags to logging bucket * Add logs scopes to project * Add missing inventory
130 lines
6.3 KiB
Markdown
130 lines
6.3 KiB
Markdown
# Google Cloud Logging Buckets Module
|
|
|
|
This module manages [logging buckets](https://cloud.google.com/logging/docs/routing/overview#buckets) for a project, folder, organization or billing account.
|
|
|
|
Note that some logging buckets are automatically created for a given folder, project, organization, and billing account cannot be deleted. Creating a resource of this type will acquire and update the resource that already exists at the desired location. These buckets cannot be removed so deleting this resource will remove the bucket config from your terraform state but will leave the logging bucket unchanged. The buckets that are currently automatically created are "_Default" and "_Required".
|
|
|
|
See also the `logging_sinks` argument within the [project](../project/), [folder](../folder/) and [organization](../organization) modules.
|
|
|
|
## TOC
|
|
|
|
<!-- BEGIN TOC -->
|
|
- [TOC](#toc)
|
|
- [Custom logging bucket in a project](#custom-logging-bucket-in-a-project)
|
|
- [Custom logging bucket in a project with Log Analytics](#custom-logging-bucket-in-a-project-with-log-analytics)
|
|
- [Change retention period of a folder's _Default bucket](#change-retention-period-of-a-folders-_default-bucket)
|
|
- [Organization and billing account buckets](#organization-and-billing-account-buckets)
|
|
- [Custom bucket with views](#custom-bucket-with-views)
|
|
- [Variables](#variables)
|
|
- [Outputs](#outputs)
|
|
<!-- END TOC -->
|
|
|
|
## Custom logging bucket in a project
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./fabric/modules/logging-bucket"
|
|
parent_type = "project"
|
|
parent = var.project_id
|
|
id = "mybucket"
|
|
}
|
|
# tftest modules=1 resources=1 inventory=project.yaml
|
|
```
|
|
|
|
## Custom logging bucket in a project with Log Analytics
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./fabric/modules/logging-bucket"
|
|
parent_type = "project"
|
|
parent = var.project_id
|
|
id = "mybucket"
|
|
log_analytics = {
|
|
enable = true
|
|
dataset_link_id = "log"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2 inventory=log_analytics.yaml
|
|
```
|
|
|
|
## Change retention period of a folder's _Default bucket
|
|
|
|
```hcl
|
|
module "folder" {
|
|
source = "./fabric/modules/folder"
|
|
parent = "folders/657104291943"
|
|
name = "my folder"
|
|
}
|
|
|
|
module "bucket-default" {
|
|
source = "./fabric/modules/logging-bucket"
|
|
parent_type = "folder"
|
|
parent = module.folder.id
|
|
id = "_Default"
|
|
retention = 10
|
|
}
|
|
# tftest modules=2 resources=2 inventory=retention.yaml
|
|
```
|
|
|
|
## Organization and billing account buckets
|
|
|
|
```hcl
|
|
module "bucket-organization" {
|
|
source = "./fabric/modules/logging-bucket"
|
|
parent_type = "organization"
|
|
parent = "organizations/012345"
|
|
id = "mybucket"
|
|
}
|
|
|
|
module "bucket-billing-account" {
|
|
source = "./fabric/modules/logging-bucket"
|
|
parent_type = "billing_account"
|
|
parent = "012345"
|
|
id = "mybucket"
|
|
}
|
|
# tftest modules=2 resources=2 inventory=org-ba.yaml
|
|
```
|
|
|
|
## Custom bucket with views
|
|
|
|
```hcl
|
|
module "bucket" {
|
|
source = "./fabric/modules/logging-bucket"
|
|
parent_type = "project"
|
|
parent = var.project_id
|
|
id = "mybucket"
|
|
views = {
|
|
myview = {
|
|
filter = "LOG_ID(\"stdout\")"
|
|
iam = {
|
|
"roles/logging.viewAccessor" = ["user:user@example.com"]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3 inventory=views.yaml
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [id](variables.tf#L23) | Name of the logging bucket. | <code>string</code> | ✓ | |
|
|
| [parent](variables.tf#L51) | ID of the parentresource containing the bucket in the format 'project_id' 'folders/folder_id', 'organizations/organization_id' or 'billing_account_id'. | <code>string</code> | ✓ | |
|
|
| [parent_type](variables.tf#L56) | Parent object type for the bucket (project, folder, organization, billing_account). | <code>string</code> | ✓ | |
|
|
| [description](variables.tf#L17) | Human-readable description for the logging bucket. | <code>string</code> | | <code>null</code> |
|
|
| [kms_key_name](variables.tf#L28) | To enable CMEK for a project logging bucket, set this field to a valid name. The associated service account requires cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. | <code>string</code> | | <code>null</code> |
|
|
| [location](variables.tf#L34) | Location of the bucket. | <code>string</code> | | <code>"global"</code> |
|
|
| [log_analytics](variables.tf#L40) | Enable and configure Analytics Log. | <code title="object({ enable = optional(bool, false) dataset_link_id = optional(string) description = optional(string, "Log Analytics Dataset") })">object({…})</code> | | <code>{}</code> |
|
|
| [retention](variables.tf#L61) | Retention time in days for the logging bucket. | <code>number</code> | | <code>30</code> |
|
|
| [tag_bindings](variables.tf#L67) | Tag bindings for this bucket, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
|
| [views](variables.tf#L74) | Log views for this bucket. | <code title="map(object({ filter = string location = optional(string) description = optional(string) iam = optional(map(list(string)), {}) iam_bindings = optional(map(object({ members = list(string) condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) iam_bindings_additive = optional(map(object({ member = string role = string condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [id](outputs.tf#L17) | Fully qualified logging bucket id. | |
|
|
| [view_ids](outputs.tf#L22) | The automatic and user-created views in this bucket. | |
|
|
<!-- END TFDOC -->
|