mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-10-03 01:01:06 +00:00
Merge pull request #1387 from terraform-providers/paddy_spanner_instance_iam
Add support for IAM on Spanner Instances.
This commit is contained in:
commit
afcd482297
112
google/iam_spanner_instance.go
Normal file
112
google/iam_spanner_instance.go
Normal file
@ -0,0 +1,112 @@
|
||||
package google
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/hashicorp/errwrap"
|
||||
"github.com/hashicorp/terraform/helper/schema"
|
||||
"google.golang.org/api/cloudresourcemanager/v1"
|
||||
spanner "google.golang.org/api/spanner/v1"
|
||||
)
|
||||
|
||||
var IamSpannerInstanceSchema = map[string]*schema.Schema{
|
||||
"instance": {
|
||||
Type: schema.TypeString,
|
||||
Required: true,
|
||||
ForceNew: true,
|
||||
},
|
||||
|
||||
"project": {
|
||||
Type: schema.TypeString,
|
||||
Optional: true,
|
||||
Computed: true,
|
||||
ForceNew: true,
|
||||
},
|
||||
}
|
||||
|
||||
type SpannerInstanceIamUpdater struct {
|
||||
project string
|
||||
instance string
|
||||
Config *Config
|
||||
}
|
||||
|
||||
func NewSpannerInstanceIamUpdater(d *schema.ResourceData, config *Config) (ResourceIamUpdater, error) {
|
||||
project, err := getProject(d, config)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &SpannerInstanceIamUpdater{
|
||||
project: project,
|
||||
instance: d.Get("instance").(string),
|
||||
Config: config,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func SpannerInstanceIdParseFunc(d *schema.ResourceData, config *Config) error {
|
||||
id, err := extractSpannerInstanceId(d.Id())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
d.Set("instance", id.Instance)
|
||||
d.Set("project", id.Project)
|
||||
|
||||
// Explicitly set the id so imported resources have the same ID format as non-imported ones.
|
||||
d.SetId(id.terraformId())
|
||||
return nil
|
||||
}
|
||||
|
||||
func (u *SpannerInstanceIamUpdater) GetResourceIamPolicy() (*cloudresourcemanager.Policy, error) {
|
||||
p, err := u.Config.clientSpanner.Projects.Instances.GetIamPolicy(spannerInstanceId{
|
||||
Project: u.project,
|
||||
Instance: u.instance,
|
||||
}.instanceUri(), &spanner.GetIamPolicyRequest{}).Do()
|
||||
|
||||
if err != nil {
|
||||
return nil, errwrap.Wrapf(fmt.Sprintf("Error retrieving IAM policy for %s: {{err}}", u.DescribeResource()), err)
|
||||
}
|
||||
|
||||
cloudResourcePolicy, err := spannerToResourceManagerPolicy(p)
|
||||
|
||||
if err != nil {
|
||||
return nil, errwrap.Wrapf(fmt.Sprintf("Invalid IAM policy for %s: {{err}}", u.DescribeResource()), err)
|
||||
}
|
||||
|
||||
return cloudResourcePolicy, nil
|
||||
}
|
||||
|
||||
func (u *SpannerInstanceIamUpdater) SetResourceIamPolicy(policy *cloudresourcemanager.Policy) error {
|
||||
spannerPolicy, err := resourceManagerToSpannerPolicy(policy)
|
||||
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(fmt.Sprintf("Invalid IAM policy for %s: {{err}}", u.DescribeResource()), err)
|
||||
}
|
||||
|
||||
_, err = u.Config.clientSpanner.Projects.Instances.SetIamPolicy(spannerInstanceId{
|
||||
Project: u.project,
|
||||
Instance: u.instance,
|
||||
}.instanceUri(), &spanner.SetIamPolicyRequest{
|
||||
Policy: spannerPolicy,
|
||||
}).Do()
|
||||
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(fmt.Sprintf("Error setting IAM policy for %s: {{err}}", u.DescribeResource()), err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (u *SpannerInstanceIamUpdater) GetResourceId() string {
|
||||
return spannerInstanceId{
|
||||
Project: u.project,
|
||||
Instance: u.instance,
|
||||
}.terraformId()
|
||||
}
|
||||
|
||||
func (u *SpannerInstanceIamUpdater) GetMutexKey() string {
|
||||
return fmt.Sprintf("iam-spanner-instance-%s-%s", u.project, u.instance)
|
||||
}
|
||||
|
||||
func (u *SpannerInstanceIamUpdater) DescribeResource() string {
|
||||
return fmt.Sprintf("Spanner Instance: %s/%s", u.project, u.instance)
|
||||
}
|
@ -168,6 +168,9 @@ func Provider() terraform.ResourceProvider {
|
||||
"google_kms_crypto_key_iam_member": ResourceIamMemberWithImport(IamKmsCryptoKeySchema, NewKmsCryptoKeyIamUpdater, CryptoIdParseFunc),
|
||||
"google_sourcerepo_repository": resourceSourceRepoRepository(),
|
||||
"google_spanner_instance": resourceSpannerInstance(),
|
||||
"google_spanner_instance_iam_binding": ResourceIamBindingWithImport(IamSpannerInstanceSchema, NewSpannerInstanceIamUpdater, SpannerInstanceIdParseFunc),
|
||||
"google_spanner_instance_iam_member": ResourceIamMemberWithImport(IamSpannerInstanceSchema, NewSpannerInstanceIamUpdater, SpannerInstanceIdParseFunc),
|
||||
"google_spanner_instance_iam_policy": ResourceIamPolicyWithImport(IamSpannerInstanceSchema, NewSpannerInstanceIamUpdater, SpannerInstanceIdParseFunc),
|
||||
"google_spanner_database": resourceSpannerDatabase(),
|
||||
"google_spanner_database_iam_binding": ResourceIamBindingWithImport(IamSpannerDatabaseSchema, NewSpannerDatabaseIamUpdater, SpannerDatabaseIdParseFunc),
|
||||
"google_spanner_database_iam_member": ResourceIamMemberWithImport(IamSpannerDatabaseSchema, NewSpannerDatabaseIamUpdater, SpannerDatabaseIdParseFunc),
|
||||
|
215
google/resource_spanner_instance_iam_test.go
Normal file
215
google/resource_spanner_instance_iam_test.go
Normal file
@ -0,0 +1,215 @@
|
||||
package google
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/hashicorp/terraform/helper/acctest"
|
||||
"github.com/hashicorp/terraform/helper/resource"
|
||||
)
|
||||
|
||||
func TestAccSpannerInstanceIamBinding(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
account := acctest.RandomWithPrefix("tf-test")
|
||||
role := "roles/spanner.databaseAdmin"
|
||||
project := getTestProjectFromEnv()
|
||||
instance := fmt.Sprintf("tf-test-%s", acctest.RandString(10))
|
||||
|
||||
resource.Test(t, resource.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Providers: testAccProviders,
|
||||
Steps: []resource.TestStep{
|
||||
{
|
||||
Config: testAccSpannerInstanceIamBinding_basic(account, instance, role),
|
||||
},
|
||||
resource.TestStep{
|
||||
ResourceName: "google_spanner_instance_iam_binding.foo",
|
||||
ImportStateId: fmt.Sprintf("%s %s", spannerInstanceId{
|
||||
Project: project,
|
||||
Instance: instance,
|
||||
}.terraformId(), role),
|
||||
ImportState: true,
|
||||
ImportStateVerify: true,
|
||||
},
|
||||
{
|
||||
// Test Iam Binding update
|
||||
Config: testAccSpannerInstanceIamBinding_update(account, instance, role),
|
||||
},
|
||||
resource.TestStep{
|
||||
ResourceName: "google_spanner_instance_iam_binding.foo",
|
||||
ImportStateId: fmt.Sprintf("%s %s", spannerInstanceId{
|
||||
Project: project,
|
||||
Instance: instance,
|
||||
}.terraformId(), role),
|
||||
ImportState: true,
|
||||
ImportStateVerify: true,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func TestAccSpannerInstanceIamMember(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
project := getTestProjectFromEnv()
|
||||
account := acctest.RandomWithPrefix("tf-test")
|
||||
role := "roles/spanner.databaseAdmin"
|
||||
instance := fmt.Sprintf("tf-test-%s", acctest.RandString(10))
|
||||
|
||||
resource.Test(t, resource.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Providers: testAccProviders,
|
||||
Steps: []resource.TestStep{
|
||||
{
|
||||
// Test Iam Member creation (no update for member, no need to test)
|
||||
Config: testAccSpannerInstanceIamMember_basic(account, instance, role),
|
||||
},
|
||||
resource.TestStep{
|
||||
ResourceName: "google_spanner_instance_iam_member.foo",
|
||||
ImportStateId: fmt.Sprintf("%s %s serviceAccount:%s@%s.iam.gserviceaccount.com", spannerInstanceId{
|
||||
Instance: instance,
|
||||
Project: project,
|
||||
}.terraformId(), role, account, project),
|
||||
ImportState: true,
|
||||
ImportStateVerify: true,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func TestAccSpannerInstanceIamPolicy(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
project := getTestProjectFromEnv()
|
||||
account := acctest.RandomWithPrefix("tf-test")
|
||||
role := "roles/spanner.databaseAdmin"
|
||||
instance := fmt.Sprintf("tf-test-%s", acctest.RandString(10))
|
||||
|
||||
resource.Test(t, resource.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Providers: testAccProviders,
|
||||
Steps: []resource.TestStep{
|
||||
{
|
||||
Config: testAccSpannerInstanceIamPolicy_basic(account, instance, role),
|
||||
},
|
||||
// Test a few import formats
|
||||
resource.TestStep{
|
||||
ResourceName: "google_spanner_instance_iam_policy.foo",
|
||||
ImportStateId: fmt.Sprintf("%s", spannerInstanceId{
|
||||
Instance: instance,
|
||||
Project: project,
|
||||
}.terraformId()),
|
||||
ImportState: true,
|
||||
ImportStateVerify: true,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func testAccSpannerInstanceIamBinding_basic(account, instance, roleId string) string {
|
||||
return fmt.Sprintf(`
|
||||
resource "google_service_account" "test_account" {
|
||||
account_id = "%s"
|
||||
display_name = "Spanner Iam Testing Account"
|
||||
}
|
||||
|
||||
resource "google_spanner_instance" "instance" {
|
||||
name = "%s"
|
||||
config = "regional-us-central1"
|
||||
display_name = "%s"
|
||||
num_nodes = 1
|
||||
}
|
||||
|
||||
resource "google_spanner_instance_iam_binding" "foo" {
|
||||
project = "${google_spanner_instance.instance.project}"
|
||||
instance = "${google_spanner_instance.instance.name}"
|
||||
role = "%s"
|
||||
members = ["serviceAccount:${google_service_account.test_account.email}"]
|
||||
}
|
||||
`, account, instance, instance, roleId)
|
||||
}
|
||||
|
||||
func testAccSpannerInstanceIamBinding_update(account, instance, roleId string) string {
|
||||
return fmt.Sprintf(`
|
||||
resource "google_service_account" "test_account" {
|
||||
account_id = "%s"
|
||||
display_name = "Spanner Iam Testing Account"
|
||||
}
|
||||
|
||||
resource "google_service_account" "test_account_2" {
|
||||
account_id = "%s-2"
|
||||
display_name = "Spanner Iam Testing Account"
|
||||
}
|
||||
|
||||
resource "google_spanner_instance" "instance" {
|
||||
name = "%s"
|
||||
config = "regional-us-central1"
|
||||
display_name = "%s"
|
||||
num_nodes = 1
|
||||
}
|
||||
|
||||
resource "google_spanner_instance_iam_binding" "foo" {
|
||||
project = "${google_spanner_instance.instance.project}"
|
||||
instance = "${google_spanner_instance.instance.name}"
|
||||
role = "%s"
|
||||
members = [
|
||||
"serviceAccount:${google_service_account.test_account.email}",
|
||||
"serviceAccount:${google_service_account.test_account_2.email}"
|
||||
]
|
||||
}
|
||||
`, account, account, instance, instance, roleId)
|
||||
}
|
||||
|
||||
func testAccSpannerInstanceIamMember_basic(account, instance, roleId string) string {
|
||||
return fmt.Sprintf(`
|
||||
resource "google_service_account" "test_account" {
|
||||
account_id = "%s"
|
||||
display_name = "Spanner Iam Testing Account"
|
||||
}
|
||||
|
||||
resource "google_spanner_instance" "instance" {
|
||||
name = "%s"
|
||||
config = "regional-us-central1"
|
||||
display_name = "%s"
|
||||
num_nodes = 1
|
||||
}
|
||||
|
||||
resource "google_spanner_instance_iam_member" "foo" {
|
||||
project = "${google_spanner_instance.instance.project}"
|
||||
instance = "${google_spanner_instance.instance.name}"
|
||||
role = "%s"
|
||||
member = "serviceAccount:${google_service_account.test_account.email}"
|
||||
}
|
||||
`, account, instance, instance, roleId)
|
||||
}
|
||||
|
||||
func testAccSpannerInstanceIamPolicy_basic(account, instance, roleId string) string {
|
||||
return fmt.Sprintf(`
|
||||
resource "google_service_account" "test_account" {
|
||||
account_id = "%s"
|
||||
display_name = "Spanner Iam Testing Account"
|
||||
}
|
||||
|
||||
resource "google_spanner_instance" "instance" {
|
||||
name = "%s"
|
||||
config = "regional-us-central1"
|
||||
display_name = "%s"
|
||||
num_nodes = 1
|
||||
}
|
||||
|
||||
data "google_iam_policy" "foo" {
|
||||
binding {
|
||||
role = "%s"
|
||||
|
||||
members = ["serviceAccount:${google_service_account.test_account.email}"]
|
||||
}
|
||||
}
|
||||
|
||||
resource "google_spanner_instance_iam_policy" "foo" {
|
||||
project = "${google_spanner_instance.instance.project}"
|
||||
instance = "${google_spanner_instance.instance.name}"
|
||||
policy_data = "${data.google_iam_policy.foo.policy_data}"
|
||||
}
|
||||
`, account, instance, instance, roleId)
|
||||
}
|
121
website/docs/r/spanner_instance_iam.html.markdown
Normal file
121
website/docs/r/spanner_instance_iam.html.markdown
Normal file
@ -0,0 +1,121 @@
|
||||
---
|
||||
layout: "google"
|
||||
page_title: "Google: google_spanner_instance_iam"
|
||||
sidebar_current: "docs-google-spanner-instance-iam"
|
||||
description: |-
|
||||
Collection of resources to manage IAM policy for a Spanner instance.
|
||||
---
|
||||
|
||||
# IAM policy for Spanner Instances
|
||||
|
||||
Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:
|
||||
|
||||
* `google_spanner_instance_iam_policy`: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
|
||||
|
||||
~> **Warning:** It's entirely possibly to lock yourself out of your instance using `google_spanner_instance_iam_policy`. Any permissions granted by default will be removed unless you include them in your config.
|
||||
|
||||
* `google_spanner_instance_iam_binding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the instance are preserved.
|
||||
* `google_spanner_instance_iam_member`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.
|
||||
|
||||
~> **Note:** `google_spanner_instance_iam_policy` **cannot** be used in conjunction with `google_spanner_instance_iam_binding` and `google_spanner_instance_iam_member` or they will fight over what your policy should be.
|
||||
|
||||
~> **Note:** `google_spanner_instance_iam_binding` resources **can be** used in conjunction with `google_spanner_instance_iam_member` resources **only if** they do not grant privilege to the same role.
|
||||
|
||||
## google\_spanner\_instance\_iam\_policy
|
||||
|
||||
```hcl
|
||||
data "google_iam_policy" "admin" {
|
||||
binding {
|
||||
role = "roles/editor"
|
||||
|
||||
members = [
|
||||
"user:jane@example.com",
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
resource "google_spanner_instance_iam_policy" "instance" {
|
||||
instance = "your-instance-name"
|
||||
policy_data = "${data.google_iam_policy.admin.policy_data}"
|
||||
}
|
||||
```
|
||||
|
||||
## google\_spanner\_instance\_iam\_binding
|
||||
|
||||
```hcl
|
||||
resource "google_spanner_instance_iam_binding" "instance" {
|
||||
instance = "your-instance-name"
|
||||
role = "roles/compute.networkUser"
|
||||
|
||||
members = [
|
||||
"user:jane@example.com",
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## google\_spanner\_instance\_iam\_member
|
||||
|
||||
```hcl
|
||||
resource "google_spanner_instance_iam_member" "instance" {
|
||||
instance = "your-instance-name"
|
||||
role = "roles/compute.networkUser"
|
||||
member = "user:jane@example.com"
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `instance` - (Required) The name of the instance.
|
||||
|
||||
* `member/members` - (Required) Identities that will be granted the privilege in `role`.
|
||||
Each entry can have one of the following values:
|
||||
* **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
|
||||
* **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
|
||||
* **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
|
||||
* **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
|
||||
* **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com.
|
||||
* **domain:{domain}**: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.
|
||||
|
||||
* `role` - (Required) The role that should be applied. Only one
|
||||
`google_spanner_instance_iam_binding` can be used per role. Note that custom roles must be of the format
|
||||
`[projects|organizations]/{parent-name}/roles/{role-name}`.
|
||||
|
||||
* `policy_data` - (Required only by `google_spanner_instance_iam_policy`) The policy data generated by
|
||||
a `google_iam_policy` data source.
|
||||
|
||||
* `project` - (Optional) The ID of the project in which the resource belongs. If it
|
||||
is not provided, the provider project is used.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
In addition to the arguments listed above, the following computed attributes are
|
||||
exported:
|
||||
|
||||
* `etag` - (Computed) The etag of the instance's IAM policy.
|
||||
|
||||
## Import
|
||||
|
||||
For all import syntaxes, the "resource in question" can take any of the following forms:
|
||||
|
||||
* {{project}}/{{name}}
|
||||
* {{name}} (project is taken from provider project)
|
||||
|
||||
IAM member imports use space-delimited identifiers; the resource in question, the role, and the account, e.g.
|
||||
|
||||
```
|
||||
$ terraform import google_spanner_instance_iam_member.instance "project-name/instance-name roles/viewer foo@example.com"
|
||||
```
|
||||
|
||||
IAM binding imports use space-delimited identifiers; the resource in question and the role, e.g.
|
||||
|
||||
```
|
||||
$ terraform import google_spanner_instance_iam_binding.instance "project-name/instance-name roles/viewer"
|
||||
```
|
||||
|
||||
IAM policy imports use the identifier of the resource in question, e.g.
|
||||
|
||||
```
|
||||
$ terraform import google_spanner_instance_iam_policy.instance project-name/instance-name
|
||||
```
|
@ -536,6 +536,15 @@
|
||||
<li<%= sidebar_current("docs-google-spanner-instance") %>>
|
||||
<a href="/docs/providers/google/r/spanner_instance.html">google_spanner_instance</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-google-spanner-instance-iam") %>>
|
||||
<a href="/docs/providers/google/r/spanner_instance_iam.html">google_spanner_instance_iam_binding</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-google-spanner-instance-iam") %>>
|
||||
<a href="/docs/providers/google/r/spanner_instance_iam.html">google_spanner_instance_iam_member</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-google-spanner-instance-iam") %>>
|
||||
<a href="/docs/providers/google/r/spanner_instance_iam.html">google_spanner_instance_iam_policy</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user