Make Placement the default

`PlacementRule` is deprecated

ref: https://issues.redhat.com/browse/ACM-1286
Signed-off-by: Dale Haiducek <[email protected]>

Author: dhaiducek

docs/policygenerator.md

@@ -23,10 +23,10 @@ set `placement.name` along with `placement.clusterSelector`. When the PlacementB
 this way, `placementBindingDefaults.name` must be specified so that the generator can create unique
 names for the bindings.
 
-The PlacementRule kind in the `apps.open-cluster-management.io` API group is used by default if no
-placement is given. However, you can use the Placement kind in the
-`cluster.open-cluster-management.io` API group by specifying a Placement manifest in
-`placement.placementPath` or specifying labels in `placement.labelSelector`.
+The Placement kind in the `cluster.open-cluster-management.io` API group is used by default if no
+placement is given. However, you can use the deprecated PlacementRule kind in the
+`apps.open-cluster-management.io` API group by specifying a PlacementRule manifest in
+`placement.placementRulePath` or specifying labels in `placement.clusterSelector`.
 
 ## Policy expanders
 

examples/input/placementrule.yaml

@@ -6,9 +6,6 @@ metadata:
   name: placement-red-hat-cloud
   namespace: my-policies
 spec:
-  clusterConditions:
-    - status: "True"
-      type: ManagedClusterConditionAvailable
   clusterSelector:
     matchExpressions:
       - key: cloud

examples/policyGenerator-kustomize.yaml

@@ -8,7 +8,7 @@ policyDefaults:
   consolidateManifests: false
   # Use the name of an existing placement rule
   placement:
-    placementRuleName: placement-red-hat-cloud
+    placementName: placement-red-hat-cloud
 policies:
 - name: myapp
   manifests:

examples/policyGenerator.yaml

@@ -10,12 +10,12 @@ policyDefaults:
   controls: 
     - PR.DS-1 Data-at-rest
   namespace: my-policies
-  # Use an existing placement rule so that placement bindings can be consolidated
+  # Use an existing placement so that placement bindings can be consolidated
   placement:
-    placementRulePath: input/placementrule.yaml
-  # Example of using clusterSelectors to generate a placement rule
+    placementPath: input/placement.yaml
+  # Example of using labelSelector to generate a placement
   # placement:
-  #   clusterSelector:
+  #   labelSelector:
   #     matchLabels:
   #       cloud: red hat
   remediationAction: inform
@@ -75,10 +75,10 @@ policySets:
   policies:
     - pre-exists-kyverno-policy
   placement:
-    placementRulePath: input/placementrule.yaml
+    placementPath: input/placement.yaml
 - name: policyset-gatekeeper
   description: this is a gatekeeper policy set.
   placement:
-    placementRulePath: input/placementrule.yaml
+    placementPath: input/placement.yaml
 - name: policyset-iam
-  description: this is a iam policy set.
+  description: this is a iam policy set.

internal/plugin.go

@@ -1141,7 +1141,7 @@ func (p *Plugin) assertValidConfig() error {
 		)
 	}
 
-	p.usingPlR = plCount.plc == 0
+	p.usingPlR = plCount.plr != 0
 
 	return nil
 }

internal/plugin_test.go

@@ -39,7 +39,7 @@ func TestGenerate(t *testing.T) {
 	}
 
 	p.PlacementBindingDefaults.Name = "my-placement-binding"
-	p.PolicyDefaults.Placement.Name = "my-placement-rule"
+	p.PolicyDefaults.Placement.Name = "my-placement"
 	p.PolicyDefaults.Namespace = "my-policies"
 	p.PolicyDefaults.MetadataComplianceType = "musthave"
 	p.PolicyDefaults.PruneObjectBehavior = "DeleteAll"
@@ -154,24 +154,26 @@ spec:
                 severity: low
     remediationAction: inform
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
-    name: my-placement-rule
+    name: my-placement
     namespace: my-policies
 spec:
-    clusterSelector:
-        matchExpressions: []
+    predicates:
+        - requiredClusterSelector:
+            labelSelector:
+                matchExpressions: []
 ---
 apiVersion: policy.open-cluster-management.io/v1
 kind: PlacementBinding
 metadata:
     name: my-placement-binding
     namespace: my-policies
 placementRef:
-    apiGroup: apps.open-cluster-management.io
-    kind: PlacementRule
-    name: my-placement-rule
+    apiGroup: cluster.open-cluster-management.io
+    kind: Placement
+    name: my-placement
 subjects:
     - apiGroup: policy.open-cluster-management.io
       kind: Policy
@@ -747,32 +749,36 @@ spec:
                 severity: low
     remediationAction: inform
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
     name: placement-policy-app-config
     namespace: my-policies
 spec:
-    clusterSelector:
-        matchExpressions: []
+    predicates:
+        - requiredClusterSelector:
+            labelSelector:
+                matchExpressions: []
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
     name: placement-policy-app-config2
     namespace: my-policies
 spec:
-    clusterSelector:
-        matchExpressions: []
+    predicates:
+        - requiredClusterSelector:
+            labelSelector:
+                matchExpressions: []
 ---
 apiVersion: policy.open-cluster-management.io/v1
 kind: PlacementBinding
 metadata:
     name: binding-policy-app-config
     namespace: my-policies
 placementRef:
-    apiGroup: apps.open-cluster-management.io
-    kind: PlacementRule
+    apiGroup: cluster.open-cluster-management.io
+    kind: Placement
     name: placement-policy-app-config
 subjects:
     - apiGroup: policy.open-cluster-management.io
@@ -785,8 +791,8 @@ metadata:
     name: binding-policy-app-config2
     namespace: my-policies
 placementRef:
-    apiGroup: apps.open-cluster-management.io
-    kind: PlacementRule
+    apiGroup: cluster.open-cluster-management.io
+    kind: Placement
     name: placement-policy-app-config2
 subjects:
     - apiGroup: policy.open-cluster-management.io
@@ -1836,8 +1842,10 @@ kind: PlacementRule
 metadata:
     namespace: my-policies
 spec:
-    clusterSelector:
-        matchExpressions: []
+    predicates:
+        - requiredClusterSelector:
+            labelSelector:
+                matchExpressions: []
 `
 	p, plrPath := plPathHelper(t, plrYAML, true)
 
@@ -2387,7 +2395,7 @@ func TestGeneratePolicySetsWithPlacement(t *testing.T) {
 	}
 
 	p.PlacementBindingDefaults.Name = "my-placement-binding"
-	p.PolicyDefaults.Placement.Name = "my-placement-rule"
+	p.PolicyDefaults.Placement.Name = "my-placement"
 	p.PolicyDefaults.Namespace = "my-policies"
 
 	policyConf := types.PolicyConfig{
@@ -2452,24 +2460,26 @@ spec:
     policies:
         - policy-app-config
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
-    name: my-placement-rule
+    name: my-placement
     namespace: my-policies
 spec:
-    clusterSelector:
-        matchExpressions: []
+    predicates:
+        - requiredClusterSelector:
+            labelSelector:
+                matchExpressions: []
 ---
 apiVersion: policy.open-cluster-management.io/v1
 kind: PlacementBinding
 metadata:
     name: my-placement-binding
     namespace: my-policies
 placementRef:
-    apiGroup: apps.open-cluster-management.io
-    kind: PlacementRule
-    name: my-placement-rule
+    apiGroup: cluster.open-cluster-management.io
+    kind: Placement
+    name: my-placement
 subjects:
     - apiGroup: policy.open-cluster-management.io
       kind: PolicySet

internal/testdata/ordering/default-deps-propagated.yaml

@@ -73,32 +73,36 @@ spec:
           severity: low
   remediationAction: inform
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
   name: placement-one
   namespace: my-policies
 spec:
-  clusterSelector:
-    matchExpressions: []
+  predicates:
+  - requiredClusterSelector:
+      labelSelector:
+        matchExpressions: []
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
   name: placement-two
   namespace: my-policies
 spec:
-  clusterSelector:
-    matchExpressions: []
+  predicates:
+  - requiredClusterSelector:
+      labelSelector:
+        matchExpressions: []
 ---
 apiVersion: policy.open-cluster-management.io/v1
 kind: PlacementBinding
 metadata:
   name: binding-one
   namespace: my-policies
 placementRef:
-  apiGroup: apps.open-cluster-management.io
-  kind: PlacementRule
+  apiGroup: cluster.open-cluster-management.io
+  kind: Placement
   name: placement-one
 subjects:
   - apiGroup: policy.open-cluster-management.io
@@ -111,8 +115,8 @@ metadata:
   name: binding-two
   namespace: my-policies
 placementRef:
-  apiGroup: apps.open-cluster-management.io
-  kind: PlacementRule
+  apiGroup: cluster.open-cluster-management.io
+  kind: Placement
   name: placement-two
 subjects:
   - apiGroup: policy.open-cluster-management.io

internal/testdata/ordering/default-extradeps-consolidated.yaml

@@ -81,32 +81,36 @@ spec:
           severity: low
   remediationAction: inform
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
   name: placement-one
   namespace: my-policies
 spec:
-  clusterSelector:
-    matchExpressions: []
+  predicates:
+  - requiredClusterSelector:
+      labelSelector:
+        matchExpressions: []
 ---
-apiVersion: apps.open-cluster-management.io/v1
-kind: PlacementRule
+apiVersion: cluster.open-cluster-management.io/v1beta1
+kind: Placement
 metadata:
   name: placement-two
   namespace: my-policies
 spec:
-  clusterSelector:
-    matchExpressions: []
+  predicates:
+  - requiredClusterSelector:
+      labelSelector:
+        matchExpressions: []
 ---
 apiVersion: policy.open-cluster-management.io/v1
 kind: PlacementBinding
 metadata:
   name: binding-one
   namespace: my-policies
 placementRef:
-  apiGroup: apps.open-cluster-management.io
-  kind: PlacementRule
+  apiGroup: cluster.open-cluster-management.io
+  kind: Placement
   name: placement-one
 subjects:
   - apiGroup: policy.open-cluster-management.io
@@ -119,8 +123,8 @@ metadata:
   name: binding-two
   namespace: my-policies
 placementRef:
-  apiGroup: apps.open-cluster-management.io
-  kind: PlacementRule
+  apiGroup: cluster.open-cluster-management.io
+  kind: Placement
   name: placement-two
 subjects:
   - apiGroup: policy.open-cluster-management.io