Skip to content

Commit 6fbb017

Browse files
modular-magicianrileykarson
authored andcommitted
Fix docs for BinAuth Policy cluster_admission_rules (hashicorp#2125)
<!-- This change is generated by MagicModules. --> /cc @rileykarson
1 parent f2fc8a2 commit 6fbb017

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

docs/r/binaryauthorization_policy.html.markdown

+14-8
Original file line numberDiff line numberDiff line change
@@ -108,17 +108,21 @@ The `default_admission_rule` block supports:
108108

109109
* `admission_whitelist_patterns` -
110110
(Optional)
111-
Admission policy whitelisting. A matching admission request will
112-
always be permitted. This feature is typically used to exclude Google
113-
or third-party infrastructure images from Binary Authorization
114-
policies. Structure is documented below.
111+
A whitelist of image patterns to exclude from admission rules. If an
112+
image's name matches a whitelist pattern, the image's admission
113+
requests will always be permitted regardless of your admission rules. Structure is documented below.
115114

116115
* `cluster_admission_rules` -
117116
(Optional)
118-
Admission policy whitelisting. A matching admission request will
119-
always be permitted. This feature is typically used to exclude Google
120-
or third-party infrastructure images from Binary Authorization
121-
policies.
117+
Per-cluster admission rules. An admission rule specifies either that
118+
all container images used in a pod creation request must be attested
119+
to by one or more attestors, that all pod creations will be allowed,
120+
or that all pod creations will be denied. There can be at most one
121+
admission rule per cluster spec.
122+
123+
Identifier format: `{{location}}.{{clusterId}}`.
124+
A location is either a compute zone (e.g. `us-central1-a`) or a region
125+
(e.g. `us-central1`). Structure is documented below.
122126
* `project` - (Optional) The ID of the project in which the resource belongs.
123127
If it is not provided, the provider project is used.
124128

@@ -134,6 +138,8 @@ The `admission_whitelist_patterns` block supports:
134138

135139
The `cluster_admission_rules` block supports:
136140

141+
* `cluster` - (Required) The identifier for this object. Format specified above.
142+
137143
* `evaluation_mode` -
138144
(Optional)
139145
How this admission rule will be evaluated.

0 commit comments

Comments
 (0)