Skip to content

Commit

Permalink
Add google_kms_key_ring_iam_policy resource and improve iam docs (has…
Browse files Browse the repository at this point in the history
…hicorp#814)

* Add google_kms_key_ring_iam_policy resource and improve iam docs
* Delete iam_binding and iam_member specific doc page for key ring
  • Loading branch information
rosbo authored Dec 6, 2017
1 parent 6bdc8ec commit 1162b74
Show file tree
Hide file tree
Showing 6 changed files with 98 additions and 102 deletions.
2 changes: 1 addition & 1 deletion docs/r/google_kms_crypto_key.html.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: "google"
page_title: "Google: google_kms_crypto_key"
sidebar_current: "docs-google-kms-crypto-key"
sidebar_current: "docs-google-kms-crypto-key-x"
description: |-
Allows creation of a Google Cloud Platform KMS CryptoKey.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/r/google_kms_key_ring.html.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: "google"
page_title: "Google: google_kms_key_ring"
sidebar_current: "docs-google-kms-key-ring"
sidebar_current: "docs-google-kms-key-ring-x"
description: |-
Allows creation of a Google Cloud Platform KMS KeyRing.
---
Expand Down
92 changes: 92 additions & 0 deletions docs/r/google_kms_key_ring_iam.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
layout: "google"
page_title: "Google: google_kms_key_ring_iam"
sidebar_current: "docs-google-kms-key-ring-iam"
description: |-
Collection of resources to manage IAM policy for a Google Cloud KMS key ring.
---

# IAM policy for Google Cloud KMS key ring

Three different resources help you manage your IAM policy for KMS key ring. Each of these resources serves a different use case:

* `google_kms_key_ring_iam_policy`: Authoritative. Sets the IAM policy for the key ring and replaces any existing policy already attached.
* `google_kms_key_ring_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 key ring are preserved.
* `google_kms_key_ring_iam_member`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the key ring are preserved.

~> **Note:** `google_kms_key_ring_iam_policy` **cannot** be used in conjunction with `google_kms_key_ring_iam_binding` and `google_kms_key_ring_iam_member` or they will fight over what your policy should be.

~> **Note:** `google_kms_key_ring_iam_binding` resources **can be** used in conjunction with `google_kms_key_ring_iam_member` resources **only if** they do not grant privilege to the same role.

## google\_kms\_key\_ring\_iam\_policy

```hcl
data "google_iam_policy" "admin" {
binding {
role = "roles/editor"
members = [
"user:[email protected]",
]
}
}
resource "google_kms_key_ring_iam_policy" "key_ring" {
key_ring_id = "your-key-ring-id"
policy_data = "${data.google_iam_policy.admin.policy_data}"
}
```

## google\_kms\_key\_ring\_iam\_binding

```hcl
resource "google_kms_key_ring_binding" "key_ring" {
key_ring_id = "your-key-ring-id"
role = "roles/editor"
members = [
"user:[email protected]",
]
}
```

## google\_kms\_key\_ring\_iam\_member

```hcl
resource "google_kms_key_ring_iam_member" "key_ring" {
key_ring_id = "your-key-ring-id"
role = "roles/editor"
member = "user:[email protected]"
}
```

## Argument Reference

The following arguments are supported:

* `key_ring_id` - (Required) The key ring ID, in the form
`{project_id}/{location_name}/{key_ring_name}` or
`{location_name}/{key_ring_name}`. In the second form, the provider's
project setting will be used as a fallback.

* `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, [email protected] or [email protected].
* **serviceAccount:{emailid}**: An email address that represents a service account. For example, [email protected].
* **group:{emailid}**: An email address that represents a Google group. For example, [email protected].
* **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_kms_key_ring_iam_binding` can be used per role.

* `policy_data` - (Required only by `google_kms_key_ring_iam_policy`) The policy data generated by
a `google_iam_policy` data source.

## Attributes Reference

In addition to the arguments listed above, the following computed attributes are
exported:

* `etag` - (Computed) The etag of the key ring's IAM policy.
46 changes: 0 additions & 46 deletions docs/r/google_kms_key_ring_iam_binding.html.markdown

This file was deleted.

47 changes: 0 additions & 47 deletions docs/r/google_kms_key_ring_iam_member.html.markdown

This file was deleted.

11 changes: 4 additions & 7 deletions google.erb
Original file line number Diff line number Diff line change
Expand Up @@ -447,16 +447,13 @@
<li<%= sidebar_current("docs-google-kms") %>>
<a href="#">Google Key Management Service Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-google-kms-key-ring") %>>
<li<%= sidebar_current("docs-google-kms-key-ring-x") %>>
<a href="/docs/providers/google/r/google_kms_key_ring.html">google_kms_key_ring</a>
</li>
<li<%= sidebar_current("docs-google-kms-key-ring-iam-binding") %>>
<a href="/docs/providers/google/r/google_kms_key_ring_iam_binding.html">google_kms_key_ring_iam_binding</a>
<li<%= sidebar_current("docs-google-kms-key-ring-iam") %>>
<a href="/docs/providers/google/r/google_kms_key_ring_iam.html">google_kms_key_ring_iam_*</a>
</li>
<li<%= sidebar_current("docs-google-kms-key-ring-iam-member") %>>
<a href="/docs/providers/google/r/google_kms_key_ring_iam_member.html">google_kms_key_ring_iam_member</a>
</li>
<li<%= sidebar_current("docs-google-kms-crypto-key") %>>
<li<%= sidebar_current("docs-google-kms-crypto-key-x") %>>
<a href="/docs/providers/google/r/google_kms_crypto_key.html">google_kms_crypto_key</a>
</li>
<li<%= sidebar_current("docs-google-kms-crypto-key-iam-binding") %>>
Expand Down

0 comments on commit 1162b74

Please sign in to comment.