Skip to content

Commit e6768c4

Browse files
dhaiducekopenshift-merge-robot
authored andcommitted
Update reference YAML
Signed-off-by: Dale Haiducek <[email protected]>
1 parent 5ae8685 commit e6768c4

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/policygenerator-reference.yaml

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ policyDefaults:
1717
# annotation. This defaults to ["CM Configuration Management"].
1818
categories:
1919
- "CM Configuration Management"
20+
# Optional. Determines the policy controller behavior when comparing the manifest to objects on
21+
# the cluster ("musthave", "mustonlyhave", or "mustnothave"). Defaults to "musthave".
22+
complianceType: "musthave"
2023
# Optional. Key-value pairs of annotations to set on generated configuration policies. For
2124
# example, to disable policy templates, you can set this to:
2225
# {"policy.open-cluster-management.io/disable-templates": "true"}. This defaults to {}.
@@ -49,6 +52,14 @@ policyDefaults:
4952
metadataComplianceType: ""
5053
# Required. The namespace of all the policies.
5154
namespace: ""
55+
# Optional. Determines the list of namespaces to check on the cluster for the given manifest. If
56+
# a namespace is specified in the manifest, the selector is not necessary. This defaults to no
57+
# selectors.
58+
namespaceSelector:
59+
include: []
60+
exclude: []
61+
matchLabels: {}
62+
matchExpressions: []
5263
# Optional. The placement configuration for the policies. This defaults to a placement
5364
# configuration that matches all clusters.
5465
placement:
@@ -79,8 +90,6 @@ policyDefaults:
7990
# exists. Use of this setting will prevent a placement rule from being generated, but the
8091
# placement binding will still be created.
8192
placementRuleName: ""
82-
83-
8493
# Optional. The remediation action ("inform" or "enforce") for each configuration policy. This
8594
# defaults to "inform".
8695
remediationAction: "inform"
@@ -103,6 +112,7 @@ policyDefaults:
103112
# Optional. Annotations that the policy will include under its metadata.annotations. It will be applied for all
104113
# policies unless specified in the policy.
105114
policyAnnotations: {}
115+
106116
# Required. The list of policies to create along with overrides to either the default values or, if
107117
# set, the values given in policyDefaults.
108118
policies:
@@ -121,7 +131,7 @@ policies:
121131
# 2) For everything else, ConfigurationPolicy objects are generated to wrap these manifests.
122132
# The resulting ConfigurationPolicy is added as a Policy's policy-templates entry.
123133
- path: ""
124-
# Optional. (See policy[0].complianceType for description.)
134+
# Optional. (See policyDefaults.complianceType for description.)
125135
complianceType: "musthave"
126136
# Optional. (See policyDefaults.metadataComplianceType for description.)
127137
metadataComplianceType: ""
@@ -150,8 +160,7 @@ policies:
150160
# Optional. (See policyDefaults.categories for description.)
151161
categories:
152162
- "CM Configuration Management"
153-
# Optional. Determines the policy controller behavior when comparing the manifest to objects on
154-
# the cluster ("musthave", "mustonlyhave", or "mustnothave"). Defaults to "musthave".
163+
# Optional. (See policyDefaults.complianceType for description.)
155164
complianceType: "musthave"
156165
# Optional. (See policyDefaults.configurationPolicyAnnotations for description.)
157166
configurationPolicyAnnotations: {}
@@ -168,12 +177,8 @@ policies:
168177
informKyvernoPolicies: true
169178
# Optional. (See policyDefaults.consolidateManifests for description.)
170179
consolidateManifests: true
171-
# Optional. Determines the list of namespaces to check on the cluster for the given manifest. If
172-
# a namespace is specified in the manifest, the selector is not necessary. This defaults to no
173-
# selectors.
174-
namespaceSelector:
175-
include: []
176-
exclude: []
180+
# Optional.(See policyDefaults.namespaceSelector for description.)
181+
namespaceSelector: {}
177182
# Optional. (See policyDefaults.placement for description.)
178183
placement: {}
179184
# Optional. (See policyDefaults.remediationAction for description.)

0 commit comments

Comments
 (0)