|
| 1 | +# GCP Service Prinicpal Module |
| 2 | + |
| 3 | +This module will deploy a Service Principal (GCP Service Account) for a single GCP project, or for a GCP Organization. |
| 4 | + |
| 5 | +The following resources will be created in each instrumented project: |
| 6 | +- A Service Account with associated role permissions to grant Sysdig read only permissions to secure your GCP Project. |
| 7 | + - A Service Account Key attached to this service account using its name. |
| 8 | + |
| 9 | +If instrumenting a GCP Organization, the service account will be created in the Management Account (provided via the project ID), with appropriate organizational level permissions. |
| 10 | + |
| 11 | +<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 12 | +## Requirements |
| 13 | + |
| 14 | +| Name | Version | |
| 15 | +|------|---------| |
| 16 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 | |
| 17 | +| <a name="requirement_google"></a> [google](#requirement\_google) | >= 4.21.0 | |
| 18 | + |
| 19 | +## Providers |
| 20 | + |
| 21 | +| Name | Version | |
| 22 | +|------|---------| |
| 23 | +| <a name="provider_google"></a> [google](#provider\_google) | >= 4.21.0 | |
| 24 | + |
| 25 | +## Modules |
| 26 | + |
| 27 | +No modules. |
| 28 | + |
| 29 | +## Resources |
| 30 | + |
| 31 | +| Name | Type | |
| 32 | +|------|------| |
| 33 | +| [google_service_account.sa](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_service_account) | resource | |
| 34 | +| [google_service_account_key.secure_service_account_key](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_service_account_key) | resource | |
| 35 | +| [google_project_iam_member.browser](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_project_iam#google_project_iam_member) | resource | |
| 36 | +| [google_project_iam_member.cloudasset_viewer](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_project_iam#google_project_iam_member) | resource | |
| 37 | +| [google_project_iam_member.identity_mgmt](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_project_iam#google_project_iam_member) | resource | |
| 38 | +| [google_organization.org](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/organization) | data source | |
| 39 | +| [google_organization_iam_member.browser](https://registry.terraform.io/providers/hashicorp/google/5.0.0/docs/resources/google_organization_iam#google_organization_iam_member) | resource | |
| 40 | +| [google_organization_iam_member.cloudasset_viewer](https://registry.terraform.io/providers/hashicorp/google/5.0.0/docs/resources/google_organization_iam#google_organization_iam_member) | resource | |
| 41 | +| [google_organization_iam_member.identity_mgmt](https://registry.terraform.io/providers/hashicorp/google/5.0.0/docs/resources/google_organization_iam#google_organization_iam_member) | resource | |
| 42 | + |
| 43 | +## Inputs |
| 44 | + |
| 45 | +| Name | Description | Type | Default | Required | |
| 46 | +|------|-------------|------|---------|:--------:| |
| 47 | +| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | The identifier of the GCP project. A service principal will be created in it, to allow Sysdig usage | `string` | n/a | yes | |
| 48 | +| <a name="input_service_account_name"></a> [service\_account\_name](#input\_service\_account\_name) | The name of the service principal to be created | `string` | `sysdig-secure` | no | |
| 49 | +| <a name="input_is_organizational"></a> [is\_organizational](#input\_is\_organizational) | true/false whether secure-for-cloud should be deployed in an organizational setup (all projects of org) or not (only on default gcp provider project) | `bool` | `false` | no | |
| 50 | +| <a name="input_organization_domain"></a> [organization\_domain](#input\_organization\_domain) | GCP Organization domain unit id to install posture management | `string` | `""` | no | |
| 51 | + |
| 52 | +## Outputs |
| 53 | + |
| 54 | +| Name | Description | |
| 55 | +|------|-------------| |
| 56 | +| <a name="output_service_account_email"></a> [service\_account\_email](#output\_service\_account\_email) | Email address of the Service Principal created for Secure Posture Management | |
| 57 | +| <a name="output_service_account_key"></a> [service\_account\_key](#output\_service\_account\_key) | Private Key of the Service Principal created for Secure Posture Management | |
| 58 | +<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 59 | + |
| 60 | +## Authors |
| 61 | + |
| 62 | +Module is maintained by [Sysdig](https://sysdig.com). |
| 63 | + |
| 64 | +## License |
| 65 | + |
| 66 | +Apache 2 Licensed. See LICENSE for full details. |
0 commit comments