Implement ignoreFields in server side apply

Signed-off-by: Jian Qiu <[email protected]>
open-cluster-management-io · Nov 28, 2024 · 0575d30 · 0575d30
1 parent 52a1861
commit 0575d30
Show file tree

Hide file tree

Showing 22 changed files with 651 additions and 44 deletions.
diff --git a/...y/cluster-manager/olm-catalog/latest/manifests/cluster-manager.clusterserviceversion.yaml b/...y/cluster-manager/olm-catalog/latest/manifests/cluster-manager.clusterserviceversion.yaml
@@ -59,7 +59,7 @@ metadata:
     categories: Integration & Delivery,OpenShift Optional
     certified: "false"
     containerImage: quay.io/open-cluster-management/registration-operator:latest
-    createdAt: "2024-11-20T09:03:54Z"
+    createdAt: "2024-11-26T08:12:07Z"
     description: Manages the installation and upgrade of the ClusterManager.
     operators.operatorframework.io/builder: operator-sdk-v1.32.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3

diff --git a/...et/chart/klusterlet/crds/0000_00_operator.open-cluster-management.io_klusterlets.crd.yaml b/...et/chart/klusterlet/crds/0000_00_operator.open-cluster-management.io_klusterlets.crd.yaml
@@ -312,13 +312,15 @@ spec:
                               The arn of the hub cluster (ie: an EKS cluster). This will be required to pass information to hub, which hub will use to create IAM identities for this klusterlet.
                               Example - arn:eks:us-west-2:12345678910:cluster/hub-cluster1.
                             minLength: 1
+                            pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
                             type: string
                           managedClusterArn:
                             description: |-
                               The arn of the managed cluster (ie: an EKS cluster). This will be required to generate the md5hash which will be used as a suffix to create IAM role on hub
                               as well as used by kluslerlet-agent, to assume role suffixed with the md5hash, on startup.
                               Example - arn:eks:us-west-2:12345678910:cluster/managed-cluster1.
                             minLength: 1
+                            pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
                             type: string
                         type: object
                     type: object

diff --git a/...y/klusterlet/config/crds/0000_00_operator.open-cluster-management.io_klusterlets.crd.yaml b/...y/klusterlet/config/crds/0000_00_operator.open-cluster-management.io_klusterlets.crd.yaml
@@ -312,13 +312,15 @@ spec:
                               The arn of the hub cluster (ie: an EKS cluster). This will be required to pass information to hub, which hub will use to create IAM identities for this klusterlet.
                               Example - arn:eks:us-west-2:12345678910:cluster/hub-cluster1.
                             minLength: 1
+                            pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
                             type: string
                           managedClusterArn:
                             description: |-
                               The arn of the managed cluster (ie: an EKS cluster). This will be required to generate the md5hash which will be used as a suffix to create IAM role on hub
                               as well as used by kluslerlet-agent, to assume role suffixed with the md5hash, on startup.
                               Example - arn:eks:us-west-2:12345678910:cluster/managed-cluster1.
                             minLength: 1
+                            pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
                             type: string
                         type: object
                     type: object

diff --git a/deploy/klusterlet/olm-catalog/latest/manifests/klusterlet.clusterserviceversion.yaml b/deploy/klusterlet/olm-catalog/latest/manifests/klusterlet.clusterserviceversion.yaml
@@ -31,7 +31,7 @@ metadata:
     categories: Integration & Delivery,OpenShift Optional
     certified: "false"
     containerImage: quay.io/open-cluster-management/registration-operator:latest
-    createdAt: "2024-11-20T09:03:55Z"
+    createdAt: "2024-11-26T08:12:07Z"
     description: Manages the installation and upgrade of the Klusterlet.
     operators.operatorframework.io/builder: operator-sdk-v1.32.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3

diff --git a/...sterlet/olm-catalog/latest/manifests/operator.open-cluster-management.io_klusterlets.yaml b/...sterlet/olm-catalog/latest/manifests/operator.open-cluster-management.io_klusterlets.yaml
@@ -312,13 +312,15 @@ spec:
                               The arn of the hub cluster (ie: an EKS cluster). This will be required to pass information to hub, which hub will use to create IAM identities for this klusterlet.
                               Example - arn:eks:us-west-2:12345678910:cluster/hub-cluster1.
                             minLength: 1
