Skip to content

Commit c176bcc

Browse files
Felix Ziegermeshkodiak[bot]
authored andcommitted
docs: new variables
1 parent 35ab65b commit c176bcc

File tree

6 files changed

+17
-16
lines changed

6 files changed

+17
-16
lines changed

TERRAFORM_DOCS.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,21 @@ No resources.
2424
| Name | Description | Type | Default | Required |
2525
|------|-------------|------|---------|:--------:|
2626
| <a name="input_billing_account_id"></a> [billing\_account\_id](#input\_billing\_account\_id) | The GCP billing account in your organization. | `string` | n/a | yes |
27-
| <a name="input_billing_dataset_project_id"></a> [billing\_dataset\_project\_id](#input\_billing\_dataset\_project\_id) | GCP Project ID where the biquery table resides that holds billing data export. | `string` | n/a | yes |
28-
| <a name="input_billing_org_id"></a> [billing\_org\_id](#input\_billing\_org\_id) | GCP organization ID that holds billing account | `string` | n/a | yes |
29-
| <a name="input_kraken_sa_name"></a> [kraken\_sa\_name](#input\_kraken\_sa\_name) | Name of the service account to create for Kraken | `string` | `"mesh-kraken-service-tf"` | no |
27+
| <a name="input_billing_org_id"></a> [billing\_org\_id](#input\_billing\_org\_id) | GCP organization ID that holds billing account. | `string` | n/a | yes |
28+
| <a name="input_cloud_billing_export_dataset_id"></a> [cloud\_billing\_export\_dataset\_id](#input\_cloud\_billing\_export\_dataset\_id) | GCP BigQuery dataset containing the Cloud Billing BigQuery export. | `string` | n/a | yes |
29+
| <a name="input_cloud_billing_export_project_id"></a> [cloud\_billing\_export\_project\_id](#input\_cloud\_billing\_export\_project\_id) | GCP Project where the BiqQery table resides that holds the Cloud Billing export to BigQuery. See https://cloud.google.com/billing/docs/how-to/export-data-bigquery | `string` | n/a | yes |
30+
| <a name="input_cloud_billing_export_table_id"></a> [cloud\_billing\_export\_table\_id](#input\_cloud\_billing\_export\_table\_id) | GCP BigQuery table containing the Cloud Billing BigQuery export. | `string` | n/a | yes |
31+
| <a name="input_kraken_sa_name"></a> [kraken\_sa\_name](#input\_kraken\_sa\_name) | Name of the service account to create for Kraken. | `string` | `"mesh-kraken-service-tf"` | no |
3032
| <a name="input_landing_zone_folder_ids"></a> [landing\_zone\_folder\_ids](#input\_landing\_zone\_folder\_ids) | GCP Folders that make up the Landing Zone. The service account will only receive permissions on these folders. | `list(string)` | n/a | yes |
3133
| <a name="input_org_id"></a> [org\_id](#input\_org\_id) | GCP Organization ID that holds the projects that generate billing data that the service account should import. | `string` | n/a | yes |
32-
| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | GCP Project ID where to create the resources. This is typically a 'meshstack-root' project | `string` | n/a | yes |
33-
| <a name="input_replicator_sa_name"></a> [replicator\_sa\_name](#input\_replicator\_sa\_name) | Name of the service account to create for Replicator | `string` | `"mesh-replicator-service-tf"` | no |
34+
| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | GCP Project ID where to create the resources. This is typically a 'meshstack-root' project. | `string` | n/a | yes |
35+
| <a name="input_replicator_sa_name"></a> [replicator\_sa\_name](#input\_replicator\_sa\_name) | Name of the service account to create for Replicator. | `string` | `"mesh-replicator-service-tf"` | no |
3436

3537
## Outputs
3638

3739
| Name | Description |
3840
|------|-------------|
41+
| <a name="output_cloud_billing_export_table_name"></a> [cloud\_billing\_export\_table\_name](#output\_cloud\_billing\_export\_table\_name) | The BigQuery table name containing the GCP Cloud Billing BigQuery export. |
3942
| <a name="output_kraken_sa_email"></a> [kraken\_sa\_email](#output\_kraken\_sa\_email) | Kraken service account email. |
4043
| <a name="output_kraken_sa_key"></a> [kraken\_sa\_key](#output\_kraken\_sa\_key) | Kraken service account key. |
4144
| <a name="output_replicator_manual_setup"></a> [replicator\_manual\_setup](#output\_replicator\_manual\_setup) | Replicator service account setup information. |

modules/meshcloud-kraken-service-account/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ No modules.
3030

3131
| Name | Description | Type | Default | Required |
3232
|------|-------------|------|---------|:--------:|
33-
| <a name="input_billing_dataset_project_id"></a> [billing\_dataset\_project\_id](#input\_billing\_dataset\_project\_id) | GCP Project ID where the biquery table resides that holds billing data export. | `string` | n/a | yes |
33+
| <a name="input_cloud_billing_export_project_id"></a> [cloud\_billing\_export\_project\_id](#input\_cloud\_billing\_export\_project\_id) | GCP Project where the BiqQery table resides that holds the Cloud Billing export to BigQuery. | `string` | n/a | yes |
3434
| <a name="input_landing_zone_folder_ids"></a> [landing\_zone\_folder\_ids](#input\_landing\_zone\_folder\_ids) | GCP Folders that make up the Landing Zone. The service account will only receive permissions on these folders. | `set(string)` | n/a | yes |
3535
| <a name="input_meshstack_root_project_id"></a> [meshstack\_root\_project\_id](#input\_meshstack\_root\_project\_id) | GCP Project ID where to create the service account. This is typically a 'meshstack-root' project. | `string` | n/a | yes |
3636
| <a name="input_org_id"></a> [org\_id](#input\_org\_id) | GCP Organization ID that holds the projects that generate billing data that the service account should import. | `string` | n/a | yes |
37-
| <a name="input_sa_name"></a> [sa\_name](#input\_sa\_name) | name of the service account to create | `string` | n/a | yes |
37+
| <a name="input_sa_name"></a> [sa\_name](#input\_sa\_name) | Name of the service account to create. | `string` | n/a | yes |
3838

3939
## Outputs
4040

modules/meshcloud-kraken-service-account/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
variable "sa_name" {
22
type = string
3-
description = "name of the service account to create"
3+
description = "Name of the service account to create."
44
}
55

66
variable "org_id" {

modules/meshcloud-replicator-service-account/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ No modules.
2424
| [google_organization_iam_custom_role.replicator_service](https://registry.terraform.io/providers/hashicorp/google/4.11.0/docs/resources/organization_iam_custom_role) | resource |
2525
| [google_project_service.admin_api](https://registry.terraform.io/providers/hashicorp/google/4.11.0/docs/resources/project_service) | resource |
2626
| [google_project_service.cloudbilling_api](https://registry.terraform.io/providers/hashicorp/google/4.11.0/docs/resources/project_service) | resource |
27+
| [google_project_service.cloudresourcemanager_api](https://registry.terraform.io/providers/hashicorp/google/4.11.0/docs/resources/project_service) | resource |
2728
| [google_service_account.replicator_service](https://registry.terraform.io/providers/hashicorp/google/4.11.0/docs/resources/service_account) | resource |
2829
| [google_service_account_key.sa_key](https://registry.terraform.io/providers/hashicorp/google/4.11.0/docs/resources/service_account_key) | resource |
2930

modules/meshcloud-replicator-service-account/outputs.tf

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ output "sa_email" {
1414
description = "Service account email."
1515
}
1616

17-
# further manual setup is required because currently there is no way to figure out the role id and do GSuite
18-
# calls needed with Terraform. See this ticket in a custom TF module:
19-
# https://github.com/DeviaVir/terraform-provider-gsuite/issues/147
2017
output "replicator_manual_setup" {
2118
value = <<EOF
2219
Attention. The created service account ${google_service_account.replicator_service.email} with the unique id '${google_service_account.replicator_service.unique_id}' needs a manual role assignment for the G Suite role 'Group Administrator' so necessary group operations can be performed domain-wide.

variables.tf

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
variable "project_id" {
22
type = string
3-
description = "GCP Project ID where to create the resources. This is typically a 'meshstack-root' project"
3+
description = "GCP Project ID where to create the resources. This is typically a 'meshstack-root' project."
44
}
55

66
variable "org_id" {
@@ -10,7 +10,7 @@ variable "org_id" {
1010

1111
variable "billing_org_id" {
1212
type = string
13-
description = "GCP organization ID that holds billing account"
13+
description = "GCP organization ID that holds billing account."
1414
}
1515

1616
variable "billing_account_id" {
@@ -45,12 +45,12 @@ variable "cloud_billing_export_table_id" {
4545

4646
variable "replicator_sa_name" {
4747
type = string
48-
description = "Name of the service account to create for Replicator"
48+
description = "Name of the service account to create for Replicator."
4949
default = "mesh-replicator-service-tf"
5050
}
5151

5252
variable "kraken_sa_name" {
5353
type = string
54-
description = "Name of the service account to create for Kraken"
54+
description = "Name of the service account to create for Kraken."
5555
default = "mesh-kraken-service-tf"
56-
}
56+
}

0 commit comments

Comments
 (0)