Add resource references to cluster names (#17)

Description of changes: Add resource references to each of the custom resources to replace `ClusterName`. I have tested these changes manually and, while they work, are currently sub-optimal. The generated code currently does not check for the `ResourceSynced` condition to be `true` before resolving the reference. Therefore, since all of these resources reference the cluster spec field, they immediately resolve. As a result, the resources immediately attempt to create - even though the cluster is still in `CREATING` status. Once aws-controllers-k8s/community#1064 is properly implemented, and the code gating the `ResourceSynced` status is enabled, these resources should work flawlessly. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
aws-controllers-k8s · Jan 12, 2022 · a8e1ec0 · a8e1ec0
1 parent dd817be
commit a8e1ec0
Show file tree

Hide file tree

Showing 19 changed files with 394 additions and 22 deletions.
diff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml
@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2022-01-09T00:30:18Z"
-  build_hash: 3e184727de8a4dfd4769e3d88f4f52f885858335
+  build_date: "2022-01-12T20:00:52Z"
+  build_hash: b24c062600f1ae90d62e760c23e69651ac167a24
   go_version: go1.17.1
   version: v0.16.0
-api_directory_checksum: 18423a5aa90c547e267c460f25ce08e5c0b4aaa6
+api_directory_checksum: aca79dadb322fdb182185a7e9b9cb44e14b30d0a
 api_version: v1alpha1
 aws_sdk_go_version: v1.38.67
 generator_config_info:
-  file_checksum: b66d077bc28c12a65378f3eb515c5ab814a93090
+  file_checksum: 794a511b629b00b81bfe943eaf41eedf7c780ff7
   original_file_name: generator.yaml
 last_modification:
   reason: API generation
diff --git a/apis/v1alpha1/addon.go b/apis/v1alpha1/addon.go
diff --git a/apis/v1alpha1/fargate_profile.go b/apis/v1alpha1/fargate_profile.go
diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml
@@ -1,5 +1,10 @@
 resources:
   Addon:
+    fields:
+      ClusterName:
+        references:
+          resource: Cluster
+          path: Spec.Name
     renames:
       operations:
         CreateAddon:
@@ -58,6 +63,11 @@ resources:
     update_operation:
       custom_method_name: customUpdate
   FargateProfile:
+    fields:
+      ClusterName:
+        references:
+          resource: Cluster
+          path: Spec.Name
     renames:
       operations:
         CreateFargateProfile:
@@ -87,6 +97,11 @@ resources:
         - MissingParameter
         - ValidationError
   Nodegroup:
+    fields:
+      ClusterName:
+        references:
+          resource: Cluster
+          path: Spec.Name
     renames:
       operations:
         CreateNodegroup:

diff --git a/apis/v1alpha1/nodegroup.go b/apis/v1alpha1/nodegroup.go
diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/eks.services.k8s.aws_addons.yaml b/config/crd/bases/eks.services.k8s.aws_addons.yaml
@@ -48,6 +48,20 @@ spec:
               clusterName:
                 description: The name of the cluster to create the add-on for.
                 type: string
+              clusterNameRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef:   from:     name:
+                  my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               name:
                 description: The name of the add-on. The name must match one of the
                   names returned by ListAddons (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html).
@@ -77,7 +91,6 @@ spec:
                   both of which you define.
                 type: object
             required:
-            - clusterName
             - name
             type: object
           status:

diff --git a/config/crd/bases/eks.services.k8s.aws_fargateprofiles.yaml b/config/crd/bases/eks.services.k8s.aws_fargateprofiles.yaml
@@ -45,6 +45,20 @@ spec:
                 description: The name of the Amazon EKS cluster to apply the Fargate
                   profile to.
                 type: string
+              clusterNameRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef:   from:     name:
+                  my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               name:
                 description: The name of the Fargate profile.
                 type: string
@@ -91,7 +105,6 @@ spec:
                   Fargate profile, such as the pods that are scheduled with it.
                 type: object
             required:
-            - clusterName
             - name
             - podExecutionRoleARN
             type: object

diff --git a/config/crd/bases/eks.services.k8s.aws_nodegroups.yaml b/config/crd/bases/eks.services.k8s.aws_nodegroups.yaml
@@ -58,6 +58,20 @@ spec:
               clusterName:
                 description: The name of the cluster to create the node group in.
                 type: string
+              clusterNameRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef:   from:     name:
+                  my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               diskSize:
                 description: The root device disk size (in GiB) for your node group
                   instances. The default disk size is 20 GiB. If you specify launchTemplate,
@@ -217,7 +231,6 @@ spec:
                   in the Amazon EKS User Guide.
                 type: string
             required:
-            - clusterName
             - name
             - nodeRole
             - subnets

diff --git a/generator.yaml b/generator.yaml
@@ -1,5 +1,10 @@
 resources:
   Addon:
+    fields:
+      ClusterName:
+        references:
+          resource: Cluster
+          path: Spec.Name
     renames:
       operations:
         CreateAddon:
@@ -58,6 +63,11 @@ resources:
     update_operation:
       custom_method_name: customUpdate
   FargateProfile:
+    fields:
+      ClusterName:
+        references:
+          resource: Cluster
+          path: Spec.Name
     renames:
       operations:
         CreateFargateProfile:
@@ -87,6 +97,11 @@ resources:
         - MissingParameter
         - ValidationError
   Nodegroup:
+    fields:
+      ClusterName:
+        references:
+          resource: Cluster
+          path: Spec.Name
     renames:
       operations:
         CreateNodegroup:

diff --git a/helm/crds/eks.services.k8s.aws_addons.yaml b/helm/crds/eks.services.k8s.aws_addons.yaml
@@ -48,6 +48,20 @@ spec:
               clusterName:
                 description: The name of the cluster to create the add-on for.
                 type: string
+              clusterNameRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef:   from:     name:
+                  my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               name:
                 description: The name of the add-on. The name must match one of the
                   names returned by ListAddons (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html).
@@ -77,7 +91,6 @@ spec:
                   both of which you define.
                 type: object
             required:
-            - clusterName
             - name
             type: object
           status:

diff --git a/helm/crds/eks.services.k8s.aws_fargateprofiles.yaml b/helm/crds/eks.services.k8s.aws_fargateprofiles.yaml
@@ -45,6 +45,20 @@ spec:
                 description: The name of the Amazon EKS cluster to apply the Fargate
                   profile to.
                 type: string
+              clusterNameRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef:   from:     name:
+                  my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               name:
                 description: The name of the Fargate profile.
                 type: string
@@ -91,7 +105,6 @@ spec:
                   Fargate profile, such as the pods that are scheduled with it.
                 type: object
             required:
-            - clusterName
             - name
             - podExecutionRoleARN
             type: object

diff --git a/helm/crds/eks.services.k8s.aws_nodegroups.yaml b/helm/crds/eks.services.k8s.aws_nodegroups.yaml
@@ -58,6 +58,20 @@ spec:
               clusterName:
                 description: The name of the cluster to create the node group in.
                 type: string
+              clusterNameRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef:   from:     name:
+                  my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               diskSize:
                 description: The root device disk size (in GiB) for your node group
                   instances. The default disk size is 20 GiB. If you specify launchTemplate,
@@ -217,7 +231,6 @@ spec:
                   in the Amazon EKS User Guide.
                 type: string
             required:
-            - clusterName
             - name
             - nodeRole
             - subnets

diff --git a/pkg/resource/addon/delta.go b/pkg/resource/addon/delta.go