+                            pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
                             type: string
                           managedClusterArn:
                             description: |-
                               The arn of the managed cluster (ie: an EKS cluster). This will be required to generate the md5hash which will be used as a suffix to create IAM role on hub
                               as well as used by kluslerlet-agent, to assume role suffixed with the md5hash, on startup.
                               Example - arn:eks:us-west-2:12345678910:cluster/managed-cluster1.
                             minLength: 1
+                            pattern: ^arn:aws:eks:([a-zA-Z0-9-]+):(\d{12}):cluster/([a-zA-Z0-9-]+)$
                             type: string
                         type: object
                     type: object

diff --git a/go.mod b/go.mod
@@ -33,7 +33,7 @@ require (
 	k8s.io/kube-aggregator v0.31.3
 	k8s.io/utils v0.0.0-20240921022957-49e7df575cb6
 	open-cluster-management.io/addon-framework v0.11.0
-	open-cluster-management.io/api v0.15.1-0.20241120090202-cb7ce98ab874
+	open-cluster-management.io/api v0.15.1-0.20241126073717-05ff7c1affe8
 	open-cluster-management.io/sdk-go v0.15.1-0.20241125015855-1536c3970f8f
 	sigs.k8s.io/cluster-inventory-api v0.0.0-20240730014211-ef0154379848
 	sigs.k8s.io/controller-runtime v0.19.2

diff --git a/go.sum b/go.sum
@@ -453,8 +453,8 @@ k8s.io/utils v0.0.0-20240921022957-49e7df575cb6 h1:MDF6h2H/h4tbzmtIKTuctcwZmY0tY
 k8s.io/utils v0.0.0-20240921022957-49e7df575cb6/go.mod h1:OLgZIPagt7ERELqWJFomSt595RzquPNLL48iOWgYOg0=
 open-cluster-management.io/addon-framework v0.11.0 h1:ZJxphgHQ36VUJF0RIag+nzcEn5PNyep2rsEPdz6wT7o=
 open-cluster-management.io/addon-framework v0.11.0/go.mod h1:ruMU8i/dciz3qCv2CQ46Cu1b7rkK7TpvB+W4bRwHf+I=
-open-cluster-management.io/api v0.15.1-0.20241120090202-cb7ce98ab874 h1:WgkuYXTbJV7EK+qtiMq3soa21faGUKeTG5w0C8Mn1Ok=
-open-cluster-management.io/api v0.15.1-0.20241120090202-cb7ce98ab874/go.mod h1:9erZEWEn4bEqh0nIX2wA7f/s3KCuFycQdBrPrRzi0QM=
+open-cluster-management.io/api v0.15.1-0.20241126073717-05ff7c1affe8 h1:yKI2N8VN3zij+2O8kEOGfXBtZDs3pMey0BFfikgBpJM=
+open-cluster-management.io/api v0.15.1-0.20241126073717-05ff7c1affe8/go.mod h1:9erZEWEn4bEqh0nIX2wA7f/s3KCuFycQdBrPrRzi0QM=
 open-cluster-management.io/sdk-go v0.15.1-0.20241125015855-1536c3970f8f h1:zeC7QrFNarfK2zY6jGtd+mX+yDrQQmnH/J8A7n5Nh38=
 open-cluster-management.io/sdk-go v0.15.1-0.20241125015855-1536c3970f8f/go.mod h1:fi5WBsbC5K3txKb8eRLuP0Sim/Oqz/PHX18skAEyjiA=
 sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.30.3 h1:2770sDpzrjjsAtVhSeUFseziht227YAWYHLGNM8QPwY=

diff --git a/...ster-manager/hub/0000_00_work.open-cluster-management.io_manifestworkreplicasets.crd.yaml b/...ster-manager/hub/0000_00_work.open-cluster-management.io_manifestworkreplicasets.crd.yaml
@@ -262,8 +262,8 @@ spec:
                           properties:
                             serverSideApply:
                               description: |-
-                                serverSideApply defines the configuration for server side apply. It is honored only when
-                                type of updateStrategy is ServerSideApply
+                                serverSideApply defines the configuration for server side apply. It is honored only when the
+                                type of the updateStrategy is ServerSideApply
                               properties:
                                 fieldManager:
                                   default: work-agent
@@ -276,6 +276,37 @@ spec:
                                   description: Force represents to force apply the
                                     manifest.
                                   type: boolean
+                                ignoreFields:
+                                  description: IgnoreFields defines a list of json
+                                    paths in the resource that will not be updated
+                                    on the spoke.
+                                  items:
+                                    properties:
+                                      condition:
+                                        default: OnSpokePresent
+                                        description: |-
+                                          Condition defines the condition that the fields should be ignored when apply the resource.
+                                          Fields in JSONPaths are all ignored when condition is met, otherwise no fields is ignored
+                                          in the apply operation.
+                                        enum:
+                                        - OnSpokePresent
+                                        - OnSpokeChange
+                                        type: string
+                                      jsonPaths:
+                                        description: JSONPaths defines the list of
+                                          json path in the resource to be ignored
+                                        items:
+                                          type: string
+                                        minItems: 1
+                                        type: array
+                                    required:
+                                    - condition
+                                    - jsonPaths
+                                    type: object
+                                  type: array
+                                  x-kubernetes-list-map-keys:
+                                  - condition
+                                  x-kubernetes-list-type: map
                               type: object
                             type:
                               default: Update

diff --git a/manifests/cluster-manager/hub/0000_00_work.open-cluster-management.io_manifestworks.crd.yaml b/manifests/cluster-manager/hub/0000_00_work.open-cluster-management.io_manifestworks.crd.yaml
@@ -239,8 +239,8 @@ spec:
                       properties:
                         serverSideApply:
                           description: |-
-                            serverSideApply defines the configuration for server side apply. It is honored only when
-                            type of updateStrategy is ServerSideApply
+                            serverSideApply defines the configuration for server side apply. It is honored only when the
+                            type of the updateStrategy is ServerSideApply
                           properties:
                             fieldManager:
                               default: work-agent
@@ -252,6 +252,36 @@ spec:
                             force:
                               description: Force represents to force apply the manifest.
                               type: boolean
+                            ignoreFields:
+                              description: IgnoreFields defines a list of json paths
+                                in the resource that will not be updated on the spoke.
+                              items:
+                                properties:
+                                  condition:
+                                    default: OnSpokePresent
+                                    description: |-
+                                      Condition defines the condition that the fields should be ignored when apply the resource.
+                                      Fields in JSONPaths are all ignored when condition is met, otherwise no fields is ignored
+                                      in the apply operation.
+                                    enum:
+                                    - OnSpokePresent
+                                    - OnSpokeChange
+                                    type: string
+                                  jsonPaths:
+                                    description: JSONPaths defines the list of json
+                                      path in the resource to be ignored
+                                    items:
+                                      type: string
+                                    minItems: 1
+                                    type: array
+                                required:
+                                - condition
+                                - jsonPaths
+                                type: object
+                              type: array
+                              x-kubernetes-list-map-keys:
+                              - condition
+                              x-kubernetes-list-type: map
                           type: object
                         type:
                           default: Update

diff --git a/...ests/cluster-manager/hub/0000_03_addon.open-cluster-management.io_addontemplates.crd.yaml b/...ests/cluster-manager/hub/0000_03_addon.open-cluster-management.io_addontemplates.crd.yaml
@@ -255,8 +255,8 @@ spec:
                           properties:
                             serverSideApply:
                               description: |-
-                                serverSideApply defines the configuration for server side apply. It is honored only when
-                                type of updateStrategy is ServerSideApply
+                                serverSideApply defines the configuration for server side apply. It is honored only when the
+                                type of the updateStrategy is ServerSideApply
                               properties:
                                 fieldManager:
                                   default: work-agent
@@ -269,6 +269,37 @@ spec:
                                   description: Force represents to force apply the
                                     manifest.
                                   type: boolean
+                                ignoreFields:
+                                  description: IgnoreFields defines a list of json
+                                    paths in the resource that will not be updated
+                                    on the spoke.
+                                  items:
+                                    properties:
+                                      condition:
+                                        default: OnSpokePresent
+                                        description: |-
+                                          Condition defines the condition that the fields should be ignored when apply the resource.
+                                          Fields in JSONPaths are all ignored when condition is met, otherwise no fields is ignored
+                                          in the apply operation.
+                                        enum:
+                                        - OnSpokePresent
+                                        - OnSpokeChange
+                                        type: string
+                                      jsonPaths:
+                                        description: JSONPaths defines the list of
+                                          json path in the resource to be ignored
+                                        items:
+                                          type: string
+                                        minItems: 1
+                                        type: array
+                                    required:
+                                    - condition
+                                    - jsonPaths
+                                    type: object
+                                  type: array
+                                  x-kubernetes-list-map-keys:
+                                  - condition
+                                  x-kubernetes-list-type: map
                               type: object
                             type:
                               default: Update